Print message to view Firestore database in console after creation or…

… restore (#6949)
firebase · Apr 10, 2024 · 45b5491 · 45b5491
1 parent c096f32
commit 45b5491
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1 @@
+- Add Firebase console link after creating or restoring a Firestore database (#6949)
diff --git a/src/commands/firestore-databases-create.ts b/src/commands/firestore-databases-create.ts
@@ -85,6 +85,9 @@ export const command = new Command("firestore:databases:create <database>")
           "the new database. By default, created databases will have closed rules that\n" +
           "block any incoming third-party traffic.",
       );
+      logger.info(
+        `Your database may be viewed at ${printer.firebaseConsoleDatabaseUrl(options.project, database)}`,
+      );
     }
 
     return databaseResp;

diff --git a/src/commands/firestore-databases-restore.ts b/src/commands/firestore-databases-restore.ts
@@ -53,6 +53,9 @@ export const command = new Command("firestore:databases:restore")
           "the new database. By default, created databases will have closed rules that\n" +
           "block any incoming third-party traffic.",
       );
+      logger.info(
+        `Once the restore is complete, your database may be viewed at ${printer.firebaseConsoleDatabaseUrl(options.project, databaseId)}`,
+      );
     }
 
     return databaseResp;

diff --git a/src/firestore/pretty-print.ts b/src/firestore/pretty-print.ts
@@ -5,6 +5,7 @@ import * as sort from "./api-sort";
 import * as types from "./api-types";
 import { logger } from "../logger";
 import * as util from "./util";
+import { consoleUrl } from "../utils";
 import { Backup, BackupSchedule } from "../gcp/firestore";
 
 export class PrettyPrint {
@@ -274,6 +275,14 @@ export class PrettyPrint {
     return clc.yellow(typeof database === "string" ? database : database.name);
   }
 
+  /**
+   * Get a URL to view a given Firestore database in the Firebase console
+   */
+  firebaseConsoleDatabaseUrl(project: string, databaseId: string): string {
+    const urlFriendlyDatabaseId = databaseId === "(default)" ? "-default-" : databaseId;
+    return consoleUrl(project, `/firestore/databases/${urlFriendlyDatabaseId}/data`);
+  }
+
   /**
    * Get a colored, pretty-printed representation of a field
    */

diff --git a/src/test/firestore/pretty-print.test.ts b/src/test/firestore/pretty-print.test.ts
@@ -66,3 +66,17 @@ describe("prettyIndexString", () => {
     ).to.contain("(foo,ASCENDING) (bar,VECTOR<200>) ");
   });
 });
+
+describe("firebaseConsoleDatabaseUrl", () => {
+  it("should provide a console link", () => {
+    expect(printer.firebaseConsoleDatabaseUrl("example-project", "example-db")).to.equal(
+      "https://console.firebase.google.com/project/example-project/firestore/databases/example-db/data",
+    );
+  });
+
+  it("should convert (default) to -default-", () => {
+    expect(printer.firebaseConsoleDatabaseUrl("example-project", "(default)")).to.equal(
+      "https://console.firebase.google.com/project/example-project/firestore/databases/-default-/data",
+    );
+  });
+});