refactor: integrations handler #16946

Ryukemeister · 2024-10-04T17:22:36Z

What does this PR do?

This PR aims to refactor the integrations handler which returns data for all kinds of integrations and app data. There's no major change in logic of the code, just abstraction of a lot of logic into standalone functions.

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. 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?

This can be tested in the webapp anywhere we have something related to integrations. The best and easiest I found is the app store.

vercel · 2024-10-04T17:25:49Z

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		Oct 5, 2024 0:21am
calcom-web-canary	⬜️ Ignored (Inspect)	Visit Preview		Oct 5, 2024 0:21am

Ryukemeister · 2024-10-05T12:14:25Z

packages/app-store/utils.ts

@@ -104,6 +104,16 @@ function getApps(credentials: CredentialDataWithTeamName[], filterOnCredentials?
  return apps;
 }

+export function getAppsBySlug(


If we want to get a specific app instead of all, can be useful for v2 api.

Ryukemeister · 2024-10-05T12:15:22Z

packages/lib/apps/checkAppSetupStatus.ts

+import type { CredentialDataWithTeamName } from "@calcom/app-store/utils";
+import type { PaymentApp } from "@calcom/types/PaymentService";
+
+const checkAppSetupStatus = async (


Helper function, abstracted the logic from the integrations handler.

Ryukemeister · 2024-10-05T12:15:43Z

packages/lib/apps/constructUserTeams.ts

+
+import type { Credentials } from "./getTeamAppCredentials";
+
+const constructUserTeams = async (credentials: Credentials, appSlug: string, userTeams: TeamQuery[]) => {


Helper function, abstracted the logic from the integrations handler.

Ryukemeister · 2024-10-05T12:15:52Z

packages/lib/apps/getAppDependencyData.ts

+
+import type { EnabledApp } from "./getEnabledAppsFromCredentials";
+
+const getAppDependencyData = (enabledApps: EnabledApp[], dependencies?: string[] | undefined) => {


Helper function, abstracted the logic from the integrations handler.

Ryukemeister · 2024-10-05T12:16:34Z

packages/lib/apps/getEnabledAppsFromCredentials.ts

@@ -42,6 +45,10 @@ const getEnabledAppsFromCredentials = async (
    if (teamIds.length) filterOnIds.credentials.some.OR.push({ teamId: { in: teamIds } });
  }

+  if (!!filterOnAppSlug) {


Gets a specific app based on slug instead of all.

Ryukemeister · 2024-10-05T12:16:58Z

packages/lib/apps/getTeamAppCredentials.ts

+  invalid: boolean | null;
+}[];
+
+const getTeamAppCredentials = (


Helper function, abstracted the logic from the integrations handler.

Ryukemeister · 2024-10-05T12:17:08Z

packages/lib/apps/getUserAvailableTeams.ts

+import getUserTeamsQuery from "@calcom/lib/apps/getUserTeamsQuery";
+import type { TeamQuery } from "@calcom/trpc/server/routers/loggedInViewer/integrations.handler";
+
+const getUserAvailableTeams = async (userId: number, teamId?: number | null) => {


Helper function, abstracted the logic from the integrations handler.

Ryukemeister · 2024-10-05T12:17:26Z

packages/lib/apps/getUserTeamsQuery.ts

+import prisma from "@calcom/prisma";
+import { credentialForCalendarServiceSelect } from "@calcom/prisma/selects/credential";
+
+const getUserTeamsQuery = async (userId: number) => {


Another helper function.

Feels better suited to be in a repository

Ryukemeister · 2024-10-05T12:18:16Z

packages/trpc/server/routers/loggedInViewer/integrations.handler.ts

  let credentials = await getUsersCredentials(user);
  let userTeams: TeamQuery[] = [];

-  if (includeTeamInstalledApps || teamId) {
-    const teamsQuery = await prisma.team.findMany({


This has been abstracted to getUserTeamsQuery function.

Ryukemeister · 2024-10-05T12:18:44Z

packages/trpc/server/routers/loggedInViewer/integrations.handler.ts

-    });
-    // If a team is a part of an org then include those apps
-    // Don't want to iterate over these parent teams
-    const filteredTeams: TeamQuery[] = [];


This has been abstracted to getUserAvailableTeams function.

Ryukemeister · 2024-10-05T12:19:16Z

packages/trpc/server/routers/loggedInViewer/integrations.handler.ts

-
-    userTeams = [...teamsQuery, ...parentTeams];
-
-    const teamAppCredentials: CredentialPayload[] = userTeams.flatMap((teamApp) => {


This has been abstracted to getTeamAppCredentials function.

Ryukemeister · 2024-10-05T12:19:36Z

packages/trpc/server/routers/loggedInViewer/integrations.handler.ts

@@ -144,56 +69,21 @@ export const integrationsHandler = async ({ ctx, input }: IntegrationsOptions) =
      const invalidCredentialIds = credentials
        .filter((c) => c.appId === app.slug && c.invalid)
        .map((c) => c.id);
-      const teams = await Promise.all(


This has been abstracted to constructUserTeams function.

Ryukemeister · 2024-10-05T12:19:54Z

packages/trpc/server/routers/loggedInViewer/integrations.handler.ts

      // type infer as CredentialOwner
      const credentialOwner: CredentialOwner = {
        name: user.name,
        avatar: user.avatar,
      };

-      // We need to know if app is payment type
-      // undefined it means that app don't require app/setup/page
-      let isSetupAlready = undefined;


This has been abstracted to checkAppSetupStatus function.

Ryukemeister · 2024-10-05T12:20:49Z

packages/trpc/server/routers/loggedInViewer/integrations.handler.ts

-        }
-      }
-
-      let dependencyData: TDependencyData = [];


This has been abstracted to getAppDependencyData function.

graphite-app · 2024-10-05T12:25:10Z

Graphite Automations

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

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

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

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

Ryukemeister · 2024-10-05T12:29:55Z

packages/trpc/server/routers/loggedInViewer/integrations.handler.ts

@@ -39,10 +36,6 @@ type TeamQuery = Prisma.TeamGetPayload<{
  };
 }>;

-// type TeamQueryWithParent = TeamQuery & {


@joeauyeung removed this code which was commented but I don't if this is needed still or left there by mistake, should I bring it back?

Ryukemeister · 2024-10-05T12:35:08Z

packages/trpc/server/routers/loggedInViewer/integrations.handler.ts

@@ -205,6 +95,8 @@ export const integrationsHandler = async ({ ctx, input }: IntegrationsOptions) =
        isSetupAlready,
        ...(app.dependencies && { dependencyData }),
      };
+
+      return appData;
    })
  );



Was thinking of shifting all the code below into a function of its own, but don't think it'll be really helpful since the logic is fairly simple to understand( just an if conditional ) and there's a lot of variables from input. What do you guys thinkabout this, should we split the code below into its own separate function?

Probably, there's too many variables and if statements involved here not to.

emrysal · 2024-10-05T12:55:31Z

packages/lib/apps/getTeamAppCredentials.ts

+
+const getTeamAppCredentials = (
+  userTeams: TeamQuery[],
+  userCredentialIds: Credentials,


What do you think about this? Maybe merge outside of this function to keep this function dumber?

initial commit

24ecbdd

keithwillcode added core area: core, team members only platform Anything related to our platform plan labels Oct 4, 2024

fix typing

34140a9

Ryukemeister added 2 commits October 4, 2024 22:56

typing error

eab5084

rearrange arguments order

77e81ae

vercel bot deployed to Preview – api October 4, 2024 17:38 View deployment

vercel bot deployed to Preview – dev October 4, 2024 17:54 View deployment

Ryukemeister added the high-risk Requires approval by Foundation team label Oct 4, 2024

Ryukemeister added 2 commits October 5, 2024 01:27

abstracting logic into standalone functions

f5dfc4f

more refactors

dbb09fc

vercel bot deployed to Preview – api October 4, 2024 20:11 View deployment

vercel bot deployed to Preview – dev October 4, 2024 20:30 View deployment

Ryukemeister added 3 commits October 5, 2024 02:41

more abstractions

b86dad4

more abstractions

a2e1ec5

refactor

aa4ea15

vercel bot deployed to Preview – api October 4, 2024 21:22 View deployment

vercel bot deployed to Preview – dev October 4, 2024 21:29 View deployment

Ryukemeister added 3 commits October 5, 2024 17:07

helper function for integration handler

936b3e9

fixup and refactors

e3700b4

cleanup comment

de31ddc

vercel bot deployed to Preview – api October 5, 2024 11:55 View deployment

vercel bot deployed to Preview – dev October 5, 2024 12:11 View deployment

Ryukemeister commented Oct 5, 2024

View reviewed changes

Merge branch 'main' into refactor-intergrations-handler

4395ed9

Ryukemeister marked this pull request as ready for review October 5, 2024 12:21

graphite-app bot requested review from a team October 5, 2024 12:21

dosubot bot added the 💻 refactor label Oct 5, 2024

Ryukemeister requested review from hariombalhara, zomars and joeauyeung and removed request for a team October 5, 2024 12:22

vercel bot deployed to Preview – api October 5, 2024 12:29 View deployment

Ryukemeister commented Oct 5, 2024

View reviewed changes

vercel bot deployed to Preview – dev October 5, 2024 12:39 View deployment

emrysal reviewed Oct 5, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: integrations handler #16946

refactor: integrations handler #16946

Ryukemeister commented Oct 4, 2024 •

edited

Loading

vercel bot commented Oct 4, 2024 •

edited

Loading

Ryukemeister Oct 5, 2024

Ryukemeister Oct 5, 2024

Ryukemeister Oct 5, 2024

Ryukemeister Oct 5, 2024

Ryukemeister Oct 5, 2024

Ryukemeister Oct 5, 2024

Ryukemeister Oct 5, 2024

Ryukemeister Oct 5, 2024

emrysal Oct 5, 2024

Ryukemeister Oct 5, 2024

Ryukemeister Oct 5, 2024 •

edited

Loading

Ryukemeister Oct 5, 2024

Ryukemeister Oct 5, 2024 •

edited

Loading

Ryukemeister Oct 5, 2024

Ryukemeister Oct 5, 2024

graphite-app bot commented Oct 5, 2024

Ryukemeister Oct 5, 2024 •

edited

Loading

Ryukemeister Oct 5, 2024 •

edited

Loading

emrysal Oct 5, 2024

emrysal Oct 5, 2024


		import type { Credentials } from "./getTeamAppCredentials";

		const constructUserTeams = async (credentials: Credentials, appSlug: string, userTeams: TeamQuery[]) => {


		import type { EnabledApp } from "./getEnabledAppsFromCredentials";

		const getAppDependencyData = (enabledApps: EnabledApp[], dependencies?: string[] \| undefined) => {


		userTeams = [...teamsQuery, ...parentTeams];

		const teamAppCredentials: CredentialPayload[] = userTeams.flatMap((teamApp) => {

refactor: integrations handler #16946

Are you sure you want to change the base?

refactor: integrations handler #16946

Conversation

Ryukemeister commented Oct 4, 2024 • edited Loading

What does this PR do?

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

vercel bot commented Oct 4, 2024 • edited Loading

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

Ryukemeister Oct 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ryukemeister Oct 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

graphite-app bot commented Oct 5, 2024

Graphite Automations

Ryukemeister Oct 5, 2024 • edited Loading

Choose a reason for hiding this comment

Ryukemeister Oct 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ryukemeister commented Oct 4, 2024 •

edited

Loading

vercel bot commented Oct 4, 2024 •

edited

Loading

Ryukemeister Oct 5, 2024 •

edited

Loading

Ryukemeister Oct 5, 2024 •

edited

Loading

Ryukemeister Oct 5, 2024 •

edited

Loading

Ryukemeister Oct 5, 2024 •

edited

Loading