firebase-tools 11.29.1 → 12.0.0

package/lib/database/import.js

@@ -6,14 +6,91 @@ const Filter = require("stream-json/filters/Filter");
 const stream = require("stream");
 const StreamObject = require("stream-json/streamers/StreamObject");
 const apiv2_1 = require("../apiv2");
+const node_fetch_1 = require("node-fetch");
 const error_1 = require("../error");
 const pLimit = require("p-limit");
+class BatchChunks extends stream.Transform {
+    constructor(maxSize, opts) {
+        super(Object.assign(Object.assign({}, opts), { objectMode: true }));
+        this.maxSize = maxSize;
+        this.batch = [];
+        this.size = 0;
+    }
+    _transform(chunk, _, callback) {
+        const totalChunkSize = chunk.size + chunk.pathname.length;
+        if (this.size + totalChunkSize > this.maxSize) {
+            this.push(this.transformBatchToPatchData(this.batch));
+            this.batch = [];
+            this.size = 0;
+        }
+        this.batch.push(chunk);
+        this.size += totalChunkSize;
+        callback(null);
+    }
+    transformBatchToPatchData(batch) {
+        return this.sanitizePatchData(this.compactData(batch));
+    }
+    compactData(batch) {
+        if (batch.length === 1) {
+            return batch[0];
+        }
+        const pathname = this.findLongestCommonPrefixArray(batch.map((d) => d.pathname));
+        let json = {};
+        let size = 0;
+        for (const chunk of batch) {
+            const truncatedPath = chunk.pathname.substring(pathname.length + 1);
+            json = Object.assign({}, json, { [truncatedPath]: chunk.json });
+            size += chunk.size;
+        }
+        return { json, pathname, size };
+    }
+    sanitizePatchData({ json, pathname, size }) {
+        if (typeof json === "string" || typeof json === "number" || typeof json === "boolean") {
+            const tokens = pathname.split("/");
+            const lastToken = tokens.pop();
+            return { json: { [lastToken]: json }, pathname: tokens.join("/"), size };
+        }
+        if (Array.isArray(json)) {
+            return { json: Object.assign({}, json), pathname, size };
+        }
+        return { json, pathname, size };
+    }
+    findLongestCommonPrefixArray(paths) {
+        const findLongestCommonPrefixPair = (p, q) => {
+            const pTokens = p.split("/");
+            const qTokens = q.split("/");
+            let prefix = pTokens.slice(0, qTokens.length);
+            for (let i = 0; i < prefix.length; i++) {
+                if (prefix[i] !== qTokens[i]) {
+                    prefix = prefix.slice(0, i);
+                    break;
+                }
+            }
+            return prefix.join("/");
+        };
+        if (paths.length === 0) {
+            return "";
+        }
+        let prefix = paths[0];
+        for (let i = 1; i < paths.length; i++) {
+            prefix = findLongestCommonPrefixPair(prefix, paths[i]);
+        }
+        return prefix;
+    }
+    _flush(callback) {
+        if (this.size > 0) {
+            this.push(this.transformBatchToPatchData(this.batch));
+        }
+        callback(null);
+    }
+}
 class DatabaseImporter {
-    constructor(dbUrl, inStream, dataPath, chunkBytes, concurrency) {
+    constructor(dbUrl, inStream, dataPath, payloadSize, concurrency) {
         this.dbUrl = dbUrl;
         this.inStream = inStream;
         this.dataPath = dataPath;
-        this.chunkBytes = chunkBytes;
+        this.payloadSize = payloadSize;
+        this.nonFatalRetryTimeout = 1000;
         this.client = new apiv2_1.Client({ urlPrefix: dbUrl.origin, auth: true });
         this.limit = pLimit(concurrency);
     }
@@ -34,23 +111,23 @@ class DatabaseImporter {
         }
     }
     readAndWriteChunks() {
-        const { dbUrl } = this;
+        const { dbUrl, payloadSize } = this;
         const chunkData = this.chunkData.bind(this);
-        const writeChunk = this.writeChunk.bind(this);
+        const doWriteBatch = this.doWriteBatch.bind(this);
         const getJoinedPath = this.joinPath.bind(this);
         const readChunks = new stream.Transform({ objectMode: true });
         readChunks._transform = function (chunk, _, done) {
             const data = { json: chunk.value, pathname: getJoinedPath(dbUrl.pathname, chunk.key) };
             const chunkedData = chunkData(data);
-            const chunks = chunkedData.chunks || [data];
+            const chunks = chunkedData.chunks || [Object.assign(Object.assign({}, data), { size: JSON.stringify(data.json).length })];
             for (const chunk of chunks) {
                 this.push(chunk);
             }
             done();
         };
-        const writeChunks = new stream.Transform({ objectMode: true });
-        writeChunks._transform = async function (chunk, _, done) {
-            const res = await writeChunk(chunk);
+        const writeBatch = new stream.Transform({ objectMode: true });
+        writeBatch._transform = async function (batch, _, done) {
+            const res = await doWriteBatch(batch);
             this.push(res);
             done();
         };
@@ -70,19 +147,37 @@ class DatabaseImporter {
                 exit: 2,
             })))
                 .pipe(readChunks)
-                .pipe(writeChunks)
+                .pipe(new BatchChunks(payloadSize))
+                .pipe(writeBatch)
                 .on("data", (res) => responses.push(res))
                 .on("error", reject)
                 .once("end", () => resolve(responses));
         });
     }
-    writeChunk(chunk) {
-        return this.limit(() => this.client.request({
-            method: "PUT",
-            path: chunk.pathname + ".json",
-            body: JSON.stringify(chunk.json),
-            queryParams: this.dbUrl.searchParams,
-        }));
+    doWriteBatch(batch) {
+        const doRequest = () => {
+            return this.client.request({
+                method: "PATCH",
+                path: `${batch.pathname}.json`,
+                body: batch.json,
+                queryParams: this.dbUrl.searchParams,
+            });
+        };
+        return this.limit(async () => {
+            try {
+                return await doRequest();
+            }
+            catch (err) {
+                const isTimeoutErr = err instanceof error_1.FirebaseError &&
+                    err.original instanceof node_fetch_1.FetchError &&
+                    err.original.code === "ETIMEDOUT";
+                if (isTimeoutErr) {
+                    await new Promise((res) => setTimeout(res, this.nonFatalRetryTimeout));
+                    return await doRequest();
+                }
+                throw err;
+            }
+        });
     }
     chunkData({ json, pathname }) {
         if (typeof json === "string" || typeof json === "number" || typeof json === "boolean") {
@@ -102,10 +197,10 @@ class DatabaseImporter {
                     chunks.push(...childChunks.chunks);
                 }
                 else {
-                    chunks.push(child);
+                    chunks.push(Object.assign(Object.assign({}, child), { size: childChunks.size }));
                 }
             }
-            if (hasChunkedChild || size >= this.chunkBytes) {
+            if (hasChunkedChild || size >= this.payloadSize) {
                 return { chunks, size };
             }
             else {

package/lib/deploy/extensions/planner.js

@@ -129,17 +129,23 @@ async function want(args) {
 exports.want = want;
 async function resolveVersion(ref) {
     const extensionRef = refs.toExtensionRef(ref);
+    const extension = await extensionsApi.getExtension(extensionRef);
+    if (!ref.version || ref.version === "latest-approved") {
+        if (!extension.latestApprovedVersion) {
+            throw new error_1.FirebaseError(`${extensionRef} has not been published to Extensions Hub (https://extensions.dev). To install it, you must specify the version you want to install.`);
+        }
+        return extension.latestApprovedVersion;
+    }
+    if (ref.version === "latest") {
+        if (!extension.latestVersion) {
+            throw new error_1.FirebaseError(`${extensionRef} has no stable non-deprecated versions. If you wish to install a prerelease version, you must specify the version you want to install.`);
+        }
+        return extension.latestVersion;
+    }
     const versions = await extensionsApi.listExtensionVersions(extensionRef, undefined, true);
     if (versions.length === 0) {
         throw new error_1.FirebaseError(`No versions found for ${extensionRef}`);
     }
-    if (!ref.version || ref.version === "latest") {
-        return versions
-            .filter((ev) => ev.spec.version !== undefined)
-            .map((ev) => ev.spec.version)
-            .sort(semver.compare)
-            .pop();
-    }
     const maxSatisfying = semver.maxSatisfying(versions.map((ev) => ev.spec.version), ref.version);
     if (!maxSatisfying) {
         throw new error_1.FirebaseError(`No version of ${extensionRef} matches requested version ${ref.version}`);

package/lib/deploy/extensions/prepare.js

@@ -15,6 +15,7 @@ const secrets_1 = require("./secrets");
 const warnings_1 = require("../../extensions/warnings");
 const etags_1 = require("../../extensions/etags");
 const v2FunctionHelper_1 = require("./v2FunctionHelper");
+const tos_1 = require("../../extensions/tos");
 async function prepare(context, options, payload) {
     var _a, _b;
     const projectId = (0, projectUtils_1.needProjectId)(options);
@@ -33,16 +34,10 @@ async function prepare(context, options, payload) {
     const etagsChanged = (0, etags_1.detectEtagChanges)(options.rc, projectId, context.have);
     if (etagsChanged.length) {
         (0, warnings_1.outOfBandChangesWarning)(etagsChanged);
-        if (!options.force && options.nonInteractive) {
-            throw new error_1.FirebaseError("Pass the --force flag to overwrite out of band changes in non-interactive mode");
-        }
-        else if (!options.force &&
-            !options.nonInteractive &&
-            !(await prompt.promptOnce({
-                type: "confirm",
-                message: `Do you wish to continue deploying these extension instances?`,
-                default: false,
-            }))) {
+        if (!(await prompt.confirm({
+            message: `Do you wish to continue deploying these extension instances?`,
+            default: false,
+        }))) {
             throw new error_1.FirebaseError("Deployment cancelled");
         }
     }
@@ -59,16 +54,10 @@ async function prepare(context, options, payload) {
     payload.instancesToUpdate = context.want.filter((i) => { var _a; return (_a = context.have) === null || _a === void 0 ? void 0 : _a.some(isUpdate(i)); });
     payload.instancesToDelete = context.have.filter((i) => { var _a; return !((_a = context.want) === null || _a === void 0 ? void 0 : _a.some(matchesInstanceId(i))); });
     if (await (0, warnings_1.displayWarningsForDeploy)(payload.instancesToCreate)) {
-        if (!options.force && options.nonInteractive) {
-            throw new error_1.FirebaseError("Pass the --force flag to acknowledge these terms in non-interactive mode");
-        }
-        else if (!options.force &&
-            !options.nonInteractive &&
-            !(await prompt.promptOnce({
-                type: "confirm",
-                message: `Do you wish to continue deploying these extension instances?`,
-                default: true,
-            }))) {
+        if (!(await prompt.confirm({
+            message: `Do you wish to continue deploying these extension instances?`,
+            default: true,
+        }))) {
             throw new error_1.FirebaseError("Deployment cancelled");
         }
     }
@@ -87,18 +76,12 @@ async function prepare(context, options, payload) {
     }
     if (payload.instancesToDelete.length) {
         logger_1.logger.info(deploymentSummary.deletesSummary(payload.instancesToDelete));
-        if (!options.force && options.nonInteractive) {
-            throw new error_1.FirebaseError("Pass the --force flag to use this command in non-interactive mode");
-        }
-        else if (!options.force &&
-            !options.nonInteractive &&
-            !(await prompt.promptOnce({
-                type: "confirm",
-                message: `Would you like to delete ${payload.instancesToDelete
-                    .map((i) => i.instanceId)
-                    .join(", ")}?`,
-                default: false,
-            }))) {
+        if (!(await prompt.confirm({
+            message: `Would you like to delete ${payload.instancesToDelete
+                .map((i) => i.instanceId)
+                .join(", ")}?`,
+            default: false,
+        }))) {
             payload.instancesToDelete = [];
         }
         else {
@@ -106,6 +89,7 @@ async function prepare(context, options, payload) {
         }
     }
     await (0, requirePermissions_1.requirePermissions)(options, permissionsNeeded);
+    await (0, tos_1.acceptLatestAppDeveloperTOS)(options, projectId, context.want.map((i) => i.instanceId));
 }
 exports.prepare = prepare;
 const matchesInstanceId = (dep) => (test) => {

package/lib/deploy/functions/ensure.js

@@ -12,8 +12,14 @@ const track_1 = require("../../track");
 const backend = require("./backend");
 const FAQ_URL = "https://firebase.google.com/support/faq#functions-runtime";
 const CLOUD_BUILD_API = "cloudbuild.googleapis.com";
+const metadataCallCache = new Map();
 async function defaultServiceAccount(e) {
-    const metadata = await (0, projects_1.getFirebaseProject)(e.project);
+    let metadataCall = metadataCallCache.get(e.project);
+    if (!metadataCall) {
+        metadataCall = (0, projects_1.getFirebaseProject)(e.project);
+        metadataCallCache.set(e.project, metadataCall);
+    }
+    const metadata = await metadataCall;
     if (e.platform === "gcfv1") {
         return `${metadata.projectId}@appspot.gserviceaccount.com`;
     }

package/lib/deploy/functions/release/fabricator.js

@@ -276,6 +276,7 @@ class Fabricator {
             .catch(rethrowAs(endpoint, "create"));
         endpoint.uri = (_d = resultFunction.serviceConfig) === null || _d === void 0 ? void 0 : _d.uri;
         const serviceName = (_e = resultFunction.serviceConfig) === null || _e === void 0 ? void 0 : _e.service;
+        endpoint.runServiceId = utils.last(serviceName === null || serviceName === void 0 ? void 0 : serviceName.split("/"));
         if (!serviceName) {
             logger_1.logger.debug("Result function unexpectedly didn't have a service name.");
             utils.logLabeledWarning("functions", "Updated function is not associated with a service. This deployment is in an unexpected state - please re-deploy your functions.");
@@ -369,6 +370,7 @@ class Fabricator {
             .catch(rethrowAs(endpoint, "update"));
         endpoint.uri = (_c = resultFunction.serviceConfig) === null || _c === void 0 ? void 0 : _c.uri;
         const serviceName = (_d = resultFunction.serviceConfig) === null || _d === void 0 ? void 0 : _d.service;
+        endpoint.runServiceId = utils.last(serviceName === null || serviceName === void 0 ? void 0 : serviceName.split("/"));
         if (!serviceName) {
             logger_1.logger.debug("Result function unexpectedly didn't have a service name.");
             utils.logLabeledWarning("functions", "Updated function is not associated with a service. This deployment is in an unexpected state - please re-deploy your functions.");

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

@@ -45,7 +45,7 @@ async function detectFromYaml(directory, project, runtime) {
     return yamlToBuild(parsed, project, api.functionsDefaultRegion, runtime);
 }
 exports.detectFromYaml = detectFromYaml;
-async function detectFromPort(port, project, runtime, timeout = 30000) {
+async function detectFromPort(port, project, runtime, timeout = 10000) {
     let res;
     const timedOut = new Promise((resolve, reject) => {
         setTimeout(() => {

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

@@ -5,8 +5,16 @@ const node = require("./node");
 const python = require("./python");
 const validate = require("../validate");
 const error_1 = require("../../../error");
-const RUNTIMES = ["nodejs10", "nodejs12", "nodejs14", "nodejs16", "nodejs18"];
-const EXPERIMENTAL_RUNTIMES = ["python310", "python311"];
+const RUNTIMES = [
+    "nodejs10",
+    "nodejs12",
+    "nodejs14",
+    "nodejs16",
+    "nodejs18",
+    "python310",
+    "python311",
+];
+const EXPERIMENTAL_RUNTIMES = [];
 const DEPRECATED_RUNTIMES = ["nodejs6", "nodejs8"];
 function isDeprecatedRuntime(runtime) {
     return DEPRECATED_RUNTIMES.includes(runtime);
@@ -25,7 +33,7 @@ const MESSAGE_FRIENDLY_RUNTIMES = {
     nodejs16: "Node.js 16",
     nodejs18: "Node.js 18",
     python310: "Python 3.10",
-    python311: "Python 3.11 (Preview)",
+    python311: "Python 3.11",
 };
 function getHumanFriendlyRuntimeName(runtime) {
     return MESSAGE_FRIENDLY_RUNTIMES[runtime] || runtime;

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

@@ -19,11 +19,11 @@ const ENGINE_RUNTIMES = {
 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": "nodejs16"\n';
+    '"runtime": "nodejs18"\n';
 exports.UNSUPPORTED_NODE_VERSION_FIREBASE_JSON_MSG = clc.bold(`functions.runtime value is unsupported. ` +
-    `Valid choices are: ${clc.bold("nodejs{10|12|14|16}")}.`);
+    `Valid choices are: ${clc.bold("nodejs{10|12|14|16|18}")}.`);
 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|12|14|16}')}`);
+    `Valid choices are: ${clc.bold('{"node": 10|12|14|16|18}')}`);
 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 at a future date")}`)}. Update existing functions to Node.js 10 or greater as soon as possible.`;
 function getRuntimeChoiceFromPackageJson(sourceDir) {

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

@@ -11,7 +11,8 @@ const discovery = require("../discovery");
 const logger_1 = require("../../../../logger");
 const python_1 = require("../../../../functions/python");
 const error_1 = require("../../../../error");
-exports.LATEST_VERSION = "python310";
+const utils_1 = require("../../../../utils");
+exports.LATEST_VERSION = "python311";
 async function tryCreateDelegate(context) {
     const requirementsTextPath = path.join(context.sourceDir, "requirements.txt");
     if (!(await (0, util_1.promisify)(fs.exists)(requirementsTextPath))) {
@@ -54,15 +55,21 @@ class Delegate {
         return this._bin;
     }
     async modulesDir() {
-        var _a;
+        var _a, _b;
         if (!this._modulesDir) {
+            let out = "";
+            let stderr = "";
             const child = (0, python_1.runWithVirtualEnv)([
                 this.bin,
                 "-c",
                 '"import firebase_functions; import os; print(os.path.dirname(firebase_functions.__file__))"',
             ], this.sourceDir, {});
-            let out = "";
-            (_a = child.stdout) === null || _a === void 0 ? void 0 : _a.on("data", (chunk) => {
+            (_a = child.stderr) === null || _a === void 0 ? void 0 : _a.on("data", (chunk) => {
+                const chunkString = chunk.toString();
+                stderr = stderr + chunkString;
+                logger_1.logger.debug(`stderr: ${chunkString}`);
+            });
+            (_b = child.stdout) === null || _b === void 0 ? void 0 : _b.on("data", (chunk) => {
                 const chunkString = chunk.toString();
                 out = out + chunkString;
                 logger_1.logger.debug(`stdout: ${chunkString}`);
@@ -72,6 +79,15 @@ class Delegate {
                 child.on("error", reject);
             });
             this._modulesDir = out.trim();
+            if (this._modulesDir === "") {
+                if (stderr.includes("venv") && stderr.includes("activate")) {
+                    throw new error_1.FirebaseError("Failed to find location of Firebase Functions SDK: Missing virtual environment at venv directory. " +
+                        `Did you forget to run '${this.bin} -m venv venv'?`);
+                }
+                const { command, args } = (0, python_1.virtualEnvCmd)(this.sourceDir, python_1.DEFAULT_VENV_DIR);
+                throw new error_1.FirebaseError("Failed to find location of Firebase Functions SDK. " +
+                    `Did you forget to run '${command} ${args.join(" ")} && ${this.bin} -m pip install -r requirements.txt'?`);
+            }
         }
         return this._modulesDir;
     }
@@ -92,24 +108,32 @@ class Delegate {
         const modulesDir = await this.modulesDir();
         const envWithAdminPort = Object.assign(Object.assign({}, envs), { ADMIN_PORT: port.toString() });
         const args = [this.bin, path.join(modulesDir, "private", "serving.py")];
+        const stdout = [];
+        const stderr = [];
         logger_1.logger.debug(`Running admin server with args: ${JSON.stringify(args)} and env: ${JSON.stringify(envWithAdminPort)} in ${this.sourceDir}`);
         const childProcess = (0, python_1.runWithVirtualEnv)(args, this.sourceDir, envWithAdminPort);
         (_a = childProcess.stdout) === null || _a === void 0 ? void 0 : _a.on("data", (chunk) => {
             const chunkString = chunk.toString();
+            stdout.push(chunkString);
             logger_1.logger.debug(`stdout: ${chunkString}`);
         });
         (_b = childProcess.stderr) === null || _b === void 0 ? void 0 : _b.on("data", (chunk) => {
             const chunkString = chunk.toString();
+            stderr.push(chunkString);
             logger_1.logger.debug(`stderr: ${chunkString}`);
         });
-        return Promise.resolve(async () => {
-            await (0, node_fetch_1.default)(`http://127.0.0.1:${port}/__/quitquitquit`);
-            const quitTimeout = setTimeout(() => {
-                if (!childProcess.killed) {
-                    childProcess.kill("SIGKILL");
-                }
-            }, 10000);
-            clearTimeout(quitTimeout);
+        return Promise.resolve({
+            stderr,
+            stdout,
+            killProcess: async () => {
+                await (0, node_fetch_1.default)(`http://127.0.0.1:${port}/__/quitquitquit`);
+                const quitTimeout = setTimeout(() => {
+                    if (!childProcess.killed) {
+                        childProcess.kill("SIGKILL");
+                    }
+                }, 10000);
+                clearTimeout(quitTimeout);
+            },
         });
     }
     async discoverBuild(_configValues, envs) {
@@ -118,10 +142,14 @@ class Delegate {
             const adminPort = await portfinder.getPortPromise({
                 port: 8081,
             });
-            const killProcess = await this.serveAdmin(adminPort, envs);
+            const { killProcess, stderr } = await this.serveAdmin(adminPort, envs);
             try {
                 discovered = await discovery.detectFromPort(adminPort, this.projectId, this.runtime);
             }
+            catch (e) {
+                (0, utils_1.logLabeledWarning)("functions", `Failed to detect functions from source ${e}.\nstderr:${stderr.join("\n")}`);
+                throw e;
+            }
             finally {
                 await killProcess();
             }

package/lib/deploy/hosting/convertConfig.js

@@ -113,10 +113,10 @@ async function convertConfig(context, functionsPayload, deploy) {
             }
             if (endpoint.platform === "gcfv1") {
                 if (!backend.isHttpsTriggered(endpoint) && !backend.isCallableTriggered(endpoint)) {
-                    throw new error_1.FirebaseError(`Function ${endpoint.id} is a gen 1 function and therefore must be an https function type`);
+                    throw new error_1.FirebaseError(`Function ${endpoint.id} is a 1st gen function and therefore must be an https function type`);
                 }
                 if (rewrite.function.pinTag) {
-                    throw new error_1.FirebaseError(`Function ${endpoint.id} is a gen 1 function and therefore does not support the ${(0, colorette_1.bold)("pinTag")} option`);
+                    throw new error_1.FirebaseError(`Function ${endpoint.id} is a 1st gen function and therefore does not support the ${(0, colorette_1.bold)("pinTag")} option`);
                 }
                 return Object.assign(Object.assign({}, target), { function: endpoint.id, functionRegion: endpoint.region });
             }
@@ -137,9 +137,13 @@ async function convertConfig(context, functionsPayload, deploy) {
             return Object.assign(Object.assign({}, target), { dynamicLinks: true });
         }
         if ("run" in rewrite) {
-            const apiRewrite = Object.assign(Object.assign({}, target), { run: Object.assign({ region: "us-central1" }, rewrite.run) });
-            if (apiRewrite.run.tag) {
+            const apiRewrite = Object.assign(Object.assign({}, target), { run: {
+                    serviceId: rewrite.run.serviceId,
+                    region: rewrite.run.region || "us-central1",
+                } });
+            if (rewrite.run.pinTag) {
                 experiments.assertEnabled("pintags", "pin to a run service revision");
+                apiRewrite.run.tag = runTags.TODO_TAG_NAME;
             }
             return apiRewrite;
         }

package/lib/deploy/hosting/prepare.js

@@ -1,36 +1,94 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unsafePins = exports.prepare = void 0;
+exports.unsafePins = exports.prepare = exports.addPinnedFunctionsToOnlyString = exports.hasPinnedFunctions = void 0;
 const error_1 = require("../../error");
 const api = require("../../hosting/api");
 const config = require("../../hosting/config");
 const deploymentTool = require("../../deploymentTool");
+const clc = require("colorette");
 const functional_1 = require("../../functional");
 const track_1 = require("../../track");
 const utils = require("../../utils");
 const backend = require("../functions/backend");
-async function prepare(context, options) {
+const ensureTargeted_1 = require("../../functions/ensureTargeted");
+function handlePublicDirectoryFlag(options) {
     if (options.public) {
         if (Array.isArray(options.config.get("hosting"))) {
             throw new error_1.FirebaseError("Cannot specify --public option with multi-site configuration.");
         }
         options.config.set("hosting.public", options.public);
     }
+}
+function hasPinnedFunctions(options) {
+    handlePublicDirectoryFlag(options);
+    for (const c of config.hostingConfig(options)) {
+        for (const r of c.rewrites || []) {
+            if ("function" in r && typeof r.function === "object" && r.function.pinTag) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+exports.hasPinnedFunctions = hasPinnedFunctions;
+async function addPinnedFunctionsToOnlyString(context, options) {
+    var _a;
+    if (!options.only) {
+        return false;
+    }
+    handlePublicDirectoryFlag(options);
+    const addedFunctions = [];
+    for (const c of config.hostingConfig(options)) {
+        const addedFunctionsPerSite = [];
+        for (const r of c.rewrites || []) {
+            if (!("function" in r) || typeof r.function !== "object" || !r.function.pinTag) {
+                continue;
+            }
+            const endpoint = (_a = (await backend.existingBackend(context)).endpoints[r.function.region || "us-central1"]) === null || _a === void 0 ? void 0 : _a[r.function.functionId];
+            if (endpoint) {
+                options.only = (0, ensureTargeted_1.ensureTargeted)(options.only, endpoint.codebase || "default", endpoint.id);
+            }
+            else {
+                options.only = (0, ensureTargeted_1.ensureTargeted)(options.only, r.function.functionId);
+            }
+            addedFunctionsPerSite.push(r.function.functionId);
+        }
+        if (addedFunctionsPerSite.length) {
+            utils.logLabeledBullet("hosting", "The following function(s) are pinned to site " +
+                `${clc.bold(c.site)} and will be deployed as well: ` +
+                addedFunctionsPerSite.map(clc.bold).join(","));
+            addedFunctions.push(...addedFunctionsPerSite);
+        }
+    }
+    return addedFunctions.length !== 0;
+}
+exports.addPinnedFunctionsToOnlyString = addPinnedFunctionsToOnlyString;
+async function prepare(context, options) {
+    handlePublicDirectoryFlag(options);
     const configs = config.hostingConfig(options);
     if (configs.length === 0) {
         return Promise.resolve();
     }
     const versions = await Promise.all(configs.map(async (config) => {
+        var _a, _b;
         const labels = Object.assign({}, deploymentTool.labels());
         if (config.webFramework) {
             labels["firebase-web-framework"] = config.webFramework;
         }
         const unsafe = await unsafePins(context, config);
         if (unsafe.length) {
-            const msg = `Cannot deploy site ${config.site} to channel ${context.hostingChannel} because it would modify one or more rewrites in "live" that are not pinned, breaking production. Please pin "live" before pinning other channels.`;
+            const msg = `Cannot deploy site ${clc.bold(config.site)} to channel ` +
+                `${clc.bold(context.hostingChannel)} because it would modify one or ` +
+                `more rewrites in "live" that are not pinned, breaking production. ` +
+                `Please pin "live" before pinning other channels.`;
             utils.logLabeledError("Hosting", msg);
             throw new Error(msg);
         }
+        const runPins = (_b = (_a = config.rewrites) === null || _a === void 0 ? void 0 : _a.filter((r) => "run" in r && r.run.pinTag)) === null || _b === void 0 ? void 0 : _b.map((r) => r.run.serviceId);
+        if (runPins === null || runPins === void 0 ? void 0 : runPins.length) {
+            utils.logLabeledBullet("hosting", `The site ${clc.bold(config.site)} will pin rewrites to the current ` +
+                `latest revision of service(s) ${runPins.map(clc.bold).join(",")}`);
+        }
         const version = {
             status: "CREATED",
             labels,
@@ -64,7 +122,7 @@ function rewriteTarget(source) {
     }
 }
 async function unsafePins(context, config) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     if ((context.hostingChannel || "live") === "live") {
         return [];
     }
@@ -76,7 +134,7 @@ async function unsafePins(context, config) {
         }
         if ("function" in rewrite && typeof rewrite.function === "object" && rewrite.function.pinTag) {
             const region = rewrite.function.region || "us-central1";
-            const endpoint = (await backend.existingBackend(context)).endpoints[region][rewrite.function.functionId];
+            const endpoint = (_a = (await backend.existingBackend(context)).endpoints[region]) === null || _a === void 0 ? void 0 : _a[rewrite.function.functionId];
             if (!endpoint) {
                 continue;
             }
@@ -88,7 +146,7 @@ async function unsafePins(context, config) {
     }
     const channelConfig = await api.getChannel(context.projectId, config.site, "live");
     const existingUntaggedRewrites = {};
-    for (const rewrite of ((_c = (_b = (_a = channelConfig === null || channelConfig === void 0 ? void 0 : channelConfig.release) === null || _a === void 0 ? void 0 : _a.version) === null || _b === void 0 ? void 0 : _b.config) === null || _c === void 0 ? void 0 : _c.rewrites) || []) {
+    for (const rewrite of ((_d = (_c = (_b = channelConfig === null || channelConfig === void 0 ? void 0 : channelConfig.release) === null || _b === void 0 ? void 0 : _b.version) === null || _c === void 0 ? void 0 : _c.config) === null || _d === void 0 ? void 0 : _d.rewrites) || []) {
         if ("run" in rewrite && !rewrite.run.tag) {
             existingUntaggedRewrites[rewriteTarget(rewrite)] = `${rewrite.run.region}/${rewrite.run.serviceId}`;
         }