feat: booking no show webhook #15502

zomars · 2024-06-19T19:53:02Z

What does this PR do?

Fixes [CAL-3945] No-show webhook event #15483)
References feat: track no-shows in bookings #15307 feat: added Rating Template to Workflows #14215
Fixes CAL-XXXX (Linear issue number - should be visible at the bottom of the GitHub issue description)

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?

Set up a webhook for no-shows
Change the no-show on a booking

Signed-off-by: zomars <[email protected]>

linear · 2024-06-19T19:53:05Z

CAL-3945 No-show webhook event

github-actions · 2024-06-19T19:53:13Z

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

Unknown release type "WIP" found in pull request title "WIP: booking no show webhook". 

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

vercel · 2024-06-19T19:55:16Z

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	Jun 27, 2024 7:46pm

2 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
cal	⬜️ Ignored (Inspect)	Visit Preview		Jun 27, 2024 7:46pm
calcom-web-canary	⬜️ Ignored (Inspect)	Visit Preview		Jun 27, 2024 7:46pm

Signed-off-by: zomars <[email protected]>

zomars

Self review done

zomars · 2024-06-19T23:15:16Z

apps/web/playwright/bookings-list.e2e.ts

+      await webhookReceiver.waitForRequestCount(1);
+      const [request] = webhookReceiver.requestList;
+      const body = request.body;
+      // remove dynamic properties that differs depending on where you run the tests
+      const dynamic = "[redacted/dynamic]";
+      // @ts-expect-error we are modifying the object
+      body.createdAt = dynamic;
+      expect(body).toMatchObject({
+        triggerEvent: "BOOKING_NO_SHOW_UPDATED",
+        createdAt: "[redacted/dynamic]",
+        payload: {
+          message: "x_marked_as_no_show",
+          attendees: [{ email: "[email protected]", noShow: true, utcOffset: null }],
+          bookingUid: bookingWhereFirstUserIsOrganizer?.uid,
+        },
+      });
+      webhookReceiver.close();


Decided to add the test in here instead of webhooks to avoid repeating the whole logic.

zomars · 2024-06-19T23:15:30Z

apps/web/playwright/fixtures/webhooks.ts

Extracted this reused logic into a fixture.

zomars · 2024-06-19T23:15:42Z

apps/web/playwright/lib/fixtures.ts

New webhooks fixture

zomars · 2024-06-19T23:15:57Z

apps/web/playwright/webhook.e2e.ts

This file is mostly refactor using the new fixture.

zomars · 2024-06-19T23:16:50Z

packages/features/webhooks/lib/WebhookService.ts

+
+const log = logger.getSubLogger({ prefix: ["[WebhookService] "] });
+
+/** This is a WIP. With minimal methods until the API matures and stabilizes */


This is a POC to simplify handling webhooks in future code.

zomars · 2024-06-19T23:19:57Z

packages/trpc/server/routers/publicViewer/noShow.handler.ts

+      const booking = await prisma.booking.findUnique({
+        where: { uid: bookingUid },
+        select: {
+          eventType: {
+            select: {
+              id: true,
+              teamId: true,
+              userId: true,
+            },
+          },
        },
      });
+      const orgId = await getOrgIdFromMemberOrTeamId({
+        memberId: booking?.eventType?.userId,
+        teamId: booking?.eventType?.teamId,
+      });


These are required payloads for Webhooks service. Would like to simplify even more.

zomars · 2024-06-19T23:20:25Z

apps/web/components/booking/BookingListItem.tsx

-        "success"
-      );
+    onSuccess: async (data) => {
+      showToast(t(data.message, { x: name || email }), "success");


We get the message from server instead

zomars · 2024-06-19T23:24:01Z

packages/features/webhooks/lib/sendPayload.ts

 export type WebhookDataType = CalendarEvent &
+  // BookingNoShowUpdatedPayload & // This breaks all other webhooks


To be fixed

zomars · 2024-06-19T23:24:18Z

packages/trpc/server/routers/publicViewer/noShow.handler.ts

+      // @ts-expect-error payload is too booking specific, we need to refactor this
+      await webhooks.sendPayload({ ...payload, bookingUid });


Added explainer here.

apps/web/playwright/bookings-list.e2e.ts

Udit-takkar

@zomars E2E test "on submitting user form, triggers user webhook" is failing locally because of createReceiver (in createWebhookPageFixture).

Udit-takkar

Fixed the test. Re approving the PR

WIP

9b4c201

Signed-off-by: zomars <[email protected]>

github-actions bot added the ❗️ migrations contains migration files label Jun 19, 2024

keithwillcode added core area: core, team members only foundation labels Jun 19, 2024

vercel bot deployed to Preview – ai June 19, 2024 19:55 View deployment

vercel bot had a problem deploying to Preview – api June 19, 2024 19:56 Failure

vercel bot had a problem deploying to Preview – dev June 19, 2024 20:00 Failure

WIP

325d5fa

Signed-off-by: zomars <[email protected]>

github-actions bot added High priority Created by Linear-GitHub Sync webhooks area: webhooks, callback, webhook payload ✨ feature New feature or request labels Jun 19, 2024

vercel bot had a problem deploying to Preview – api June 19, 2024 22:57 Failure

vercel bot deployed to Preview – dev June 19, 2024 23:10 View deployment

WIP

1a1643e

Signed-off-by: zomars <[email protected]>

zomars requested a review from a team June 19, 2024 23:14

zomars changed the title ~~WIP: booking no show webhook~~ feat: booking no show webhook Jun 19, 2024

zomars marked this pull request as ready for review June 19, 2024 23:14

dosubot bot added the bookings area: bookings, availability, timezones, double booking label Jun 19, 2024

dosubot bot added this to the v4.2 milestone Jun 19, 2024

vercel bot had a problem deploying to Preview – api June 19, 2024 23:18 Failure

Type fixes

80d95a0

zomars commented Jun 19, 2024

View reviewed changes

vercel bot deployed to Preview – api June 19, 2024 23:30 View deployment

Update webhook.e2e.ts

3bec71b

vercel bot deployed to Preview – api June 19, 2024 23:48 View deployment

vercel bot deployed to Preview – dev June 20, 2024 00:00 View deployment

keithwillcode requested changes Jun 20, 2024

View reviewed changes

apps/web/playwright/bookings-list.e2e.ts Outdated Show resolved Hide resolved

keithwillcode added this pull request to the merge queue Jun 26, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 26, 2024

keithwillcode added this pull request to the merge queue Jun 27, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 27, 2024

Merge branch 'main' into zomars/cal-3945-no-show-webhook-event

549987d

vercel bot deployed to Preview – ai June 27, 2024 13:20 View deployment

Udit-takkar reviewed Jun 27, 2024

View reviewed changes

fix: webhook end to end test

098bbc4

Udit-takkar dismissed keithwillcode’s stale review via 098bbc4 June 27, 2024 13:23

Udit-takkar previously approved these changes Jun 27, 2024

View reviewed changes

Udit-takkar enabled auto-merge June 27, 2024 13:24

fix: type error

c7fff79

Udit-takkar dismissed their stale review via c7fff79 June 27, 2024 13:31

vercel bot deployed to Preview – api June 27, 2024 13:37 View deployment

fix: test

c927c09

vercel bot deployed to Preview – api June 27, 2024 13:45 View deployment

Udit-takkar approved these changes Jun 27, 2024

View reviewed changes

Udit-takkar added this pull request to the merge queue Jun 27, 2024

vercel bot deployed to Preview – dev June 27, 2024 14:07 View deployment

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 27, 2024

Udit-takkar added this pull request to the merge queue Jun 27, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 27, 2024

Merge branch 'main' into zomars/cal-3945-no-show-webhook-event

86c2c62

vercel bot deployed to Preview – ai June 27, 2024 19:46 View deployment

vercel bot deployed to Preview – api June 27, 2024 19:51 View deployment

zomars added this pull request to the merge queue Jun 27, 2024

Merged via the queue into main with commit 3948b8d Jun 27, 2024
34 of 35 checks passed

zomars deleted the zomars/cal-3945-no-show-webhook-event branch June 27, 2024 20:28

vercel bot deployed to Preview – dev June 27, 2024 21:56 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: booking no show webhook #15502

feat: booking no show webhook #15502

zomars commented Jun 19, 2024 •

edited by keithwillcode

Loading

linear bot commented Jun 19, 2024

github-actions bot commented Jun 19, 2024 •

edited

Loading

vercel bot commented Jun 19, 2024 •

edited

Loading

zomars left a comment

zomars Jun 19, 2024

zomars Jun 19, 2024

zomars Jun 19, 2024

zomars Jun 19, 2024

zomars Jun 19, 2024

zomars Jun 19, 2024

zomars Jun 19, 2024

zomars Jun 19, 2024

zomars Jun 19, 2024

Udit-takkar left a comment

Udit-takkar left a comment


		const log = logger.getSubLogger({ prefix: ["[WebhookService] "] });

		/** This is a WIP. With minimal methods until the API matures and stabilizes */

		export type WebhookDataType = CalendarEvent &
		// BookingNoShowUpdatedPayload & // This breaks all other webhooks

		// @ts-expect-error payload is too booking specific, we need to refactor this
		await webhooks.sendPayload({ ...payload, bookingUid });

feat: booking no show webhook #15502

feat: booking no show webhook #15502

Conversation

zomars commented Jun 19, 2024 • edited by keithwillcode Loading

What does this PR do?

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

linear bot commented Jun 19, 2024

github-actions bot commented Jun 19, 2024 • edited Loading

vercel bot commented Jun 19, 2024 • edited Loading

zomars left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Udit-takkar left a comment

Choose a reason for hiding this comment

Udit-takkar left a comment

Choose a reason for hiding this comment

zomars commented Jun 19, 2024 •

edited by keithwillcode

Loading

github-actions bot commented Jun 19, 2024 •

edited

Loading

vercel bot commented Jun 19, 2024 •

edited

Loading