firebase-tools 11.23.1 → 11.24.1

package/lib/commands/ext-dev-init.js

@@ -24,7 +24,7 @@ function readCommonTemplates() {
         extSpecTemplate: fs.readFileSync(path.join(TEMPLATE_ROOT, "extension.yaml"), "utf8"),
         preinstallTemplate: fs.readFileSync(path.join(TEMPLATE_ROOT, "PREINSTALL.md"), "utf8"),
         postinstallTemplate: fs.readFileSync(path.join(TEMPLATE_ROOT, "POSTINSTALL.md"), "utf8"),
-        changelogTemplate: fs.readFileSync(path.join(TEMPLATE_ROOT, "CHANGELOG.md"), "utf8"),
+        changelogTemplate: fs.readFileSync(path.join(TEMPLATE_ROOT, "CL-template.md"), "utf8"),
     };
 }
 exports.command = new command_1.Command("ext:dev:init")

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

@@ -93,7 +93,7 @@ class Delegate {
     }
     serveAdmin(port, config, envs) {
         var _a;
-        const env = Object.assign(Object.assign({}, envs), { PORT: port, FUNCTIONS_CONTROL_API: "true", HOME: process.env.HOME, PATH: process.env.PATH, NODE_ENV: process.env.NODE_ENV });
+        const env = Object.assign(Object.assign({}, envs), { PORT: port, FUNCTIONS_CONTROL_API: "true", HOME: process.env.HOME, PATH: process.env.PATH, NODE_ENV: process.env.NODE_ENV, __FIREBASE_FRAMEWORKS_ENTRY__: process.env.__FIREBASE_FRAMEWORKS_ENTRY__ });
         if (Object.keys(config || {}).length) {
             env.CLOUD_RUNTIME_CONFIG = JSON.stringify(config);
         }

package/lib/deploy/hosting/convertConfig.js

@@ -143,7 +143,13 @@ async function convertConfig(context, functionsPayload, deploy) {
             }
             return apiRewrite;
         }
-        (0, functional_1.assertExhaustive)(rewrite);
+        try {
+            (0, functional_1.assertExhaustive)(rewrite);
+        }
+        catch (e) {
+            throw new error_1.FirebaseError("Invalid hosting rewrite config in firebase.json. " +
+                "A rewrite config must specify 'destination', 'function', 'dynamicLinks', or 'run'");
+        }
     });
     if (config.rewrites) {
         const versionId = (0, utils_1.last)(deploy.version.split("/"));

package/lib/emulator/commandUtils.js

@@ -219,6 +219,13 @@ exports.shutdownWhenKilled = shutdownWhenKilled;
 async function runScript(script, extraEnv) {
     utils.logBullet(`Running script: ${clc.bold(script)}`);
     const env = Object.assign(Object.assign({}, process.env), extraEnv);
+    if (env.GCLOUD_PROJECT && !env.FIREBASE_CONFIG) {
+        env.FIREBASE_CONFIG = JSON.stringify({
+            projectId: env.GCLOUD_PROJECT,
+            storageBucket: `${env.GCLOUD_PROJECT}.appspot.com`,
+            databaseURL: `https://${env.GCLOUD_PROJECT}.firebaseio.com`,
+        });
+    }
     const emulatorInfos = registry_1.EmulatorRegistry.listRunningWithInfo();
     (0, env_1.setEnvVarsForEmulators)(env, emulatorInfos);
     const proc = childProcess.spawn(script, {
@@ -342,7 +349,7 @@ async function checkJavaMajorVersion() {
         });
     }).then((output) => {
         let versionInt = -1;
-        const match = output.match(JAVA_VERSION_REGEX);
+        const match = JAVA_VERSION_REGEX.exec(output);
         if (match) {
             const version = match[1];
             versionInt = parseInt(version, 10);

package/lib/extensions/manifest.js

@@ -136,7 +136,7 @@ function writeExtensionsToFirebaseJson(specs, config) {
 async function writeEnvFiles(specs, config, force) {
     for (const spec of specs) {
         const content = Object.entries(spec.params)
-            .filter((r) => r[1].baseValue !== "")
+            .filter((r) => r[1].baseValue !== "" && r[1].baseValue !== undefined)
             .sort((a, b) => {
             return a[0].localeCompare(b[0]);
         })

package/lib/frameworks/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createServerResponseProxy = exports.prepareFrameworks = exports.findDependency = exports.discover = exports.relativeRequire = exports.WebFrameworks = exports.NODE_VERSION = exports.DEFAULT_REGION = exports.FIREBASE_ADMIN_VERSION = exports.FIREBASE_FUNCTIONS_VERSION = exports.FIREBASE_FRAMEWORKS_VERSION = void 0;
+exports.createServerResponseProxy = exports.prepareFrameworks = exports.findDependency = exports.discover = exports.relativeRequire = exports.WebFrameworks = exports.ALLOWED_SSR_REGIONS = exports.DEFAULT_REGION = exports.NODE_VERSION = exports.FIREBASE_ADMIN_VERSION = exports.FIREBASE_FUNCTIONS_VERSION = exports.FIREBASE_FRAMEWORKS_VERSION = void 0;
 const path_1 = require("path");
 const process_1 = require("process");
 const child_process_1 = require("child_process");
@@ -37,8 +37,15 @@ const SupportLevelWarnings = {
 exports.FIREBASE_FRAMEWORKS_VERSION = "^0.6.0";
 exports.FIREBASE_FUNCTIONS_VERSION = "^3.23.0";
 exports.FIREBASE_ADMIN_VERSION = "^11.0.1";
-exports.DEFAULT_REGION = "us-central1";
 exports.NODE_VERSION = parseInt(process.versions.node, 10).toString();
+exports.DEFAULT_REGION = "us-central1";
+exports.ALLOWED_SSR_REGIONS = [
+    { name: "us-central1 (Iowa)", value: "us-central1" },
+    { name: "us-west1 (Oregon)", value: "us-west1" },
+    { name: "us-east1 (South Carolina)", value: "us-east1" },
+    { name: "europe-west1 (Belgium)", value: "europe-west1" },
+    { name: "asia-east1 (Taiwan)", value: "asia-east1" },
+];
 const DEFAULT_FIND_DEP_OPTIONS = {
     cwd: process.cwd(),
     omitDev: true,
@@ -122,8 +129,8 @@ function findDependency(name, options = {}) {
 }
 exports.findDependency = findDependency;
 async function prepareFrameworks(targetNames, context, options, emulators = []) {
-    var _a, _b;
-    var _c, _d, _e, _f;
+    var _a, _b, _c;
+    var _d, _e, _f, _g;
     const nodeVersion = process.version;
     if (!semver.satisfies(nodeVersion, ">=16.0.0")) {
         throw new error_1.FirebaseError(`The frameworks awareness feature requires Node.JS >= 16 and npm >= 8 in order to work correctly, due to some of the downstream dependencies. Please upgrade your version of Node.JS, reinstall firebase-tools, and give it another go.`);
@@ -135,7 +142,7 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
         try {
             await (0, requireHostingSite_1.requireHostingSite)(options);
         }
-        catch (_g) {
+        catch (_h) {
             options.site = project;
         }
     }
@@ -144,8 +151,9 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
     if (configs.length === 0) {
         return;
     }
+    const allowedRegionsValues = exports.ALLOWED_SSR_REGIONS.map((r) => r.value);
     for (const config of configs) {
-        const { source, site, public: publicDir } = config;
+        const { source, site, public: publicDir, frameworksBackend } = config;
         if (!source) {
             continue;
         }
@@ -159,8 +167,13 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
         if (publicDir) {
             throw new Error(`hosting.public and hosting.source cannot both be set in firebase.json`);
         }
+        const ssrRegion = (_b = frameworksBackend === null || frameworksBackend === void 0 ? void 0 : frameworksBackend.region) !== null && _b !== void 0 ? _b : exports.DEFAULT_REGION;
+        if (!allowedRegionsValues.includes(ssrRegion)) {
+            const validRegions = allowedRegionsValues.join(", ");
+            throw new error_1.FirebaseError(`Hosting config for site ${site} places server-side content in region ${ssrRegion} which is not known. Valid regions are ${validRegions}`);
+        }
         const getProjectPath = (...args) => (0, path_1.join)(projectRoot, source, ...args);
-        const functionName = `ssr${site.toLowerCase().replace(/-/g, "")}`;
+        const functionId = `ssr${site.toLowerCase().replace(/-/g, "")}`;
         const usesFirebaseAdminSdk = !!findDependency("firebase-admin", { cwd: getProjectPath() });
         const usesFirebaseJsSdk = !!findDependency("@firebase/app", { cwd: getProjectPath() });
         if (usesFirebaseAdminSdk) {
@@ -249,7 +262,7 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
             config.rewrites.push(...rewrites);
             config.redirects.push(...redirects);
             config.headers.push(...headers);
-            (_b = config.trailingSlash) !== null && _b !== void 0 ? _b : (config.trailingSlash = trailingSlash);
+            (_c = config.trailingSlash) !== null && _c !== void 0 ? _c : (config.trailingSlash = trailingSlash);
             if (await (0, fs_extra_1.pathExists)(hostingDist))
                 await (0, promises_1.rm)(hostingDist, { recursive: true });
             await (0, fs_extra_1.mkdirp)(hostingDist);
@@ -265,7 +278,7 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
             const rewrite = {
                 source: "**",
                 function: {
-                    functionId: functionName,
+                    functionId,
                 },
             };
             if (experiments.isEnabled("pintags")) {
@@ -306,27 +319,15 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
                 await (0, fs_extra_1.mkdirp)(functionsDist);
             }
             const { packageJson, bootstrapScript, frameworksEntry = framework, } = await codegenFunctionsDirectory(getProjectPath(), functionsDist);
-            await (0, promises_1.writeFile)((0, path_1.join)(functionsDist, "functions.yaml"), JSON.stringify({
-                endpoints: {
-                    [functionName]: {
-                        platform: "gcfv2",
-                        region: [exports.DEFAULT_REGION],
-                        labels: {},
-                        httpsTrigger: {},
-                        entryPoint: "ssr",
-                    },
-                },
-                specVersion: "v1alpha1",
-                requiredAPIs: [],
-            }, null, 2));
+            process.env.__FIREBASE_FRAMEWORKS_ENTRY__ = frameworksEntry;
             packageJson.main = "server.js";
             delete packageJson.devDependencies;
             packageJson.dependencies || (packageJson.dependencies = {});
-            (_c = packageJson.dependencies)["firebase-frameworks"] || (_c["firebase-frameworks"] = exports.FIREBASE_FRAMEWORKS_VERSION);
-            (_d = packageJson.dependencies)["firebase-functions"] || (_d["firebase-functions"] = exports.FIREBASE_FUNCTIONS_VERSION);
-            (_e = packageJson.dependencies)["firebase-admin"] || (_e["firebase-admin"] = exports.FIREBASE_ADMIN_VERSION);
+            (_d = packageJson.dependencies)["firebase-frameworks"] || (_d["firebase-frameworks"] = exports.FIREBASE_FRAMEWORKS_VERSION);
+            (_e = packageJson.dependencies)["firebase-functions"] || (_e["firebase-functions"] = exports.FIREBASE_FUNCTIONS_VERSION);
+            (_f = packageJson.dependencies)["firebase-admin"] || (_f["firebase-admin"] = exports.FIREBASE_ADMIN_VERSION);
             packageJson.engines || (packageJson.engines = {});
-            (_f = packageJson.engines).node || (_f.node = exports.NODE_VERSION);
+            (_g = packageJson.engines).node || (_g.node = exports.NODE_VERSION);
             for (const [name, version] of Object.entries(packageJson.dependencies)) {
                 if (version.startsWith("file:")) {
                     const path = version.replace(/^file:/, "");
@@ -374,10 +375,18 @@ ${firebaseDefaults ? `__FIREBASE_DEFAULTS__=${JSON.stringify(firebaseDefaults)}\
             });
             if (bootstrapScript)
                 await (0, promises_1.writeFile)((0, path_1.join)(functionsDist, "bootstrap.js"), bootstrapScript);
-            await (0, promises_1.writeFile)((0, path_1.join)(functionsDist, "server.js"), `const { onRequest } = require('firebase-functions/v2/https');
-const server = import('firebase-frameworks');
-exports.ssr = onRequest((req, res) => server.then(it => it.handle(req, res)));
-`);
+            if (packageJson.type === "module") {
+                await (0, promises_1.writeFile)((0, path_1.join)(functionsDist, "server.js"), `import { onRequest } from 'firebase-functions/v2/https';
+  const server = import('firebase-frameworks');
+  export const ${functionId} = onRequest(${JSON.stringify(frameworksBackend || {})}, (req, res) => server.then(it => it.handle(req, res)));
+  `);
+            }
+            else {
+                await (0, promises_1.writeFile)((0, path_1.join)(functionsDist, "server.js"), `const { onRequest } = require('firebase-functions/v2/https');
+  const server = import('firebase-frameworks');
+  exports.${functionId} = onRequest(${JSON.stringify(frameworksBackend || {})}, (req, res) => server.then(it => it.handle(req, res)));
+  `);
+            }
         }
         else {
             config.rewrites.push({

package/lib/functional.js

@@ -53,7 +53,7 @@ const zipIn = (other) => (elem, ndx) => {
 };
 exports.zipIn = zipIn;
 function assertExhaustive(val) {
-    throw new Error(`Never has a value (${val}). This should be impossible`);
+    throw new Error(`Never has a value (${val}).`);
 }
 exports.assertExhaustive = assertExhaustive;
 function partition(arr, predicate) {

package/lib/functionsShellCommandAction.js

@@ -37,6 +37,9 @@ const actionFunction = async (options) => {
     const otherEmulators = types_1.EMULATORS_SUPPORTED_BY_FUNCTIONS.filter((e) => remoteEmulators[e] === undefined);
     let host = constants_1.Constants.getDefaultHost();
     let port = 5000;
+    if (typeof options.port === "number") {
+        port = options.port;
+    }
     const functionsInfo = remoteEmulators[types_1.Emulators.FUNCTIONS];
     if (functionsInfo) {
         utils.logLabeledWarning("functions", `You are already running the Cloud Functions emulator on port ${functionsInfo.port}. Running the emulator and the Functions shell simultaenously can result in unexpected behavior.`);

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

@@ -86,9 +86,19 @@ async function doSetup(setup, config) {
                 (0, rimraf_1.sync)(setup.hosting.source);
             await frameworks_1.WebFrameworks[setup.hosting.whichFramework].init(setup, config);
         }
+        await (0, prompt_1.promptOnce)({
+            name: "region",
+            type: "list",
+            message: "In which region would you like to host server-side content, if applicable?",
+            default: frameworks_1.DEFAULT_REGION,
+            choices: frameworks_1.ALLOWED_SSR_REGIONS,
+        }, setup.hosting);
         setup.config.hosting = {
             source: setup.hosting.source,
             ignore: DEFAULT_IGNORES,
+            frameworksBackend: {
+                region: setup.hosting.region,
+            },
         };
     }
     else {

package/lib/prompt.js

@@ -24,7 +24,8 @@ async function prompt(options, questions) {
 }
 exports.prompt = prompt;
 async function promptOnce(question, options = {}) {
-    question.name = question.name || "question";
+    var _a;
+    question.name = ((_a = question.name) === null || _a === void 0 ? void 0 : _a.replace(/\./g, "/")) || "question";
     await prompt(options, [question]);
     return options[question.name];
 }

package/npm-shrinkwrap.json

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

package/package.json

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

package/schema/firebase-config.json

@@ -5,6 +5,126 @@
         "ExtensionsConfig": {
             "additionalProperties": false,
             "type": "object"
+        },
+        "FrameworksBackendOptions": {
+            "additionalProperties": false,
+            "properties": {
+                "concurrency": {
+                    "description": "Number of requests a function can serve at once.",
+                    "type": "number"
+                },
+                "cors": {
+                    "description": "If true, allows CORS on requests to this function.\nIf this is a `string` or `RegExp`, allows requests from domains that match the provided value.\nIf this is an `Array`, allows requests from domains matching at least one entry of the array.\nDefaults to true for {@link https.CallableFunction} and false otherwise.",
+                    "type": [
+                        "string",
+                        "boolean"
+                    ]
+                },
+                "cpu": {
+                    "anyOf": [
+                        {
+                            "enum": [
+                                "gcf_gen1"
+                            ],
+                            "type": "string"
+                        },
+                        {
+                            "type": "number"
+                        }
+                    ],
+                    "description": "Fractional number of CPUs to allocate to a function."
+                },
+                "enforceAppCheck": {
+                    "description": "Determines whether Firebase AppCheck is enforced. Defaults to false.",
+                    "type": "boolean"
+                },
+                "ingressSettings": {
+                    "description": "Ingress settings which control where this function can be called from.",
+                    "enum": [
+                        "ALLOW_ALL",
+                        "ALLOW_INTERNAL_AND_GCLB",
+                        "ALLOW_INTERNAL_ONLY"
+                    ],
+                    "type": "string"
+                },
+                "invoker": {
+                    "description": "Invoker to set access control on https functions.",
+                    "enum": [
+                        "public"
+                    ],
+                    "type": "string"
+                },
+                "labels": {
+                    "$ref": "#/definitions/Record<string,string>",
+                    "description": "User labels to set on the function."
+                },
+                "maxInstances": {
+                    "description": "Max number of instances to be running in parallel.",
+                    "type": "number"
+                },
+                "memory": {
+                    "description": "Amount of memory to allocate to a function.",
+                    "enum": [
+                        "128MiB",
+                        "16GiB",
+                        "1GiB",
+                        "256MiB",
+                        "2GiB",
+                        "32GiB",
+                        "4GiB",
+                        "512MiB",
+                        "8GiB"
+                    ],
+                    "type": "string"
+                },
+                "minInstances": {
+                    "description": "Min number of actual instances to be running at a given time.",
+                    "type": "number"
+                },
+                "omit": {
+                    "description": "If true, do not deploy or emulate this function.",
+                    "type": "boolean"
+                },
+                "preserveExternalChanges": {
+                    "description": "Controls whether function configuration modified outside of function source is preserved. Defaults to false.",
+                    "type": "boolean"
+                },
+                "region": {
+                    "description": "HTTP functions can override global options and can specify multiple regions to deploy to.",
+                    "type": "string"
+                },
+                "secrets": {
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                },
+                "serviceAccount": {
+                    "description": "Specific service account for the function to run as.",
+                    "type": "string"
+                },
+                "timeoutSeconds": {
+                    "description": "Timeout for the function in sections, possible values are 0 to 540.\nHTTPS functions can specify a higher timeout.",
+                    "type": "number"
+                },
+                "vpcConnector": {
+                    "description": "Connect cloud function to specified VPC connector.",
+                    "type": "string"
+                },
+                "vpcConnectorEgressSettings": {
+                    "description": "Egress settings for VPC connector.",
+                    "enum": [
+                        "ALL_TRAFFIC",
+                        "PRIVATE_RANGES_ONLY"
+                    ],
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "Record<string,string>": {
+            "additionalProperties": false,
+            "type": "object"
         }
     },
     "properties": {
@@ -473,6 +593,9 @@
                         "cleanUrls": {
                             "type": "boolean"
                         },
+                        "frameworksBackend": {
+                            "$ref": "#/definitions/FrameworksBackendOptions"
+                        },
                         "headers": {
                             "items": {
                                 "anyOf": [
@@ -1064,6 +1187,9 @@
                                     "cleanUrls": {
                                         "type": "boolean"
                                     },
+                                    "frameworksBackend": {
+                                        "$ref": "#/definitions/FrameworksBackendOptions"
+                                    },
                                     "headers": {
                                         "items": {
                                             "anyOf": [
@@ -1655,6 +1781,9 @@
                                     "cleanUrls": {
                                         "type": "boolean"
                                     },
+                                    "frameworksBackend": {
+                                        "$ref": "#/definitions/FrameworksBackendOptions"
+                                    },
                                     "headers": {
                                         "items": {
                                             "anyOf": [

package/templates/extensions/CL-template.md

@@ -0,0 +1,2 @@
+## Version 0.0.1
+- Initial Version

package/templates/init/functions/javascript/package.lint.json

@@ -14,7 +14,7 @@
   },
   "main": "index.js",
   "dependencies": {
-    "firebase-admin": "^111.5.0",
+    "firebase-admin": "^11.5.0",
     "firebase-functions": "^4.2.0"
   },
   "devDependencies": {

package/templates/init/functions/python/main.py

@@ -2,12 +2,12 @@
 # To get started, simply uncomment the below code or create your own.
 # Deploy with `firebase deploy`
 
-from firebase_functions import https
+from firebase_functions import https_fn
 from firebase_admin import initialize_app
 
 # initialize_app()
 #
 #
-# @https.on_request()
-# def on_request_example(req: https.Request) -> https.Response:
-#     return https.Response("Hello world!")
+# @https_fn.on_request()
+# def on_request_example(req: https_fn.Request) -> https_fn.Response:
+#     return https_fn.Response("Hello world!")