Skip to content
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.

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

App router migration google tag manager script #1117

Conversation

boodland
Copy link
Contributor

@boodland boodland commented Sep 2, 2024

Children PR for the progressive migration of _app.tsx and _document.tsx within the Root Layout

Issue link / number:

#1083

What changes did you make?

Changed script strategy to afterInteractive as worker doesn't work for app router
https://nextjs.org/docs/pages/building-your-application/optimizing/scripts#offloading-scripts-to-a-web-worker-experimental
https://nextjs.org/docs/pages/api-reference/components/script#afterinteractive
Added google tag manager configuration to root layout
Moved Script from _document to _app as recommended in the pages router documentation
https://nextjs.org/docs/pages/building-your-application/optimizing/scripts#application-scripts
https://nextjs.org/docs/pages/api-reference/components/script#afterinteractive
Added comment about new approach not being used due to how events are pushed to the dataLayer

Why did you make the changes?

In order to be able to have google tag manager within app router

Did you run tests?

Yes

Navigate to http://localhost:3000/ to check that the head gtag and body scripts are added properly
image

Navigate to http://localhost:3000/public-route-test to check that the head gtag and body scripts are added properly

image

Copy link

vercel bot commented Sep 2, 2024

@boodland is attempting to deploy a commit to the Chayn Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Sep 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bloom-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 9:19am

@eleanorreem eleanorreem merged commit 5fd9223 into chaynHQ:next-js-migration Sep 17, 2024
5 checks passed
@eleanorreem
Copy link
Contributor

@boodland looks great. Thanks!

@boodland boodland deleted the app-router-migration-google-tag-manager-script branch September 18, 2024 06:46
eleanorreem pushed a commit that referenced this pull request Oct 2, 2024
* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Add google tag manager to root layout

* Change strategy as worker is experimental and is not including the script

* Move gtm to body as next is including it in head properly

* Add comment to tackle in the future

* Move gtm script from _document to _app
eleanorreem added a commit that referenced this pull request Oct 8, 2024
* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Add new relic nextjs configuration

* Create new relic configuration file

* Use new relic configuration

* Remove non required file

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* App router migration google tag manager script (#1117)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Add google tag manager to root layout

* Change strategy as worker is experimental and is not including the script

* Move gtm to body as next is including it in head properly

* Add comment to tackle in the future

* Move gtm script from _document to _app

* App router migration rollbar script (#1118)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Use script tag and set id

* Add rollbar script to root layout

* Make it beforeInteractive so it is included in the head

* Move to _app as next/script is not working in _document

* App router migration opengraph metadata (#1120)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Move primary color to a constant so can be used in a server component (root layout)

* Create rootMetadata

* Fix format

* Add metadata to root layout

---------

Co-authored-by: eleanorreem <[email protected]>

* App router migration error boundary component (#1121)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Make error boundary client component

* Add ErrorBoundary component to root layout

* Create app router error route test page

---------

Co-authored-by: eleanorreem <[email protected]>

* App router migration material UI configuration (#1122)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Create theme registry component

* Add ThemeRegistry to root layout

* Make theme client component

* Install mui for app router

---------

Co-authored-by: eleanorreem <[email protected]>

* App router migration analytics (#1123)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Create Analytics component

* Add analytics to root layout

* Update layout.tsx

---------

Co-authored-by: eleanorreem <[email protected]>

---------

Co-authored-by: eleanorreem <[email protected]>
eleanorreem pushed a commit that referenced this pull request Oct 8, 2024
* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Add google tag manager to root layout

* Change strategy as worker is experimental and is not including the script

* Move gtm to body as next is including it in head properly

* Add comment to tackle in the future

* Move gtm script from _document to _app
eleanorreem added a commit that referenced this pull request Oct 8, 2024
* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Add new relic nextjs configuration

* Create new relic configuration file

* Use new relic configuration

* Remove non required file

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* App router migration google tag manager script (#1117)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Add google tag manager to root layout

* Change strategy as worker is experimental and is not including the script

* Move gtm to body as next is including it in head properly

* Add comment to tackle in the future

* Move gtm script from _document to _app

* App router migration rollbar script (#1118)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Use script tag and set id

* Add rollbar script to root layout

* Make it beforeInteractive so it is included in the head

* Move to _app as next/script is not working in _document

* App router migration opengraph metadata (#1120)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Move primary color to a constant so can be used in a server component (root layout)

* Create rootMetadata

* Fix format

* Add metadata to root layout

---------

Co-authored-by: eleanorreem <[email protected]>

* App router migration error boundary component (#1121)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Make error boundary client component

* Add ErrorBoundary component to root layout

* Create app router error route test page

---------

Co-authored-by: eleanorreem <[email protected]>

* App router migration material UI configuration (#1122)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Create theme registry component

* Add ThemeRegistry to root layout

* Make theme client component

* Install mui for app router

---------

Co-authored-by: eleanorreem <[email protected]>

* App router migration analytics (#1123)

* Add basic Root Layout

* Add metadata

* Add reference included by next

* Add comment to explain the default meta tags

* Add public testing page to check the migration

* Remove non required file

* Create Analytics component

* Add analytics to root layout

* Update layout.tsx

---------

Co-authored-by: eleanorreem <[email protected]>

---------

Co-authored-by: eleanorreem <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants