feat: Add framework to send all events fired for embed to Analytics Apps #15173

hariombalhara · 2024-05-23T09:30:31Z

What does this PR do?

Now, we can simply add the support of pushing any event to any analytics app by defining a pushEventScript prop in config.json. This would work for any analytics app that support sending an event with any payload.

Any event fired through sdkActionManager.fire call will reach the enabled analytic app if it has pushEventScript prop defined

Added support for GTM app pushEvent
Added 2 new events bookingSuccessfulV2 and rescheduleBookingSuccessfulV2. Also, deprecated bookingSuccessful and rescheduleBookingSuccessful

bookingSuccessfulV2: {
    uid: string | undefined;
    title: string | undefined;
    startTime: string | undefined;
    endTime: string | undefined;
    eventTypeId: number | null | undefined;
    status: string | undefined;
    paymentRequired: boolean;
  };

rescheduleBookingSuccessfulV2: {
    uid: string | undefined;
    title: string | undefined;
    startTime: string | undefined;
    endTime: string | undefined;
    eventTypeId: number | null | undefined;
    status: string | undefined;
    paymentRequired: boolean;
  };

Fixes #15168
Fixes CAL-3785

GTM dataLayer event demo

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected)
I have added a Docs issue here if this PR makes changes that would require a documentation change
I have added or modified automated tests that prove my fix is effective or that my feature works (PRs might be rejected if logical changes are not properly tested)

How should this be tested?

Are there environment variables that should be set?
What are the minimal test data to have?
What is expected (happy path) to have (input and output)?
Any other important info that could help to test that PR

NOTE:
For apps like fathom which just supports _value as an event prop and recommends event name to be dynamic as well, GTM(or some other tag manager) is better suited to listen to the event and send that specific event based on the dataLayer variables.

vercel · 2024-05-23T09:30:39Z

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

Name	Status	Preview	Comments	Updated (UTC)
ai	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 30, 2024 10:17am

2 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
cal	⬜️ Ignored (Inspect)	Visit Preview		May 30, 2024 10:17am
calcom-web-canary	⬜️ Ignored (Inspect)	Visit Preview		May 30, 2024 10:17am

github-actions · 2024-05-23T09:30:44Z

Thank you for following the naming conventions! 🙏 Feel free to join our discord and post your PR link.

hariombalhara · 2024-05-23T09:30:49Z

feat: Add framework to send all events fired for embed to Analytics Apps #15173 👈
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @hariombalhara and the rest of your teammates on Graphite

linear · 2024-05-23T09:32:42Z

CAL-3785 Analytics Apps: Track "Confirm" as an event (GTM, Fathom, etc.)

github-actions · 2024-05-23T09:40:54Z

📦 Next.js Bundle Analysis for @calcom/web

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

packages/app-store/BookingPageTagManager.tsx

hariombalhara · 2024-05-30T08:28:31Z

packages/app-store/BookingPageTagManager.tsx


 import type { appDataSchemas } from "./apps.schemas.generated";

+const PushEventPrefix = "cal_analytics_app_";


A global function is defined starting with this string for each analytics app.

…Support added)

hariombalhara · 2024-05-30T08:41:25Z

packages/features/bookings/lib/create-booking.ts

+      startTime: string;
+      endTime: string;


The response of a regular fetch request can't have Date as value for any prop, so we accordingly adjust the types.

hariombalhara · 2024-05-30T08:41:33Z

packages/features/bookings/lib/handleNewBooking.ts

@@ -2253,7 +2253,7 @@ async function handler(
    req.statusCode = 201;
    // TODO: Refactor better so this booking object is not passed
    // all around and instead the individual fields are sent as args.
-    const bookingReponse = {
+    const bookingResponse = {


hariombalhara · 2024-05-30T08:42:05Z

packages/features/bookings/lib/handleNewBooking.ts

@@ -1636,8 +1636,8 @@ async function handler(
          ...newBooking.user,
          email: null,
        },
+        paymentRequired: false,


Added this prop to easily differentiate the case where payment is required.

graphite-app · 2024-05-30T10:15:11Z

Graphite Automations

"Add consumer team as reviewer" took an action on this PR • (05/30/24)

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

CarinaWolli

Code looks good 🙏

…pps (calcom#15173) * Send all events to analytics apps * feat: Start sending all events fired for embed to Analytics Apps(GTM Support added) * Add tests

Send all events to analytics apps

36729c4

keithwillcode added consumer core area: core, team members only labels May 23, 2024

hariombalhara changed the title ~~feat: Start sending all events fired for embed to Analytics Apps(GTM Support added)~~ feat: Add framework to send all events fired for embed to Analytics Apps May 23, 2024

vercel bot deployed to Preview – ai May 23, 2024 09:33 View deployment

vercel bot had a problem deploying to Preview – api May 23, 2024 09:34 Failure

vercel bot deployed to Preview – dev May 23, 2024 09:42 View deployment

hariombalhara force-pushed the 05-23-feat_start_sending_all_events_fired_for_embed_to_analytics_apps_gtm_support_added_ branch from 78f8074 to 3e64d6c Compare May 30, 2024 08:09

github-actions bot added High priority Created by Linear-GitHub Sync organizations area: organizations, orgs 🐛 bug Something isn't working labels May 30, 2024

vercel bot deployed to Preview – ai May 30, 2024 08:12 View deployment

vercel bot deployed to Preview – api May 30, 2024 08:16 View deployment

vercel bot deployed to Preview – dev May 30, 2024 08:21 View deployment

hariombalhara commented May 30, 2024

View reviewed changes

packages/app-store/BookingPageTagManager.tsx Outdated Show resolved Hide resolved

hariombalhara commented May 30, 2024

View reviewed changes

hariombalhara force-pushed the 05-23-feat_start_sending_all_events_fired_for_embed_to_analytics_apps_gtm_support_added_ branch from 3e64d6c to 6a0142d Compare May 30, 2024 08:31

vercel bot deployed to Preview – ai May 30, 2024 08:34 View deployment

feat: Start sending all events fired for embed to Analytics Apps(GTM …

0477e34

…Support added)

vercel bot deployed to Preview – api May 30, 2024 08:38 View deployment

hariombalhara commented May 30, 2024

View reviewed changes

vercel bot deployed to Preview – dev May 30, 2024 08:43 View deployment

hariombalhara force-pushed the 05-23-feat_start_sending_all_events_fired_for_embed_to_analytics_apps_gtm_support_added_ branch from 6a0142d to b3f3140 Compare May 30, 2024 10:04

hariombalhara force-pushed the 05-23-feat_start_sending_all_events_fired_for_embed_to_analytics_apps_gtm_support_added_ branch from b3f3140 to d48815d Compare May 30, 2024 10:05

vercel bot deployed to Preview – ai May 30, 2024 10:10 View deployment

hariombalhara force-pushed the 05-23-feat_start_sending_all_events_fired_for_embed_to_analytics_apps_gtm_support_added_ branch from d48815d to ca98c6d Compare May 30, 2024 10:12

Add tests

b67dad6

hariombalhara force-pushed the 05-23-feat_start_sending_all_events_fired_for_embed_to_analytics_apps_gtm_support_added_ branch from ca98c6d to b67dad6 Compare May 30, 2024 10:14

hariombalhara marked this pull request as ready for review May 30, 2024 10:14

graphite-app bot requested a review from a team May 30, 2024 10:14

dosubot bot added bookings area: bookings, availability, timezones, double booking embed area: embed, widget, react embed ✨ feature New feature or request labels May 30, 2024

dosubot bot added this to the v4.2 milestone May 30, 2024

vercel bot deployed to Preview – ai May 30, 2024 10:17 View deployment

vercel bot deployed to Preview – api May 30, 2024 10:24 View deployment

vercel bot deployed to Preview – dev May 30, 2024 10:28 View deployment

CarinaWolli approved these changes May 31, 2024

View reviewed changes

CarinaWolli added this pull request to the merge queue May 31, 2024

Merged via the queue into main with commit 1730ef7 May 31, 2024
25 checks passed

CarinaWolli deleted the 05-23-feat_start_sending_all_events_fired_for_embed_to_analytics_apps_gtm_support_added_ branch May 31, 2024 16:29

p6l-richard mentioned this pull request Jul 24, 2024

fix(marketing): move the sitemap for search engines to core app #15893

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add framework to send all events fired for embed to Analytics Apps #15173

feat: Add framework to send all events fired for embed to Analytics Apps #15173

hariombalhara commented May 23, 2024 •

edited

Loading

vercel bot commented May 23, 2024 •

edited

Loading

github-actions bot commented May 23, 2024 •

edited

Loading

hariombalhara commented May 23, 2024

linear bot commented May 23, 2024

github-actions bot commented May 23, 2024

hariombalhara May 30, 2024 •

edited

Loading

hariombalhara May 30, 2024

hariombalhara May 30, 2024

hariombalhara May 30, 2024

graphite-app bot commented May 30, 2024

CarinaWolli left a comment


		import type { appDataSchemas } from "./apps.schemas.generated";

		const PushEventPrefix = "cal_analytics_app_";

feat: Add framework to send all events fired for embed to Analytics Apps #15173

feat: Add framework to send all events fired for embed to Analytics Apps #15173

Conversation

hariombalhara commented May 23, 2024 • edited Loading

What does this PR do?

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

vercel bot commented May 23, 2024 • edited Loading

github-actions bot commented May 23, 2024 • edited Loading

hariombalhara commented May 23, 2024

linear bot commented May 23, 2024

github-actions bot commented May 23, 2024

📦 Next.js Bundle Analysis for @calcom/web

hariombalhara May 30, 2024 • edited Loading

Choose a reason for hiding this comment

hariombalhara May 30, 2024

Choose a reason for hiding this comment

hariombalhara May 30, 2024

Choose a reason for hiding this comment

hariombalhara May 30, 2024

Choose a reason for hiding this comment

graphite-app bot commented May 30, 2024

Graphite Automations

CarinaWolli left a comment

Choose a reason for hiding this comment

hariombalhara commented May 23, 2024 •

edited

Loading

vercel bot commented May 23, 2024 •

edited

Loading

github-actions bot commented May 23, 2024 •

edited

Loading

hariombalhara May 30, 2024 •

edited

Loading