firebase-tools 10.3.1 → 10.4.2

package/lib/extensions/paramHelper.js

@@ -57,14 +57,19 @@ async function getParams(args) {
     }
     else if (args.paramsEnvPath) {
         params = getParamsFromFile({
-            projectId: args.projectId,
             paramSpecs: args.paramSpecs,
             paramsEnvPath: args.paramsEnvPath,
         });
     }
     else {
         const firebaseProjectParams = await (0, extensionsHelper_1.getFirebaseProjectParams)(args.projectId);
-        params = await askUserForParam.ask(args.projectId, args.instanceId, args.paramSpecs, firebaseProjectParams, !!args.reconfiguring);
+        params = await askUserForParam.ask({
+            projectId: args.projectId,
+            instanceId: args.instanceId,
+            paramSpecs: args.paramSpecs,
+            firebaseProjectParams,
+            reconfiguring: !!args.reconfiguring,
+        });
     }
     void track("Extension Params", _.isEmpty(params) ? "Not Present" : "Present", _.size(params));
     return params;
@@ -85,7 +90,6 @@ async function getParamsForUpdate(args) {
     }
     else if (args.paramsEnvPath) {
         params = getParamsFromFile({
-            projectId: args.projectId,
             paramSpecs: args.newSpec.params,
             paramsEnvPath: args.paramsEnvPath,
         });
@@ -104,6 +108,7 @@ async function getParamsForUpdate(args) {
 }
 exports.getParamsForUpdate = getParamsForUpdate;
 async function promptForNewParams(args) {
+    const newParamBindingOptions = buildBindingOptionsWithBaseValue(args.currentParams);
     const firebaseProjectParams = await (0, extensionsHelper_1.getFirebaseProjectParams)(args.projectId);
     const comparer = (param1, param2) => {
         return param1.type === param2.type && param1.param === param2.param;
@@ -117,7 +122,7 @@ async function promptForNewParams(args) {
         logger_1.logger.info("The following params will no longer be used:");
         paramsDiffDeletions.forEach((param) => {
             logger_1.logger.info(clc.red(`- ${param.param}: ${args.currentParams[param.param.toUpperCase()]}`));
-            delete args.currentParams[param.param.toUpperCase()];
+            delete newParamBindingOptions[param.param.toUpperCase()];
         });
     }
     if (paramsDiffAdditions.length) {
@@ -129,10 +134,10 @@ async function promptForNewParams(args) {
                 paramSpec: param,
                 reconfiguring: false,
             });
-            args.currentParams[param.param] = chosenValue.baseValue;
+            newParamBindingOptions[param.param] = chosenValue;
         }
     }
-    return buildBindingOptionsWithBaseValue(args.currentParams);
+    return newParamBindingOptions;
 }
 exports.promptForNewParams = promptForNewParams;
 function getParamsFromFile(args) {

package/lib/fsutils.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dirExistsSync = exports.fileExistsSync = void 0;
+exports.readFile = exports.dirExistsSync = exports.fileExistsSync = void 0;
 const fs_1 = require("fs");
+const error_1 = require("./error");
 function fileExistsSync(path) {
     try {
         return (0, fs_1.statSync)(path).isFile();
@@ -20,3 +21,15 @@ function dirExistsSync(path) {
     }
 }
 exports.dirExistsSync = dirExistsSync;
+function readFile(path) {
+    try {
+        return (0, fs_1.readFileSync)(path).toString();
+    }
+    catch (e) {
+        if (e.code === "ENOENT") {
+            throw new error_1.FirebaseError(`File not found: ${path}`);
+        }
+        throw e;
+    }
+}
+exports.readFile = readFile;

package/lib/functions/projectConfig.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeAndValidate = exports.validate = exports.normalize = void 0;
+const error_1 = require("../error");
+function normalize(config) {
+    if (!config) {
+        throw new error_1.FirebaseError("No valid functions configuration detected in firebase.json");
+    }
+    if (Array.isArray(config)) {
+        if (config.length < 1) {
+            throw new error_1.FirebaseError("Requires at least one functions.source in firebase.json.");
+        }
+        return config;
+    }
+    return [config];
+}
+exports.normalize = normalize;
+function validateSingle(config) {
+    if (!config.source) {
+        throw new error_1.FirebaseError("functions.source must be specified");
+    }
+    return Object.assign(Object.assign({}, config), { source: config.source });
+}
+function validate(config) {
+    if (config.length > 1) {
+        throw new error_1.FirebaseError("More than one functions.source detected in firebase.json.");
+    }
+    return [validateSingle(config[0])];
+}
+exports.validate = validate;
+function normalizeAndValidate(config) {
+    return validate(normalize(config));
+}
+exports.normalizeAndValidate = normalizeAndValidate;

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

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.doSetup = void 0;
 const clc = require("cli-color");
 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");
-module.exports = async function (setup, config, options) {
+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");
@@ -44,4 +45,5 @@ module.exports = async function (setup, config, options) {
         choices,
     });
     return require("./" + language)(setup, config);
-};
+}
+exports.doSetup = doSetup;

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

@@ -1,23 +1,23 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.doSetup = void 0;
 const clc = require("cli-color");
 const fs = require("fs");
-const { Client } = require("../../../apiv2");
-const { initGitHub } = require("./github");
-const { prompt } = require("../../../prompt");
-const { logger } = require("../../../logger");
+const apiv2_1 = require("../../../apiv2");
+const github_1 = require("./github");
+const prompt_1 = require("../../../prompt");
+const logger_1 = require("../../../logger");
 const INDEX_TEMPLATE = fs.readFileSync(__dirname + "/../../../../templates/init/hosting/index.html", "utf8");
 const MISSING_TEMPLATE = fs.readFileSync(__dirname + "/../../../../templates/init/hosting/404.html", "utf8");
 const DEFAULT_IGNORES = ["firebase.json", "**/.*", "**/node_modules/**"];
-module.exports = function (setup, config, options) {
+async function doSetup(setup, config, options) {
     setup.hosting = {};
-    logger.info();
-    logger.info("Your " +
-        clc.bold("public") +
-        " directory is the folder (relative to your project directory) that");
-    logger.info("will contain Hosting assets to be uploaded with " + clc.bold("firebase deploy") + ". If you");
-    logger.info("have a build process for your assets, use your build's output directory.");
-    logger.info();
-    return prompt(setup.hosting, [
+    logger_1.logger.info();
+    logger_1.logger.info(`Your ${clc.bold("public")} directory is the folder (relative to your project directory) that`);
+    logger_1.logger.info(`will contain Hosting assets to be uploaded with ${clc.bold("firebase deploy")}. If you`);
+    logger_1.logger.info("have a build process for your assets, use your build's output directory.");
+    logger_1.logger.info();
+    await (0, prompt_1.prompt)(setup.hosting, [
         {
             name: "public",
             type: "input",
@@ -36,31 +36,22 @@ module.exports = function (setup, config, options) {
             default: false,
             message: "Set up automatic builds and deploys with GitHub?",
         },
-    ]).then(function () {
-        setup.config.hosting = {
-            public: setup.hosting.public,
-            ignore: DEFAULT_IGNORES,
-        };
-        let next;
-        if (setup.hosting.spa) {
-            setup.config.hosting.rewrites = [{ source: "**", destination: "/index.html" }];
-            next = Promise.resolve();
-        }
-        else {
-            next = config.askWriteProjectFile(setup.hosting.public + "/404.html", MISSING_TEMPLATE);
-        }
-        return next
-            .then(() => {
-            const c = new Client({ urlPrefix: "https://www.gstatic.com", auth: false });
-            return c.get("/firebasejs/releases.json");
-        })
-            .then((response) => {
-            return config.askWriteProjectFile(setup.hosting.public + "/index.html", INDEX_TEMPLATE.replace(/{{VERSION}}/g, response.body.current.version));
-        })
-            .then(() => {
-            if (setup.hosting.github) {
-                return initGitHub(setup, config, options);
-            }
-        });
-    });
-};
+    ]);
+    setup.config.hosting = {
+        public: setup.hosting.public,
+        ignore: DEFAULT_IGNORES,
+    };
+    if (setup.hosting.spa) {
+        setup.config.hosting.rewrites = [{ source: "**", destination: "/index.html" }];
+    }
+    else {
+        await config.askWriteProjectFile(`${setup.hosting.public}/404.html`, MISSING_TEMPLATE);
+    }
+    const c = new apiv2_1.Client({ urlPrefix: "https://www.gstatic.com", auth: false });
+    const response = await c.get("/firebasejs/releases.json");
+    await config.askWriteProjectFile(`${setup.hosting.public}/index.html`, INDEX_TEMPLATE.replace(/{{VERSION}}/g, response.body.current.version));
+    if (setup.hosting.github) {
+        return (0, github_1.initGitHub)(setup, config, options);
+    }
+}
+exports.doSetup = doSetup;

package/lib/init/features/index.js

@@ -1,13 +1,23 @@
 "use strict";
-module.exports = {
-    account: require("./account").doSetup,
-    database: require("./database").doSetup,
-    firestore: require("./firestore").doSetup,
-    functions: require("./functions"),
-    hosting: require("./hosting"),
-    storage: require("./storage").doSetup,
-    emulators: require("./emulators").doSetup,
-    project: require("./project").doSetup,
-    remoteconfig: require("./remoteconfig").doSetup,
-    "hosting:github": require("./hosting/github").initGitHub,
-};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hostingGithub = exports.remoteconfig = exports.project = exports.emulators = exports.storage = exports.hosting = exports.functions = exports.firestore = exports.database = exports.account = void 0;
+var account_1 = require("./account");
+Object.defineProperty(exports, "account", { enumerable: true, get: function () { return account_1.doSetup; } });
+var database_1 = require("./database");
+Object.defineProperty(exports, "database", { enumerable: true, get: function () { return database_1.doSetup; } });
+var firestore_1 = require("./firestore");
+Object.defineProperty(exports, "firestore", { enumerable: true, get: function () { return firestore_1.doSetup; } });
+var functions_1 = require("./functions");
+Object.defineProperty(exports, "functions", { enumerable: true, get: function () { return functions_1.doSetup; } });
+var hosting_1 = require("./hosting");
+Object.defineProperty(exports, "hosting", { enumerable: true, get: function () { return hosting_1.doSetup; } });
+var storage_1 = require("./storage");
+Object.defineProperty(exports, "storage", { enumerable: true, get: function () { return storage_1.doSetup; } });
+var emulators_1 = require("./emulators");
+Object.defineProperty(exports, "emulators", { enumerable: true, get: function () { return emulators_1.doSetup; } });
+var project_1 = require("./project");
+Object.defineProperty(exports, "project", { enumerable: true, get: function () { return project_1.doSetup; } });
+var remoteconfig_1 = require("./remoteconfig");
+Object.defineProperty(exports, "remoteconfig", { enumerable: true, get: function () { return remoteconfig_1.doSetup; } });
+var github_1 = require("./hosting/github");
+Object.defineProperty(exports, "hostingGithub", { enumerable: true, get: function () { return github_1.initGitHub; } });

package/lib/init/index.js

@@ -1,22 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = void 0;
-const _ = require("lodash");
+const lodash_1 = require("lodash");
 const clc = require("cli-color");
+const error_1 = require("../error");
 const logger_1 = require("../logger");
-const _features = require("./features");
-const utils = require("../utils");
-const features = _features;
+const features = require("./features");
+const featureFns = new Map([
+    ["account", features.account],
+    ["database", features.database],
+    ["firestore", features.firestore],
+    ["functions", features.functions],
+    ["hosting", features.hosting],
+    ["storage", features.storage],
+    ["emulators", features.emulators],
+    ["project", features.project],
+    ["remoteconfig", features.remoteconfig],
+    ["hosting:github", features.hostingGithub],
+]);
 async function init(setup, config, options) {
-    const nextFeature = setup.features ? setup.features.shift() : undefined;
+    var _a;
+    const nextFeature = (_a = setup.features) === null || _a === void 0 ? void 0 : _a.shift();
     if (nextFeature) {
-        if (!features[nextFeature]) {
-            return utils.reject(clc.bold(nextFeature) +
-                " is not a valid feature. Must be one of " +
-                _.without(_.keys(features), "project").join(", "));
+        if (!featureFns.has(nextFeature)) {
+            const availableFeatures = Object.keys(features)
+                .filter((f) => f !== "project")
+                .join(", ");
+            throw new error_1.FirebaseError(`${clc.bold(nextFeature)} is not a valid feature. Must be one of ${availableFeatures}`);
         }
-        logger_1.logger.info(clc.bold("\n" + clc.white("=== ") + _.capitalize(nextFeature) + " Setup"));
-        await Promise.resolve(features[nextFeature](setup, config, options));
+        logger_1.logger.info(clc.bold(`\n${clc.white("===")} ${(0, lodash_1.capitalize)(nextFeature)} Setup`));
+        const fn = featureFns.get(nextFeature);
+        if (!fn) {
+            throw new error_1.FirebaseError(`We've lost the function to init ${nextFeature}`, { exit: 2 });
+        }
+        await fn(setup, config, options);
         return init(setup, config, options);
     }
 }

package/lib/requireConfig.js

@@ -1,11 +1,13 @@
 "use strict";
-var { FirebaseError } = require("./error");
-module.exports = function (options) {
-    if (options.config) {
-        return Promise.resolve();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireConfig = void 0;
+const error_1 = require("./error");
+async function requireConfig(options) {
+    await Promise.resolve();
+    if (!options.config) {
+        throw options.configError
+            ? options.configError
+            : new error_1.FirebaseError("Not in a Firebase project directory (could not locate firebase.json)");
     }
-    return Promise.reject(options.configError ||
-        new FirebaseError("Not in a Firebase project directory (could not locate firebase.json)", {
-            exit: 1,
-        }));
-};
+}
+exports.requireConfig = requireConfig;

package/lib/requirePermissions.js

@@ -9,7 +9,10 @@ const error_1 = require("./error");
 const iam_1 = require("./gcp/iam");
 const BASE_PERMISSIONS = ["firebase.projects.get"];
 async function requirePermissions(options, permissions = []) {
-    const projectId = (0, projectUtils_1.needProjectId)(options);
+    const projectId = (0, projectUtils_1.getProjectId)(options);
+    if (!projectId) {
+        return;
+    }
     const requiredPermissions = BASE_PERMISSIONS.concat(permissions).sort();
     await (0, requireAuth_1.requireAuth)(options);
     logger_1.logger.debug(`[iam] checking project ${projectId} for permissions ${JSON.stringify(requiredPermissions)}`);

package/lib/serve/functions.js

@@ -7,6 +7,7 @@ const emulatorServer_1 = require("../emulator/emulatorServer");
 const functionsEmulatorUtils_1 = require("../emulator/functionsEmulatorUtils");
 const projectUtils_1 = require("../projectUtils");
 const auth_1 = require("../auth");
+const projectConfig = require("../functions/projectConfig");
 const utils = require("../utils");
 class FunctionsServer {
     constructor() {
@@ -20,11 +21,10 @@ class FunctionsServer {
     }
     async start(options, partialArgs) {
         const projectId = (0, projectUtils_1.needProjectId)(options);
-        utils.assertDefined(options.config.src.functions);
-        utils.assertDefined(options.config.src.functions.source, "Error: 'functions.source' is not defined");
-        const functionsDir = path.join(options.config.projectDir, options.config.src.functions.source);
+        const config = projectConfig.normalizeAndValidate(options.config.src.functions)[0];
+        const functionsDir = path.join(options.config.projectDir, config.source);
         const account = (0, auth_1.getProjectDefaultAccount)(options.config.projectDir);
-        const nodeMajorVersion = (0, functionsEmulatorUtils_1.parseRuntimeVersion)(options.config.get("functions.runtime"));
+        const nodeMajorVersion = (0, functionsEmulatorUtils_1.parseRuntimeVersion)(config.runtime);
         this.backend = {
             functionsDir,
             nodeMajorVersion,
@@ -40,7 +40,7 @@ class FunctionsServer {
             utils.assertIsNumber(options.port);
             const targets = options.targets;
             const port = options.port;
-            const hostingRunning = targets && targets.indexOf("hosting") >= 0;
+            const hostingRunning = targets && targets.includes("hosting");
             if (hostingRunning) {
                 args.port = port + 1;
             }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "firebase-tools",
-  "version": "10.3.1",
+  "version": "10.4.2",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "firebase-tools",
-      "version": "10.3.1",
+      "version": "10.4.2",
       "license": "MIT",
       "dependencies": {
         "@google-cloud/pubsub": "^2.18.4",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-tools",
-  "version": "10.3.1",
+  "version": "10.4.2",
   "description": "Command-Line Interface for Firebase",
   "main": "./lib/index.js",
   "bin": {

package/schema/firebase-config.json

@@ -326,54 +326,111 @@
             "type": "object"
         },
         "functions": {
-            "additionalProperties": false,
-            "properties": {
-                "ignore": {
-                    "items": {
-                        "type": "string"
-                    },
-                    "type": "array"
-                },
-                "postdeploy": {
-                    "anyOf": [
-                        {
+            "anyOf": [
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "ignore": {
                             "items": {
                                 "type": "string"
                             },
                             "type": "array"
                         },
-                        {
+                        "postdeploy": {
+                            "anyOf": [
+                                {
+                                    "items": {
+                                        "type": "string"
+                                    },
+                                    "type": "array"
+                                },
+                                {
+                                    "type": "string"
+                                }
+                            ]
+                        },
+                        "predeploy": {
+                            "anyOf": [
+                                {
+                                    "items": {
+                                        "type": "string"
+                                    },
+                                    "type": "array"
+                                },
+                                {
+                                    "type": "string"
+                                }
+                            ]
+                        },
+                        "runtime": {
+                            "enum": [
+                                "nodejs10",
+                                "nodejs12",
+                                "nodejs14",
+                                "nodejs16"
+                            ],
+                            "type": "string"
+                        },
+                        "source": {
                             "type": "string"
                         }
-                    ]
+                    },
+                    "type": "object"
                 },
-                "predeploy": {
-                    "anyOf": [
-                        {
-                            "items": {
+                {
+                    "items": {
+                        "additionalProperties": false,
+                        "properties": {
+                            "ignore": {
+                                "items": {
+                                    "type": "string"
+                                },
+                                "type": "array"
+                            },
+                            "postdeploy": {
+                                "anyOf": [
+                                    {
+                                        "items": {
+                                            "type": "string"
+                                        },
+                                        "type": "array"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "predeploy": {
+                                "anyOf": [
+                                    {
+                                        "items": {
+                                            "type": "string"
+                                        },
+                                        "type": "array"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "runtime": {
+                                "enum": [
+                                    "nodejs10",
+                                    "nodejs12",
+                                    "nodejs14",
+                                    "nodejs16"
+                                ],
                                 "type": "string"
                             },
-                            "type": "array"
+                            "source": {
+                                "type": "string"
+                            }
                         },
-                        {
-                            "type": "string"
-                        }
-                    ]
-                },
-                "runtime": {
-                    "enum": [
-                        "nodejs10",
-                        "nodejs12",
-                        "nodejs14",
-                        "nodejs16"
-                    ],
-                    "type": "string"
-                },
-                "source": {
-                    "type": "string"
+                        "type": "object"
+                    },
+                    "type": "array"
                 }
-            },
-            "type": "object"
+            ]
         },
         "hosting": {
             "anyOf": [

package/lib/prepareUpload.js

@@ -1,44 +0,0 @@
-"use strict";
-var fs = require("fs");
-var path = require("path");
-var tar = require("tar");
-var tmp = require("tmp");
-var { listFiles } = require("./listFiles");
-var { FirebaseError } = require("./error");
-var fsutils = require("./fsutils");
-module.exports = function (options) {
-    var hostingConfig = options.config.get("hosting");
-    var publicDir = options.config.path(hostingConfig.public);
-    var indexPath = path.join(publicDir, "index.html");
-    var tmpFile = tmp.fileSync({
-        prefix: "firebase-upload-",
-        postfix: ".tar.gz",
-    });
-    var manifest = listFiles(publicDir, hostingConfig.ignore);
-    return tar
-        .c({
-        gzip: true,
-        file: tmpFile.name,
-        cwd: publicDir,
-        prefix: "public",
-        follow: true,
-        noDirRecurse: true,
-        portable: true,
-    }, manifest.slice(0))
-        .then(function () {
-        var stats = fs.statSync(tmpFile.name);
-        return {
-            file: tmpFile.name,
-            stream: fs.createReadStream(tmpFile.name),
-            manifest: manifest,
-            foundIndex: fsutils.fileExistsSync(indexPath),
-            size: stats.size,
-        };
-    })
-        .catch(function (err) {
-        return Promise.reject(new FirebaseError("There was an issue preparing Hosting files for upload.", {
-            original: err,
-            exit: 2,
-        }));
-    });
-};