Remove Duplicate Command Setup Code (#85)

Introducing a setup function that is used by most (non-deprecated)
commands.

We also remove some unnecessary console logs from tests.

Author: bh2smith

src/commands/delete.ts

@@ -1,34 +1,19 @@
 import { Command } from "commander";
 
+import { setup } from "./setup.ts";
 import { PluginService } from "../services/plugin";
-import { deployedUrl } from "../utils/deployed-url";
-import { validateAndParseOpenApiSpec } from "../utils/openapi";
-import { getSpecUrl, getHostname } from "../utils/url";
 
 export const deleteCommand = new Command()
   .name("delete")
   .description("Delete your AI agent plugin")
   .option("-u, --url <url>", "Specify the deployment URL")
   .action(async (options) => {
-    const url = options.url || deployedUrl;
-
-    if (!url) {
-      console.error("Deployed URL could not be determined.");
-      return;
-    }
-
-    const pluginId = getHostname(url);
-    const specUrl = getSpecUrl(url);
-    const xMbSpec = await validateAndParseOpenApiSpec(specUrl);
-
-    if (!xMbSpec) {
-      console.error("OpenAPI specification validation failed.");
-      return;
-    }
-    const accountId = xMbSpec["account-id"];
-
     const pluginService = new PluginService();
-    const authentication = await pluginService.auth.getAuthentication();
+    const [{ pluginId }, authentication] = await Promise.all([
+      setup(options.url),
+      pluginService.auth.getAuthentication(),
+    ]);
+
     if (!authentication) {
       console.error("Authentication failed. Unable to delete the plugin.");
       return;

src/commands/deploy.ts

@@ -1,9 +1,7 @@
 import { Command } from "commander";
 
+import { setup } from "./setup.ts";
 import { PluginService } from "../services/plugin";
-import { deployedUrl } from "../utils/deployed-url";
-import { validateAndParseOpenApiSpec } from "../utils/openapi";
-import { getSpecUrl, getHostname } from "../utils/url";
 
 export const deployCommand = new Command()
   .name("deploy")
@@ -12,33 +10,16 @@ export const deployCommand = new Command()
   )
   .option("-u, --url <url>", "Specify the deployment URL")
   .action(async (options) => {
-    const url = options.url || deployedUrl;
-
-    if (!url) {
-      console.error("Deployed URL could not be determined.");
-      return;
-    } else {
-      console.log("Using deployment URL:", url);
-    }
-
-    const id = getHostname(url);
-    const specUrl = getSpecUrl(url);
-    const xMbSpec = await validateAndParseOpenApiSpec(specUrl);
-    if (!xMbSpec) {
-      console.error("OpenAPI specification validation failed.");
-      return;
-    }
+    const { pluginId } = await setup(options.url);
 
     const pluginService = new PluginService();
     try {
-      const updateRes = await pluginService.update(id);
+      const updateRes = await pluginService.update(pluginId);
       if (!updateRes) {
         console.log("Attempting to register plugin...");
-        await pluginService.register({
-          pluginId: id,
-        });
+        await pluginService.register({ pluginId });
       }
     } catch (error) {
-      console.error(`Failed to deploy plugin ${id}. Error: ${error}`);
+      console.error(`Failed to deploy plugin ${pluginId}. Error: ${error}`);
     }
   });

src/commands/setup.ts

@@ -0,0 +1,22 @@
+import type { XMbSpec } from "../config/types.ts";
+import { deployedUrl } from "../utils/deployed-url.ts";
+import { validateAndParseOpenApiSpec } from "../utils/openapi.ts";
+import { getHostname, getSpecUrl } from "../utils/url.ts";
+
+export async function setup(
+  optionsUrl?: string,
+): Promise<{ pluginId: string; xMbSpec: XMbSpec }> {
+  const url = optionsUrl || deployedUrl;
+
+  if (!url) {
+    throw new Error("Deployed URL could not be determined.");
+  }
+
+  const pluginId = getHostname(url);
+  const specUrl = getSpecUrl(url);
+  const xMbSpec = await validateAndParseOpenApiSpec(specUrl);
+  if (!xMbSpec) {
+    throw new Error("OpenAPI specification validation failed.");
+  }
+  return { pluginId, xMbSpec };
+}

src/commands/verify.ts

@@ -1,10 +1,8 @@
 import { Command } from "commander";
 
+import { setup } from "./setup.ts";
 import type { VerifyData, XMbSpec } from "../config/types";
 import { PluginService } from "../services/plugin";
-import { deployedUrl } from "../utils/deployed-url";
-import { validateAndParseOpenApiSpec } from "../utils/openapi";
-import { getHostname, getSpecUrl } from "../utils/url";
 
 export const verifyCommand = new Command()
   .name("verify")
@@ -43,20 +41,7 @@ export const verifyCommand = new Command()
     },
   )
   .action(async (options) => {
-    const url = options.url || deployedUrl;
-
-    if (!url) {
-      console.error("Deployed URL could not be determined.");
-      return;
-    }
-
-    const pluginId = getHostname(url);
-    const specUrl = getSpecUrl(url);
-    const xMbSpec = await validateAndParseOpenApiSpec(specUrl);
-    if (!xMbSpec) {
-      console.error("OpenAPI specification validation failed.");
-      return;
-    }
+    const { pluginId, xMbSpec } = await setup(options.url);
 
     try {
       const agentData = formVerifyData(options, xMbSpec);
@@ -71,7 +56,7 @@ export const verifyCommand = new Command()
   });
 
 function formVerifyData(options: unknown, spec: XMbSpec): VerifyData {
-  const verifyData: VerifyData = {
+  return {
     accountId: spec["account-id"],
     email:
       ((options as { email?: string }).email ?? spec.email) ||
@@ -91,5 +76,4 @@ function formVerifyData(options: unknown, spec: XMbSpec): VerifyData {
     chainIds:
       (options as { chains?: number[] }).chains ?? spec.assistant.chainIds,
   };
-  return verifyData;
 }

tests/utils/deployed-url.spec.ts

@@ -118,10 +118,6 @@ describe("deployed-url utilities", () => {
       "should return $name URL when in $name environment",
       ({ env, expected }) => {
         Object.assign(process.env, env);
-        console.log("process.env", process.env.VERCEL_ENV);
-        console.log("process.env", env);
-        console.log("expected", expected);
-        console.log("getDeployedUrl", getDeployedUrl());
         expect(getDeployedUrl()).toBe(expected);
       },
     );