firebase-tools 11.20.0 → 11.21.0

package/lib/bin/firebase.js

@@ -8,7 +8,7 @@ if (!semver.satisfies(nodeVersion, pkg.engines.node)) {
     console.error(`Firebase CLI v${pkg.version} is incompatible with Node.js ${nodeVersion} Please upgrade Node.js to version ${pkg.engines.node}`);
     process.exit(1);
 }
-const updateNotifierPkg = require("update-notifier");
+const updateNotifierPkg = require("update-notifier-cjs");
 const clc = require("colorette");
 const TerminalRenderer = require("marked-terminal");
 const updateNotifier = updateNotifierPkg({ pkg });

package/lib/commands/appdistribution-distribute.js

@@ -90,6 +90,9 @@ exports.command = new command_1.Command("appdistribution:distribute <release-bin
             default:
                 utils.logSuccess(`uploaded release ${release.displayVersion} (${release.buildVersion}) successfully!`);
         }
+        utils.logSuccess(`View this release in the Firebase console: ${release.firebaseConsoleUri}`);
+        utils.logSuccess(`Share this release with testers who have access: ${release.testingUri}`);
+        utils.logSuccess(`Download the release binary (link expires in 1 hour): ${release.binaryDownloadUri}`);
         releaseName = uploadResponse.release.name;
     }
     catch (err) {

package/lib/commands/ext-configure.js

@@ -32,6 +32,7 @@ exports.command = new command_1.Command("ext:configure <extensionInstanceId>")
     .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extMinVersion")
     .before(extensionsHelper_1.diagnoseAndFixProject)
     .action(async (instanceId, options) => {
+    var _a;
     const projectId = (0, projectUtils_1.getProjectId)(options);
     if (options.nonInteractive) {
         throw new error_1.FirebaseError(`Command not supported in non-interactive mode, edit ./extensions/${instanceId}.env directly instead. ` +
@@ -56,7 +57,7 @@ exports.command = new command_1.Command("ext:configure <extensionInstanceId>")
         instanceId,
         projectDir: config.projectDir,
     });
-    const [immutableParams, tbdParams] = (0, functional_1.partition)(spec.params, (param) => { var _a; return (_a = param.immutable) !== null && _a !== void 0 ? _a : false; });
+    const [immutableParams, tbdParams] = (0, functional_1.partition)(spec.params.concat((_a = spec.systemParams) !== null && _a !== void 0 ? _a : []), (param) => { var _a; return (_a = param.immutable) !== null && _a !== void 0 ? _a : false; });
     infoImmutableParams(immutableParams, oldParamValues);
     paramHelper.setNewDefaults(tbdParams, oldParamValues);
     const mutableParamsBindingOptions = await paramHelper.getParams({

package/lib/commands/ext-install.js

@@ -120,7 +120,7 @@ async function infoExtensionVersion(args) {
     await (0, warnings_1.displayWarningPrompts)(ref.publisherId, extension.registryLaunchStage, args.extensionVersion);
 }
 async function installToManifest(options) {
-    var _a;
+    var _a, _b;
     const { projectId, extensionName, extVersion, source, paramsEnvPath, nonInteractive, force } = options;
     const isLocalSource = (0, extensionsHelper_1.isLocalPath)(extensionName);
     const spec = (_a = extVersion === null || extVersion === void 0 ? void 0 : extVersion.spec) !== null && _a !== void 0 ? _a : source === null || source === void 0 ? void 0 : source.spec;
@@ -134,7 +134,7 @@ async function installToManifest(options) {
     }
     const paramBindingOptions = await paramHelper.getParams({
         projectId,
-        paramSpecs: spec.params,
+        paramSpecs: spec.params.concat((_b = spec.systemParams) !== null && _b !== void 0 ? _b : []),
         nonInteractive,
         paramsEnvPath,
         instanceId,

package/lib/deploy/extensions/planner.js

@@ -8,7 +8,9 @@ const error_1 = require("../../error");
 const extensionsHelper_1 = require("../../extensions/extensionsHelper");
 const logger_1 = require("../../logger");
 const manifest_1 = require("../../extensions/manifest");
+const paramHelper_1 = require("../../extensions/paramHelper");
 const specHelper_1 = require("../../extensions/emulator/specHelper");
+const functional_1 = require("../../functional");
 async function getExtensionVersion(i) {
     if (!i.extensionVersion) {
         if (!i.ref) {
@@ -49,9 +51,11 @@ exports.getExtensionSpec = getExtensionSpec;
 async function have(projectId) {
     const instances = await extensionsApi.listInstances(projectId);
     return instances.map((i) => {
+        var _a;
         const dep = {
             instanceId: i.name.split("/").pop(),
             params: i.config.params,
+            systemParams: (_a = i.config.systemParams) !== null && _a !== void 0 ? _a : {},
             allowedEventTypes: i.config.allowedEventTypes,
             eventarcChannel: i.config.eventarcChannel,
             etag: i.etag,
@@ -71,7 +75,7 @@ async function want(args) {
     for (const e of Object.entries(args.extensions)) {
         try {
             const instanceId = e[0];
-            const params = (0, manifest_1.readInstanceParam)({
+            const rawParams = (0, manifest_1.readInstanceParam)({
                 projectDir: args.projectDir,
                 instanceId,
                 projectId: args.projectId,
@@ -80,18 +84,20 @@ async function want(args) {
                 checkLocal: args.emulatorMode,
             });
             const autoPopulatedParams = await (0, extensionsHelper_1.getFirebaseProjectParams)(args.projectId, args.emulatorMode);
-            const subbedParams = (0, extensionsHelper_1.substituteParams)(params, autoPopulatedParams);
-            const allowedEventTypes = subbedParams.ALLOWED_EVENT_TYPES !== undefined
-                ? subbedParams.ALLOWED_EVENT_TYPES.split(",").filter((e) => e !== "")
+            const subbedParams = (0, extensionsHelper_1.substituteParams)(rawParams, autoPopulatedParams);
+            const [systemParams, params] = (0, functional_1.partitionRecord)(subbedParams, paramHelper_1.isSystemParam);
+            const allowedEventTypes = params.ALLOWED_EVENT_TYPES !== undefined
+                ? params.ALLOWED_EVENT_TYPES.split(",").filter((e) => e !== "")
                 : undefined;
-            const eventarcChannel = subbedParams.EVENTARC_CHANNEL;
-            delete subbedParams["EVENTARC_CHANNEL"];
-            delete subbedParams["ALLOWED_EVENT_TYPES"];
+            const eventarcChannel = params.EVENTARC_CHANNEL;
+            delete params["EVENTARC_CHANNEL"];
+            delete params["ALLOWED_EVENT_TYPES"];
             if ((0, extensionsHelper_1.isLocalPath)(e[1])) {
                 instanceSpecs.push({
                     instanceId,
                     localPath: e[1],
-                    params: subbedParams,
+                    params,
+                    systemParams,
                     allowedEventTypes: allowedEventTypes,
                     eventarcChannel: eventarcChannel,
                 });
@@ -102,7 +108,8 @@ async function want(args) {
                 instanceSpecs.push({
                     instanceId,
                     ref,
-                    params: subbedParams,
+                    params,
+                    systemParams,
                     allowedEventTypes: allowedEventTypes,
                     eventarcChannel: eventarcChannel,
                 });

package/lib/deploy/extensions/tasks.js

@@ -32,6 +32,7 @@ function createExtensionInstanceTask(projectId, instanceSpec, validateOnly = fal
                 projectId,
                 instanceId: instanceSpec.instanceId,
                 params: instanceSpec.params,
+                systemParams: instanceSpec.systemParams,
                 extensionVersionRef: refs.toExtensionVersionRef(instanceSpec.ref),
                 allowedEventTypes: instanceSpec.allowedEventTypes,
                 eventarcChannel: instanceSpec.eventarcChannel,
@@ -44,6 +45,7 @@ function createExtensionInstanceTask(projectId, instanceSpec, validateOnly = fal
                 projectId,
                 instanceId: instanceSpec.instanceId,
                 params: instanceSpec.params,
+                systemParams: instanceSpec.systemParams,
                 extensionSource,
                 allowedEventTypes: instanceSpec.allowedEventTypes,
                 eventarcChannel: instanceSpec.eventarcChannel,
@@ -71,6 +73,7 @@ function updateExtensionInstanceTask(projectId, instanceSpec, validateOnly = fal
                 instanceId: instanceSpec.instanceId,
                 extRef: refs.toExtensionVersionRef(instanceSpec.ref),
                 params: instanceSpec.params,
+                systemParams: instanceSpec.systemParams,
                 canEmitEvents: !!instanceSpec.allowedEventTypes,
                 allowedEventTypes: instanceSpec.allowedEventTypes,
                 eventarcChannel: instanceSpec.eventarcChannel,
@@ -84,6 +87,8 @@ function updateExtensionInstanceTask(projectId, instanceSpec, validateOnly = fal
                 instanceId: instanceSpec.instanceId,
                 extensionSource,
                 validateOnly,
+                params: instanceSpec.params,
+                systemParams: instanceSpec.systemParams,
                 canEmitEvents: !!instanceSpec.allowedEventTypes,
                 allowedEventTypes: instanceSpec.allowedEventTypes,
                 eventarcChannel: instanceSpec.eventarcChannel,
@@ -109,6 +114,7 @@ function configureExtensionInstanceTask(projectId, instanceSpec, validateOnly =
                 projectId,
                 instanceId: instanceSpec.instanceId,
                 params: instanceSpec.params,
+                systemParams: instanceSpec.systemParams,
                 canEmitEvents: !!instanceSpec.allowedEventTypes,
                 allowedEventTypes: instanceSpec.allowedEventTypes,
                 eventarcChannel: instanceSpec.eventarcChannel,

package/lib/deploy/functions/prepareFunctionsUpload.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.prepareFunctionsUpload = exports.getFunctionsConfig = void 0;
+exports.convertToSortedKeyValueArray = exports.prepareFunctionsUpload = exports.getFunctionsConfig = void 0;
 const archiver = require("archiver");
 const clc = require("colorette");
 const filesize = require("filesize");
@@ -66,8 +66,9 @@ async function packageSource(sourceDir, config, runtimeConfig) {
             });
         }
         if (typeof runtimeConfig !== "undefined") {
+            const runtimeConfigHashString = JSON.stringify(convertToSortedKeyValueArray(runtimeConfig));
+            hashes.push(runtimeConfigHashString);
             const runtimeConfigString = JSON.stringify(runtimeConfig, null, 2);
-            hashes.push(runtimeConfigString);
             archive.append(runtimeConfigString, {
                 name: CONFIG_DEST_FILE,
                 mode: 420,
@@ -94,3 +95,13 @@ async function prepareFunctionsUpload(sourceDir, config, runtimeConfig) {
     return packageSource(sourceDir, config, runtimeConfig);
 }
 exports.prepareFunctionsUpload = prepareFunctionsUpload;
+function convertToSortedKeyValueArray(config) {
+    if (typeof config !== "object" || config === null)
+        return config;
+    return Object.keys(config)
+        .sort()
+        .map((key) => {
+        return { key, value: convertToSortedKeyValueArray(config[key]) };
+    });
+}
+exports.convertToSortedKeyValueArray = convertToSortedKeyValueArray;

package/lib/deploy/functions/runtimes/index.js

@@ -5,7 +5,7 @@ const node = require("./node");
 const validate = require("../validate");
 const error_1 = require("../../../error");
 const RUNTIMES = ["nodejs10", "nodejs12", "nodejs14", "nodejs16", "nodejs18"];
-const EXPERIMENTAL_RUNTIMES = ["go113"];
+const EXPERIMENTAL_RUNTIMES = [];
 const DEPRECATED_RUNTIMES = ["nodejs6", "nodejs8"];
 function isDeprecatedRuntime(runtime) {
     return DEPRECATED_RUNTIMES.includes(runtime);
@@ -23,7 +23,6 @@ const MESSAGE_FRIENDLY_RUNTIMES = {
     nodejs14: "Node.js 14",
     nodejs16: "Node.js 16",
     nodejs18: "Node.js 18",
-    go113: "Go 1.13",
 };
 function getHumanFriendlyRuntimeName(runtime) {
     return MESSAGE_FRIENDLY_RUNTIMES[runtime] || runtime;

package/lib/deploy/functions/runtimes/node/index.js

@@ -63,7 +63,9 @@ class Delegate {
         if (Object.keys(config || {}).length) {
             env.CLOUD_RUNTIME_CONFIG = JSON.stringify(config);
         }
-        const childProcess = spawn("./node_modules/.bin/firebase-functions", [this.sourceDir], {
+        const sdkPath = require.resolve("firebase-functions", { paths: [this.sourceDir] });
+        const binPath = sdkPath.substring(0, sdkPath.lastIndexOf("node_modules") + 12);
+        const childProcess = spawn(path.join(binPath, ".bin", "firebase-functions"), [this.sourceDir], {
             env,
             cwd: this.sourceDir,
             stdio: ["ignore", "pipe", "inherit"],

package/lib/emulator/auth/operations.js

@@ -502,7 +502,7 @@ function createSessionCookie(state, reqBody) {
     const { payload } = parseIdToken(state, reqBody.idToken);
     const issuedAt = (0, utils_1.toUnixTimestamp)(new Date());
     const expiresAt = issuedAt + validDuration;
-    const sessionCookie = (0, jsonwebtoken_1.sign)(Object.assign(Object.assign({}, payload), { iat: issuedAt, exp: expiresAt, iss: `https://session.firebase.google.com/${payload.aud}` }), "", {
+    const sessionCookie = (0, jsonwebtoken_1.sign)(Object.assign(Object.assign({}, payload), { iat: issuedAt, exp: expiresAt, iss: `https://session.firebase.google.com/${payload.aud}` }), "fake-secret", {
         algorithm: "none",
     });
     return { sessionCookie };
@@ -1552,7 +1552,7 @@ function generateJwt(user, { projectId, signInProvider, expiresInSeconds, extraC
             tenant: tenantId,
             sign_in_attributes: signInAttributes,
         } });
-    const jwtStr = (0, jsonwebtoken_1.sign)(customPayloadFields, "", {
+    const jwtStr = (0, jsonwebtoken_1.sign)(customPayloadFields, "fake-secret", {
         algorithm: "none",
         expiresIn: expiresInSeconds,
         subject: user.localId,
@@ -2129,7 +2129,7 @@ function generateBlockingFunctionJwt(state, event, url, timeoutMs, user, options
     if (state.shouldForwardCredentialToBlockingFunction("refreshToken")) {
         jwt.oauth_refresh_token = oauthTokens.oauthRefreshToken;
     }
-    const jwtStr = (0, jsonwebtoken_1.sign)(jwt, "", {
+    const jwtStr = (0, jsonwebtoken_1.sign)(jwt, "fake-secret", {
         algorithm: "none",
     });
     return jwtStr;

package/lib/emulator/downloadableEmulators.js

@@ -28,9 +28,9 @@ const EMULATOR_UPDATE_DETAILS = {
         expectedChecksum: "4f41d24a3c0f3b55ea22804a424cc0ee",
     },
     storage: {
-        version: "1.1.2",
-        expectedSize: 47028740,
-        expectedChecksum: "983b4415b1e72b109864f1b8e7ea7546",
+        version: "1.1.3",
+        expectedSize: 52892936,
+        expectedChecksum: "2ca11ec1193003bea89f806cc085fa25",
     },
     ui: experiments.isEnabled("emulatoruisnapshot")
         ? { version: "SNAPSHOT", expectedSize: -1, expectedChecksum: "" }

package/lib/emulator/storage/apis/firebase.js

@@ -229,6 +229,7 @@ function createFirebaseEndpoints(emulator) {
                     throw err;
                 }
                 res.header("X-Goog-Upload-Size-Received", upload.size.toString());
+                res.header("x-goog-upload-status", upload.status);
                 return res.sendStatus(200);
             }
             if (uploadCommand === "cancel") {

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

@@ -52,7 +52,7 @@ class DefaultStorageRulesManager {
                 this._logger.log("WARN", `${parsedIssue.description_.replace(/\.$/, "")} in ${parsedIssue.sourcePosition_.fileName_}:${parsedIssue.sourcePosition_.line_}`);
             }
             catch (_a) {
-                this._logger.log("WARN", issue);
+                this._logger.logLabeled("WARN", "storage", issue);
             }
         });
         return issues;

package/lib/emulator/storage/server.js

@@ -24,8 +24,8 @@ function createApp(defaultProjectId, emulator) {
         exposedHeaders: [
             "content-type",
             "x-firebase-storage-version",
+            "X-Goog-Upload-Size-Received",
             "x-goog-upload-url",
-            "x-goog-upload-status",
             "x-goog-upload-command",
             "x-gupload-uploadid",
             "x-goog-upload-header-content-length",

package/lib/emulator/storage/upload.js

@@ -11,9 +11,9 @@ var UploadType;
 })(UploadType = exports.UploadType || (exports.UploadType = {}));
 var UploadStatus;
 (function (UploadStatus) {
-    UploadStatus[UploadStatus["ACTIVE"] = 0] = "ACTIVE";
-    UploadStatus[UploadStatus["CANCELLED"] = 1] = "CANCELLED";
-    UploadStatus[UploadStatus["FINISHED"] = 2] = "FINISHED";
+    UploadStatus["ACTIVE"] = "active";
+    UploadStatus["CANCELLED"] = "cancelled";
+    UploadStatus["FINISHED"] = "final";
 })(UploadStatus = exports.UploadStatus || (exports.UploadStatus = {}));
 class UploadNotActiveError extends Error {
 }

package/lib/extensions/extensionsApi.js

@@ -34,9 +34,10 @@ async function createInstanceHelper(projectId, instanceId, config, validateOnly
     return pollRes;
 }
 async function createInstance(args) {
-    var _a, _b;
+    var _a, _b, _c;
     const config = {
         params: args.params,
+        systemParams: (_a = args.systemParams) !== null && _a !== void 0 ? _a : {},
         allowedEventTypes: args.allowedEventTypes,
         eventarcChannel: args.eventarcChannel,
     };
@@ -44,12 +45,12 @@ async function createInstance(args) {
         throw new error_1.FirebaseError("ExtensionSource and ExtensionVersion both provided, but only one should be.");
     }
     else if (args.extensionSource) {
-        config.source = { name: (_a = args.extensionSource) === null || _a === void 0 ? void 0 : _a.name };
+        config.source = { name: (_b = args.extensionSource) === null || _b === void 0 ? void 0 : _b.name };
     }
     else if (args.extensionVersionRef) {
         const ref = refs.parse(args.extensionVersionRef);
         config.extensionRef = refs.toExtensionRef(ref);
-        config.extensionVersion = (_b = ref.version) !== null && _b !== void 0 ? _b : "";
+        config.extensionVersion = (_c = ref.version) !== null && _c !== void 0 ? _c : "";
     }
     else {
         throw new error_1.FirebaseError("No ExtensionVersion or ExtensionSource provided but one is required.");
@@ -128,6 +129,10 @@ async function configureInstance(args) {
         reqBody.data.config.eventarcChannel = args.eventarcChannel;
     }
     reqBody.updateMask += ",config.allowed_event_types,config.eventarc_channel";
+    if (args.systemParams) {
+        reqBody.data.config.systemParams = args.systemParams;
+        reqBody.updateMask += ",config.system_params";
+    }
     return patchInstance(reqBody);
 }
 exports.configureInstance = configureInstance;
@@ -143,6 +148,10 @@ async function updateInstance(args) {
         body.config.params = args.params;
         updateMask += ",config.params";
     }
+    if (args.systemParams) {
+        body.config.systemParams = args.systemParams;
+        updateMask += ",config.system_params";
+    }
     if (args.canEmitEvents) {
         if (args.allowedEventTypes === undefined || args.eventarcChannel === undefined) {
             throw new error_1.FirebaseError(`This instance is configured to emit events, but either allowed event types or eventarc channel is undefined.`);
@@ -174,6 +183,10 @@ async function updateInstanceFromRegistry(args) {
         body.config.params = args.params;
         updateMask += ",config.params";
     }
+    if (args.systemParams) {
+        body.config.systemParams = args.systemParams;
+        updateMask += ",config.system_params";
+    }
     if (args.canEmitEvents) {
         if (args.allowedEventTypes === undefined || args.eventarcChannel === undefined) {
             throw new error_1.FirebaseError(`This instance is configured to emit events, but either allowed event types or eventarc channel is undefined.`);

package/lib/extensions/paramHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readEnvFile = exports.promptForNewParams = exports.getParamsForUpdate = exports.getParams = exports.getParamsWithCurrentValuesAsDefaults = exports.setNewDefaults = exports.buildBindingOptionsWithBaseValue = exports.getBaseParamBindings = void 0;
+exports.isSystemParam = exports.readEnvFile = exports.promptForNewParams = exports.getParamsForUpdate = exports.getParams = exports.getParamsWithCurrentValuesAsDefaults = exports.setNewDefaults = exports.buildBindingOptionsWithBaseValue = exports.getBaseParamBindings = void 0;
 const path = require("path");
 const clc = require("colorette");
 const fs = require("fs-extra");
@@ -172,3 +172,8 @@ function readEnvFile(envPath) {
     return result.envs;
 }
 exports.readEnvFile = readEnvFile;
+function isSystemParam(paramName) {
+    const regex = /^firebaseextensions\.[a-zA-Z0-9\.]*\//;
+    return regex.test(paramName);
+}
+exports.isSystemParam = isSystemParam;

package/lib/functional.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.nullsafeVisitor = exports.mapObject = exports.partition = exports.assertExhaustive = exports.zipIn = exports.zip = exports.reduceFlat = exports.flatten = exports.flattenArray = exports.flattenObject = void 0;
+exports.nullsafeVisitor = exports.mapObject = exports.partitionRecord = exports.partition = exports.assertExhaustive = exports.zipIn = exports.zip = exports.reduceFlat = exports.flatten = exports.flattenArray = exports.flattenObject = void 0;
 function* flattenObject(obj) {
     function* helper(path, obj) {
         for (const [k, v] of Object.entries(obj)) {
@@ -56,13 +56,20 @@ function assertExhaustive(val) {
     throw new Error(`Never has a value (${val}). This should be impossible`);
 }
 exports.assertExhaustive = assertExhaustive;
-function partition(arr, callbackFn) {
+function partition(arr, predicate) {
     return arr.reduce((acc, elem) => {
-        acc[callbackFn(elem) ? 0 : 1].push(elem);
+        acc[predicate(elem) ? 0 : 1].push(elem);
         return acc;
     }, [[], []]);
 }
 exports.partition = partition;
+function partitionRecord(rec, predicate) {
+    return Object.entries(rec).reduce((acc, [key, val]) => {
+        acc[predicate(key, val) ? 0 : 1][key] = val;
+        return acc;
+    }, [{}, {}]);
+}
+exports.partitionRecord = partitionRecord;
 function mapObject(input, transform) {
     const result = {};
     for (const [k, v] of Object.entries(input)) {

package/lib/functions/env.js

@@ -32,7 +32,7 @@ const RESERVED_KEYS = [
 ];
 const LINE_RE = new RegExp("^" +
     "\\s*" +
-    "(\\w+)" +
+    "([\\w./]+)" +
     "\\s*=[\\f\\t\\v]*" +
     "(" +
     "\\s*'(?:\\\\'|[^'])*'|" +