firebase-tools 10.9.2 → 11.1.0

package/lib/emulator/functionsEmulator.js

@@ -11,14 +11,12 @@ const jwt = require("jsonwebtoken");
 const cors = require("cors");
 const url_1 = require("url");
 const events_1 = require("events");
-const api = require("../api");
 const logger_1 = require("../logger");
 const track_1 = require("../track");
 const constants_1 = require("./constants");
 const types_1 = require("./types");
 const chokidar = require("chokidar");
 const spawn = require("cross-spawn");
-const child_process_1 = require("child_process");
 const functionsEmulatorShared_1 = require("./functionsEmulatorShared");
 const registry_1 = require("./registry");
 const emulatorLogger_1 = require("./emulatorLogger");
@@ -35,6 +33,7 @@ const runtimes = require("../deploy/functions/runtimes");
 const backend = require("../deploy/functions/backend");
 const functionsEnv = require("../functions/env");
 const v1_1 = require("../functions/events/v1");
+const apiv2_1 = require("../apiv2");
 const EVENT_INVOKE = "functions:invoke";
 const DATABASE_PATH_PATTERN = new RegExp("^projects/[^/]+/instances/([^/]+)/refs(/.*)$");
 class FunctionsEmulator {
@@ -383,15 +382,12 @@ class FunctionsEmulator {
         }
         const path = `/identitytoolkit.googleapis.com/v2/projects/${this.getProjectId()}/config?updateMask=blockingFunctions`;
         try {
-            await api.request("PATCH", path, {
-                origin: `http://${registry_1.EmulatorRegistry.getInfoHostString(authEmu.getInfo())}`,
-                headers: {
-                    Authorization: "Bearer owner",
-                },
-                data: {
-                    blockingFunctions: this.blockingFunctionsConfig,
-                },
-                json: true,
+            const client = new apiv2_1.Client({
+                urlPrefix: `http://${registry_1.EmulatorRegistry.getInfoHostString(authEmu.getInfo())}`,
+                auth: false,
+            });
+            await client.patch(path, { blockingFunctions: this.blockingFunctionsConfig }, {
+                headers: { Authorization: "Bearer owner" },
             });
         }
         catch (err) {
@@ -399,15 +395,15 @@ class FunctionsEmulator {
             throw err;
         }
     }
-    addRealtimeDatabaseTrigger(projectId, key, eventTrigger) {
+    async addRealtimeDatabaseTrigger(projectId, key, eventTrigger) {
         const databaseEmu = registry_1.EmulatorRegistry.get(types_1.Emulators.DATABASE);
         if (!databaseEmu) {
-            return Promise.resolve(false);
+            return false;
         }
         const result = DATABASE_PATH_PATTERN.exec(eventTrigger.resource);
         if (result === null || result.length !== 3) {
             this.logger.log("WARN", `Event function "${key}" has malformed "resource" member. ` + `${eventTrigger.resource}`);
-            return Promise.reject();
+            throw new error_1.FirebaseError(`Event function ${key} has malformed resource member`);
         }
         const instance = result[1];
         const bundle = JSON.stringify({
@@ -424,24 +420,20 @@ class FunctionsEmulator {
         else {
             this.logger.log("WARN", `No project in use. Registering function for sentinel namespace '${constants_1.Constants.DEFAULT_DATABASE_EMULATOR_NAMESPACE}'`);
         }
-        return api
-            .request("POST", setTriggersPath, {
-            origin: `http://${registry_1.EmulatorRegistry.getInfoHostString(databaseEmu.getInfo())}`,
-            headers: {
-                Authorization: "Bearer owner",
-            },
-            data: bundle,
-            json: false,
-        })
-            .then(() => {
-            return true;
-        })
-            .catch((err) => {
+        const client = new apiv2_1.Client({
+            urlPrefix: `http://${registry_1.EmulatorRegistry.getInfoHostString(databaseEmu.getInfo())}`,
+            auth: false,
+        });
+        try {
+            await client.post(setTriggersPath, bundle, { headers: { Authorization: "Bearer owner" } });
+        }
+        catch (err) {
             this.logger.log("WARN", "Error adding Realtime Database function: " + err);
             throw err;
-        });
+        }
+        return true;
     }
-    addFirestoreTrigger(projectId, key, eventTrigger) {
+    async addFirestoreTrigger(projectId, key, eventTrigger) {
         const firestoreEmu = registry_1.EmulatorRegistry.get(types_1.Emulators.FIRESTORE);
         if (!firestoreEmu) {
             return Promise.resolve(false);
@@ -450,19 +442,18 @@ class FunctionsEmulator {
             eventTrigger: Object.assign(Object.assign({}, eventTrigger), { service: "firestore.googleapis.com" }),
         });
         logger_1.logger.debug(`addFirestoreTrigger`, JSON.stringify(bundle));
-        return api
-            .request("PUT", `/emulator/v1/projects/${projectId}/triggers/${key}`, {
-            origin: `http://${registry_1.EmulatorRegistry.getInfoHostString(firestoreEmu.getInfo())}`,
-            data: bundle,
-            json: false,
-        })
-            .then(() => {
-            return true;
-        })
-            .catch((err) => {
+        const client = new apiv2_1.Client({
+            urlPrefix: `http://${registry_1.EmulatorRegistry.getInfoHostString(firestoreEmu.getInfo())}`,
+            auth: false,
+        });
+        try {
+            await client.put(`/emulator/v1/projects/${projectId}/triggers/${key}`, bundle);
+        }
+        catch (err) {
             this.logger.log("WARN", "Error adding firestore function: " + err);
             throw err;
-        });
+        }
+        return true;
     }
     async addPubsubTrigger(triggerName, key, eventTrigger, signatureType, schedule) {
         const pubsubEmulator = registry_1.EmulatorRegistry.get(types_1.Emulators.PUBSUB);
@@ -605,7 +596,7 @@ class FunctionsEmulator {
         let localMajorVersion = "0";
         const localNodePath = path.join(backend.functionsDir, "node_modules/.bin/node");
         try {
-            const localNodeOutput = (0, child_process_1.spawnSync)(localNodePath, ["--version"]).stdout.toString();
+            const localNodeOutput = spawn.sync(localNodePath, ["--version"]).stdout.toString();
             localMajorVersion = localNodeOutput.slice(1).split(".")[0];
         }
         catch (err) {
@@ -618,7 +609,13 @@ class FunctionsEmulator {
             this.logger.logLabeled("SUCCESS", "functions", `Using node@${requestedMajorVersion} from host.`);
         }
         else {
-            this.logger.log("WARN", `Your requested "node" version "${requestedMajorVersion}" doesn't match your global version "${hostMajorVersion}". Using node@${hostMajorVersion} from host.`);
+            if (process.env.FIREPIT_VERSION) {
+                this.logger.log("WARN", `You've requested "node" version "${requestedMajorVersion}", but the standalone Firebase CLI comes with bundled Node "${hostMajorVersion}".`);
+                this.logger.log("INFO", `To use a different Node.js version, consider removing the standalone Firebase CLI and switching to "firebase-tools" on npm.`);
+            }
+            else {
+                this.logger.log("WARN", `Your requested "node" version "${requestedMajorVersion}" doesn't match your global version "${hostMajorVersion}". Using node@${hostMajorVersion} from host.`);
+            }
         }
         return process.execPath;
     }

package/lib/emulator/hubClient.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EmulatorHubClient = void 0;
-const api = require("../api");
 const hub_1 = require("./hub");
 const error_1 = require("../error");
+const apiv2_1 = require("../apiv2");
 class EmulatorHubClient {
     constructor(projectId) {
         this.projectId = projectId;
@@ -12,29 +12,18 @@ class EmulatorHubClient {
     foundHub() {
         return this.locator !== undefined;
     }
-    getStatus() {
-        return api.request("GET", "/", {
-            origin: this.origin,
-        });
+    async getStatus() {
+        const apiClient = new apiv2_1.Client({ urlPrefix: this.origin, auth: false });
+        await apiClient.get("/");
     }
-    getEmulators() {
-        return api
-            .request("GET", hub_1.EmulatorHub.PATH_EMULATORS, {
-            origin: this.origin,
-            json: true,
-        })
-            .then((res) => {
-            return res.body;
-        });
+    async getEmulators() {
+        const apiClient = new apiv2_1.Client({ urlPrefix: this.origin, auth: false });
+        const res = await apiClient.get(hub_1.EmulatorHub.PATH_EMULATORS);
+        return res.body;
     }
-    postExport(path) {
-        return api.request("POST", hub_1.EmulatorHub.PATH_EXPORT, {
-            origin: this.origin,
-            json: true,
-            data: {
-                path,
-            },
-        });
+    async postExport(path) {
+        const apiClient = new apiv2_1.Client({ urlPrefix: this.origin, auth: false });
+        await apiClient.post(hub_1.EmulatorHub.PATH_EXPORT, { path });
     }
     get origin() {
         const locator = this.assertLocator();

package/lib/emulator/hubExport.js

@@ -5,7 +5,6 @@ const path = require("path");
 const fs = require("fs");
 const fse = require("fs-extra");
 const http = require("http");
-const api = require("../api");
 const logger_1 = require("../logger");
 const types_1 = require("./types");
 const registry_1 = require("./registry");
@@ -13,6 +12,7 @@ const error_1 = require("../error");
 const hub_1 = require("./hub");
 const downloadableEmulators_1 = require("./downloadableEmulators");
 const rimraf = require("rimraf");
+const apiv2_1 = require("../apiv2");
 class HubExport {
     constructor(projectId, exportPath) {
         this.projectId = projectId;
@@ -80,24 +80,27 @@ class HubExport {
             export_directory: this.tmpDir,
             export_name: metadata.firestore.path,
         };
-        return api.request("POST", `/emulator/v1/projects/${this.projectId}:export`, {
-            origin: firestoreHost,
-            json: true,
-            data: firestoreExportBody,
-        });
+        const client = new apiv2_1.Client({ urlPrefix: firestoreHost, auth: false });
+        await client.post(`/emulator/v1/projects/${this.projectId}:export`, firestoreExportBody);
     }
     async exportDatabase(metadata) {
         const databaseEmulator = registry_1.EmulatorRegistry.get(types_1.Emulators.DATABASE);
         const databaseAddr = `http://${registry_1.EmulatorRegistry.getInfoHostString(databaseEmulator.getInfo())}`;
-        const inspectURL = `/.inspect/databases.json?ns=${this.projectId}`;
-        const inspectRes = await api.request("GET", inspectURL, { origin: databaseAddr, auth: true });
+        const client = new apiv2_1.Client({ urlPrefix: databaseAddr, auth: true });
+        const inspectURL = `/.inspect/databases.json`;
+        const inspectRes = await client.get(inspectURL, {
+            queryParams: { ns: this.projectId },
+        });
         const namespaces = inspectRes.body.map((instance) => instance.name);
         const namespacesToExport = [];
         for (const ns of namespaces) {
-            const checkDataPath = `/.json?ns=${ns}&shallow=true&limitToFirst=1`;
-            const checkDataRes = await api.request("GET", checkDataPath, {
-                origin: databaseAddr,
-                auth: true,
+            const checkDataPath = `/.json`;
+            const checkDataRes = await client.get(checkDataPath, {
+                queryParams: {
+                    ns,
+                    shallow: "true",
+                    limitToFirst: 1,
+                },
             });
             if (checkDataRes.body !== null) {
                 namespacesToExport.push(ns);
@@ -162,11 +165,18 @@ class HubExport {
         const storageExportBody = {
             path: storageExportPath,
         };
-        return api.request("POST", "/internal/export", {
-            origin: storageHost,
-            json: true,
-            data: storageExportBody,
+        const client = new apiv2_1.Client({ urlPrefix: storageHost, auth: false });
+        const res = await client.request({
+            method: "POST",
+            path: "/internal/export",
+            headers: { "Content-Type": "application/json" },
+            body: storageExportBody,
+            responseType: "stream",
+            resolveOnHTTPError: true,
         });
+        if (res.status >= 400) {
+            throw new error_1.FirebaseError(`Failed to export storage: ${await res.response.text()}`);
+        }
     }
 }
 exports.HubExport = HubExport;

package/lib/emulator/portUtils.js

@@ -3,8 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.waitForPortClosed = exports.checkPortOpen = exports.findAvailablePort = exports.suggestUnrestricted = exports.isRestricted = void 0;
 const pf = require("portfinder");
 const tcpport = require("tcp-port-used");
+const dns = require("dns");
 const error_1 = require("../error");
 const logger_1 = require("../logger");
+dns.setDefaultResultOrder("ipv4first");
 const RESTRICTED_PORTS = [
     1,
     7,

package/lib/emulator/storage/crc.js

@@ -25,6 +25,9 @@ function crc32c(bytes) {
 }
 exports.crc32c = crc32c;
 function crc32cToString(crc32cValue) {
+    if (typeof crc32cValue === "string") {
+        crc32cValue = Number(crc32cValue);
+    }
     return "----" + Buffer.from([crc32cValue]).toString("base64");
 }
 exports.crc32cToString = crc32cToString;

package/lib/emulator/storage/rules/runtime.js

@@ -115,7 +115,7 @@ class StorageRulesRuntime {
             }
         });
         (_b = this._childprocess.stdout) === null || _b === void 0 ? void 0 : _b.on("data", (buf) => {
-            const serializedRuntimeActionResponse = buf.toString("UTF8").trim();
+            const serializedRuntimeActionResponse = buf.toString("utf-8").trim();
             if (serializedRuntimeActionResponse !== "") {
                 let rap;
                 try {

package/lib/errorOut.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.errorOut = void 0;
-const logError = require("./logError");
+const logError_1 = require("./logError");
 const error_1 = require("./error");
 function errorOut(error) {
     let fbError;
@@ -14,7 +14,7 @@ function errorOut(error) {
             exit: 2,
         });
     }
-    logError(fbError);
+    (0, logError_1.logError)(fbError);
     process.exitCode = fbError.exit || 2;
     setTimeout(() => {
         process.exit();

package/lib/extensions/extensionsHelper.js

@@ -31,6 +31,7 @@ const utils_2 = require("../utils");
 const changelog_1 = require("./changelog");
 const getProjectNumber_1 = require("../getProjectNumber");
 const constants_1 = require("../emulator/constants");
+const planner_1 = require("../deploy/extensions/planner");
 var SpecParamType;
 (function (SpecParamType) {
     SpecParamType["SELECT"] = "select";
@@ -529,15 +530,13 @@ async function diagnoseAndFixProject(options) {
     }
 }
 exports.diagnoseAndFixProject = diagnoseAndFixProject;
-function canonicalizeRefInput(extensionName) {
+async function canonicalizeRefInput(extensionName) {
     if (extensionName.split("/").length < 2) {
         const [extensionID, version] = extensionName.split("@");
         extensionName = `firebase/${extensionID}@${version || "latest"}`;
     }
     const ref = refs.parse(extensionName);
-    if (!ref.version) {
-        extensionName = `${extensionName}@latest`;
-    }
-    return extensionName;
+    ref.version = await (0, planner_1.resolveVersion)(ref);
+    return refs.toExtensionVersionRef(ref);
 }
 exports.canonicalizeRefInput = canonicalizeRefInput;

package/lib/extensions/manifest.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.showPreviewWarning = exports.showDeprecationWarning = exports.readInstanceParam = exports.getInstanceRef = exports.getInstanceTarget = exports.instanceExists = exports.loadConfig = exports.removeFromManifest = exports.writeLocalSecrets = exports.writeToManifest = exports.ENV_DIRECTORY = void 0;
+exports.showPostDeprecationNotice = exports.readInstanceParam = exports.getInstanceRef = exports.getInstanceTarget = exports.instanceExists = exports.loadConfig = exports.removeFromManifest = exports.writeLocalSecrets = exports.writeToManifest = exports.ENV_DIRECTORY = void 0;
 const clc = require("cli-color");
 const path = require("path");
 const refs = require("./refs");
@@ -181,16 +181,10 @@ function readParamsFile(projectDir, fileName) {
     const params = (0, paramHelper_1.readEnvFile)(paramPath);
     return params;
 }
-function showDeprecationWarning() {
-    utils.logLabeledWarning(extensionsHelper_1.logPrefix, "The behavior of ext:install, ext:update, ext:configure, and ext:uninstall will change in firebase-tools@11.0.0. " +
+function showPostDeprecationNotice() {
+    utils.logLabeledBullet(extensionsHelper_1.logPrefix, "The behavior of ext:install, ext:update, ext:configure, and ext:uninstall has changed in firebase-tools@11.0.0. " +
         "Instead of deploying extensions directly, " +
         "changes to extension instances will be written to firebase.json and ./extensions/*.env. " +
-        `Then ${clc.bold("firebase deploy (--only extensions)")} will deploy the changes to your Firebase project. ` +
-        `To access this behavior now, pass the ${clc.bold("--local")} flag.`);
+        `Then ${clc.bold("firebase deploy (--only extensions)")} will deploy the changes to your Firebase project. See https://firebase.google.com/docs/extensions/manifest for more details.`);
 }
-exports.showDeprecationWarning = showDeprecationWarning;
-function showPreviewWarning() {
-    utils.logLabeledWarning(extensionsHelper_1.logPrefix, `See these changes in your Firebase Emulator by running "firebase emulators:start". ` +
-        `Run ${clc.bold("firebase deploy (--only extensions)")} to deploy the changes to your Firebase project. `);
-}
-exports.showPreviewWarning = showPreviewWarning;
+exports.showPostDeprecationNotice = showPostDeprecationNotice;

package/lib/firebaseConfigValidate.js

@@ -8,7 +8,7 @@ const ajv = new Ajv();
 let _VALIDATOR = undefined;
 function getValidator() {
     if (!_VALIDATOR) {
-        const schemaStr = fs.readFileSync(path.resolve(__dirname, "../schema/firebase-config.json"), "UTF-8");
+        const schemaStr = fs.readFileSync(path.resolve(__dirname, "../schema/firebase-config.json"), "utf-8");
         const schema = JSON.parse(schemaStr);
         _VALIDATOR = ajv.compile(schema);
     }

package/lib/firestore/checkDatabaseType.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkDatabaseType = void 0;
-const api = require("../api");
+const api_1 = require("../api");
+const apiv2_1 = require("../apiv2");
 const logger_1 = require("../logger");
 async function checkDatabaseType(projectId) {
     try {
-        const resp = await api.request("GET", "/v1/apps/" + projectId, {
-            auth: true,
-            origin: api.appengineOrigin,
-        });
+        const client = new apiv2_1.Client({ urlPrefix: api_1.appengineOrigin, apiVersion: "v1" });
+        const resp = await client.get(`/apps/${projectId}`);
         return resp.body.databaseType;
     }
     catch (err) {

package/lib/firestore/indexes.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FirestoreIndexes = void 0;
 const clc = require("cli-color");
-const api = require("../api");
 const logger_1 = require("../logger");
 const utils = require("../utils");
 const validator = require("./validator");
@@ -10,7 +9,12 @@ const API = require("./indexes-api");
 const sort = require("./indexes-sort");
 const util = require("./util");
 const prompt_1 = require("../prompt");
+const api_1 = require("../api");
+const apiv2_1 = require("../apiv2");
 class FirestoreIndexes {
+    constructor() {
+        this.apiClient = new apiv2_1.Client({ urlPrefix: api_1.firestoreOrigin, apiVersion: "v1" });
+    }
     async deploy(options, indexes, fieldOverrides) {
         const spec = this.upgradeOldSpec({
             indexes,
@@ -112,11 +116,8 @@ class FirestoreIndexes {
         }
     }
     async listIndexes(project) {
-        const url = `projects/${project}/databases/(default)/collectionGroups/-/indexes`;
-        const res = await api.request("GET", `/v1/${url}`, {
-            auth: true,
-            origin: api.firestoreOrigin,
-        });
+        const url = `/projects/${project}/databases/(default)/collectionGroups/-/indexes`;
+        const res = await this.apiClient.get(url);
         const indexes = res.body.indexes;
         if (!indexes) {
             return [];
@@ -135,11 +136,8 @@ class FirestoreIndexes {
     }
     async listFieldOverrides(project) {
         const parent = `projects/${project}/databases/(default)/collectionGroups/-`;
-        const url = `${parent}/fields?filter=indexConfig.usesAncestorConfig=false`;
-        const res = await api.request("GET", `/v1/${url}`, {
-            auth: true,
-            origin: api.firestoreOrigin,
-        });
+        const url = `/${parent}/fields?filter=indexConfig.usesAncestorConfig=false`;
+        const res = await this.apiClient.get(url);
         const fields = res.body.fields;
         if (!fields) {
             return [];
@@ -248,7 +246,7 @@ class FirestoreIndexes {
         });
     }
     async patchField(project, spec) {
-        const url = `projects/${project}/databases/(default)/collectionGroups/${spec.collectionGroup}/fields/${spec.fieldPath}`;
+        const url = `/projects/${project}/databases/(default)/collectionGroups/${spec.collectionGroup}/fields/${spec.fieldPath}`;
         const indexes = spec.indexes.map((index) => {
             return {
                 queryScope: index.queryScope,
@@ -266,38 +264,23 @@ class FirestoreIndexes {
                 indexes,
             },
         };
-        await api.request("PATCH", `/v1/${url}`, {
-            auth: true,
-            origin: api.firestoreOrigin,
-            data,
-        });
+        await this.apiClient.patch(url, data);
     }
     deleteField(field) {
         const url = field.name;
         const data = {};
-        return api.request("PATCH", "/v1/" + url + "?updateMask=indexConfig", {
-            auth: true,
-            origin: api.firestoreOrigin,
-            data,
-        });
+        return this.apiClient.patch(`/${url}`, data, { queryParams: { updateMask: "indexConfig" } });
     }
     createIndex(project, index) {
-        const url = `projects/${project}/databases/(default)/collectionGroups/${index.collectionGroup}/indexes`;
-        return api.request("POST", "/v1/" + url, {
-            auth: true,
-            data: {
-                fields: index.fields,
-                queryScope: index.queryScope,
-            },
-            origin: api.firestoreOrigin,
+        const url = `/projects/${project}/databases/(default)/collectionGroups/${index.collectionGroup}/indexes`;
+        return this.apiClient.post(url, {
+            fields: index.fields,
+            queryScope: index.queryScope,
         });
     }
     deleteIndex(index) {
         const url = index.name;
-        return api.request("DELETE", "/v1/" + url, {
-            auth: true,
-            origin: api.firestoreOrigin,
-        });
+        return this.apiClient.delete(`/${url}`);
     }
     indexMatchesSpec(index, spec) {
         const collection = util.parseIndexName(index.name).collectionGroupId;

package/lib/functions/events/v2.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FIREBASE_ALERTS_PUBLISH_EVENT = exports.STORAGE_EVENTS = exports.PUBSUB_PUBLISH_EVENT = void 0;
+exports.DATABASE_EVENTS = exports.FIREBASE_ALERTS_PUBLISH_EVENT = exports.STORAGE_EVENTS = exports.PUBSUB_PUBLISH_EVENT = void 0;
 exports.PUBSUB_PUBLISH_EVENT = "google.cloud.pubsub.topic.v1.messagePublished";
 exports.STORAGE_EVENTS = [
     "google.cloud.storage.object.v1.finalized",
@@ -9,3 +9,9 @@ exports.STORAGE_EVENTS = [
     "google.cloud.storage.object.v1.metadataUpdated",
 ];
 exports.FIREBASE_ALERTS_PUBLISH_EVENT = "google.firebase.firebasealerts.alerts.v1.published";
+exports.DATABASE_EVENTS = [
+    "google.firebase.database.ref.v1.written",
+    "google.firebase.database.ref.v1.created",
+    "google.firebase.database.ref.v1.updated",
+    "google.firebase.database.ref.v1.deleted",
+];