feat: Domain-wide delegation for Google Calendar and Google Meet #16622

hariombalhara · 2024-09-13T07:14:49Z

What does this PR do?

Demo - https://www.loom.com/share/1f9e7c79697847a8bb37490e9873fb26

For feature details refer to README

Detailed Changes

getCalendar now requires value of type CredentialForCalendarService which needs an explicit value for delegatedTo. It makes it clear to CalendarService how that Credential should be used.
- For regular credentials,delegatedTo=null.
- For DWD credentials, delegatedTo={ serviceAccountKey: { client_email: string; private_key: string; client_id: string;}}
google-calendar/CalendarService now supports impersonating a user using the ServiceAccount and thus is capable of taking actions on any of the organization member's behalf on the Google Calendar.

Calendar Cache support is part of #18619

Release Plan

Read the document(domain-wide-delegation.md) and acknowledge it.
Deploy:
1. Follow "Setting up Domain-Wide Delegation for Google Calendar API" in domain-wide-delegation.md to create Service Account and create a workspace.
2. Merge PR(without Calendar Cache Support) and then deploy.
Enable for i.cal.com:
1. Disable Calendar Cache for i.cal.com
2. Enable teamFeature "domain-wide-delegation" for i.cal.com organization
3. Create DWD for i.cal.com first and enable it.
4. Wait for 1-2 days and keep monitoring the errors in Sentry and Axiom.
Merge & Deploy the Calendar Cache support(with DWD) PR
1. Enable Calendar Cache back for i.cal.com
2. Observe the errors in Sentry and Axiom.
Enable for a big customer:
1. Wait for a week and keep monitoring the errors in Sentry and Axiom.
Use delegatedCredentialsFirst instead of delegatedCredentialsLast in EventManager.ts
- Observe errors in Sentry and Axiom.

Automated Tests

Slots Availability - getSchedule.test.ts
Google Calendar Service - Calendar.test.ts
DomainWideDelegation utiltiies and repository - server.test.ts and domainWideDelegation.test.ts
Updating/Setting destinationCalendar - setDestinationCalendar.handler.test.ts
Doing a booking - domain-wide-delegation.test.ts
Fixes CAL-4610

Possible errors when enabling DWD

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 added a Docs issue here 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?

Test different scenarios like rescheduling, reassignment, team bookings etc.
Refer to https://github.com/calcom/cal.com/blob/domain-wide-delegation-google-calendar/apps/web/app/settings/(settings-layout)/organizations/domain-wide-delegation/domain-wide-delegation-TODO.md to see what has been tested

github-actions · 2024-09-13T07:15:00Z

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:

No release type found in pull request title "Add endpoints for testing the flow". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

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

…n-google-calendar

vercel · 2024-09-18T14:19:13Z

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

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
cal	⬜️ Ignored (Inspect)	Visit Preview		Jan 21, 2025 9:23am
calcom-web-canary	⬜️ Ignored (Inspect)	Visit Preview		Jan 21, 2025 9:23am

github-actions · 2024-09-19T11:31:33Z

E2E results are ready!

Workflow #44668.1 latest results

…n-google-calendar

ThyMinimalDev · 2025-01-16T12:53:27Z

everything seems fine in this pr regarding compatibility with platform atoms

hariombalhara · 2025-01-14T05:24:21Z

packages/features/ee/organizations/pages/settings/domainWideDelegation.tsx

@@ -90,6 +90,7 @@ function DelegationListItemActions({
          {
            id: "delete",
            label: t("delete"),
+            disabled: true,


Not allow deletion of DWD as of now. We would enable it later.

hariombalhara · 2025-01-14T05:25:24Z

packages/features/ee/payments/api/webhook.ts

    const metadata = eventTypeMetaDataSchemaWithTypedApps.parse(eventType?.metadata);
-    const eventManager = new EventManager(user, metadata?.apps);
+    const eventManager = new EventManager({ ...user, credentials: allCredentials }, metadata?.apps);


We need to provide DWD credentials here as well.

hariombalhara · 2025-01-15T04:40:56Z

apps/api/v1/pages/api/destination-calendars/[id]/_patch.ts

@@ -185,7 +185,7 @@ async function verifyCredentialsAndGetId({
  currentCredentialId: number | null;
 }) {
  if (parsedBody.integration && parsedBody.externalId) {
-    const calendarCredentials = getCalendarCredentials(userCredentials);
+    const calendarCredentials = getCalendarCredentialsWithoutDwd(userCredentials);


No support for DWD in v1

hariombalhara · 2025-01-15T06:28:14Z

packages/trpc/server/routers/viewer/domainWideDelegation/add.handler.ts

-    const domainWideDelegationRepository = await DomainWideDelegation.init(user.id, organizationId);
-
-    const createdDelegation = await domainWideDelegationRepository.create({
+    const createdDelegation = await DomainWideDelegationRepository.create({


Removed the need of feature repository for DWD as we already have DWD toggle on organization level

hariombalhara · 2025-01-15T07:45:27Z

packages/lib/server/repository/user.ts

-  userLevelSelectedCalendars: TCalendar[];
-};
-
-export function withSelectedCalendars<


Move in its own module

hariombalhara · 2025-01-16T04:05:49Z

apps/api/v2/src/ee/calendars/services/calendars.service.ts

@@ -39,6 +39,16 @@ export class CalendarsService {
    private readonly selectedCalendarsRepository: SelectedCalendarsRepository
  ) {}

+  private buildNonDwdCredentials<TCredential>(credentials: TCredential[]) {


Couldn't import from domainWideDelegation due to build issues. So, created a local copy here.

hariombalhara · 2025-01-16T04:06:45Z

apps/web/components/apps/InstallAppButtonChild.tsx

      disabled={shouldDisableInstallation}
      color="primary"
-      size="base"
-      {...props}>


It was causing props.disabled to override the disabled property above that in turn caused Install button to be not disabled.

…n-google-calendar

Udit-takkar

LGTM. Tested few scenarios and seems to be working fine.

ThyMinimalDev · 2025-01-17T15:41:39Z

will fully review on monday

hariombalhara · 2025-01-21T14:44:13Z

We need to encrypt the serviceAccountKey as suggsted by Keith. I will start with the implementation and we can merge only after that, should be quick though.

Add endpoints for testing the flow

9cc1fc9

github-actions bot added the ❗️ migrations contains migration files label Sep 13, 2024

keithwillcode added core area: core, team members only enterprise area: enterprise, audit log, organisation, SAML, SSO labels Sep 13, 2024

hariombalhara added the ready-for-e2e label Sep 13, 2024

hariombalhara changed the title ~~Add endpoints for testing the flow~~ feat: Domain-wide delegation for Google Calendar and Google Meet Sep 13, 2024

hariombalhara added 3 commits September 13, 2024 12:54

Add MVP

cf74351

new route

18a144d

Merge remote-tracking branch 'origin/main' into domain-wide-delegatio…

9a26de9

…n-google-calendar

keithwillcode added this to the v4.6 milestone Sep 15, 2024

hariombalhara force-pushed the domain-wide-delegation-google-calendar branch from 1700348 to 151c3be Compare September 18, 2024 14:19

vercel bot deployed to Preview – api September 18, 2024 14:27 View deployment

vercel bot had a problem deploying to Preview – dev September 18, 2024 14:29 Failure

hariombalhara force-pushed the domain-wide-delegation-google-calendar branch 3 times, most recently from e123b08 to 6c94a0c Compare September 19, 2024 10:00

vercel bot deployed to Preview – api September 19, 2024 10:08 View deployment

vercel bot had a problem deploying to Preview – dev September 19, 2024 10:14 Failure

hariombalhara force-pushed the domain-wide-delegation-google-calendar branch from 6c94a0c to 02529ca Compare September 19, 2024 11:08

vercel bot deployed to Preview – api September 19, 2024 11:14 View deployment

vercel bot deployed to Preview – dev September 19, 2024 11:23 View deployment

Fixes

ddade88

hariombalhara force-pushed the domain-wide-delegation-google-calendar branch from 02529ca to ddade88 Compare September 20, 2024 06:56

vercel bot deployed to Preview – api September 20, 2024 07:04 View deployment

vercel bot deployed to Preview – dev September 20, 2024 07:11 View deployment

hariombalhara added 2 commits September 20, 2024 13:51

Merge remote-tracking branch 'origin/main' into domain-wide-delegatio…

d1d5395

…n-google-calendar

Fixes

77fba87

Merge remote-tracking branch 'origin/main' into domain-wide-delegatio…

a327dcf

…n-google-calendar

vercel bot deployed to Preview – api January 16, 2025 11:53 View deployment

vercel bot deployed to Preview – api January 16, 2025 12:11 View deployment

add getSchedule tests

60a930c

hariombalhara force-pushed the domain-wide-delegation-google-calendar branch from 1ef9b76 to 60a930c Compare January 16, 2025 12:18

vercel bot deployed to Preview – api January 16, 2025 12:23 View deployment

vercel bot deployed to Preview – api January 16, 2025 12:53 View deployment

keithwillcode modified the milestones: v4.9, v5.0 Jan 16, 2025

hariombalhara commented Jan 16, 2025

View reviewed changes

hariombalhara added 2 commits January 17, 2025 09:09

Improve tests

6a3d28e

Merge remote-tracking branch 'origin/main' into domain-wide-delegatio…

033332e

…n-google-calendar

hariombalhara force-pushed the domain-wide-delegation-google-calendar branch from cfa7d7b to d9425a3 Compare January 17, 2025 07:12

vercel bot had a problem deploying to Preview – api January 17, 2025 07:16 Failure

hariombalhara force-pushed the domain-wide-delegation-google-calendar branch from d9425a3 to bfd156b Compare January 17, 2025 07:17

vercel bot had a problem deploying to Preview – api January 17, 2025 07:21 Failure

Make Google Meet default when DWD for google is enabled

0d0ca15

hariombalhara force-pushed the domain-wide-delegation-google-calendar branch from bfd156b to 0d0ca15 Compare January 17, 2025 08:10

vercel bot had a problem deploying to Preview – api January 17, 2025 08:14 Failure

vercel bot deployed to Preview – api January 17, 2025 09:03 View deployment

Udit-takkar reviewed Jan 17, 2025

View reviewed changes

ThyMinimalDev self-requested a review January 17, 2025 15:41

Enable feature flagging for DWD

4079e31

hariombalhara force-pushed the domain-wide-delegation-google-calendar branch from bb194f7 to 4079e31 Compare January 20, 2025 12:17

vercel bot deployed to Preview – api January 20, 2025 12:23 View deployment

chore: bump libraries

d9b499f

vercel bot deployed to Preview – api January 21, 2025 09:28 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Domain-wide delegation for Google Calendar and Google Meet #16622

feat: Domain-wide delegation for Google Calendar and Google Meet #16622

hariombalhara commented Sep 13, 2024 •

edited

Loading

github-actions bot commented Sep 13, 2024

vercel bot commented Sep 18, 2024 •

edited

Loading

github-actions bot commented Sep 19, 2024 •

edited

Loading

ThyMinimalDev commented Jan 16, 2025

hariombalhara Jan 14, 2025

hariombalhara Jan 14, 2025

hariombalhara Jan 15, 2025

hariombalhara Jan 15, 2025

hariombalhara Jan 15, 2025

hariombalhara Jan 16, 2025

hariombalhara Jan 16, 2025

Udit-takkar left a comment

ThyMinimalDev commented Jan 17, 2025

hariombalhara commented Jan 21, 2025

feat: Domain-wide delegation for Google Calendar and Google Meet #16622

Are you sure you want to change the base?

feat: Domain-wide delegation for Google Calendar and Google Meet #16622

Conversation

hariombalhara commented Sep 13, 2024 • edited Loading

What does this PR do?

Release Plan

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

github-actions bot commented Sep 13, 2024

vercel bot commented Sep 18, 2024 • edited Loading

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

E2E results are ready!

ThyMinimalDev commented Jan 16, 2025

hariombalhara Jan 14, 2025

Choose a reason for hiding this comment

hariombalhara Jan 14, 2025

Choose a reason for hiding this comment

hariombalhara Jan 15, 2025

Choose a reason for hiding this comment

hariombalhara Jan 15, 2025

Choose a reason for hiding this comment

hariombalhara Jan 15, 2025

Choose a reason for hiding this comment

hariombalhara Jan 16, 2025

Choose a reason for hiding this comment

hariombalhara Jan 16, 2025

Choose a reason for hiding this comment

Udit-takkar left a comment

Choose a reason for hiding this comment

ThyMinimalDev commented Jan 17, 2025

hariombalhara commented Jan 21, 2025

hariombalhara commented Sep 13, 2024 •

edited

Loading

vercel bot commented Sep 18, 2024 •

edited

Loading

github-actions bot commented Sep 19, 2024 •

edited

Loading