fix: Remove global GTM container on private booking page. #21490

vijayraghav-io · 2025-05-23T13:29:17Z

What does this PR do?

Fixes GTM container meant for dashboard loads on Private Booking links #21430
Fixes CAL-5796

Root cause
Layout - apps/web/app/(use-page-wrapper)/layout.tsx where global GTM container scripts are injected through env.
This layout also wraps the apps/web/app/(use-page-wrapper)/d/[link]/[slug]/page.tsx (private booking page)
Hence the gtm.js is loaded for private booking page.

Implemented solution
Move the d/[link]/[slug]/page.tsx to under (booking-page-wrapper)

Alternate solution
Apply a route/path based filter in (use-page-wrapper)/layout.tsx , to not inject scripts for /d/[link]/[slug]/page.tsx
For this the exact pathname has to be detected.
h.get('Referer) will not work all the time.
So we need to append a header like x-pathname in middleware. This requires to allow all paths to middleware.
We can create a parallel middleware without modifying existing middleware.
The new middleware allows all paths and only appends the x-pathname from req.nextUrl.pathname.
The performance implications of all requests or paths reaching middleware has to be considered.

Visual Demo (For contributors especially)

Video Demo (if applicable):

Before Changes - https://www.loom.com/share/93edfb9104fb445bb329946631e7df87?sid=95f1ce78-7133-43f8-8b7c-98fa9b74a9a8

After Changes - https://www.loom.com/share/a89aefbf16f94ecb8cf17be798a7515c?sid=a0ef0fc8-8cce-4e70-8a35-38e50d9f53f9

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected).
-N/A I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

Are there environment variables that should be set?
What are the minimal test data to have?
In .env
Set NEXT_PUBLIC_BODY_SCRIPTS=(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;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-PV22BDLZ');
What is expected (happy path) to have (input and output)?
Create a private booking link for any event. (Edit -> EventType -> Advanced Tab -> Private links)
Visit this link, gtm.js should not be loaded when checked in network tab
Also check the script with id = injected-body-script should not be loaded inside the html body
Visit any other page (except booking pages), the gtm.js should be loaded.
Any other important info that could help to test that PR

Summary by cubic

Stopped the Google Tag Manager script from loading on private booking links to protect user privacy.

Bug Fixes
- Added a route filter in the layout to prevent GTM scripts from injecting on /d/[link]/[slug] pages.

vercel · 2025-05-23T13:29:26Z

@vijayraghav-io is attempting to deploy a commit to the cal Team on Vercel.

A member of the Team first needs to authorize it.

graphite-app · 2025-05-23T13:30:11Z

Graphite Automations

"Add community label" took an action on this PR • (05/23/25)

1 label was added to this PR based on Keith Williams's automation.

"Add ready-for-e2e label" took an action on this PR • (05/25/25)

1 label was added to this PR based on Keith Williams's automation.

vijayraghav-io · 2025-05-23T15:10:45Z

@hariombalhara , Kindly review.
Moved d/[link]/[slug]/page.tsx to under (booking-page-wrapper).
Please refer description for more details and alternate approach 🙏

…_on_privatelinks

…n middleware

vijayraghav-io · 2025-05-24T14:34:55Z

Allowing catch all paths in existing middleware requires to whitelist certain paths.
Considering the recent changes in middleware to remove catch all for performance, dint want to bring back this.

So, switched to other method of moving d/[link]/[slug]/page.tsx to under (booking-page-wrapper) from (use-page-wrapper)

vijayraghav-io · 2025-05-24T14:51:18Z

Added e2e tests :

test - "global GTM should not be loaded on private booking link" - verifies the script with id=injected-body-script is Not loaded on visiting private booking page link.

test - "global GTM should be loaded on non-booking pages" - verifies that the current PR changes will not affected the GTM script being loaded on Non-booking pages. Given the script is injected through env.

Verified both tests Passing locally.

…_on_privatelinks

vijayraghav-io · 2025-05-24T15:15:56Z

To more verify the fix :
when test - "global GTM should not be loaded on private booking link" , applied on current main

vijayraghav-io · 2025-05-24T15:23:54Z

apps/web/playwright/booking-pages.e2e.ts

+  });
+
+  test("global GTM should be loaded on non-booking pages", async ({ page, users }) => {
+    test.skip(!process.env.NEXT_PUBLIC_BODY_SCRIPTS, "Skipping test as NEXT_PUBLIC_BODY_SCRIPTS is not set");


This test can be best tested if envNEXT_PUBLIC_BODY_SCRIPTS= is assigned with a value as described in the PR description.
By permanently assigning a value for testing purpose inside .env.example, for the above variable, has some implications -

All Non-Booking routes will have gtm.js loaded , all these related test executions will be impacted as an additional external API call will be made always. This may result in increasing the test execution time.

Locally this test alone can be tested with .only and appending the value for the above env variable, for verification without skipping test.

hariombalhara

Great fix @vijayraghav-io 🙏

vijayraghav-io · 2025-05-25T14:14:37Z

Thank you! @hariombalhara 🙏

github-actions · 2025-05-25T14:39:39Z

E2E results are ready!

Workflow #61607.1 latest results

vijayraghav-io · 2025-05-25T15:54:36Z

@hariombalhara , all tests are passing 🙏

add route filter to inject script

4248d0d

vijayraghav-io requested review from a team as code owners May 23, 2025 13:29

graphite-app bot added the community Created by Linear-GitHub Sync label May 23, 2025

github-actions bot added booking-page area: booking page, public booking page, booker 🐛 bug Something isn't working labels May 23, 2025

update middleware for pathname as Referer might not work all time

c058d0e

vijayraghav-io changed the title ~~fix: GTM container on private booking links~~ fix: Remove global GTM container on private booking links. May 24, 2025

vijayraghav-io changed the title ~~fix: Remove global GTM container on private booking links.~~ fix: Remove global GTM container on private booking page. May 24, 2025

vijayraghav-io added 3 commits May 24, 2025 17:27

Merge branch 'main' of https://github.com/calcom/cal.com into fix_gtm…

8ebc322

…_on_privatelinks

move d to (booking-page-wrapper) instead of route filter and change i…

dc09afd

…n middleware

add e2e tests

9fe0f49

Merge branch 'main' of https://github.com/calcom/cal.com into fix_gtm…

7f292ba

…_on_privatelinks

vijayraghav-io commented May 24, 2025

View reviewed changes

hariombalhara approved these changes May 25, 2025

View reviewed changes

graphite-app bot added the ready-for-e2e label May 25, 2025

Merge branch 'main' into fix_gtm_on_privatelinks

ca4875d

hariombalhara merged commit b8ffcef into calcom:main May 26, 2025
33 of 36 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: Remove global GTM container on private booking page. #21490

fix: Remove global GTM container on private booking page. #21490

Uh oh!

vijayraghav-io commented May 23, 2025 •

edited

Loading

Uh oh!

vercel bot commented May 23, 2025

Uh oh!

graphite-app bot commented May 23, 2025 •

edited

Loading

Uh oh!

vijayraghav-io commented May 23, 2025 •

edited

Loading

Uh oh!

vijayraghav-io commented May 24, 2025 •

edited

Loading

Uh oh!

vijayraghav-io commented May 24, 2025 •

edited

Loading

Uh oh!

vijayraghav-io commented May 24, 2025 •

edited

Loading

Uh oh!

vijayraghav-io May 24, 2025 •

edited

Loading

Uh oh!

hariombalhara left a comment

Uh oh!

vijayraghav-io commented May 25, 2025

Uh oh!

github-actions bot commented May 25, 2025 •

edited

Loading

Uh oh!

vijayraghav-io commented May 25, 2025

Uh oh!

Uh oh!

Uh oh!

fix: Remove global GTM container on private booking page. #21490

fix: Remove global GTM container on private booking page. #21490

Uh oh!

Conversation

vijayraghav-io commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Visual Demo (For contributors especially)

Video Demo (if applicable):

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

Summary by cubic

Uh oh!

vercel bot commented May 23, 2025

Uh oh!

graphite-app bot commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Graphite Automations

Uh oh!

vijayraghav-io commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vijayraghav-io commented May 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vijayraghav-io commented May 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vijayraghav-io commented May 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vijayraghav-io May 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hariombalhara left a comment

Choose a reason for hiding this comment

Uh oh!

vijayraghav-io commented May 25, 2025

Uh oh!

github-actions bot commented May 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

E2E results are ready!

Uh oh!

vijayraghav-io commented May 25, 2025

Uh oh!

Uh oh!

Uh oh!

vijayraghav-io commented May 23, 2025 •

edited

Loading

graphite-app bot commented May 23, 2025 •

edited

Loading

vijayraghav-io commented May 23, 2025 •

edited

Loading

vijayraghav-io commented May 24, 2025 •

edited

Loading

vijayraghav-io commented May 24, 2025 •

edited

Loading

vijayraghav-io commented May 24, 2025 •

edited

Loading

vijayraghav-io May 24, 2025 •

edited

Loading

github-actions bot commented May 25, 2025 •

edited

Loading