Adding support for baseWorkflowDomain, ID vs URL

Author: dylburger

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

@@ -5,6 +5,7 @@ import fetchMock from "jest-fetch-mock";
 import { ClientCredentials } from "simple-oauth2";
 
 let client: ServerClient;
+let customDomainClient: ServerClient;
 let oauthClientMock: ClientCredentials;
 
 beforeEach(() => {
@@ -30,6 +31,16 @@ beforeEach(() => {
     },
     oauthClientMock,
   );
+
+  customDomainClient = new ServerClient({
+    publicKey: "test-public-key",
+    secretKey: "test-secret-key",
+    oauth: {
+      clientId: "test-client-id",
+      clientSecret: "test-client-secret",
+    },
+    baseWorkflowDomain: "example.com",
+  });
 });
 
 describe("ServerClient", () => {
@@ -730,4 +741,70 @@ describe("ServerClient", () => {
       })).rejects.toThrow("External user ID is required");
     });
   });
+
+  describe("ServerClient - buildWorkflowUrl", () => {
+    describe("Default domain (m.pipedream.net)", () => {
+      it("should return full URL if input is a full URL with protocol", () => {
+        const input = "https://en123.m.pipedream.net";
+        const expected = "https://en123.m.pipedream.net/";
+        expect(client["buildWorkflowUrl"](input)).toBe(expected);
+      });
+
+      it("should return full URL if input is a URL without protocol", () => {
+        const input = "en123.m.pipedream.net";
+        const expected = "https://en123.m.pipedream.net/";
+        expect(client["buildWorkflowUrl"](input)).toBe(expected);
+      });
+
+      it("should construct URL with 'm.pipedream.net' if input is an endpoint ID", () => {
+        const input = "en123";
+        const expected = "https://en123.m.pipedream.net";
+        expect(client["buildWorkflowUrl"](input)).toBe(expected);
+      });
+
+      it("should handle input with a path in full URL with protocol", () => {
+        const input = "https://en123.m.pipedream.net/foo";
+        const expected = "https://en123.m.pipedream.net/foo";
+        expect(client["buildWorkflowUrl"](input)).toBe(expected);
+      });
+
+      it("should handle input with a path when no protocol is provided", () => {
+        const input = "en123.m.pipedream.net/foo";
+        const expected = "https://en123.m.pipedream.net/foo";
+        expect(client["buildWorkflowUrl"](input)).toBe(expected);
+      });
+    });
+
+    describe("Custom domain (example.com)", () => {
+      it("should return full URL if input is a full URL with protocol", () => {
+        const input = "https://en123.example.com";
+        const expected = "https://en123.example.com/";
+        expect(customDomainClient["buildWorkflowUrl"](input)).toBe(expected);
+      });
+
+      it("should return full URL if input is a URL without protocol", () => {
+        const input = "en123.example.com";
+        const expected = "https://en123.example.com/";
+        expect(customDomainClient["buildWorkflowUrl"](input)).toBe(expected);
+      });
+
+      it("should construct URL with 'example.com' if input is an endpoint ID", () => {
+        const input = "en123";
+        const expected = "https://en123.example.com";
+        expect(customDomainClient["buildWorkflowUrl"](input)).toBe(expected);
+      });
+
+      it("should handle input with a path in full URL with protocol", () => {
+        const input = "https://en123.example.com/foo";
+        const expected = "https://en123.example.com/foo";
+        expect(customDomainClient["buildWorkflowUrl"](input)).toBe(expected);
+      });
+
+      it("should handle input with a path when no protocol is provided", () => {
+        const input = "en123.example.com/foo";
+        const expected = "https://en123.example.com/foo";
+        expect(customDomainClient["buildWorkflowUrl"](input)).toBe(expected);
+      });
+    });
+  });
 });

packages/sdk/src/server/index.ts

@@ -55,6 +55,11 @@ export type CreateServerClientOpts = {
    * The API host URL. Used by Pipedream employees. Defaults to "api.pipedream.com" if not provided.
    */
   apiHost?: string;
+
+  /**
+   * Base domain for workflows. Used for custom domains: https://pipedream.com/docs/workflows/domains
+   */
+  baseWorkflowDomain?: string;
 };
 
 /**
@@ -329,7 +334,8 @@ export class ServerClient {
   private environment: string;
   private oauthClient?: ClientCredentials;
   private oauthToken?: AccessToken;
-  private readonly baseURL: string;
+  private readonly baseAPIURL: string;
+  private readonly baseWorkflowDomain: string;
 
   /**
    * Constructs a new ServerClient instance.
@@ -345,15 +351,18 @@ export class ServerClient {
     this.secretKey = opts.secretKey;
     this.publicKey = opts.publicKey;
 
-    const { apiHost = "api.pipedream.com" } = opts;
-    this.baseURL = `https://${apiHost}/v1`;
+    const {
+      apiHost = "api.pipedream.com", baseWorkflowDomain = "m.pipedream.net",
+    } = opts;
+    this.baseAPIURL = `https://${apiHost}/v1`;
+    this.baseWorkflowDomain = baseWorkflowDomain;
 
     if (oauthClient) {
       // Use the provided OAuth client (useful for testing)
       this.oauthClient = oauthClient;
     } else {
       // Configure the OAuth client normally
-      this.configureOauthClient(opts, this.baseURL);
+      this.configureOauthClient(opts, this.baseAPIURL);
     }
   }
 
@@ -445,7 +454,7 @@ export class ServerClient {
       headers: customHeaders,
       body,
       method = "GET",
-      baseURL = this.baseURL,
+      baseURL = this.baseAPIURL,
       ...fetchOpts
     } = opts;
 
@@ -754,10 +763,53 @@ export class ServerClient {
     });
   }
 
+  /**
+   * Builds a full workflow URL based on the input.
+   *
+   * @param input - Either a full URL (with or without protocol) or just an endpoint ID.
+   *
+   * @returns The fully constructed URL.
+   *
+   * @throws If the input is not a valid URL and not an ID, the function assumes it's an endpoint ID.
+   *
+   * @example
+   * // Full URL input
+   * this.buildWorkflowUrl("https://en123.m.pipedream.net");
+   * // Returns: "https://en123.m.pipedream.net"
+   *
+   * @example
+   * // Partial URL (without protocol)
+   * this.buildWorkflowUrl("en123.m.pipedream.net");
+   * // Returns: "https://en123.m.pipedream.net"
+   *
+   * @example
+   * // ID only input
+   * this.buildWorkflowUrl("en123");
+   * // Returns: "https://en123.yourdomain.com" (where `yourdomain.com` is set in `baseWorkflowDomain`)
+   */
+  private buildWorkflowUrl(input: string): string {
+    let url: string;
+
+    const isUrl = input.includes(".") || input.startsWith("http");
+
+    if (isUrl) {
+    // Try to parse the input as a URL
+      const parsedUrl = new URL(input.startsWith("http")
+        ? input
+        : `https://${input}`);
+      url = parsedUrl.href;
+    } else {
+    // If the input is an ID, construct the full URL using the base domain
+      url = `https://${input}.${this.baseWorkflowDomain}`;
+    }
+
+    return url;
+  }
+
   /**
    * Invokes a workflow using the URL of its HTTP interface(s), by sending an
    *
-   * @param url - The URL of the workflow's HTTP interface.
+   * @param urlOrEndpoint - The URL of the workflow's HTTP interface, or the ID of the endpoint
    * @param opts - The options for the request.
    * @param opts.body - The body of the request. It must be a JSON-serializable
    * value (e.g. an object, null, a string, etc.).
@@ -787,12 +839,14 @@ export class ServerClient {
    * console.log(response);
    * ```
    */
-  public async invokeWorkflow(url: string, opts: RequestOptions = {}, authType: HTTPAuthType = HTTPAuthType.None): Promise<unknown> {
+  public async invokeWorkflow(urlOrEndpoint: string, opts: RequestOptions = {}, authType: HTTPAuthType = HTTPAuthType.None): Promise<unknown> {
     const {
       body,
       headers = {},
     } = opts;
 
+    const url = this.buildWorkflowUrl(urlOrEndpoint);
+
     let authHeader: string | undefined;
     switch (authType) {
     // It's expected that users will pass their own Authorization header in the static bearer case