Mocking client and mock OAuth client once

Author: dylburger

packages/sdk/src/server/__tests__/server.test.ts

@@ -4,9 +4,35 @@ import {
 import fetchMock from "jest-fetch-mock";
 import { ClientCredentials } from "simple-oauth2";
 
-describe("ServerClient", () => {
-  let client: ServerClient;
+let client: ServerClient;
+let oauthClientMock: ClientCredentials;
+
+beforeEach(() => {
+  const getTokenMock = jest.fn().mockResolvedValue({
+    token: {
+      access_token: "mocked-oauth-token",
+    },
+    expired: jest.fn().mockReturnValue(false),
+  });
+
+  oauthClientMock = {
+    getToken: getTokenMock,
+  } as unknown as ClientCredentials;
+
+  client = new ServerClient(
+    {
+      publicKey: "test-public-key",
+      secretKey: "test-secret-key",
+      oauth: {
+        clientId: "test-client-id",
+        clientSecret: "test-client-secret",
+      },
+    },
+    oauthClientMock,
+  );
+});
 
+describe("ServerClient", () => {
   beforeEach(() => {
     fetchMock.resetMocks();
   });
@@ -18,7 +44,7 @@ describe("ServerClient", () => {
         secretKey: "test-secret-key",
       };
 
-      const client = createClient(params);
+      client = createClient(params);
       expect(client).toBeInstanceOf(ServerClient);
     });
   });
@@ -36,11 +62,6 @@ describe("ServerClient", () => {
         },
       );
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       const result = await client.makeRequest("/test-path", {
         method: "GET",
       });
@@ -66,11 +87,6 @@ describe("ServerClient", () => {
         },
       );
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       const result = await client.makeRequest("/test-path", {
         method: "POST",
         body: {
@@ -103,11 +119,6 @@ describe("ServerClient", () => {
         },
       });
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       await expect(client.makeRequest("/bad-path")).rejects.toThrow("HTTP error! status: 404, body: Not Found");
       expect(fetchMock).toHaveBeenCalledWith(
         "https://api.pipedream.com/v1/bad-path",
@@ -118,28 +129,6 @@ describe("ServerClient", () => {
 
   describe("makeApiRequest", () => {
     it("should include OAuth Authorization header and make an API request", async () => {
-      const getTokenMock = jest.fn().mockResolvedValue({
-        token: {
-          access_token: "mocked-oauth-token",
-        },
-        expired: jest.fn().mockReturnValue(false),
-      });
-
-      const oauthClientMock = {
-        getToken: getTokenMock,
-      } as unknown as ClientCredentials;
-
-      // Inject the mock oauthClient into the ServerClient instance
-      client = new ServerClient(
-        {
-          publicKey: "test-public-key",
-          secretKey: "test-secret-key",
-          oauthClientId: "test-client-id",
-          oauthClientSecret: "test-client-secret",
-        },
-        oauthClientMock,
-      );
-
       fetchMock.mockResponseOnce(
         JSON.stringify({
           success: true,
@@ -168,34 +157,13 @@ describe("ServerClient", () => {
     });
 
     it("should handle OAuth token retrieval failure", async () => {
-      // Create a mock oauthClient that fails to get a token
-      const getTokenMock = jest.fn().mockRejectedValue(new Error("Invalid credentials"));
-
-      const oauthClientMock = {
-        getToken: getTokenMock,
-      } as unknown as ClientCredentials;
-
-      client = new ServerClient(
-        {
-          publicKey: "test-public-key",
-          secretKey: "test-secret-key",
-          oauthClientId: "test-client-id",
-          oauthClientSecret: "test-client-secret",
-        },
-        oauthClientMock,
-      );
-
+      oauthClientMock.getToken = jest.fn().mockRejectedValue(new Error("Invalid credentials"));
       await expect(client["makeApiRequest"]("/test-path")).rejects.toThrow("Failed to obtain OAuth token: Invalid credentials");
     });
   });
 
   describe("makeConnectRequest", () => {
     it("should include Connect Authorization header and make a request", async () => {
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       fetchMock.mockResponseOnce(
         JSON.stringify({
           success: true,
@@ -237,11 +205,6 @@ describe("ServerClient", () => {
         },
       );
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       const result = await client.connectTokenCreate({
         external_user_id: "user-id",
       });
@@ -279,11 +242,6 @@ describe("ServerClient", () => {
         },
       );
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       const result = await client.connectTokenCreate({
         external_user_id: "user-id",
         success_redirect_uri: "https://example.com/success",
@@ -329,11 +287,6 @@ describe("ServerClient", () => {
         },
       );
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       const result = await client.getAccounts({
         include_credentials: 1,
       });
@@ -365,11 +318,6 @@ describe("ServerClient", () => {
         },
       );
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       const result = await client.getAccount("account-1");
 
       expect(result).toEqual({
@@ -399,11 +347,6 @@ describe("ServerClient", () => {
         },
       );
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       const result = await client.getAccountsByApp("app-1");
 
       expect(result).toEqual([
@@ -435,11 +378,6 @@ describe("ServerClient", () => {
         },
       );
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       const result = await client.getAccountsByExternalId("external-id-1");
 
       expect(result).toEqual([
@@ -461,11 +399,6 @@ describe("ServerClient", () => {
         status: 204,
       });
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       await client.deleteAccount("account-1");
 
       expect(fetchMock).toHaveBeenCalledWith(
@@ -483,11 +416,6 @@ describe("ServerClient", () => {
         status: 204,
       });
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       await client.deleteAccountsByApp("app-1");
 
       expect(fetchMock).toHaveBeenCalledWith(
@@ -505,11 +433,6 @@ describe("ServerClient", () => {
         status: 204,
       });
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       await client.deleteExternalUser("external-id-1");
 
       expect(fetchMock).toHaveBeenCalledWith(
@@ -539,11 +462,6 @@ describe("ServerClient", () => {
         },
       );
 
-      client = new ServerClient({
-        publicKey: "test-public-key",
-        secretKey: "test-secret-key",
-      });
-
       const result = await client.getProjectInfo();
 
       expect(result).toEqual({
@@ -565,31 +483,6 @@ describe("ServerClient", () => {
 
   describe("invokeWorkflow", () => {
     it("should invoke a workflow with provided URL and body, with no auth type", async () => {
-      // Create a mock oauthClient
-      const getTokenMock = jest.fn().mockResolvedValue({
-        token: {
-          access_token: "mocked-oauth-token",
-        },
-        expired: jest.fn().mockReturnValue(false),
-      });
-
-      const oauthClientMock = {
-        getToken: getTokenMock,
-      } as unknown as ClientCredentials;
-
-      // Inject the mock oauthClient into the ServerClient instance
-      const client = new ServerClient(
-        {
-          publicKey: "test-public-key",
-          secretKey: "test",
-          oauth: {
-            clientId: "test-client-id",
-            clientSecret: "test-client-secret",
-          },
-        },
-        oauthClientMock,
-      );
-
       fetchMock.mockResponseOnce(
         JSON.stringify({
           result: "workflow-response",

packages/sdk/src/server/index.ts

@@ -7,15 +7,6 @@ import {
   ClientCredentials,
 } from "simple-oauth2";
 
-export type Project = {
-  id: string;
-};
-
-export type ProjectEnvironment = {
-  project: Project;
-  environment: string;
-};
-
 export type PipedreamOAuthClient = {
   clientId: string;
   clientSecret: string;
@@ -27,13 +18,13 @@ export type PipedreamOAuthClient = {
  */
 export type CreateServerClientOpts = {
   /**
-   * @deprecated Use the `project` object instead.
+   * @deprecated Use the `oauth` object instead.
    * The public API key for accessing the service.
    */
   publicKey?: string;
 
   /**
-   * @deprecated Use the `project` object instead.
+   * @deprecated Use the `oauth` object instead.
    * The secret API key for accessing the service.
    */
   secretKey?: string;