firebase-tools 11.10.0 → 11.10.1-canary.1

package/lib/bin/firebase.js

@@ -102,10 +102,21 @@ process.on("exit", (code) => {
     else {
         configstore_1.configstore.delete("lastError");
     }
-    const updateMessage = `Update available ${clc.gray("{currentVersion}")} → ${clc.green("{latestVersion}")}\n` +
-        `To update to the latest version using npm, run\n${clc.cyan("npm install -g firebase-tools")}\n` +
-        `For other CLI management options, visit the ${(0, marked_1.marked)("[CLI documentation](https://firebase.google.com/docs/cli#update-cli)")}`;
-    updateNotifier.notify({ defer: false, isGlobal: true, message: updateMessage });
+    try {
+        const updateMessage = `Update available ${clc.gray("{currentVersion}")} → ${clc.green("{latestVersion}")}\n` +
+            `To update to the latest version using npm, run\n${clc.cyan("npm install -g firebase-tools")}\n` +
+            `For other CLI management options, visit the ${(0, marked_1.marked)("[CLI documentation](https://firebase.google.com/docs/cli#update-cli)")}`;
+        updateNotifier.notify({ defer: false, isGlobal: true, message: updateMessage });
+    }
+    catch (err) {
+        logger_1.logger.debug("Error when notifying about new CLI updates:");
+        if (err instanceof Error) {
+            logger_1.logger.debug(err);
+        }
+        else {
+            logger_1.logger.debug(`${err}`);
+        }
+    }
 });
 process.on("uncaughtException", (err) => {
     (0, errorOut_1.errorOut)(err);

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serviceIsResolved = exports.Fabricator = void 0;
+exports.Fabricator = void 0;
 const clc = require("colorette");
 const error_1 = require("../../../error");
 const sourceTokenScraper_1 = require("./sourceTokenScraper");
@@ -23,7 +23,6 @@ const scheduler = require("../../../gcp/cloudscheduler");
 const utils = require("../../../utils");
 const services = require("../services");
 const v1_1 = require("../../../functions/events/v1");
-const throttler_1 = require("../../../throttler/throttler");
 const checkIam_1 = require("../checkIam");
 const gcfV1PollerOptions = {
     apiOrigin: api_1.functionsOrigin,
@@ -401,7 +400,7 @@ class Fabricator {
     async setRunTraits(serviceName, endpoint) {
         await this.functionExecutor
             .run(async () => {
-            let service = await run.getService(serviceName);
+            const service = await run.getService(serviceName);
             let changed = false;
             if (service.spec.template.spec.containerConcurrency !== endpoint.concurrency) {
                 service.spec.template.spec.containerConcurrency = endpoint.concurrency;
@@ -415,15 +414,7 @@ class Fabricator {
                 logger_1.logger.debug("Skipping setRunTraits on", serviceName, " because it already matches");
                 return;
             }
-            delete service.status;
-            delete service.spec.template.metadata.name;
-            service = await run.replaceService(serviceName, service);
-            let retry = 0;
-            while (!exports.serviceIsResolved(service)) {
-                await (0, throttler_1.backoff)(retry, 2, 30);
-                retry = retry + 1;
-                service = await run.getService(serviceName);
-            }
+            await run.updateService(serviceName, service);
         })
             .catch(rethrowAs(endpoint, "set concurrency"));
     }
@@ -547,26 +538,3 @@ class Fabricator {
     }
 }
 exports.Fabricator = Fabricator;
-function serviceIsResolved(service) {
-    var _a, _b, _c, _d, _e;
-    if (((_a = service.status) === null || _a === void 0 ? void 0 : _a.observedGeneration) !== service.metadata.generation) {
-        logger_1.logger.debug(`Service ${service.metadata.name} is not resolved because` +
-            `observed generation ${(_b = service.status) === null || _b === void 0 ? void 0 : _b.observedGeneration} does not ` +
-            `match spec generation ${service.metadata.generation}`);
-        return false;
-    }
-    const readyCondition = (_d = (_c = service.status) === null || _c === void 0 ? void 0 : _c.conditions) === null || _d === void 0 ? void 0 : _d.find((condition) => {
-        return condition.type === "Ready";
-    });
-    if ((readyCondition === null || readyCondition === void 0 ? void 0 : readyCondition.status) === "Unknown") {
-        logger_1.logger.debug(`Waiting for service ${service.metadata.name} to be ready. ` +
-            `Status is ${JSON.stringify((_e = service.status) === null || _e === void 0 ? void 0 : _e.conditions)}`);
-        return false;
-    }
-    else if ((readyCondition === null || readyCondition === void 0 ? void 0 : readyCondition.status) === "True") {
-        return true;
-    }
-    logger_1.logger.debug(`Service ${service.metadata.name} has unexpected ready status ${JSON.stringify(readyCondition)}. It may have failed rollout.`);
-    throw new error_1.FirebaseError(`Unexpected Status ${readyCondition === null || readyCondition === void 0 ? void 0 : readyCondition.status} for service ${service.metadata.name}`);
-}
-exports.serviceIsResolved = serviceIsResolved;

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

@@ -201,7 +201,7 @@ function createFirebaseEndpoints(emulator) {
             }
             return res.status(200).json(new metadata_1.OutgoingFirebaseMetadata(metadata));
         }
-        if (uploadType === "resumable") {
+        if (uploadType === "resumable" || req.header("x-goog-upload-command")) {
             const uploadCommand = req.header("x-goog-upload-command");
             if (!uploadCommand) {
                 res.sendStatus(400);

package/lib/functions/projectConfig.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configForCodebase = exports.normalizeAndValidate = exports.validate = exports.normalize = exports.DEFAULT_CODEBASE = void 0;
+exports.configForCodebase = exports.normalizeAndValidate = exports.validate = exports.assertUnique = exports.validateCodebase = exports.normalize = exports.DEFAULT_CODEBASE = void 0;
 const error_1 = require("../error");
 exports.DEFAULT_CODEBASE = "default";
 function normalize(config) {
@@ -16,6 +16,13 @@ function normalize(config) {
     return [config];
 }
 exports.normalize = normalize;
+function validateCodebase(codebase) {
+    if (codebase.length === 0 || codebase.length > 63 || !/^[a-z0-9_-]+$/.test(codebase)) {
+        throw new error_1.FirebaseError("Invalid codebase name. Codebase must be less than 64 characters and " +
+            "can contain only lowercase letters, numeric characters, underscores, and dashes.");
+    }
+}
+exports.validateCodebase = validateCodebase;
 function validateSingle(config) {
     if (!config.source) {
         throw new error_1.FirebaseError("functions.source must be specified");
@@ -23,14 +30,14 @@ function validateSingle(config) {
     if (!config.codebase) {
         config.codebase = exports.DEFAULT_CODEBASE;
     }
-    if (config.codebase.length > 63 || !/^[a-z0-9_-]+$/.test(config.codebase)) {
-        throw new error_1.FirebaseError("Invalid codebase name. Codebase must be less than 63 characters and " +
-            "can contain only lowercase letters, numeric characters, underscores, and dashes.");
-    }
+    validateCodebase(config.codebase);
     return Object.assign(Object.assign({}, config), { source: config.source, codebase: config.codebase });
 }
-function assertUnique(config, property) {
+function assertUnique(config, property, propval) {
     const values = new Set();
+    if (propval) {
+        values.add(propval);
+    }
     for (const single of config) {
         const value = single[property];
         if (values.has(value)) {
@@ -39,6 +46,7 @@ function assertUnique(config, property) {
         values.add(value);
     }
 }
+exports.assertUnique = assertUnique;
 function validate(config) {
     const validated = config.map((cfg) => validateSingle(cfg));
     assertUnique(validated, "source");

package/lib/gcp/run.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setInvokerUpdate = exports.setInvokerCreate = exports.getIamPolicy = exports.setIamPolicy = exports.replaceService = exports.getService = exports.LOCATION_LABEL = void 0;
+exports.setInvokerUpdate = exports.setInvokerCreate = exports.getIamPolicy = exports.setIamPolicy = exports.replaceService = exports.serviceIsResolved = exports.updateService = exports.getService = exports.LOCATION_LABEL = void 0;
 const apiv2_1 = require("../apiv2");
 const error_1 = require("../error");
 const api_1 = require("../api");
 const proto = require("./proto");
+const throttler_1 = require("../throttler/throttler");
+const logger_1 = require("../logger");
 const API_VERSION = "v1";
 const client = new apiv2_1.Client({
     urlPrefix: api_1.runOrigin,
@@ -24,13 +26,49 @@ async function getService(name) {
     }
 }
 exports.getService = getService;
+async function updateService(name, service) {
+    delete service.status;
+    delete service.spec.template.metadata.name;
+    service = await exports.replaceService(name, service);
+    let retry = 0;
+    while (!exports.serviceIsResolved(service)) {
+        await (0, throttler_1.backoff)(retry, 2, 30);
+        retry = retry + 1;
+        service = await exports.getService(name);
+    }
+    return service;
+}
+exports.updateService = updateService;
+function serviceIsResolved(service) {
+    var _a, _b, _c, _d, _e;
+    if (((_a = service.status) === null || _a === void 0 ? void 0 : _a.observedGeneration) !== service.metadata.generation) {
+        logger_1.logger.debug(`Service ${service.metadata.name} is not resolved because` +
+            `observed generation ${(_b = service.status) === null || _b === void 0 ? void 0 : _b.observedGeneration} does not ` +
+            `match spec generation ${service.metadata.generation}`);
+        return false;
+    }
+    const readyCondition = (_d = (_c = service.status) === null || _c === void 0 ? void 0 : _c.conditions) === null || _d === void 0 ? void 0 : _d.find((condition) => {
+        return condition.type === "Ready";
+    });
+    if ((readyCondition === null || readyCondition === void 0 ? void 0 : readyCondition.status) === "Unknown") {
+        logger_1.logger.debug(`Waiting for service ${service.metadata.name} to be ready. ` +
+            `Status is ${JSON.stringify((_e = service.status) === null || _e === void 0 ? void 0 : _e.conditions)}`);
+        return false;
+    }
+    else if ((readyCondition === null || readyCondition === void 0 ? void 0 : readyCondition.status) === "True") {
+        return true;
+    }
+    logger_1.logger.debug(`Service ${service.metadata.name} has unexpected ready status ${JSON.stringify(readyCondition)}. It may have failed rollout.`);
+    throw new error_1.FirebaseError(`Unexpected Status ${readyCondition === null || readyCondition === void 0 ? void 0 : readyCondition.status} for service ${service.metadata.name}`);
+}
+exports.serviceIsResolved = serviceIsResolved;
 async function replaceService(name, service) {
     try {
         const response = await client.put(name, service);
         return response.body;
     }
     catch (err) {
-        throw new error_1.FirebaseError(`Failed to update Run service ${name}`, {
+        throw new error_1.FirebaseError(`Failed to replace Run service ${name}`, {
             original: err,
         });
     }

package/lib/init/features/functions/index.js

@@ -2,19 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.doSetup = void 0;
 const clc = require("colorette");
-const _ = require("lodash");
 const logger_1 = require("../../../logger");
 const prompt_1 = require("../../../prompt");
 const requirePermissions_1 = require("../../../requirePermissions");
 const previews_1 = require("../../../previews");
 const ensureApiEnabled_1 = require("../../../ensureApiEnabled");
+const projectConfig_1 = require("../../../functions/projectConfig");
+const error_1 = require("../../../error");
+const MAX_ATTEMPTS = 5;
 async function doSetup(setup, config, options) {
     var _a, _b;
-    logger_1.logger.info();
-    logger_1.logger.info("A " + clc.bold("functions") + " directory will be created in your project with sample code");
-    logger_1.logger.info("pre-configured. Functions can be deployed with " + clc.bold("firebase deploy") + ".");
-    logger_1.logger.info();
-    setup.functions = {};
     const projectId = (_b = (_a = setup === null || setup === void 0 ? void 0 : setup.rcfile) === null || _a === void 0 ? void 0 : _a.projects) === null || _b === void 0 ? void 0 : _b.default;
     if (projectId) {
         await (0, requirePermissions_1.requirePermissions)(Object.assign(Object.assign({}, options), { project: projectId }));
@@ -23,6 +20,116 @@ async function doSetup(setup, config, options) {
             (0, ensureApiEnabled_1.ensure)(projectId, "runtimeconfig.googleapis.com", "unused", true),
         ]);
     }
+    setup.functions = {};
+    if (!config.src.functions) {
+        setup.config.functions = [];
+        return initNewCodebase(setup, config);
+    }
+    const codebases = setup.config.functions.map((cfg) => clc.bold(cfg.codebase));
+    logger_1.logger.info(`\nDetected existing codebase(s): ${codebases.join(", ")}\n`);
+    setup.config.functions = (0, projectConfig_1.normalizeAndValidate)(setup.config.functions);
+    const choices = [
+        {
+            name: "Initialize",
+            value: "new",
+        },
+        {
+            name: "Overwrite",
+            value: "overwrite",
+        },
+    ];
+    const initOpt = await (0, prompt_1.promptOnce)({
+        type: "list",
+        message: "Would you like to initialize a new codebase, or overwrite an existing one?",
+        default: "new",
+        choices,
+    });
+    return initOpt === "new" ? initNewCodebase(setup, config) : overwriteCodebase(setup, config);
+}
+exports.doSetup = doSetup;
+async function initNewCodebase(setup, config) {
+    logger_1.logger.info("Let's create a new codebase for your functions.");
+    logger_1.logger.info("A directory corresponding to the codebase will be created in your project");
+    logger_1.logger.info("with sample code pre-configured.\n");
+    logger_1.logger.info("See https://firebase.google.com/docs/functions/organize-functions for");
+    logger_1.logger.info("more information on organizing your functions using codebases.\n");
+    logger_1.logger.info(`Functions can be deployed with ${clc.bold("firebase deploy")}.\n`);
+    let source;
+    let codebase;
+    if (setup.config.functions.length === 0) {
+        source = "functions";
+        codebase = "default";
+    }
+    else {
+        let attempts = 0;
+        while (true) {
+            if (attempts++ >= MAX_ATTEMPTS) {
+                throw new error_1.FirebaseError("Exceeded max number of attempts to input valid codebase name. Please restart.");
+            }
+            codebase = await (0, prompt_1.promptOnce)({
+                type: "input",
+                message: "What should be the name of this codebase?",
+            });
+            try {
+                (0, projectConfig_1.validateCodebase)(codebase);
+                (0, projectConfig_1.assertUnique)(setup.config.functions, "codebase", codebase);
+                break;
+            }
+            catch (err) {
+                logger_1.logger.error(err);
+            }
+        }
+        attempts = 0;
+        while (true) {
+            if (attempts >= MAX_ATTEMPTS) {
+                throw new error_1.FirebaseError("Exceeded max number of attempts to input valid source. Please restart.");
+            }
+            attempts++;
+            source = await (0, prompt_1.promptOnce)({
+                type: "input",
+                message: `In what sub-directory would you like to initialize your functions for codebase ${clc.bold(codebase)}?`,
+                default: codebase,
+            });
+            try {
+                (0, projectConfig_1.assertUnique)(setup.config.functions, "source", source);
+                break;
+            }
+            catch (err) {
+                logger_1.logger.error(err);
+            }
+        }
+    }
+    setup.config.functions.push({
+        source,
+        codebase,
+    });
+    setup.functions.source = source;
+    setup.functions.codebase = codebase;
+    return languageSetup(setup, config);
+}
+async function overwriteCodebase(setup, config) {
+    let codebase;
+    if (setup.config.functions.length > 1) {
+        const choices = setup.config.functions.map((cfg) => ({
+            name: cfg["codebase"],
+            value: cfg["codebase"],
+        }));
+        codebase = await (0, prompt_1.promptOnce)({
+            type: "list",
+            message: "Which codebase would you like to overwrite?",
+            choices,
+        });
+    }
+    else {
+        codebase = setup.config.functions[0].codebase;
+    }
+    const cbconfig = (0, projectConfig_1.configForCodebase)(setup.config.functions, codebase);
+    setup.functions.source = cbconfig.source;
+    setup.functions.codebase = cbconfig.codebase;
+    logger_1.logger.info(`\nOverwriting ${clc.bold(`codebase ${codebase}...\n`)}`);
+    return languageSetup(setup, config);
+}
+async function languageSetup(setup, config) {
     const choices = [
         {
             name: "JavaScript",
@@ -45,12 +152,14 @@ async function doSetup(setup, config, options) {
         default: "javascript",
         choices,
     });
-    _.set(setup, "config.functions.ignore", [
-        "node_modules",
-        ".git",
-        "firebase-debug.log",
-        "firebase-debug.*.log",
-    ]);
+    const cbconfig = (0, projectConfig_1.configForCodebase)(setup.config.functions, setup.functions.codebase);
+    switch (language) {
+        case "javascript":
+            cbconfig.ignore = ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log"];
+            break;
+        case "typescript":
+            cbconfig.ignore = ["node_modules", ".git", "firebase-debug.log", "firebase-debug.*.log"];
+            break;
+    }
     return require("./" + language).setup(setup, config);
 }
-exports.doSetup = doSetup;

package/lib/init/features/functions/javascript.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setup = void 0;
-const _ = require("lodash");
 const fs = require("fs");
 const path = require("path");
 const npm_dependencies_1 = require("./npm-dependencies");
 const prompt_1 = require("../../../prompt");
+const projectConfig_1 = require("../../../functions/projectConfig");
 const TEMPLATE_ROOT = path.resolve(__dirname, "../../../../templates/init/functions/javascript/");
 const INDEX_TEMPLATE = fs.readFileSync(path.join(TEMPLATE_ROOT, "index.js"), "utf8");
 const PACKAGE_LINTING_TEMPLATE = fs.readFileSync(path.join(TEMPLATE_ROOT, "package.lint.json"), "utf8");
@@ -23,20 +23,21 @@ function setup(setup, config) {
     ])
         .then(() => {
         if (setup.functions.lint) {
-            _.set(setup, "config.functions.predeploy", ['npm --prefix "$RESOURCE_DIR" run lint']);
+            const cbconfig = (0, projectConfig_1.configForCodebase)(setup.config.functions, setup.functions.codebase);
+            cbconfig.predeploy = ['npm --prefix "$RESOURCE_DIR" run lint'];
             return config
-                .askWriteProjectFile("functions/package.json", PACKAGE_LINTING_TEMPLATE)
+                .askWriteProjectFile(`${setup.functions.source}/package.json`, PACKAGE_LINTING_TEMPLATE)
                 .then(() => {
-                config.askWriteProjectFile("functions/.eslintrc.js", ESLINT_TEMPLATE);
+                config.askWriteProjectFile(`${setup.functions.source}/.eslintrc.js`, ESLINT_TEMPLATE);
             });
         }
-        return config.askWriteProjectFile("functions/package.json", PACKAGE_NO_LINTING_TEMPLATE);
+        return config.askWriteProjectFile(`${setup.functions.source}/package.json`, PACKAGE_NO_LINTING_TEMPLATE);
     })
         .then(() => {
-        return config.askWriteProjectFile("functions/index.js", INDEX_TEMPLATE);
+        return config.askWriteProjectFile(`${setup.functions.source}/index.js`, INDEX_TEMPLATE);
     })
         .then(() => {
-        return config.askWriteProjectFile("functions/.gitignore", GITIGNORE_TEMPLATE);
+        return config.askWriteProjectFile(`${setup.functions.source}/.gitignore`, GITIGNORE_TEMPLATE);
     })
         .then(() => {
         return (0, npm_dependencies_1.askInstallDependencies)(setup.functions, config);

package/lib/init/features/functions/npm-dependencies.js

@@ -16,7 +16,7 @@ function askInstallDependencies(setup, config) {
         if (setup.npm) {
             return new Promise((resolve) => {
                 const installer = spawn("npm", ["install"], {
-                    cwd: config.projectDir + "/functions",
+                    cwd: config.projectDir + `/${setup.source}`,
                     stdio: "inherit",
                 });
                 installer.on("error", (err) => {

package/lib/init/features/functions/typescript.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setup = void 0;
-const _ = require("lodash");
 const fs = require("fs");
 const path = require("path");
 const npm_dependencies_1 = require("./npm-dependencies");
 const prompt_1 = require("../../../prompt");
+const projectConfig_1 = require("../../../functions/projectConfig");
 const TEMPLATE_ROOT = path.resolve(__dirname, "../../../../templates/init/functions/typescript/");
 const PACKAGE_LINTING_TEMPLATE = fs.readFileSync(path.join(TEMPLATE_ROOT, "package.lint.json"), "utf8");
 const PACKAGE_NO_LINTING_TEMPLATE = fs.readFileSync(path.join(TEMPLATE_ROOT, "package.nolint.json"), "utf8");
@@ -24,33 +24,35 @@ function setup(setup, config) {
         },
     ])
         .then(() => {
+        const cbconfig = (0, projectConfig_1.configForCodebase)(setup.config.functions, setup.functions.codebase);
+        cbconfig.predeploy = [];
         if (setup.functions.lint) {
-            _.set(setup, "config.functions.predeploy", [
-                'npm --prefix "$RESOURCE_DIR" run lint',
-                'npm --prefix "$RESOURCE_DIR" run build',
-            ]);
+            cbconfig.predeploy.push('npm --prefix "$RESOURCE_DIR" run lint');
+            cbconfig.predeploy.push('npm --prefix "$RESOURCE_DIR" run build');
             return config
-                .askWriteProjectFile("functions/package.json", PACKAGE_LINTING_TEMPLATE)
+                .askWriteProjectFile(`${setup.functions.source}/package.json`, PACKAGE_LINTING_TEMPLATE)
                 .then(() => {
-                return config.askWriteProjectFile("functions/.eslintrc.js", ESLINT_TEMPLATE);
+                return config.askWriteProjectFile(`${setup.functions.source}/.eslintrc.js`, ESLINT_TEMPLATE);
             });
         }
-        _.set(setup, "config.functions.predeploy", 'npm --prefix "$RESOURCE_DIR" run build');
-        return config.askWriteProjectFile("functions/package.json", PACKAGE_NO_LINTING_TEMPLATE);
+        else {
+            cbconfig.predeploy.push('npm --prefix "$RESOURCE_DIR" run build');
+        }
+        return config.askWriteProjectFile(`${setup.functions.source}/package.json`, PACKAGE_NO_LINTING_TEMPLATE);
     })
         .then(() => {
-        return config.askWriteProjectFile("functions/tsconfig.json", TSCONFIG_TEMPLATE);
+        return config.askWriteProjectFile(`${setup.functions.source}/tsconfig.json`, TSCONFIG_TEMPLATE);
     })
         .then(() => {
         if (setup.functions.lint) {
-            return config.askWriteProjectFile("functions/tsconfig.dev.json", TSCONFIG_DEV_TEMPLATE);
+            return config.askWriteProjectFile(`${setup.functions.source}/tsconfig.dev.json`, TSCONFIG_DEV_TEMPLATE);
         }
     })
         .then(() => {
-        return config.askWriteProjectFile("functions/src/index.ts", INDEX_TEMPLATE);
+        return config.askWriteProjectFile(`${setup.functions.source}/src/index.ts`, INDEX_TEMPLATE);
     })
         .then(() => {
-        return config.askWriteProjectFile("functions/.gitignore", GITIGNORE_TEMPLATE);
+        return config.askWriteProjectFile(`${setup.functions.source}/.gitignore`, GITIGNORE_TEMPLATE);
     })
         .then(() => {
         return (0, npm_dependencies_1.askInstallDependencies)(setup.functions, config);