Skip to content

feat(gatsby-plugin-google-tagmanager): add self hosted path option #38731

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
merged 4 commits into from
Dec 4, 2023
Merged

feat(gatsby-plugin-google-tagmanager): add self hosted path option #38731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2be2ec5
Add initial commit, update README.md with new attribute
Dec 2, 2023
0e320c2
Copy over files from PR with ID 34287
Dec 2, 2023
ff78203
fix lint
pieh Dec 4, 2023
e9ec11f
Merge branch 'master' into topics/google-tag-manager-add-option-for-s…
pieh Dec 4, 2023
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
2 changes: 2 additions & 0 deletions packages/gatsby-plugin-google-tagmanager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ plugins: [
enableWebVitalsTracking: true,
// Defaults to https://www.googletagmanager.com
selfHostedOrigin: "YOUR_SELF_HOSTED_ORIGIN",
// Defaults to gtm.js
selfHostedPath: "YOUR_SELF_HOSTED_PATH",
},
},
]
Expand Down
1 change: 1 addition & 0 deletions packages/gatsby-plugin-google-tagmanager/src/__tests__/gatsby-node.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ describe(`pluginOptionsSchema`, () => {
routeChangeEventName: `YOUR_ROUTE_CHANGE_EVENT_NAME`,
enableWebVitalsTracking: true,
selfHostedOrigin: `YOUR_SELF_HOSTED_ORIGIN`,
selfHostedPath: `YOUR_SELF_HOSTED_PATH`,
}
)

Expand Down
41 changes: 41 additions & 0 deletions packages/gatsby-plugin-google-tagmanager/src/__tests__/gatsby-ssr.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,5 +228,46 @@ describe(`gatsby-plugin-google-tagmanager`, () => {
`${selfHostedOrigin}/ns.html`
)
})
it(`should set selfHostedPath as gtm.js by default`, () => {
const mocks = {
setHeadComponents: jest.fn(),
setPreBodyComponents: jest.fn(),
}
const pluginOptions = {
id: `123`,
includeInDevelopment: true,
}

onRenderBody(mocks, pluginOptions)
const [headConfig] = mocks.setHeadComponents.mock.calls[0][0]
const [preBodyConfig] = mocks.setPreBodyComponents.mock.calls[0][0]

// eslint-disable-next-line no-useless-escape
expect(headConfig.props.dangerouslySetInnerHTML.__html).toContain(
`https://www.googletagmanager.com/gtm.js`
)
})

it(`should set selfHostedPath`, () => {
const selfHostedPath = `YOUR_SELF_HOSTED_PATH`
const mocks = {
setHeadComponents: jest.fn(),
setPreBodyComponents: jest.fn(),
}
const pluginOptions = {
id: `123`,
includeInDevelopment: true,
selfHostedPath: selfHostedPath,
}

onRenderBody(mocks, pluginOptions)
const [headConfig] = mocks.setHeadComponents.mock.calls[0][0]
const [preBodyConfig] = mocks.setPreBodyComponents.mock.calls[0][0]

// eslint-disable-next-line no-useless-escape
expect(headConfig.props.dangerouslySetInnerHTML.__html).toContain(
`https://www.googletagmanager.com/${selfHostedPath}`
)
})
})
})
3 changes: 3 additions & 0 deletions packages/gatsby-plugin-google-tagmanager/src/gatsby-node.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,7 @@ exports.pluginOptionsSchema = ({ Joi }) =>
selfHostedOrigin: Joi.string()
.default(`https://www.googletagmanager.com`)
.description(`The origin where GTM is hosted.`),
selfHostedPath: Joi.string()
.default(`gtm.js`)
.description(`The path where GTM is hosted.`),
})
5 changes: 4 additions & 1 deletion packages/gatsby-plugin-google-tagmanager/src/gatsby-ssr.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ const generateGTM = ({
environmentParamStr,
dataLayerName,
selfHostedOrigin,
selfHostedPath,
}) => stripIndent`
(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'${selfHostedOrigin}/gtm.js?id='+i+dl+'${environmentParamStr}';f.parentNode.insertBefore(j,f);
'${selfHostedOrigin}/${selfHostedPath}?id='+i+dl+'${environmentParamStr}';f.parentNode.insertBefore(j,f);
})(window,document,'script','${dataLayerName}', '${id}');`

const generateGTMIframe = ({ id, environmentParamStr, selfHostedOrigin }) =>
Expand Down Expand Up @@ -47,6 +48,7 @@ exports.onRenderBody = (
dataLayerName = `dataLayer`,
enableWebVitalsTracking = false,
selfHostedOrigin = `https://www.googletagmanager.com`,
selfHostedPath = `gtm.js`,
}
) => {
if (process.env.NODE_ENV === `production` || includeInDevelopment) {
Expand Down Expand Up @@ -96,6 +98,7 @@ exports.onRenderBody = (
environmentParamStr,
dataLayerName,
selfHostedOrigin,
selfHostedPath,
})}`,
}}
/>
Expand Down