self-review

Author: hariombalhara

packages/app-store/_utils/oauth/OAuthManager.ts

@@ -355,7 +355,7 @@ export class OAuthManager {
   }
 
   /**
-   * currentTokenObject is set in getTokenObjectOrFetch and refreshOAuthToken
+   * currentTokenObject is set through getTokenObjectOrFetch call
    */
   private assertCurrentTokenObjectIsSet(): asserts this is this & {
     currentTokenObject: CurrentTokenObject;
@@ -374,6 +374,7 @@ export class OAuthManager {
     if (this.autoCheckTokenExpiryOnRequest) {
       await this.getTokenObjectOrFetch();
     }
+    // `getTokenObjectOrFetch` has been called or `currentTokenObject` is set through constructor
     this.assertCurrentTokenObjectIsSet();
     const headers = {
       Authorization: `Bearer ${this.currentTokenObject.access_token}`,

packages/app-store/_utils/oauth/getCurrentTokenObject.ts

@@ -1,5 +1,5 @@
 import logger from "@calcom/lib/logger";
-import prisma from "@calcom/prisma";
+import { CredentialRepository } from "@calcom/lib/server/repository/credential";
 import type { CredentialForCalendarService } from "@calcom/types/Credential";
 
 import { getTokenObjectFromCredential } from "./getTokenObjectFromCredential";
@@ -8,20 +8,10 @@ const log = logger.getSubLogger({
   prefix: ["getCurrentTokenObject"],
 });
 
-async function getDelegationUserCredentialInDb({
-  userId,
-  delegationCredentialId,
-}: {
-  userId: number;
-  delegationCredentialId: string;
-}) {
-  const delegationUserCredentialInDb = await prisma.credential.findFirst({
-    where: {
-      userId,
-      delegationCredentialId,
-    },
-  });
-  return delegationUserCredentialInDb;
+function buildDummyTokenObjectForDelegationUserCredential() {
+  return {
+    access_token: "TOKEN_PLACEHOLDER_FOR_DELEGATION_CREDENTIAL",
+  };
 }
 
 export async function getCurrentTokenObject(
@@ -33,16 +23,17 @@ export async function getCurrentTokenObject(
       log.error("DelegationCredential: No user id found for delegation credential");
     } else {
       log.debug("Getting current token object for delegation credential");
-      const delegationUserCredentialInDb = await getDelegationUserCredentialInDb({
-        userId: credential.userId,
-        delegationCredentialId: credential.delegatedToId,
-      });
+      const delegationUserCredentialInDb =
+        await CredentialRepository.findUniqueByUserIdAndDelegationCredentialId({
+          userId: credential.userId,
+          delegationCredentialId: credential.delegatedToId,
+        });
       inDbCredential = delegationUserCredentialInDb;
       if (!inDbCredential) {
         log.error("getCurrentTokenObject: No delegation user credential found in db");
-        return {
-          access_token: "TOKEN_PLACEHOLDER_FOR_DELEGATION_CREDENTIAL",
-        };
+        // We return a dummy token object. OAuthManager requires a token object that must have access_token.
+        // OAuthManager will help fetching new token object and then that would be stored in DB.
+        return buildDummyTokenObjectForDelegationUserCredential();
       }
     }
   } else {

packages/app-store/_utils/oauth/updateTokenObject.ts

@@ -1,7 +1,9 @@
+import type { Prisma } from "@prisma/client";
 import type z from "zod";
 
 import logger from "@calcom/lib/logger";
 import { safeStringify } from "@calcom/lib/safeStringify";
+import { CredentialRepository } from "@calcom/lib/server/repository/credential";
 import prisma from "@calcom/prisma";
 
 import type { OAuth2UniversalSchemaWithCalcomBackwardCompatibility } from "./universalSchema";
@@ -60,35 +62,30 @@ export const updateTokenObjectInDb = async (
       log.error("Cannot update token object in DB for Delegation as delegatedToId is not present");
       return;
     }
-    const updated = await prisma.credential.updateMany({
-      where: {
-        userId: userId,
-        delegationCredentialId: delegatedToId,
-      },
+
+    const updated = await CredentialRepository.updateWhereUserIdAndDelegationCredentialId({
+      userId,
+      delegationCredentialId: delegatedToId,
       data: {
-        key: tokenObject,
+        key: tokenObject as Prisma.InputJsonValue,
       },
     });
     // If no delegation-credential is found, create one
     if (updated.count === 0) {
       log.debug("No delegation-credential found. Creating one");
-      await prisma.credential.create({
-        data: {
-          userId,
-          delegationCredentialId: delegatedToId,
-          type: credentialType,
-          key: tokenObject,
-        },
+      await CredentialRepository.createDelegationCredential({
+        userId,
+        delegationCredentialId: delegatedToId,
+        type: credentialType,
+        key: tokenObject as Prisma.InputJsonValue,
       });
     }
   } else {
     const { credentialId } = args;
-    await prisma.credential.update({
-      where: {
-        id: credentialId,
-      },
+    await CredentialRepository.updateWhereId({
+      id: credentialId,
       data: {
-        key: tokenObject,
+        key: tokenObject as Prisma.InputJsonValue,
       },
     });
   }

packages/app-store/tests/__mocks__/OAuthManager.ts

@@ -51,4 +51,5 @@ const defaultMockOAuthManager = vi.fn().mockImplementation(() => {
     }),
   };
 });
+
 export { oAuthManagerMock, defaultMockOAuthManager, setFullMockOAuthManagerRequest };

packages/lib/server/repository/credential.ts

@@ -1,9 +1,14 @@
+import type { Prisma } from "@prisma/client";
+
+import logger from "@calcom/lib/logger";
 import { prisma } from "@calcom/prisma";
 import { safeCredentialSelect } from "@calcom/prisma/selects/credential";
 import { credentialForCalendarServiceSelect } from "@calcom/prisma/selects/credential";
 
 import { buildNonDelegationCredential } from "../../delegationCredential/server";
 
+const log = logger.getSubLogger({ prefix: ["CredentialRepository"] });
+
 type CredentialCreateInput = {
   type: string;
   key: any;
@@ -142,4 +147,67 @@ export class CredentialRepository {
       };
     });
   }
+
+  static async findUniqueByUserIdAndDelegationCredentialId({
+    userId,
+    delegationCredentialId,
+  }: {
+    userId: number;
+    delegationCredentialId: string;
+  }) {
+    const delegationUserCredentials = await prisma.credential.findMany({
+      where: {
+        userId,
+        delegationCredentialId,
+      },
+    });
+
+    if (delegationUserCredentials.length > 1) {
+      // Instead of crashing use the first one and log for observability
+      log.error(`DelegationCredential: Multiple delegation user credentials found - this should not happen`, {
+        userId,
+        delegationCredentialId,
+      });
+    }
+
+    return delegationUserCredentials[0];
+  }
+
+  static async updateWhereUserIdAndDelegationCredentialId({
+    userId,
+    delegationCredentialId,
+    data,
+  }: {
+    userId: number;
+    delegationCredentialId: string;
+    data: {
+      key: Prisma.InputJsonValue;
+    };
+  }) {
+    return prisma.credential.updateMany({
+      where: {
+        userId,
+        delegationCredentialId,
+      },
+      data,
+    });
+  }
+
+  static async createDelegationCredential({
+    userId,
+    delegationCredentialId,
+    type,
+    key,
+  }: {
+    userId: number;
+    delegationCredentialId: string;
+    type: string;
+    key: Prisma.InputJsonValue;
+  }) {
+    return prisma.credential.create({ data: { userId, delegationCredentialId, type, key } });
+  }
+
+  static async updateWhereId({ id, data }: { id: number; data: { key: Prisma.InputJsonValue } }) {
+    return prisma.credential.update({ where: { id }, data });
+  }
 }

scripts/prepare-local-for-delegation-credentials-testing.js

@@ -63,6 +63,7 @@ async function main() {
         teamId: org.id,
         featureId: "delegation-credential",
         assignedAt: new Date(),
+        assignedBy: "prepare-local-script",
       },
     });
     console.log("Created TeamFeatures: delegation-credential");

tests/libs/__mocks__/app-store.ts

@@ -11,7 +11,9 @@ beforeEach(() => {
 
 const appStoreMock = mockDeep<typeof appStore>({
   fallbackMockImplementation: () => {
-    throw new Error("Unimplemented appStoreMock. You seem to have mocked the app that you are trying to use");
+    throw new Error(
+      "Unimplemented appStoreMock. You seem to have not mocked the app that you are trying to use"
+    );
   },
 });
 export default appStoreMock;