firebase-tools 13.3.1 → 13.4.0

package/lib/firestore/pretty-print.js

@@ -0,0 +1,184 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrettyPrint = void 0;
+const clc = require("colorette");
+const Table = require("cli-table");
+const sort = require("./api-sort");
+const types = require("./api-types");
+const logger_1 = require("../logger");
+const util = require("./util");
+class PrettyPrint {
+    prettyPrintIndexes(indexes) {
+        if (indexes.length === 0) {
+            logger_1.logger.info("None");
+            return;
+        }
+        const sortedIndexes = indexes.sort(sort.compareApiIndex);
+        sortedIndexes.forEach((index) => {
+            logger_1.logger.info(this.prettyIndexString(index));
+        });
+    }
+    prettyPrintDatabases(databases) {
+        if (databases.length === 0) {
+            logger_1.logger.info("No databases found.");
+            return;
+        }
+        const sortedDatabases = databases.sort(sort.compareApiDatabase);
+        const table = new Table({
+            head: ["Database Name"],
+            colWidths: [Math.max(...sortedDatabases.map((database) => database.name.length + 5), 20)],
+        });
+        table.push(...sortedDatabases.map((database) => [this.prettyDatabaseString(database)]));
+        logger_1.logger.info(table.toString());
+    }
+    prettyPrintDatabase(database) {
+        const table = new Table({
+            head: ["Field", "Value"],
+            colWidths: [25, Math.max(50, 5 + database.name.length)],
+        });
+        table.push(["Name", clc.yellow(database.name)], ["Create Time", clc.yellow(database.createTime)], ["Last Update Time", clc.yellow(database.updateTime)], ["Type", clc.yellow(database.type)], ["Location", clc.yellow(database.locationId)], ["Delete Protection State", clc.yellow(database.deleteProtectionState)], ["Point In Time Recovery", clc.yellow(database.pointInTimeRecoveryEnablement)], ["Earliest Version Time", clc.yellow(database.earliestVersionTime)], ["Version Retention Period", clc.yellow(database.versionRetentionPeriod)]);
+        logger_1.logger.info(table.toString());
+    }
+    prettyPrintBackups(backups) {
+        if (backups.length === 0) {
+            logger_1.logger.info("No backups found.");
+            return;
+        }
+        const sortedBackups = backups.sort(sort.compareApiBackup);
+        const table = new Table({
+            head: ["Backup Name", "Database Name", "Snapshot Time", "State"],
+            colWidths: [
+                Math.max(...sortedBackups.map((backup) => backup.name.length + 5), 20),
+                Math.max(...sortedBackups.map((backup) => backup.database.length + 5), 20),
+                30,
+                10,
+            ],
+        });
+        table.push(...sortedBackups.map((backup) => [
+            this.prettyBackupString(backup),
+            this.prettyDatabaseString(backup.database || ""),
+            backup.snapshotTime,
+            backup.state,
+        ]));
+        logger_1.logger.info(table.toString());
+    }
+    prettyPrintBackupSchedules(backupSchedules, databaseId) {
+        if (backupSchedules.length === 0) {
+            logger_1.logger.info(`No backup schedules for database ${databaseId} found.`);
+            return;
+        }
+        const sortedBackupSchedules = backupSchedules.sort(sort.compareApiBackupSchedule);
+        sortedBackupSchedules.forEach((schedule) => this.prettyPrintBackupSchedule(schedule));
+    }
+    prettyPrintBackupSchedule(backupSchedule) {
+        const table = new Table({
+            head: ["Field", "Value"],
+            colWidths: [25, Math.max(50, 5 + backupSchedule.name.length)],
+        });
+        table.push(["Name", clc.yellow(backupSchedule.name)], ["Create Time", clc.yellow(backupSchedule.createTime)], ["Last Update Time", clc.yellow(backupSchedule.updateTime)], ["Retention", clc.yellow(backupSchedule.retention)], ["Recurrence", this.prettyRecurrenceString(backupSchedule)]);
+        logger_1.logger.info(table.toString());
+    }
+    prettyRecurrenceString(backupSchedule) {
+        if (backupSchedule.dailyRecurrence) {
+            return clc.yellow("DAILY");
+        }
+        else if (backupSchedule.weeklyRecurrence) {
+            return clc.yellow(`WEEKLY (${backupSchedule.weeklyRecurrence.day})`);
+        }
+        return "";
+    }
+    prettyPrintBackup(backup) {
+        const table = new Table({
+            head: ["Field", "Value"],
+            colWidths: [25, Math.max(50, 5 + backup.name.length, 5 + backup.database.length)],
+        });
+        table.push(["Name", clc.yellow(backup.name)], ["Database", clc.yellow(backup.database)], ["Database UID", clc.yellow(backup.databaseUid)], ["State", clc.yellow(backup.state)], ["Snapshot Time", clc.yellow(backup.snapshotTime)], ["Expire Time", clc.yellow(backup.expireTime)], ["Stats", clc.yellow(backup.stats)]);
+        logger_1.logger.info(table.toString());
+    }
+    prettyPrintLocations(locations) {
+        if (locations.length === 0) {
+            logger_1.logger.info("No Locations Available");
+            return;
+        }
+        const table = new Table({
+            head: ["Display Name", "LocationId"],
+            colWidths: [20, 30],
+        });
+        table.push(...locations
+            .sort(sort.compareLocation)
+            .map((location) => [location.displayName, location.locationId]));
+        logger_1.logger.info(table.toString());
+    }
+    printFieldOverrides(fields) {
+        if (fields.length === 0) {
+            logger_1.logger.info("None");
+            return;
+        }
+        const sortedFields = fields.sort(sort.compareApiField);
+        sortedFields.forEach((field) => {
+            logger_1.logger.info(this.prettyFieldString(field));
+        });
+    }
+    prettyIndexString(index, includeState = true) {
+        let result = "";
+        if (index.state && includeState) {
+            const stateMsg = `[${index.state}] `;
+            if (index.state === types.State.READY) {
+                result += clc.green(stateMsg);
+            }
+            else if (index.state === types.State.CREATING) {
+                result += clc.yellow(stateMsg);
+            }
+            else {
+                result += clc.red(stateMsg);
+            }
+        }
+        const nameInfo = util.parseIndexName(index.name);
+        result += clc.cyan(`(${nameInfo.collectionGroupId})`);
+        result += " -- ";
+        index.fields.forEach((field) => {
+            if (field.fieldPath === "__name__") {
+                return;
+            }
+            const orderOrArrayConfig = field.order ? field.order : field.arrayConfig;
+            result += `(${field.fieldPath},${orderOrArrayConfig}) `;
+        });
+        return result;
+    }
+    prettyBackupString(backup) {
+        return clc.yellow(backup.name || "");
+    }
+    prettyBackupScheduleString(backupSchedule) {
+        return clc.yellow(backupSchedule.name || "");
+    }
+    prettyDatabaseString(database) {
+        return clc.yellow(typeof database === "string" ? database : database.name);
+    }
+    prettyFieldString(field) {
+        let result = "";
+        const parsedName = util.parseFieldName(field.name);
+        result +=
+            "[" +
+                clc.cyan(parsedName.collectionGroupId) +
+                "." +
+                clc.yellow(parsedName.fieldPath) +
+                "] --";
+        const fieldIndexes = field.indexConfig.indexes || [];
+        if (fieldIndexes.length > 0) {
+            fieldIndexes.forEach((index) => {
+                const firstField = index.fields[0];
+                const mode = firstField.order || firstField.arrayConfig;
+                result += ` (${mode})`;
+            });
+        }
+        else {
+            result += " (no indexes)";
+        }
+        const fieldTtl = field.ttlConfig;
+        if (fieldTtl) {
+            result += ` TTL(${fieldTtl.state})`;
+        }
+        return result;
+    }
+}
+exports.PrettyPrint = PrettyPrint;

package/lib/functions/secrets.js

@@ -44,7 +44,7 @@ function toUpperSnakeCase(key) {
 }
 function ensureApi(options) {
     const projectId = (0, projectUtils_1.needProjectId)(options);
-    return ensureApiEnabled.ensure(projectId, "secretmanager.googleapis.com", "secretmanager", true);
+    return ensureApiEnabled.ensure(projectId, api_1.secretManagerOrigin, "secretmanager", true);
 }
 exports.ensureApi = ensureApi;
 async function ensureValidKey(key, options) {

package/lib/gcp/apphosting.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNextRolloutId = exports.ensureApiEnabled = exports.listLocations = exports.updateTraffic = exports.listRollouts = exports.createRollout = exports.createBuild = exports.listBuilds = exports.getBuild = exports.deleteBackend = exports.listBackends = exports.getBackend = exports.createBackend = exports.client = exports.API_VERSION = exports.API_HOST = void 0;
+exports.getNextRolloutId = exports.ensureApiEnabled = exports.listLocations = exports.updateTraffic = exports.listRollouts = exports.createRollout = exports.createBuild = exports.listBuilds = exports.getBuild = exports.deleteBackend = exports.listBackends = exports.getBackend = exports.createBackend = exports.client = exports.API_VERSION = void 0;
 const proto = require("../gcp/proto");
 const apiv2_1 = require("../apiv2");
 const projectUtils_1 = require("../projectUtils");
@@ -9,7 +9,6 @@ const ensureApiEnabled_1 = require("../ensureApiEnabled");
 const deploymentTool = require("../deploymentTool");
 const error_1 = require("../error");
 const metaprogramming_1 = require("../metaprogramming");
-exports.API_HOST = new URL(api_1.apphostingOrigin).host;
 exports.API_VERSION = "v1alpha";
 exports.client = new apiv2_1.Client({
     urlPrefix: api_1.apphostingOrigin,
@@ -126,7 +125,7 @@ async function listLocations(projectId) {
 exports.listLocations = listLocations;
 async function ensureApiEnabled(options) {
     const projectId = (0, projectUtils_1.needProjectId)(options);
-    return await (0, ensureApiEnabled_1.ensure)(projectId, exports.API_HOST, "app hosting", true);
+    return await (0, ensureApiEnabled_1.ensure)(projectId, api_1.apphostingOrigin, "app hosting", true);
 }
 exports.ensureApiEnabled = ensureApiEnabled;
 async function getNextRolloutId(projectId, location, backendId, counter) {

package/lib/gcp/auth.js

@@ -5,12 +5,15 @@ const apiv2_1 = require("../apiv2");
 const api_1 = require("../api");
 const apiClient = new apiv2_1.Client({ urlPrefix: api_1.identityOrigin, auth: true });
 async function getAuthDomains(project) {
-    const res = await apiClient.get(`/admin/v2/projects/${project}/config`);
+    const res = await apiClient.get(`/admin/v2/projects/${project}/config`, { headers: { "x-goog-user-project": project } });
     return res.body.authorizedDomains;
 }
 exports.getAuthDomains = getAuthDomains;
 async function updateAuthDomains(project, authDomains) {
-    const res = await apiClient.patch(`/admin/v2/projects/${project}/config`, { authorizedDomains: authDomains }, { queryParams: { update_mask: "authorizedDomains" } });
+    const res = await apiClient.patch(`/admin/v2/projects/${project}/config`, { authorizedDomains: authDomains }, {
+        queryParams: { update_mask: "authorizedDomains" },
+        headers: { "x-goog-user-project": project },
+    });
     return res.body.authorizedDomains;
 }
 exports.updateAuthDomains = updateAuthDomains;

package/lib/gcp/firestore.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteDocuments = exports.deleteDocument = exports.listCollectionIds = exports.getDatabase = void 0;
+exports.getBackupSchedule = exports.listBackupSchedules = exports.getBackup = exports.listBackups = exports.deleteBackupSchedule = exports.deleteBackup = exports.updateBackupSchedule = exports.createBackupSchedule = exports.deleteDocuments = exports.deleteDocument = exports.listCollectionIds = exports.getDatabase = exports.DayOfWeek = void 0;
 const api_1 = require("../api");
 const apiv2_1 = require("../apiv2");
 const logger_1 = require("../logger");
+const proto_1 = require("./proto");
+const error_1 = require("../error");
 const prodOnlyClient = new apiv2_1.Client({
     auth: true,
     apiVersion: "v1",
@@ -14,6 +16,16 @@ const emuOrProdClient = new apiv2_1.Client({
     apiVersion: "v1",
     urlPrefix: api_1.firestoreOriginOrEmulator,
 });
+var DayOfWeek;
+(function (DayOfWeek) {
+    DayOfWeek["MONDAY"] = "MONDAY";
+    DayOfWeek["TUEDAY"] = "TUESDAY";
+    DayOfWeek["WEDNESDAY"] = "WEDNESDAY";
+    DayOfWeek["THURSDAY"] = "THURSDAY";
+    DayOfWeek["FRIDAY"] = "FRIDAY";
+    DayOfWeek["SATURDAY"] = "SATURDAY";
+    DayOfWeek["SUNDAY"] = "SUNDAY";
+})(DayOfWeek = exports.DayOfWeek || (exports.DayOfWeek = {}));
 async function getDatabase(project, database, allowEmulator = false) {
     const apiClient = allowEmulator ? emuOrProdClient : prodOnlyClient;
     const url = `projects/${project}/databases/${database}`;
@@ -54,3 +66,65 @@ async function deleteDocuments(project, docs, allowEmulator = false) {
     return res.body.writeResults.length;
 }
 exports.deleteDocuments = deleteDocuments;
+async function createBackupSchedule(project, databaseId, retention, dailyRecurrence, weeklyRecurrence) {
+    const url = `projects/${project}/databases/${databaseId}/backupSchedules`;
+    const data = {
+        retention: (0, proto_1.durationFromSeconds)(retention),
+        dailyRecurrence,
+        weeklyRecurrence,
+    };
+    (0, proto_1.assertOneOf)("BackupSchedule", data, "recurrence", "dailyRecurrence", "weeklyRecurrence");
+    const res = await prodOnlyClient.post(url, data);
+    return res.body;
+}
+exports.createBackupSchedule = createBackupSchedule;
+async function updateBackupSchedule(backupScheduleName, retention) {
+    const data = {
+        retention: (0, proto_1.durationFromSeconds)(retention),
+    };
+    const res = await prodOnlyClient.patch(backupScheduleName, data);
+    return res.body;
+}
+exports.updateBackupSchedule = updateBackupSchedule;
+async function deleteBackup(backupName) {
+    await prodOnlyClient.delete(backupName);
+}
+exports.deleteBackup = deleteBackup;
+async function deleteBackupSchedule(backupScheduleName) {
+    await prodOnlyClient.delete(backupScheduleName);
+}
+exports.deleteBackupSchedule = deleteBackupSchedule;
+async function listBackups(project, location) {
+    const url = `/projects/${project}/locations/${location}/backups`;
+    const res = await prodOnlyClient.get(url);
+    return res.body;
+}
+exports.listBackups = listBackups;
+async function getBackup(backupName) {
+    const res = await prodOnlyClient.get(backupName);
+    const backup = res.body;
+    if (!backup) {
+        throw new error_1.FirebaseError("Not found");
+    }
+    return backup;
+}
+exports.getBackup = getBackup;
+async function listBackupSchedules(project, database) {
+    const url = `/projects/${project}/databases/${database}/backupSchedules`;
+    const res = await prodOnlyClient.get(url);
+    const backupSchedules = res.body.backupSchedules;
+    if (!backupSchedules) {
+        return [];
+    }
+    return backupSchedules;
+}
+exports.listBackupSchedules = listBackupSchedules;
+async function getBackupSchedule(backupScheduleName) {
+    const res = await prodOnlyClient.get(backupScheduleName);
+    const backupSchedule = res.body;
+    if (!backupSchedule) {
+        throw new error_1.FirebaseError("Not found");
+    }
+    return backupSchedule;
+}
+exports.getBackupSchedule = getBackupSchedule;

package/lib/gcp/storage.js

@@ -10,7 +10,7 @@ const logger_1 = require("../logger");
 const ensureApiEnabled_1 = require("../ensureApiEnabled");
 async function getDefaultBucket(projectId) {
     var _a;
-    await (0, ensureApiEnabled_1.ensure)(projectId, "firebasestorage.googleapis.com", "storage", false);
+    await (0, ensureApiEnabled_1.ensure)(projectId, api_1.firebaseStorageOrigin, "storage", false);
     try {
         const localAPIClient = new apiv2_1.Client({ urlPrefix: api_1.firebaseStorageOrigin, apiVersion: "v1alpha" });
         const response = await localAPIClient.get(`/projects/${projectId}/defaultBucket`);

package/lib/init/features/apphosting/index.js

@@ -24,10 +24,10 @@ const apphostingPollerOptions = {
 };
 async function doSetup(projectId, location, serviceAccount) {
     await Promise.all([
-        (0, ensureApiEnabled_1.ensure)(projectId, "cloudbuild.googleapis.com", "apphosting", true),
-        (0, ensureApiEnabled_1.ensure)(projectId, "secretmanager.googleapis.com", "apphosting", true),
-        (0, ensureApiEnabled_1.ensure)(projectId, "run.googleapis.com", "apphosting", true),
-        (0, ensureApiEnabled_1.ensure)(projectId, "artifactregistry.googleapis.com", "apphosting", true),
+        (0, ensureApiEnabled_1.ensure)(projectId, api_1.cloudbuildOrigin, "apphosting", true),
+        (0, ensureApiEnabled_1.ensure)(projectId, api_1.secretManagerOrigin, "apphosting", true),
+        (0, ensureApiEnabled_1.ensure)(projectId, api_1.cloudRunApiOrigin, "apphosting", true),
+        (0, ensureApiEnabled_1.ensure)(projectId, api_1.artifactRegistryDomain, "apphosting", true),
     ]);
     const allowedLocations = (await apphosting.listLocations(projectId)).map((loc) => loc.locationId);
     if (location) {
@@ -122,9 +122,14 @@ async function createBackend(projectId, location, backendId, repository, service
         return await createBackendAndPoll();
     }
     catch (err) {
-        if (err.status === 403 && err.message.includes(defaultServiceAccount)) {
-            await provisionDefaultComputeServiceAccount(projectId);
-            return await createBackendAndPoll();
+        if (err.status === 403) {
+            if (err.message.includes(defaultServiceAccount)) {
+                await provisionDefaultComputeServiceAccount(projectId);
+                return await createBackendAndPoll();
+            }
+            else if (serviceAccount && err.message.includes(serviceAccount)) {
+                throw new error_1.FirebaseError(`Failed to create backend due to missing delegation permissions for ${serviceAccount}. Make sure you have the iam.serviceAccounts.actAs permission.`, { children: [err] });
+            }
         }
         throw err;
     }

package/lib/init/features/database.js

@@ -12,6 +12,7 @@ const ensureApiEnabled_1 = require("../../ensureApiEnabled");
 const getDefaultDatabaseInstance_1 = require("../../getDefaultDatabaseInstance");
 const error_1 = require("../../error");
 const apiv2_1 = require("../../apiv2");
+const api_1 = require("../../api");
 const DEFAULT_RULES = JSON.stringify({ rules: { ".read": "auth != null", ".write": "auth != null" } }, null, 2);
 async function getDBRules(instanceDetails) {
     if (!instanceDetails || !instanceDetails.name) {
@@ -70,7 +71,7 @@ async function doSetup(setup, config) {
     setup.config = setup.config || {};
     let instanceDetails;
     if (setup.projectId) {
-        await (0, ensureApiEnabled_1.ensure)(setup.projectId, "firebasedatabase.googleapis.com", "database", false);
+        await (0, ensureApiEnabled_1.ensure)(setup.projectId, api_1.rtdbManagementOrigin, "database", false);
         logger_1.logger.info();
         setup.instance =
             setup.instance || (await (0, getDefaultDatabaseInstance_1.getDefaultDatabaseInstance)({ project: setup.projectId }));

package/lib/init/features/extensions/index.js

@@ -4,12 +4,13 @@ exports.doSetup = void 0;
 const requirePermissions_1 = require("../../../requirePermissions");
 const ensureApiEnabled_1 = require("../../../ensureApiEnabled");
 const manifest = require("../../../extensions/manifest");
+const api_1 = require("../../../api");
 async function doSetup(setup, config, options) {
     var _a, _b;
     const projectId = (_b = (_a = setup === null || setup === void 0 ? void 0 : setup.rcfile) === null || _a === void 0 ? void 0 : _a.projects) === null || _b === void 0 ? void 0 : _b.default;
     if (projectId) {
         await (0, requirePermissions_1.requirePermissions)(Object.assign(Object.assign({}, options), { project: projectId }));
-        await Promise.all([(0, ensureApiEnabled_1.ensure)(projectId, "firebaseextensions.googleapis.com", "unused", true)]);
+        await Promise.all([(0, ensureApiEnabled_1.ensure)(projectId, api_1.extensionsOrigin, "unused", true)]);
     }
     return manifest.writeEmptyManifest(config, options);
 }

package/lib/init/features/functions/index.js

@@ -8,6 +8,7 @@ const requirePermissions_1 = require("../../../requirePermissions");
 const ensureApiEnabled_1 = require("../../../ensureApiEnabled");
 const projectConfig_1 = require("../../../functions/projectConfig");
 const error_1 = require("../../../error");
+const api_1 = require("../../../api");
 const MAX_ATTEMPTS = 5;
 async function doSetup(setup, config, options) {
     var _a, _b;
@@ -15,8 +16,8 @@ async function doSetup(setup, config, options) {
     if (projectId) {
         await (0, requirePermissions_1.requirePermissions)(Object.assign(Object.assign({}, options), { project: projectId }));
         await Promise.all([
-            (0, ensureApiEnabled_1.ensure)(projectId, "cloudfunctions.googleapis.com", "unused", true),
-            (0, ensureApiEnabled_1.ensure)(projectId, "runtimeconfig.googleapis.com", "unused", true),
+            (0, ensureApiEnabled_1.ensure)(projectId, api_1.functionsOrigin, "unused", true),
+            (0, ensureApiEnabled_1.ensure)(projectId, api_1.runtimeconfigOrigin, "unused", true),
         ]);
     }
     setup.functions = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-tools",
-  "version": "13.3.1",
+  "version": "13.4.0",
   "description": "Command-Line Interface for Firebase",
   "main": "./lib/index.js",
   "bin": {
@@ -74,6 +74,7 @@
     "cross-env": "^5.1.3",
     "cross-spawn": "^7.0.3",
     "csv-parse": "^5.0.4",
+    "deep-equal-in-any-order": "^2.0.6",
     "exegesis": "^4.1.0",
     "exegesis-express": "^4.0.0",
     "express": "^4.16.4",