firebase-tools 10.1.5 → 10.2.2

package/lib/extensions/emulator/optionsHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getParams = exports.buildOptions = void 0;
+exports.getParams = exports.getExtensionFunctionInfo = exports.buildOptions = void 0;
 const fs = require("fs-extra");
 const _ = require("lodash");
 const path = require("path");
@@ -15,9 +15,9 @@ const emulatorLogger_1 = require("../../emulator/emulatorLogger");
 const projectUtils_1 = require("../../projectUtils");
 const types_1 = require("../../emulator/types");
 async function buildOptions(options) {
-    const extensionDir = localHelper.findExtensionYaml(process.cwd());
-    options.extensionDir = extensionDir;
-    const spec = await specHelper.readExtensionYaml(extensionDir);
+    const extDevDir = localHelper.findExtensionYaml(process.cwd());
+    options.extDevDir = extDevDir;
+    const spec = await specHelper.readExtensionYaml(extDevDir);
     extensionsHelper.validateSpec(spec);
     const params = getParams(options, spec);
     extensionsHelper.validateCommandLineParams(params, spec.params);
@@ -28,13 +28,29 @@ async function buildOptions(options) {
         checkTestConfig(testConfig, functionResources);
     }
     options.config = buildConfig(functionResources, testConfig);
-    options.extensionEnv = params;
+    options.extDevEnv = params;
     const functionEmuTriggerDefs = functionResources.map((r) => triggerHelper.functionResourceToEmulatedTriggerDefintion(r));
-    options.extensionTriggers = functionEmuTriggerDefs;
-    options.extensionNodeVersion = specHelper.getNodeVersion(functionResources);
+    options.extDevTriggers = functionEmuTriggerDefs;
+    options.extDevNodeVersion = specHelper.getNodeVersion(functionResources);
     return options;
 }
 exports.buildOptions = buildOptions;
+async function getExtensionFunctionInfo(extensionDir, instanceId, params) {
+    const spec = await specHelper.readExtensionYaml(extensionDir);
+    const functionResources = specHelper.getFunctionResourcesWithParamSubstitution(spec, params);
+    const extensionTriggers = functionResources
+        .map((r) => triggerHelper.functionResourceToEmulatedTriggerDefintion(r))
+        .map((trigger) => {
+        trigger.name = `ext-${instanceId}-${trigger.name}`;
+        return trigger;
+    });
+    const nodeMajorVersion = specHelper.getNodeVersion(functionResources);
+    return {
+        extensionTriggers,
+        nodeMajorVersion,
+    };
+}
+exports.getExtensionFunctionInfo = getExtensionFunctionInfo;
 function getParams(options, extensionSpec) {
     const projectId = (0, projectUtils_1.needProjectId)(options);
     const userParams = paramHelper.readEnvFile(options.testParams);
@@ -120,7 +136,7 @@ function getFunctionSourceDirectory(functionResources) {
         if (!sourceDirectory) {
             sourceDirectory = dir;
         }
-        else if (sourceDirectory != dir) {
+        else if (sourceDirectory !== dir) {
             throw new error_1.FirebaseError(`Found function resources with different sourceDirectories: '${sourceDirectory}' and '${dir}'. The extensions emulator only supports a single sourceDirectory.`);
         }
     }

package/lib/extensions/emulator/specHelper.js

@@ -2,13 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getNodeVersion = exports.getFunctionProperties = exports.getFunctionResourcesWithParamSubstitution = exports.readFileFromDirectory = exports.readExtensionYaml = void 0;
 const yaml = require("js-yaml");
-const _ = require("lodash");
 const path = require("path");
 const fs = require("fs-extra");
 const error_1 = require("../../error");
 const extensionsHelper_1 = require("../extensionsHelper");
-const emulatorLogger_1 = require("../../emulator/emulatorLogger");
-const types_1 = require("../../emulator/types");
+const functionsEmulatorUtils_1 = require("../../emulator/functionsEmulatorUtils");
 const SPEC_FILE = "extension.yaml";
 const validFunctionTypes = [
     "firebaseextensions.v1beta.function",
@@ -62,35 +60,24 @@ function getFunctionProperties(resources) {
 }
 exports.getFunctionProperties = getFunctionProperties;
 function getNodeVersion(resources) {
-    const functionNamesWithoutRuntime = [];
+    const invalidRuntimes = [];
     const versions = resources.map((r) => {
         var _a, _b;
-        if (_.includes(r.type, "function")) {
-            if ((_a = r.properties) === null || _a === void 0 ? void 0 : _a.runtime) {
-                return (_b = r.properties) === null || _b === void 0 ? void 0 : _b.runtime;
+        if ((_a = r.properties) === null || _a === void 0 ? void 0 : _a.runtime) {
+            const runtimeName = (_b = r.properties) === null || _b === void 0 ? void 0 : _b.runtime;
+            const runtime = (0, functionsEmulatorUtils_1.parseRuntimeVersion)(runtimeName);
+            if (!runtime) {
+                invalidRuntimes.push(runtimeName);
             }
             else {
-                functionNamesWithoutRuntime.push(r.name);
+                return runtime;
             }
         }
-        return "nodejs8";
-    });
-    if (functionNamesWithoutRuntime.length) {
-        emulatorLogger_1.EmulatorLogger.forEmulator(types_1.Emulators.FUNCTIONS).logLabeled("WARN", "extensions", `No 'runtime' property found for the following functions, defaulting to nodejs8: ${functionNamesWithoutRuntime.join(", ")}`);
-    }
-    const invalidRuntimes = _.filter(versions, (v) => {
-        return !_.includes(v, "nodejs");
+        return 14;
     });
     if (invalidRuntimes.length) {
         throw new error_1.FirebaseError(`The following runtimes are not supported by the Emulator Suite: ${invalidRuntimes.join(", ")}. \n Only Node runtimes are supported.`);
     }
-    if (_.includes(versions, "nodejs10")) {
-        return "10";
-    }
-    if (_.includes(versions, "nodejs6")) {
-        emulatorLogger_1.EmulatorLogger.forEmulator(types_1.Emulators.FUNCTIONS).logLabeled("WARN", "extensions", "Node 6 is deprecated. We recommend upgrading to a newer version.");
-        return "6";
-    }
-    return "8";
+    return Math.max(...versions);
 }
 exports.getNodeVersion = getNodeVersion;

package/lib/extensions/export.js

@@ -1,14 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeFiles = exports.displayExportInfo = exports.setSecretParamsToLatest = exports.parameterizeProject = void 0;
-const clc = require("cli-color");
-const refs = require("./refs");
-const config_1 = require("../config");
+exports.displayExportInfo = exports.setSecretParamsToLatest = exports.parameterizeProject = void 0;
 const planner_1 = require("../deploy/extensions/planner");
 const deploymentSummary_1 = require("../deploy/extensions/deploymentSummary");
 const logger_1 = require("../logger");
-const error_1 = require("../error");
-const prompt_1 = require("../prompt");
 const secretManager_1 = require("../gcp/secretManager");
 const secretsUtils_1 = require("./secretsUtils");
 function parameterizeProject(projectId, projectNumber, spec) {
@@ -60,48 +55,3 @@ function displaySpecs(specs) {
         logger_1.logger.info("");
     }
 }
-function writeExtensionsToFirebaseJson(have, existingConfig) {
-    const extensions = existingConfig.get("extensions", {});
-    for (const s of have) {
-        extensions[s.instanceId] = refs.toExtensionVersionRef(s.ref);
-    }
-    existingConfig.set("extensions", extensions);
-    logger_1.logger.info("Adding Extensions to " + clc.bold("firebase.json") + "...");
-    existingConfig.writeProjectFile("firebase.json", existingConfig.src);
-}
-async function writeEnvFile(spec, existingConfig, force) {
-    const content = Object.entries(spec.params)
-        .map((r) => `${r[0]}=${r[1]}`)
-        .join("\n");
-    await existingConfig.askWriteProjectFile(`extensions/${spec.instanceId}.env`, content, force);
-}
-async function writeFiles(have, options) {
-    const existingConfig = config_1.Config.load(options, true);
-    if (!existingConfig) {
-        throw new error_1.FirebaseError("Not currently in a Firebase directory. Please run `firebase init` to create a Firebase directory.");
-    }
-    if (existingConfig.has("extensions") &&
-        Object.keys(existingConfig.get("extensions")).length &&
-        !options.nonInteractive &&
-        !options.force) {
-        const currentExtensions = Object.entries(existingConfig.get("extensions"))
-            .map((i) => `${i[0]}: ${i[1]}`)
-            .join("\n\t");
-        const overwrite = await (0, prompt_1.promptOnce)({
-            type: "list",
-            message: `firebase.json already contains extensions:\n${currentExtensions}\nWould you like to overwrite or merge?`,
-            choices: [
-                { name: "Overwrite", value: true },
-                { name: "Merge", value: false },
-            ],
-        });
-        if (overwrite) {
-            existingConfig.set("extensions", {});
-        }
-    }
-    writeExtensionsToFirebaseJson(have, existingConfig);
-    for (const spec of have) {
-        await writeEnvFile(spec, existingConfig, options.force);
-    }
-}
-exports.writeFiles = writeFiles;

package/lib/extensions/extensionsApi.js

@@ -295,7 +295,7 @@ async function listExtensionVersions(ref, filter = "") {
 exports.listExtensionVersions = listExtensionVersions;
 async function getPublisherProfile(projectId, publisherId) {
     const res = await apiClient.get(`/projects/${projectId}/publisherProfile`, {
-        queryParams: publisherId == undefined
+        queryParams: publisherId === undefined
             ? undefined
             : {
                 publisherId,

package/lib/extensions/extensionsHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.confirm = exports.getSourceOrigin = exports.isLocalOrURLPath = exports.isLocalPath = exports.isUrlPath = exports.instanceIdExists = exports.promptForRepeatInstance = exports.promptForOfficialExtension = exports.displayReleaseNotes = exports.getPublisherProjectFromName = exports.createSourceFromLocation = exports.publishExtensionVersionFromLocalSource = exports.ensureExtensionsApiEnabled = exports.promptForValidInstanceId = exports.validateSpec = exports.validateCommandLineParams = exports.populateDefaultParams = exports.substituteParams = exports.getFirebaseProjectParams = exports.getDBInstanceFromURL = exports.resourceTypeToNiceName = exports.AUTOPOULATED_PARAM_PLACEHOLDERS = exports.EXTENSIONS_BUCKET_NAME = exports.URL_REGEX = exports.logPrefix = exports.SourceOrigin = exports.SpecParamType = void 0;
+exports.diagnoseAndFixProject = exports.confirm = exports.getSourceOrigin = exports.isLocalOrURLPath = exports.isLocalPath = exports.isUrlPath = exports.instanceIdExists = exports.promptForRepeatInstance = exports.promptForOfficialExtension = exports.displayReleaseNotes = exports.getPublisherProjectFromName = exports.createSourceFromLocation = exports.publishExtensionVersionFromLocalSource = exports.ensureExtensionsApiEnabled = exports.promptForValidInstanceId = exports.validateSpec = exports.validateCommandLineParams = exports.populateDefaultParams = exports.substituteParams = exports.getFirebaseProjectParams = exports.getDBInstanceFromURL = exports.resourceTypeToNiceName = exports.AUTOPOULATED_PARAM_PLACEHOLDERS = exports.EXTENSIONS_BUCKET_NAME = exports.URL_REGEX = exports.logPrefix = exports.SourceOrigin = exports.SpecParamType = void 0;
 const _ = require("lodash");
 const clc = require("cli-color");
 const ora = require("ora");
@@ -16,6 +16,7 @@ const utils_1 = require("./utils");
 const functionsConfig_1 = require("../functionsConfig");
 const resolveSource_1 = require("./resolveSource");
 const error_1 = require("../error");
+const diagnose_1 = require("./diagnose");
 const askUserForParam_1 = require("./askUserForParam");
 const ensureApiEnabled_1 = require("../ensureApiEnabled");
 const storage_1 = require("../gcp/storage");
@@ -111,7 +112,7 @@ function populateDefaultParams(paramVars, paramSpecs) {
     const newParams = paramVars;
     for (const param of paramSpecs) {
         if (!paramVars[param.param]) {
-            if (param.default != undefined && param.required) {
+            if (param.default !== undefined && param.required) {
                 newParams[param.param] = param.default;
             }
             else if (param.required) {
@@ -196,13 +197,13 @@ function validateSpec(spec) {
         if (param.type && !_.includes(SpecParamType, param.type)) {
             errors.push(`Invalid type ${param.type} for param${param.param ? ` ${param.param}` : ""}. Valid types are ${_.values(SpecParamType).join(", ")}`);
         }
-        if (!param.type || param.type == SpecParamType.STRING) {
+        if (!param.type || param.type === SpecParamType.STRING) {
             if (param.options) {
                 errors.push(`Param${param.param ? ` ${param.param}` : ""} cannot have options because it is type STRING`);
             }
         }
         if (param.type &&
-            (param.type == SpecParamType.SELECT || param.type == SpecParamType.MULTISELECT)) {
+            (param.type === SpecParamType.SELECT || param.type === SpecParamType.MULTISELECT)) {
             if (param.validationRegex) {
                 errors.push(`Param${param.param ? ` ${param.param}` : ""} cannot have validationRegex because it is type ${param.type}`);
             }
@@ -210,12 +211,12 @@ function validateSpec(spec) {
                 errors.push(`Param${param.param ? ` ${param.param}` : ""} requires options because it is type ${param.type}`);
             }
             for (const opt of param.options || []) {
-                if (opt.value == undefined) {
+                if (opt.value === undefined) {
                     errors.push(`Option for param${param.param ? ` ${param.param}` : ""} is missing required field: value`);
                 }
             }
         }
-        if (param.type && param.type == SpecParamType.SELECTRESOURCE) {
+        if (param.type && param.type === SpecParamType.SELECTRESOURCE) {
             if (!param.resourceType) {
                 errors.push(`Param${param.param ? ` ${param.param}` : ""} must have resourceType because it is type ${param.type}`);
             }
@@ -267,7 +268,7 @@ async function archiveAndUploadSource(extPath, bucketName) {
 }
 async function publishExtensionVersionFromLocalSource(args) {
     const extensionSpec = await (0, localHelper_1.getLocalExtensionSpec)(args.rootDirectory);
-    if (extensionSpec.name != args.extensionId) {
+    if (extensionSpec.name !== args.extensionId) {
         throw new error_1.FirebaseError(`Extension ID '${clc.bold(args.extensionId)}' does not match the name in extension.yaml '${clc.bold(extensionSpec.name)}'.`);
     }
     const subbedSpec = JSON.parse(JSON.stringify(extensionSpec));
@@ -324,7 +325,9 @@ async function publishExtensionVersionFromLocalSource(args) {
     }
     catch (err) {
         uploadSpinner.fail();
-        throw err;
+        throw new error_1.FirebaseError(`Failed to archive and upload extension source, ${err}`, {
+            original: err,
+        });
     }
     const publishSpinner = ora(`Publishing ${clc.bold(ref)}`);
     let res;
@@ -335,7 +338,7 @@ async function publishExtensionVersionFromLocalSource(args) {
     }
     catch (err) {
         publishSpinner.fail();
-        if (err.status == 404) {
+        if (err.status === 404) {
             throw new error_1.FirebaseError(marked(`Couldn't find publisher ID '${clc.bold(args.publisherId)}'. Please ensure that you have registered this ID. To register as a publisher, you can check out the [Firebase documentation](https://firebase.google.com/docs/extensions/alpha/share#register_as_an_extensions_publisher) for step-by-step instructions.`));
         }
         throw err;
@@ -359,7 +362,9 @@ async function createSourceFromLocation(projectId, sourceUri) {
         }
         catch (err) {
             uploadSpinner.fail();
-            throw err;
+            throw new error_1.FirebaseError(`Failed to archive and upload extension source, ${err}`, {
+                original: err,
+            });
         }
     }
     else {
@@ -504,3 +509,11 @@ async function confirm(args) {
     }
 }
 exports.confirm = confirm;
+async function diagnoseAndFixProject(options) {
+    const projectId = (0, projectUtils_1.needProjectId)(options);
+    const ok = await (0, diagnose_1.diagnose)(projectId);
+    if (!ok) {
+        throw new error_1.FirebaseError("Unable to proceed until all issues are resolved.");
+    }
+}
+exports.diagnoseAndFixProject = diagnoseAndFixProject;

package/lib/extensions/listExtensions.js

@@ -8,6 +8,7 @@ const extensionsApi_1 = require("./extensionsApi");
 const extensionsHelper_1 = require("./extensionsHelper");
 const utils = require("../utils");
 const extensionsUtils = require("./utils");
+const logger_1 = require("../logger");
 async function listExtensions(projectId) {
     const instances = await (0, extensionsApi_1.listInstances)(projectId);
     if (instances.length < 1) {
@@ -47,6 +48,7 @@ async function listExtensions(projectId) {
         });
     });
     utils.logLabeledBullet(extensionsHelper_1.logPrefix, `list of extensions installed in ${clc.bold(projectId)}:`);
+    logger_1.logger.info(table.toString());
     return formatted;
 }
 exports.listExtensions = listExtensions;

package/lib/extensions/manifest.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeToManifest = void 0;
+const clc = require("cli-color");
+const refs = require("./refs");
+const logger_1 = require("../logger");
+const prompt_1 = require("../prompt");
+async function writeToManifest(specs, config, options) {
+    if (config.has("extensions") &&
+        Object.keys(config.get("extensions")).length &&
+        !options.nonInteractive &&
+        !options.force) {
+        const currentExtensions = Object.entries(config.get("extensions"))
+            .map((i) => `${i[0]}: ${i[1]}`)
+            .join("\n\t");
+        const overwrite = await (0, prompt_1.promptOnce)({
+            type: "list",
+            message: `firebase.json already contains extensions:\n${currentExtensions}\nWould you like to overwrite or merge?`,
+            choices: [
+                { name: "Overwrite", value: true },
+                { name: "Merge", value: false },
+            ],
+        });
+        if (overwrite) {
+            config.set("extensions", {});
+        }
+    }
+    writeExtensionsToFirebaseJson(specs, config);
+    await writeEnvFiles(specs, config, options.force);
+}
+exports.writeToManifest = writeToManifest;
+function writeExtensionsToFirebaseJson(specs, config) {
+    const extensions = config.get("extensions", {});
+    for (const s of specs) {
+        extensions[s.instanceId] = refs.toExtensionVersionRef(s.ref);
+    }
+    config.set("extensions", extensions);
+    logger_1.logger.info("Adding Extensions to " + clc.bold("firebase.json") + "...");
+    config.writeProjectFile("firebase.json", config.src);
+}
+async function writeEnvFiles(specs, config, force) {
+    for (const spec of specs) {
+        const content = Object.entries(spec.params)
+            .map((r) => `${r[0]}=${r[1]}`)
+            .join("\n");
+        await config.askWriteProjectFile(`extensions/${spec.instanceId}.env`, content, force);
+    }
+}

package/lib/extensions/metricsUtils.js

@@ -7,19 +7,19 @@ function parseTimeseriesResponse(series) {
     const ret = [];
     for (const s of series) {
         const ref = buildRef(s);
-        if (ref == undefined) {
+        if (ref === undefined) {
             continue;
         }
         let valueToday;
         let value7dAgo;
         let value28dAgo;
-        if (s.points.length >= 28 && s.points[27].value.int64Value != undefined) {
+        if (s.points.length >= 28 && s.points[27].value.int64Value !== undefined) {
             value28dAgo = parseBucket(s.points[27].value.int64Value);
         }
-        if (s.points.length >= 7 && s.points[6].value.int64Value != undefined) {
+        if (s.points.length >= 7 && s.points[6].value.int64Value !== undefined) {
             value7dAgo = parseBucket(s.points[6].value.int64Value);
         }
-        if (s.points.length >= 1 && s.points[0].value.int64Value != undefined) {
+        if (s.points.length >= 1 && s.points[0].value.int64Value !== undefined) {
             valueToday = parseBucket(s.points[0].value.int64Value);
         }
         ret.push({

package/lib/extensions/paramHelper.js

@@ -49,7 +49,7 @@ async function getParams(args) {
         const firebaseProjectParams = await (0, extensionsHelper_1.getFirebaseProjectParams)(args.projectId);
         params = await askUserForParam.ask(args.projectId, args.instanceId, args.paramSpecs, firebaseProjectParams, !!args.reconfiguring);
     }
-    track("Extension Params", _.isEmpty(params) ? "Not Present" : "Present", _.size(params));
+    void track("Extension Params", _.isEmpty(params) ? "Not Present" : "Present", _.size(params));
     return params;
 }
 exports.getParams = getParams;
@@ -82,7 +82,7 @@ async function getParamsForUpdate(args) {
             instanceId: args.instanceId,
         });
     }
-    track("Extension Params", _.isEmpty(params) ? "Not Present" : "Present", _.size(params));
+    void track("Extension Params", _.isEmpty(params) ? "Not Present" : "Present", _.size(params));
     return params;
 }
 exports.getParamsForUpdate = getParamsForUpdate;
@@ -116,10 +116,10 @@ function getParamsFromFile(args) {
     let envParams;
     try {
         envParams = readEnvFile(args.paramsEnvPath);
-        track("Extension Env File", "Present");
+        void track("Extension Env File", "Present");
     }
     catch (err) {
-        track("Extension Env File", "Invalid");
+        void track("Extension Env File", "Invalid");
         throw new error_1.FirebaseError(`Error reading env file: ${err.message}\n`, { original: err });
     }
     const params = (0, extensionsHelper_1.populateDefaultParams)(envParams, args.paramSpecs);

package/lib/extensions/refs.js

@@ -20,7 +20,7 @@ function parse(refOrName) {
 exports.parse = parse;
 function parseRef(ref) {
     const parts = refRegex.exec(ref);
-    if (parts && (parts.length == 5 || parts.length == 7)) {
+    if (parts && (parts.length === 5 || parts.length === 7)) {
         const publisherId = parts[1];
         const extensionId = parts[2];
         const version = parts[4];

package/lib/extensions/secretsUtils.js

@@ -15,14 +15,14 @@ async function ensureSecretManagerApiEnabled(options) {
 }
 exports.ensureSecretManagerApiEnabled = ensureSecretManagerApiEnabled;
 function usesSecrets(spec) {
-    return spec.params && !!spec.params.find((p) => p.type == extensionsApi.ParamType.SECRET);
+    return spec.params && !!spec.params.find((p) => p.type === extensionsApi.ParamType.SECRET);
 }
 exports.usesSecrets = usesSecrets;
 async function grantFirexServiceAgentSecretAdminRole(secret) {
     const projectNumber = await (0, getProjectNumber_1.getProjectNumber)({ projectId: secret.projectId });
     const firexSaProjectId = utils.envOverride("FIREBASE_EXTENSIONS_SA_PROJECT_ID", "gcp-sa-firebasemods");
     const saEmail = `service-${projectNumber}@${firexSaProjectId}.iam.gserviceaccount.com`;
-    return secretManagerApi.grantServiceAgentRole(secret, saEmail, "roles/secretmanager.admin");
+    return secretManagerApi.ensureServiceAgentRole(secret, [saEmail], "roles/secretmanager.admin");
 }
 exports.grantFirexServiceAgentSecretAdminRole = grantFirexServiceAgentSecretAdminRole;
 async function getManagedSecrets(instance) {
@@ -38,7 +38,7 @@ async function getManagedSecrets(instance) {
 exports.getManagedSecrets = getManagedSecrets;
 function getActiveSecrets(spec, params) {
     return spec.params
-        .map((p) => (p.type == extensionsApi.ParamType.SECRET ? params[p.param] : ""))
+        .map((p) => (p.type === extensionsApi.ParamType.SECRET ? params[p.param] : ""))
         .filter((pv) => !!pv);
 }
 exports.getActiveSecrets = getActiveSecrets;
@@ -50,7 +50,7 @@ function getSecretLabels(instanceId) {
 exports.getSecretLabels = getSecretLabels;
 function prettySecretName(secretResourceName) {
     const nameTokens = secretResourceName.split("/");
-    if (nameTokens.length != 4 && nameTokens.length != 6) {
+    if (nameTokens.length !== 4 && nameTokens.length !== 6) {
         logger_1.logger.debug(`unable to parse secret secretResourceName: ${secretResourceName}`);
         return secretResourceName;
     }

package/lib/functional.js

@@ -40,7 +40,7 @@ function reduceFlat(accum, next) {
 }
 exports.reduceFlat = reduceFlat;
 function* zip(left, right) {
-    if (left.length != right.length) {
+    if (left.length !== right.length) {
         throw new Error("Cannot zip between two lists of differen lengths");
     }
     for (let i = 0; i < left.length; i++) {

package/lib/functions/env.js

@@ -1,17 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadFirebaseEnvs = exports.loadUserEnvs = exports.hasUserEnvs = exports.validateKey = exports.KeyValidationError = exports.parse = void 0;
+exports.loadFirebaseEnvs = exports.loadUserEnvs = exports.hasUserEnvs = exports.parseStrict = exports.validateKey = exports.KeyValidationError = exports.parse = void 0;
 const clc = require("cli-color");
 const fs = require("fs");
 const path = require("path");
 const error_1 = require("../error");
 const logger_1 = require("../logger");
-const previews_1 = require("../previews");
 const utils_1 = require("../utils");
 const FUNCTIONS_EMULATOR_DOTENV = ".env.local";
+const RESERVED_PREFIXES = ["X_GOOGLE_", "FIREBASE_", "EXT_"];
 const RESERVED_KEYS = [
     "FIREBASE_CONFIG",
     "CLOUD_RUNTIME_CONFIG",
+    "EVENTARC_CLOUD_EVENT_SOURCE",
     "ENTRY_POINT",
     "GCP_PROJECT",
     "GCLOUD_PROJECT",
@@ -87,8 +88,8 @@ function validateKey(key) {
         throw new KeyValidationError(key, `Key ${key} must start with an uppercase ASCII letter or underscore` +
             ", and then consist of uppercase ASCII letters, digits, and underscores.");
     }
-    if (key.startsWith("X_GOOGLE_") || key.startsWith("FIREBASE_")) {
-        throw new KeyValidationError(key, `Key ${key} starts with a reserved prefix (X_GOOGLE_ or FIREBASE_)`);
+    if (RESERVED_PREFIXES.some((prefix) => key.startsWith(prefix))) {
+        throw new KeyValidationError(key, `Key ${key} starts with a reserved prefix (${RESERVED_PREFIXES.join(" ")})`);
     }
 }
 exports.validateKey = validateKey;
@@ -117,6 +118,7 @@ function parseStrict(data) {
     }
     return envs;
 }
+exports.parseStrict = parseStrict;
 function findEnvfiles(functionsSource, projectId, projectAlias, isEmulator) {
     const files = [".env"];
     if (isEmulator) {
@@ -139,11 +141,8 @@ function hasUserEnvs({ functionsSource, projectId, projectAlias, isEmulator, })
 exports.hasUserEnvs = hasUserEnvs;
 function loadUserEnvs({ functionsSource, projectId, projectAlias, isEmulator, }) {
     var _a;
-    if (!previews_1.previews.dotenv) {
-        return {};
-    }
     const envFiles = findEnvfiles(functionsSource, projectId, projectAlias, isEmulator);
-    if (envFiles.length == 0) {
+    if (envFiles.length === 0) {
         return {};
     }
     if (projectAlias) {

package/lib/functions/secrets.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pruneSecrets = exports.of = exports.ensureSecret = exports.ensureValidKey = exports.labels = exports.isFirebaseManaged = void 0;
+const secretManager_1 = require("../gcp/secretManager");
+const error_1 = require("../error");
+const utils_1 = require("../utils");
+const prompt_1 = require("../prompt");
+const env_1 = require("./env");
+const FIREBASE_MANGED = "firebase-managed";
+function isFirebaseManaged(secret) {
+    return Object.keys(secret.labels || []).includes(FIREBASE_MANGED);
+}
+exports.isFirebaseManaged = isFirebaseManaged;
+function labels() {
+    return { [FIREBASE_MANGED]: "true" };
+}
+exports.labels = labels;
+function toUpperSnakeCase(key) {
+    return key
+        .replace("-", "_")
+        .replace(".", "_")
+        .replace(/([a-z])([A-Z])/g, "$1_$2")
+        .toUpperCase();
+}
+async function ensureValidKey(key, options) {
+    const transformedKey = toUpperSnakeCase(key);
+    if (transformedKey !== key) {
+        if (options.force) {
+            throw new error_1.FirebaseError("Secret key must be in UPPER_SNAKE_CASE.");
+        }
+        (0, utils_1.logWarning)(`By convention, secret key must be in UPPER_SNAKE_CASE.`);
+        const confirm = await (0, prompt_1.promptOnce)({
+            name: "updateKey",
+            type: "confirm",
+            default: true,
+            message: `Would you like to use ${transformedKey} as key instead?`,
+        }, options);
+        if (!confirm) {
+            throw new error_1.FirebaseError("Secret key must be in UPPER_SNAKE_CASE.");
+        }
+    }
+    try {
+        (0, env_1.validateKey)(transformedKey);
+    }
+    catch (err) {
+        throw new error_1.FirebaseError(`Invalid secret key ${transformedKey}`, { children: [err] });
+    }
+    return transformedKey;
+}
+exports.ensureValidKey = ensureValidKey;
+async function ensureSecret(projectId, name, options) {
+    try {
+        const secret = await (0, secretManager_1.getSecret)(projectId, name);
+        if (!isFirebaseManaged(secret)) {
+            if (!options.force) {
+                (0, utils_1.logWarning)("Your secret is not managed by Firebase. " +
+                    "Firebase managed secrets are automatically pruned to reduce your monthly cost for using Secret Manager. ");
+                const confirm = await (0, prompt_1.promptOnce)({
+                    name: "updateLabels",
+                    type: "confirm",
+                    default: true,
+                    message: `Would you like to have your secret ${secret.name} managed by Firebase?`,
+                }, options);
+                if (confirm) {
+                    return (0, secretManager_1.patchSecret)(projectId, secret.name, Object.assign(Object.assign({}, secret.labels), labels()));
+                }
+            }
+        }
+        return secret;
+    }
+    catch (err) {
+        if (err.status !== 404) {
+            throw err;
+        }
+    }
+    return await (0, secretManager_1.createSecret)(projectId, name, labels());
+}
+exports.ensureSecret = ensureSecret;
+function of(endpoints) {
+    return endpoints.reduce((envs, endpoint) => [...envs, ...(endpoint.secretEnvironmentVariables || [])], []);
+}
+exports.of = of;
+async function pruneSecrets(projectInfo, endpoints) {
+    const { projectId, projectNumber } = projectInfo;
+    const pruneKey = (name, version) => `${name}@${version}`;
+    const prunedSecrets = new Set();
+    const haveSecrets = await (0, secretManager_1.listSecrets)(projectId, `labels.${FIREBASE_MANGED}=true`);
+    for (const secret of haveSecrets) {
+        const versions = await (0, secretManager_1.listSecretVersions)(projectId, secret.name, `state: ENABLED`);
+        for (const version of versions) {
+            prunedSecrets.add(pruneKey(secret.name, version.versionId));
+        }
+    }
+    const sevs = of(endpoints).filter((sev) => sev.projectId === projectId || sev.projectId === projectNumber);
+    for (const sev of sevs) {
+        let name = sev.secret;
+        if (name.includes("/")) {
+            const secret = (0, secretManager_1.parseSecretResourceName)(name);
+            name = secret.name;
+        }
+        let version = sev.version;
+        if (version === "latest") {
+            const resolved = await (0, secretManager_1.getSecretVersion)(projectId, name, version);
+            version = resolved.versionId;
+        }
+        prunedSecrets.delete(pruneKey(name, version));
+    }
+    return Array.from(prunedSecrets)
+        .map((key) => key.split("@"))
+        .map(([secret, version]) => ({ projectId, version, secret, key: secret }));
+}
+exports.pruneSecrets = pruneSecrets;