firebase-tools 9.16.6 → 9.20.0

package/lib/deploy/functions/backend.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkAvailability = exports.existingBackend = exports.scheduleIdForFunction = exports.topicName = exports.scheduleName = exports.sameFunctionName = exports.functionName = exports.isEmptyBackend = exports.empty = exports.SCHEDULED_FUNCTION_LABEL = exports.memoryOptionDisplayName = exports.triggerTag = exports.isEventTrigger = void 0;
+exports.compareFunctions = exports.checkAvailability = exports.existingBackend = exports.scheduleIdForFunction = exports.topicName = exports.scheduleName = exports.sameFunctionName = exports.functionName = exports.isEmptyBackend = exports.empty = exports.isScheduleTriggered = exports.isEventTriggered = exports.isHttpsTriggered = exports.SCHEDULED_FUNCTION_LABEL = exports.memoryOptionDisplayName = exports.triggerTag = exports.isEventTrigger = void 0;
 const gcf = require("../../gcp/cloudfunctions");
 const gcfV2 = require("../../gcp/cloudfunctionsv2");
 const utils = require("../../utils");
@@ -46,9 +46,22 @@ function memoryOptionDisplayName(option) {
 }
 exports.memoryOptionDisplayName = memoryOptionDisplayName;
 exports.SCHEDULED_FUNCTION_LABEL = Object.freeze({ deployment: "firebase-schedule" });
+function isHttpsTriggered(triggered) {
+    return {}.hasOwnProperty.call(triggered, "httpsTrigger");
+}
+exports.isHttpsTriggered = isHttpsTriggered;
+function isEventTriggered(triggered) {
+    return {}.hasOwnProperty.call(triggered, "eventTrigger");
+}
+exports.isEventTriggered = isEventTriggered;
+function isScheduleTriggered(triggered) {
+    return {}.hasOwnProperty.call(triggered, "scheduleTrigger");
+}
+exports.isScheduleTriggered = isScheduleTriggered;
 function empty() {
     return {
         requiredAPIs: {},
+        endpoints: [],
         cloudFunctions: [],
         schedules: [],
         topics: [],
@@ -91,15 +104,9 @@ async function existingBackend(context, forceRefresh) {
 }
 exports.existingBackend = existingBackend;
 async function loadExistingBackend(ctx) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     ctx.loadedExistingBackend = true;
-    ctx.existingBackend = {
-        requiredAPIs: {},
-        cloudFunctions: [],
-        schedules: [],
-        topics: [],
-        environmentVariables: {},
-    };
+    ctx.existingBackend = Object.assign({}, empty());
     ctx.unreachableRegions = {
         gcfV1: [],
         gcfV2: [],
@@ -137,12 +144,21 @@ async function loadExistingBackend(ctx) {
     if (!previews_1.previews.functionsv2) {
         return;
     }
-    const gcfV2Results = await gcfV2.listAllFunctions(ctx.projectId);
+    let gcfV2Results;
+    try {
+        gcfV2Results = await gcfV2.listAllFunctions(ctx.projectId);
+    }
+    catch (err) {
+        if (err.status === 404 && ((_b = err.message) === null || _b === void 0 ? void 0 : _b.toLowerCase().includes("method not found"))) {
+            return;
+        }
+        throw err;
+    }
     for (const apiFunction of gcfV2Results.functions) {
         const specFunction = gcfV2.specFromFunction(apiFunction);
         ctx.existingBackend.cloudFunctions.push(specFunction);
-        const pubsubScheduled = ((_b = apiFunction.labels) === null || _b === void 0 ? void 0 : _b["deployment-scheduled"]) === "true";
-        const httpsScheduled = ((_c = apiFunction.labels) === null || _c === void 0 ? void 0 : _c["deployment-scheduled"]) === "https";
+        const pubsubScheduled = ((_c = apiFunction.labels) === null || _c === void 0 ? void 0 : _c["deployment-scheduled"]) === "true";
+        const httpsScheduled = ((_d = apiFunction.labels) === null || _d === void 0 ? void 0 : _d["deployment-scheduled"]) === "https";
         if (pubsubScheduled) {
             const id = scheduleIdForFunction(specFunction);
             ctx.existingBackend.schedules.push({
@@ -221,3 +237,22 @@ async function checkAvailability(context, want) {
     }
 }
 exports.checkAvailability = checkAvailability;
+function compareFunctions(left, right) {
+    if (left.platform != right.platform) {
+        return right.platform < left.platform ? -1 : 1;
+    }
+    if (left.region < right.region) {
+        return -1;
+    }
+    if (left.region > right.region) {
+        return 1;
+    }
+    if (left.id < right.id) {
+        return -1;
+    }
+    if (left.id > right.id) {
+        return 1;
+    }
+    return 0;
+}
+exports.compareFunctions = compareFunctions;

package/lib/deploy/functions/containerCleaner.js

@@ -37,10 +37,14 @@ async function retry(func) {
     const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
     const MAX_RETRIES = 3;
     const INITIAL_BACKOFF = 100;
+    const TIMEOUT_MS = 10000;
     let retry = 0;
     while (true) {
         try {
-            return await func();
+            const timeout = new Promise((resolve, reject) => {
+                setTimeout(() => reject(new Error("Timeout")), TIMEOUT_MS);
+            });
+            return await Promise.race([func(), timeout]);
         }
         catch (error) {
             logger_1.logger.debug("Failed docker command with error", error);

package/lib/deploy/functions/deploy.js

@@ -37,10 +37,10 @@ async function deploy(context, options, payload) {
     if (!options.config.src.functions) {
         return;
     }
-    await checkIam_1.checkHttpIam(context, options, payload);
     if (!context.functionsSourceV1 && !context.functionsSourceV2) {
         return;
     }
+    await checkIam_1.checkHttpIam(context, options, payload);
     try {
         const want = payload.functions.backend;
         const uploads = [];
@@ -61,10 +61,12 @@ async function deploy(context, options, payload) {
         }
         await Promise.all(uploads);
         utils.assertDefined(options.config.src.functions.source, "Error: 'functions.source' is not defined");
-        utils_1.logSuccess(clc.green.bold("functions:") +
-            " " +
-            clc.bold(options.config.src.functions.source) +
-            " folder uploaded successfully");
+        if (uploads.length) {
+            utils_1.logSuccess(clc.green.bold("functions:") +
+                " " +
+                clc.bold(options.config.src.functions.source) +
+                " folder uploaded successfully");
+        }
     }
     catch (err) {
         utils_1.logWarning(clc.yellow("functions:") + " Upload Error: " + err.message);

package/lib/deploy/functions/prepare.js

@@ -18,6 +18,7 @@ const runtimes = require("./runtimes");
 const validate = require("./validate");
 const utils = require("../../utils");
 const logger_1 = require("../../logger");
+const triggerRegionHelper_1 = require("./triggerRegionHelper");
 function hasUserConfig(config) {
     return Object.keys(config).length > 1;
 }
@@ -64,25 +65,25 @@ async function prepare(context, options, payload) {
     const wantBackend = await runtimeDelegate.discoverSpec(runtimeConfig, firebaseEnvs);
     wantBackend.environmentVariables = Object.assign(Object.assign({}, userEnvs), firebaseEnvs);
     payload.functions = { backend: wantBackend };
-    if (backend.isEmptyBackend(wantBackend)) {
-        return;
-    }
     if (wantBackend.cloudFunctions.find((f) => f.platform === "gcfv2")) {
         const V2_APIS = {
             artifactregistry: "artifactregistry.googleapis.com",
             cloudrun: "run.googleapis.com",
             eventarc: "eventarc.googleapis.com",
             pubsub: "pubsub.googleapis.com",
+            storage: "storage.googleapis.com",
         };
         const enablements = Object.entries(V2_APIS).map(([tag, api]) => {
             return ensureApiEnabled.ensure(context.projectId, api, tag);
         });
         await Promise.all(enablements);
     }
-    utils_1.logBullet(clc.cyan.bold("functions:") +
-        " preparing " +
-        clc.bold(options.config.src.functions.source) +
-        " directory for uploading...");
+    if (wantBackend.cloudFunctions.length) {
+        utils_1.logBullet(clc.cyan.bold("functions:") +
+            " preparing " +
+            clc.bold(options.config.src.functions.source) +
+            " directory for uploading...");
+    }
     if (wantBackend.cloudFunctions.find((fn) => fn.platform === "gcfv1")) {
         context.functionsSourceV1 = await prepareFunctionsUpload_1.prepareFunctionsUpload(runtimeConfig, options);
     }
@@ -101,6 +102,7 @@ async function prepare(context, options, payload) {
         return functionsDeployHelper_1.functionMatchesAnyGroup(fn, context.filters);
     });
     const haveFunctions = (await backend.existingBackend(context)).cloudFunctions;
+    await triggerRegionHelper_1.setTriggerRegion(wantFunctions, haveFunctions);
     await prompts_1.promptForFailurePolicies(options, wantFunctions, haveFunctions);
     await prompts_1.promptForMinInstances(options, wantFunctions, haveFunctions);
     await backend.checkAvailability(context, wantBackend);

package/lib/deploy/functions/prompts.js

@@ -9,24 +9,6 @@ const logger_1 = require("../../logger");
 const backend = require("./backend");
 const pricing = require("./pricing");
 const utils = require("../../utils");
-function compareFunctions(left, right) {
-    if (left.platform != right.platform) {
-        return right.platform < left.platform ? -1 : 1;
-    }
-    if (left.region < right.region) {
-        return -1;
-    }
-    if (left.region > right.region) {
-        return 1;
-    }
-    if (left.id < right.id) {
-        return -1;
-    }
-    if (left.id > right.id) {
-        return 1;
-    }
-    return 0;
-}
 async function promptForFailurePolicies(options, want, have) {
     const retryFunctions = want.filter((fn) => {
         return backend.isEventTrigger(fn.trigger) && fn.trigger.retry;
@@ -44,7 +26,7 @@ async function promptForFailurePolicies(options, want, have) {
         return;
     }
     const warnMessage = "The following functions will newly be retried in case of failure: " +
-        clc.bold(newRetryFunctions.sort(compareFunctions).map(functionsDeployHelper_1.getFunctionLabel).join(", ")) +
+        clc.bold(newRetryFunctions.sort(backend.compareFunctions).map(functionsDeployHelper_1.getFunctionLabel).join(", ")) +
         ". " +
         "Retried executions are billed as any other execution, and functions are retried repeatedly until they either successfully execute or the maximum retry period has elapsed, which can be up to 7 days. " +
         "For safety, you might want to ensure that your functions are idempotent; see https://firebase.google.com/docs/functions/retries to learn more.";
@@ -74,7 +56,7 @@ async function promptForFunctionDeletion(functionsToDelete, force, nonInteractiv
         return true;
     }
     const deleteList = functionsToDelete
-        .sort(compareFunctions)
+        .sort(backend.compareFunctions)
         .map((fn) => "\t" + functionsDeployHelper_1.getFunctionLabel(fn))
         .join("\n");
     if (nonInteractive) {
@@ -136,7 +118,7 @@ async function promptForMinInstances(options, want, have) {
     }
     const functionLines = want
         .filter((fn) => fn.minInstances)
-        .sort(compareFunctions)
+        .sort(backend.compareFunctions)
         .map((fn) => {
         return (`\t${functionsDeployHelper_1.getFunctionLabel(fn)}: ${fn.minInstances} instances, ` +
             backend.memoryOptionDisplayName(fn.availableMemoryMb || 256) +

package/lib/deploy/functions/runtimes/discovery/v1alpha1.js

@@ -15,6 +15,7 @@ function tryValidate(typed) {
     var _a, _b;
     parsing_1.assertKeyTypes("", typed, {
         requiredAPIs: "object",
+        endpoints: "array",
         cloudFunctions: "array",
         topics: "array",
         schedules: "array",
@@ -59,7 +60,6 @@ function tryValidate(typed) {
         }
         else {
             parsing_1.assertKeyTypes(prefix + ".trigger", func.trigger, {
-                allowInsecure: "boolean",
                 invoker: "array",
             });
         }
@@ -115,6 +115,7 @@ function fillDefaults(want, project, region, runtime) {
     want.environmentVariables = want.environmentVariables || {};
     want.schedules = want.schedules || [];
     want.topics = want.topics || [];
+    want.endpoints = want.endpoints || [];
     for (const cloudFunction of want.cloudFunctions) {
         if (!cloudFunction.project) {
             cloudFunction.project = project;

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

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

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

@@ -13,17 +13,18 @@ const ENGINE_RUNTIMES = {
     10: "nodejs10",
     12: "nodejs12",
     14: "nodejs14",
+    16: "nodejs16",
 };
 const ENGINE_RUNTIMES_NAMES = Object.values(ENGINE_RUNTIMES);
 exports.RUNTIME_NOT_SET = "`runtime` field is required but was not found in firebase.json.\n" +
     "To fix this, add the following lines to the `functions` section of your firebase.json:\n" +
     '"runtime": "nodejs14"\n';
 exports.UNSUPPORTED_NODE_VERSION_FIREBASE_JSON_MSG = clc.bold(`functions.runtime value is unsupported. ` +
-    `Valid choices are: ${clc.bold("nodejs10")}, ${clc.bold("nodejs12")}, and ${clc.bold("nodejs14")}.`);
+    `Valid choices are: ${clc.bold("nodejs{10|12|14|16}")}.`);
 exports.UNSUPPORTED_NODE_VERSION_PACKAGE_JSON_MSG = clc.bold(`package.json in functions directory has an engines field which is unsupported. ` +
-    `Valid choices are: ${clc.bold('{"node": "10"}')}, ${clc.bold('{"node":"12"}')}, and ${clc.bold('{"node":"14"}')}.`);
+    `Valid choices are: ${clc.bold('{"node": 10|12|14|16}')}`);
 exports.DEPRECATED_NODE_VERSION_INFO = `\n\nDeploys to runtimes below Node.js 10 are now disabled in the Firebase CLI. ` +
-    `${clc.bold(`Existing Node.js 8 functions ${clc.underline("will stop executing on 2021-03-15")}`)}. Update existing functions to Node.js 10 or greater as soon as possible.`;
+    `${clc.bold(`Existing Node.js 8 functions ${clc.underline("will stop executing at a future date")}`)}. Update existing functions to Node.js 10 or greater as soon as possible.`;
 function getRuntimeChoiceFromPackageJson(sourceDir) {
     const packageJsonPath = path.join(sourceDir, "package.json");
     let loaded;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addResourcesToBackend = exports.discoverBackend = exports.useStrategy = void 0;
+exports.addResourcesToBackend = exports.discoverBackend = exports.useStrategy = exports.GCS_EVENTS = void 0;
 const path = require("path");
 const _ = require("lodash");
 const child_process_1 = require("child_process");
@@ -10,6 +10,12 @@ const backend = require("../../backend");
 const api = require("../../../../api");
 const proto = require("../../../../gcp/proto");
 const TRIGGER_PARSER = path.resolve(__dirname, "./triggerParser.js");
+exports.GCS_EVENTS = new Set([
+    "google.cloud.storage.object.v1.finalized",
+    "google.cloud.storage.object.v1.archived",
+    "google.cloud.storage.object.v1.deleted",
+    "google.cloud.storage.object.v1.metadataUpdated",
+]);
 function removeInspectOptions(options) {
     return options.filter((opt) => !opt.startsWith("--inspect"));
 }
@@ -58,6 +64,7 @@ async function discoverBackend(projectId, sourceDir, runtime, configValues, envs
 }
 exports.discoverBackend = discoverBackend;
 function addResourcesToBackend(projectId, runtime, annotation, want) {
+    var _a;
     Object.freeze(annotation);
     for (const region of annotation.regions || [api.functionsDefaultRegion]) {
         let trigger;
@@ -65,14 +72,7 @@ function addResourcesToBackend(projectId, runtime, annotation, want) {
             throw new error_1.FirebaseError("Unexpected annotation generated by the Firebase Functions SDK. This should never happen.");
         }
         if (annotation.httpsTrigger) {
-            let allowInsecure;
-            if ("allowInsecure" in annotation.httpsTrigger) {
-                allowInsecure = !!annotation.httpsTrigger.allowInsecure;
-            }
-            else {
-                allowInsecure = !annotation.platform || annotation.platform === "gcfv1";
-            }
-            trigger = { allowInsecure };
+            trigger = {};
             if (annotation.failurePolicy) {
                 logger_1.logger.warn(`Ignoring retry policy for HTTPS function ${annotation.name}`);
             }
@@ -86,6 +86,11 @@ function addResourcesToBackend(projectId, runtime, annotation, want) {
                 },
                 retry: !!annotation.failurePolicy,
             };
+            if (exports.GCS_EVENTS.has(((_a = annotation.eventTrigger) === null || _a === void 0 ? void 0 : _a.eventType) || "")) {
+                trigger.eventFilters = {
+                    bucket: annotation.eventTrigger.resource,
+                };
+            }
         }
         const cloudFunctionName = {
             id: annotation.name,

package/lib/deploy/functions/triggerRegionHelper.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setTriggerRegion = void 0;
+const backend = require("./backend");
+const storage = require("../../gcp/storage");
+const error_1 = require("../../error");
+async function setTriggerRegion(want, have) {
+    var _a;
+    for (const wantFn of want) {
+        if (wantFn.platform === "gcfv1" || !backend.isEventTrigger(wantFn.trigger)) {
+            continue;
+        }
+        const match = (_a = have.find(backend.sameFunctionName(wantFn))) === null || _a === void 0 ? void 0 : _a.trigger;
+        if (match === null || match === void 0 ? void 0 : match.region) {
+            wantFn.trigger.region = match.region;
+        }
+        else {
+            await setTriggerRegionFromTriggerType(wantFn.trigger);
+        }
+    }
+}
+exports.setTriggerRegion = setTriggerRegion;
+async function setTriggerRegionFromTriggerType(trigger) {
+    if (trigger.eventFilters.bucket) {
+        try {
+            trigger.region = (await storage.getBucket(trigger.eventFilters.bucket)).location.toLowerCase();
+        }
+        catch (err) {
+            throw new error_1.FirebaseError("Can't find the storage bucket region", { original: err });
+        }
+    }
+}

package/lib/downloadUtils.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadToTmp = void 0;
+const url_1 = require("url");
+const fs = require("fs-extra");
+const ProgressBar = require("progress");
+const tmp = require("tmp");
+const apiv2_1 = require("./apiv2");
+const error_1 = require("./error");
+async function downloadToTmp(remoteUrl) {
+    const u = new url_1.URL(remoteUrl);
+    const c = new apiv2_1.Client({ urlPrefix: u.origin, auth: false });
+    const tmpfile = tmp.fileSync();
+    const writeStream = fs.createWriteStream(tmpfile.name);
+    const res = await c.request({
+        method: "GET",
+        path: u.pathname,
+        queryParams: u.searchParams,
+        responseType: "stream",
+        resolveOnHTTPError: true,
+    });
+    if (res.status !== 200) {
+        throw new error_1.FirebaseError(`download failed, status ${res.status}`, { exit: 1 });
+    }
+    const total = parseInt(res.response.headers.get("content-length") || "0", 10);
+    const totalMb = Math.ceil(total / 1000000);
+    const bar = new ProgressBar(`Progress: :bar (:percent of ${totalMb}MB)`, { total, head: ">" });
+    res.body.on("data", (chunk) => {
+        bar.tick(chunk.length);
+    });
+    await new Promise((resolve) => {
+        writeStream.on("finish", resolve);
+        res.body.pipe(writeStream);
+    });
+    return tmpfile.name;
+}
+exports.downloadToTmp = downloadToTmp;