apphosting:backend get, list, and delete commands should print table in similar format (#6813)

mathu97 · web-flow · commit 41922fe5fe8d · 2024-02-26T21:46:04.000-05:00
Co-authored-by: Mathusan Selvarajah &lt;mathusan@google.com&gt;
diff --git a/src/commands/apphosting-backends-delete.ts b/src/commands/apphosting-backends-delete.ts
@@ -3,22 +3,10 @@ import { Options } from "../options";
 import { needProjectId } from "../projectUtils";
 import { FirebaseError } from "../error";
 import { promptOnce } from "../prompt";
-import { logger } from "../logger";
 import { DEFAULT_REGION } from "../init/features/apphosting/constants";
 import * as utils from "../utils";
 import * as apphosting from "../gcp/apphosting";
-
-const Table = require("cli-table");
-
-const COLUMN_LENGTH = 20;
-const TABLE_HEAD = [
-  "Backend Id",
-  "Repository Name",
-  "Location",
-  "URL",
-  "Created Date",
-  "Updated Date",
-];
+import { printBackendsTable } from "./apphosting-backends-list";
 
 export const command = new Command("apphosting:backends:delete <backend>")
   .description("delete a backend from a Firebase project")
@@ -45,24 +33,18 @@ export const command = new Command("apphosting:backends:delete <backend>")
       });
     }
 
-    const table = new Table({
-      head: TABLE_HEAD,
-      style: { head: ["green"] },
-    });
-    table.colWidths = COLUMN_LENGTH;
-
-    let backend;
+    let backend: apphosting.Backend;
     try {
       backend = await apphosting.getBackend(projectId, location, backendId);
-      populateTable(backend, table);
     } catch (err: any) {
       throw new FirebaseError(`No backends found with given parameters. Command aborted.`, {
         original: err,
       });
     }
 
     utils.logWarning("You are about to permanently delete the backend:");
-    logger.info(table.toString());
+    const backends: apphosting.Backend[] = [backend];
+    printBackendsTable(backends);
 
     const confirmDeletion = await promptOnce(
       {
@@ -89,24 +71,3 @@ export const command = new Command("apphosting:backends:delete <backend>")
 
     return backend;
   });
-
-function populateTable(backend: apphosting.Backend, table: any) {
-  const [location, , backendId] = backend.name.split("/").slice(3, 6);
-  const entry = [
-    backendId,
-    backend.codebase.repository?.split("/").pop(),
-    location,
-    backend.uri,
-    backend.createTime,
-    backend.updateTime,
-  ];
-  const newRow = entry.map((name) => {
-    const maxCellWidth = COLUMN_LENGTH - 2;
-    const chunks = [];
-    for (let i = 0; name && i < name.length; i += maxCellWidth) {
-      chunks.push(name.substring(i, i + maxCellWidth));
-    }
-    return chunks.join("\n");
-  });
-  table.push(newRow);
-}
diff --git a/src/commands/apphosting-backends-get.ts b/src/commands/apphosting-backends-get.ts
@@ -2,13 +2,10 @@ import { Command } from "../command";
 import { Options } from "../options";
 import { needProjectId } from "../projectUtils";
 import { FirebaseError } from "../error";
-import { logger } from "../logger";
 import { logWarning } from "../utils";
 import * as apphosting from "../gcp/apphosting";
+import { printBackendsTable } from "./apphosting-backends-list";
 
-const Table = require("cli-table");
-const COLUMN_LENGTH = 20;
-const TABLE_HEAD = ["Backend Id", "Repository", "Location", "URL", "Created Date", "Updated Date"];
 export const command = new Command("apphosting:backends:get <backendId>")
   .description("get backend details of a Firebase project")
   .option("-l, --location <location>", "app backend location", "-")
@@ -18,21 +15,14 @@ export const command = new Command("apphosting:backends:get <backendId>")
     const location = options.location as string;
 
     let backendsList: apphosting.Backend[] = [];
-    const table = new Table({
-      head: TABLE_HEAD,
-      style: { head: ["green"] },
-    });
-    table.colWidths = COLUMN_LENGTH;
     try {
       if (location !== "-") {
         const backendInRegion = await apphosting.getBackend(projectId, location, backendId);
         backendsList.push(backendInRegion);
-        populateTable(backendInRegion, table);
       } else {
         const resp = await apphosting.listBackends(projectId, "-");
         const allBackends = resp.backends || [];
         backendsList = allBackends.filter((bkd) => bkd.name.split("/").pop() === backendId);
-        backendsList.forEach((bkd) => populateTable(bkd, table));
       }
     } catch (err: any) {
       throw new FirebaseError(
@@ -44,27 +34,6 @@ export const command = new Command("apphosting:backends:get <backendId>")
       logWarning(`Found no backend with id: ${backendId}`);
       return;
     }
-    logger.info(table.toString());
+    printBackendsTable(backendsList);
     return backendsList[0];
   });
-
-function populateTable(backend: apphosting.Backend, table: any) {
-  const [location, , backendId] = backend.name.split("/").slice(3, 6);
-  const entry = [
-    backendId,
-    backend.codebase.repository?.split("/").pop(),
-    location,
-    backend.uri,
-    backend.createTime,
-    backend.updateTime,
-  ];
-  const newRow = entry.map((name) => {
-    const maxCellWidth = COLUMN_LENGTH - 2;
-    const chunks = [];
-    for (let i = 0; name && i < name.length; i += maxCellWidth) {
-      chunks.push(name.substring(i, i + maxCellWidth));
-    }
-    return chunks.join("\n");
-  });
-  table.push(newRow);
-}
diff --git a/src/commands/apphosting-backends-list.ts b/src/commands/apphosting-backends-list.ts
@@ -1,5 +1,3 @@
-const Table = require("cli-table");
-
 import { Command } from "../command";
 import { datetimeString } from "../utils";
 import { FirebaseError } from "../error";
@@ -8,6 +6,7 @@ import { needProjectId } from "../projectUtils";
 import { Options } from "../options";
 import * as apphosting from "../gcp/apphosting";
 
+const Table = require("cli-table");
 const TABLE_HEAD = ["Backend ID", "Repository", "Location", "URL", "Created Date", "Updated Date"];
 
 export const command = new Command("apphosting:backends:list")
@@ -17,7 +16,6 @@ export const command = new Command("apphosting:backends:list")
   .action(async (options: Options) => {
     const projectId = needProjectId(options);
     const location = options.location as string;
-    const table = new Table({ head: TABLE_HEAD, style: { head: ["green"] } });
     let backendRes: apphosting.ListBackendsResponse;
     try {
       backendRes = await apphosting.listBackends(projectId, location);
@@ -29,18 +27,32 @@ export const command = new Command("apphosting:backends:list")
     }
 
     const backends = backendRes.backends ?? [];
-    for (const backend of backends) {
-      const [backendLocation, , backendId] = backend.name.split("/").slice(3, 6);
-      table.push([
-        backendId,
-        backend.codebase?.repository?.split("/").pop() ?? "",
-        backendLocation,
-        backend.uri.startsWith("https:") ? backend.uri : "https://" + backend.uri,
-        datetimeString(new Date(backend.createTime)),
-        datetimeString(new Date(backend.updateTime)),
-      ]);
-    }
-    logger.info(table.toString());
+    printBackendsTable(backends);
 
     return backends;
   });
+
+/**
+ * Prints a table given a list of backends
+ */
+export function printBackendsTable(backends: apphosting.Backend[]): void {
+  const table = new Table({
+    head: TABLE_HEAD,
+    style: { head: ["green"] },
+  });
+
+  for (const backend of backends) {
+    // sample backend.name value: "projects/<project-name>/locations/us-central1/backends/<backend-id>"
+    const [backendLocation, , backendId] = backend.name.split("/").slice(3, 6);
+    table.push([
+      backendId,
+      // sample repository value: "projects/<project-name>/locations/us-central1/connections/<connection-id>/repositories/<repository-name>"
+      backend.codebase?.repository?.split("/").pop() ?? "",
+      backendLocation,
+      backend.uri.startsWith("https:") ? backend.uri : "https://" + backend.uri,
+      datetimeString(new Date(backend.createTime)),
+      datetimeString(new Date(backend.updateTime)),
+    ]);
+  }
+  logger.info(table.toString());
+}
