Skip to content

fix(use-gtm): ensure environment auth is present before injecting url #719

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 1 commit into from
Apr 20, 2022
Merged

fix(use-gtm): ensure environment auth is present before injecting url #719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions packages/use-gtm/src/__tests__/__snapshots__/index.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@ exports[`GTM hook Provider should call onLoadError if script fail to load 1`] =
})(window,document,'script','dataLayer','testId');</script>"
`;

exports[`GTM hook Provider should load env when environment auth is missing 1`] = `
"<script src=\\"https://www.googletagmanager.com/gtm.js?id=testId\\"></script><script>window.dataLayer = window.dataLayer || [];</script><script>(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='https://www.googletagmanager.com/gtm.js?id='+i+dl+'';

j.addEventListener('error', function() {
var _ge = new CustomEvent('gtm_loading_error', { bubbles: true });
d.dispatchEvent(_ge);
});

f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','testId');</script>"
`;

exports[`GTM hook Provider should load when id and environment is provided 1`] = `
"<script src=\\"https://www.googletagmanager.com/gtm.js?id=testId&amp;gtm_auth=gtm&amp;gtm_preview=world&amp;gtm_cookies_win=x\\"></script><script>window.dataLayer = window.dataLayer || [];</script><script>(function(w,d,s,l,i){w[l]=w[l]||[];
w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});
Expand Down
14 changes: 14 additions & 0 deletions packages/use-gtm/src/__tests__/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,20 @@ describe('GTM hook', () => {
expect(document.head.innerHTML).toMatchSnapshot()
})

it('Provider should load env when environment auth is missing', () => {
renderHook(() => useGTM<DefaultEvents>(), {
wrapper: wrapper({
// @ts-expect-error we test a failing case
environment: {
preview: 'world',
},
id: 'testId',
}),
})

expect(document.head.innerHTML).toMatchSnapshot()
})

it('Provider should load with events when provided', () => {
const { result } = renderHook(() => useGTM<DefaultEvents>(), {
wrapper: wrapper({
Expand Down
6 changes: 3 additions & 3 deletions packages/use-gtm/src/scripts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ export const DATALAYER_NAME = 'dataLayer'
export const LOAD_ERROR_EVENT = 'gtm_loading_error'

const flattenEnvironment = (environment?: GTMEnvironment) =>
environment
? `&${Object.entries(environment)
environment && environment.auth
? `&${Object.entries({ ...environment, cookies_win: 'x' })
.filter(([, value]) => !!value)
.map(([key, value]) => `gtm_${key}=${value}`, '')
.join('&')}&gtm_cookies_win=x`
.join('&')}`
: ''

const generateSnippets = (id: string, environment?: GTMEnvironment) => {
Expand Down