Skip to content

Simplified version that doesn't break the deploy. #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
killev merged 8 commits into from
Aug 14, 2025
Merged

Simplified version that doesn't break the deploy. #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
35f9c74
Simplified version that doesn't break the deploy.
Aug 14, 2025
f616620
Fix SonarQube issues.
Aug 14, 2025
755cd17
Implement CodeRabbit suggestions.
Aug 14, 2025
914f42d
Fix dependencies from @apostrophecms/seo that we don't need.
Aug 14, 2025
06d8735
Implement CodeRabbit suggestions: 2nd round.
Aug 14, 2025
c0b222d
Fix local errors.
Aug 14, 2025
000de2d
Implement CodeRabbit suggestions: 3nd round.
Aug 14, 2025
afccd0a
Merge branch 'main' into 409-feature/integrate-gtm-bug-fix
killev Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions website/app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,8 @@ function createAposConfig() {
},
},
},
// GTM setup and dependencies
'@apostrophecms/seo': {
options: {
googleTagManager: {
id: process.env.GOOGLE_TAG_MANAGER_ID,
},
},
},
// Enable local SEO module with GTM integration
'@apostrophecms/seo': {},
'@apostrophecms/global': {},
// Make getEnv function available to templates
'@apostrophecms/template': {
Expand Down
44 changes: 10 additions & 34 deletions website/modules/@apostrophecms/seo/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,20 @@
const gtmUtils = require('./lib/gtm-utils');

module.exports = {
improve: '@apostrophecms/seo',
init(self) {
// Ensure SEO components are injected into the template
self.apos.template.prepend('body', '@apostrophecms/seo:tagManagerBody');
self.apos.template.append('head', '@apostrophecms/seo:tagManagerHead');
self.apos.template.prepend('head', '@apostrophecms/seo:metaHead');
options: {
googleTagManager: {
id: process.env.GOOGLE_TAG_MANAGER_ID,
},
},
// No init hook required (layout renders components explicitly).
components(self) {
/*
* Resolve GTM ID from global override or module options and validate it
*/
const sanitizeGtmId = (id) => {
const value = String(id || '').trim();
if (/^gtm-[\da-z]+$/iu.test(value)) {
return value.toUpperCase();
}
return '';
};
const resolveGtmId = (req) => {
const fromGlobal = req?.data?.global?.seoGoogleTagManager;
const fromOptions = self.options?.googleTagManager?.id;
const candidate =
(fromGlobal && String(fromGlobal).trim()) ||
(fromOptions && String(fromOptions).trim());
return sanitizeGtmId(candidate);
};

const getGtmId = (req) => gtmUtils.resolveGtmId(req, self.options);
return {
metaHead(req, data) {
// Only on front-end page requests
if (!req?.data?.page) {
return {};
}
return {};
},
tagManagerBody(req, data) {
if (!req?.data?.page) {
return {};
}
const gtmId = resolveGtmId(req);
const gtmId = getGtmId(req);
if (gtmId) {
return { gtmId };
}
Expand All @@ -48,7 +24,7 @@ module.exports = {
if (!req?.data?.page) {
return {};
}
const gtmId = resolveGtmId(req);
const gtmId = getGtmId(req);
if (gtmId) {
return { gtmId };
}
Expand Down
21 changes: 21 additions & 0 deletions website/modules/@apostrophecms/seo/lib/gtm-utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
const sanitizeGtmId = function (id) {
const value = String(id || '')
.trim()
.toUpperCase();
// Strict GTM container format, e.g., "GTM-XXXXXXX"
if (/^GTM-[\dA-Z]+$/u.test(value)) {
return value;
}
return '';
};

const resolveGtmId = function (req, options) {
const fromGlobal = req?.data?.global?.seoGoogleTagManager;
const fromOptions = options?.googleTagManager?.id;
const candidate =
(fromGlobal && String(fromGlobal).trim()) ||
(fromOptions && String(fromOptions).trim());
return sanitizeGtmId(candidate);
};

module.exports = { sanitizeGtmId, resolveGtmId };
1 change: 0 additions & 1 deletion website/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
"dependencies": {
"@apostrophecms/form": "^1.4.2",
"@apostrophecms/import-export": "^3.2.0",
"@apostrophecms/seo": "^1.3.1",
"@barba/core": "^2.10.3",
"abort-controller": "^3.0.0",
"apostrophe": "^4.17.0",
Expand Down
2 changes: 2 additions & 0 deletions website/views/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@
{# ✅ Add favicon in the <head> section #}
{% block extraHead %}
<link rel="icon" href="{{ apos.asset.url('/modules/asset/favicon/favicon.ico') }}" type="image/x-icon">
{% component '@apostrophecms/seo:tagManagerHead' with data %}
{% endblock %}

{% block beforeMain %}
{% component '@apostrophecms/seo:tagManagerBody' with data %}
<a class="sr-only" href="#main">Skip to content</a>
<div
class="bp-wrapper relative"
Expand Down
Loading