firebase-tools 11.29.0 → 11.30.0

package/lib/frameworks/index.js

@@ -1,15 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.prepareFrameworks = exports.findDependency = exports.getNodeModuleBin = 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;
+exports.prepareFrameworks = exports.discover = exports.WebFrameworks = void 0;
 const path_1 = require("path");
 const process_1 = require("process");
 const child_process_1 = require("child_process");
 const cross_spawn_1 = require("cross-spawn");
-const fs_1 = require("fs");
-const url_1 = require("url");
 const promises_1 = require("fs/promises");
 const fs_extra_1 = require("fs-extra");
-const clc = require("colorette");
 const process = require("node:process");
 const semver = require("semver");
 const glob = require("glob");
@@ -26,67 +23,21 @@ const constants_1 = require("../emulator/constants");
 const error_1 = require("../error");
 const requireHostingSite_1 = require("../requireHostingSite");
 const experiments = require("../experiments");
-const ensureTargeted_1 = require("../functions/ensureTargeted");
 const implicitInit_1 = require("../hosting/implicitInit");
-const fsutils_1 = require("../fsutils");
-const { dynamicImport } = require(true && "../dynamicImport");
-const SupportLevelWarnings = {
-    ["experimental"]: clc.yellow(`This is an experimental integration, proceed with caution.`),
-    ["community-supported"]: clc.yellow(`This is a community-supported integration, support is best effort.`),
-};
-exports.FIREBASE_FRAMEWORKS_VERSION = "^0.7.0";
-exports.FIREBASE_FUNCTIONS_VERSION = "^3.23.0";
-exports.FIREBASE_ADMIN_VERSION = "^11.0.1";
-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,
-};
-exports.WebFrameworks = Object.fromEntries((0, fs_1.readdirSync)(__dirname)
-    .filter((path) => (0, fs_1.statSync)((0, path_1.join)(__dirname, path)).isDirectory())
-    .map((path) => {
-    try {
-        return [path, require((0, path_1.join)(__dirname, path))];
-    }
-    catch (e) {
-        return [];
-    }
-})
-    .filter(([, obj]) => obj && obj.name && obj.discover && obj.build && obj.type !== undefined && obj.support));
-function relativeRequire(dir, mod) {
-    try {
-        const path = require.resolve(mod, { paths: [dir] });
-        if ((0, path_1.extname)(path) === ".mjs") {
-            return dynamicImport((0, url_1.pathToFileURL)(path).toString());
-        }
-        else {
-            return require(path);
-        }
-    }
-    catch (e) {
-        const path = (0, path_1.relative)(process.cwd(), dir);
-        console.error(`Could not load dependency ${mod} in ${path.startsWith("..") ? path : `./${path}`}, have you run \`npm install\`?`);
-        throw e;
-    }
-}
-exports.relativeRequire = relativeRequire;
+const utils_1 = require("./utils");
+const constants_2 = require("./constants");
+Object.defineProperty(exports, "WebFrameworks", { enumerable: true, get: function () { return constants_2.WebFrameworks; } });
+const utils_2 = require("../utils");
+const ensureTargeted_1 = require("../functions/ensureTargeted");
 async function discover(dir, warn = true) {
     const allFrameworkTypes = [
-        ...new Set(Object.values(exports.WebFrameworks).map(({ type }) => type)),
+        ...new Set(Object.values(constants_2.WebFrameworks).map(({ type }) => type)),
     ].sort();
     for (const discoveryType of allFrameworkTypes) {
         const frameworksDiscovered = [];
-        for (const framework in exports.WebFrameworks) {
-            if (exports.WebFrameworks[framework]) {
-                const { discover, type } = exports.WebFrameworks[framework];
+        for (const framework in constants_2.WebFrameworks) {
+            if (constants_2.WebFrameworks[framework]) {
+                const { discover, type } = constants_2.WebFrameworks[framework];
                 if (type !== discoveryType)
                     continue;
                 const result = await discover(dir);
@@ -107,54 +58,9 @@ async function discover(dir, warn = true) {
     return;
 }
 exports.discover = discover;
-function scanDependencyTree(searchingFor, dependencies = {}) {
-    for (const [name, dependency] of Object.entries(dependencies)) {
-        if (name === searchingFor)
-            return dependency;
-        const result = scanDependencyTree(searchingFor, dependency.dependencies);
-        if (result)
-            return result;
-    }
-    return;
-}
-function getNodeModuleBin(name, cwd) {
-    var _a;
-    const cantFindExecutable = new error_1.FirebaseError(`Could not find the ${name} executable.`);
-    const npmRoot = (_a = (0, cross_spawn_1.sync)("npm", ["root"], { cwd }).stdout) === null || _a === void 0 ? void 0 : _a.toString().trim();
-    if (!npmRoot) {
-        throw cantFindExecutable;
-    }
-    const path = (0, path_1.join)(npmRoot, ".bin", name);
-    if (!(0, fsutils_1.fileExistsSync)(path)) {
-        throw cantFindExecutable;
-    }
-    return path;
-}
-exports.getNodeModuleBin = getNodeModuleBin;
-function findDependency(name, options = {}) {
-    var _a;
-    const { cwd: dir, depth, omitDev } = Object.assign(Object.assign({}, DEFAULT_FIND_DEP_OPTIONS), options);
-    const cwd = (_a = (0, cross_spawn_1.sync)("npm", ["root"], { cwd: dir }).stdout) === null || _a === void 0 ? void 0 : _a.toString().trim();
-    if (!cwd)
-        return;
-    const env = Object.assign({}, process.env);
-    delete env.NODE_ENV;
-    const result = (0, cross_spawn_1.sync)("npm", [
-        "list",
-        name,
-        "--json",
-        ...(omitDev ? ["--omit", "dev"] : []),
-        ...(depth === undefined ? [] : ["--depth", depth.toString(10)]),
-    ], { cwd, env });
-    if (!result.stdout)
-        return;
-    const json = JSON.parse(result.stdout.toString());
-    return scanDependencyTree(name, json.dependencies);
-}
-exports.findDependency = findDependency;
 async function prepareFrameworks(targetNames, context, options, emulators = []) {
     var _a, _b, _c;
-    var _d, _e, _f, _g;
+    var _d, _e, _f, _g, _h;
     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.`);
@@ -166,7 +72,7 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
         try {
             await (0, requireHostingSite_1.requireHostingSite)(options);
         }
-        catch (_h) {
+        catch (_j) {
             options.site = project;
         }
     }
@@ -175,7 +81,7 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
     if (configs.length === 0) {
         return;
     }
-    const allowedRegionsValues = exports.ALLOWED_SSR_REGIONS.map((r) => r.value);
+    const allowedRegionsValues = constants_2.ALLOWED_SSR_REGIONS.map((r) => r.value);
     for (const config of configs) {
         const { source, site, public: publicDir, frameworksBackend } = config;
         if (!source) {
@@ -191,15 +97,15 @@ 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;
+        const ssrRegion = (_b = frameworksBackend === null || frameworksBackend === void 0 ? void 0 : frameworksBackend.region) !== null && _b !== void 0 ? _b : constants_2.DEFAULT_REGION;
         if (!allowedRegionsValues.includes(ssrRegion)) {
-            const validRegions = allowedRegionsValues.join(", ");
+            const validRegions = (0, utils_1.conjoinOptions)(allowedRegionsValues);
             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 functionId = `ssr${site.toLowerCase().replace(/-/g, "")}`;
-        const usesFirebaseAdminSdk = !!findDependency("firebase-admin", { cwd: getProjectPath() });
-        const usesFirebaseJsSdk = !!findDependency("@firebase/app", { cwd: getProjectPath() });
+        const usesFirebaseAdminSdk = !!(0, utils_1.findDependency)("firebase-admin", { cwd: getProjectPath() });
+        const usesFirebaseJsSdk = !!(0, utils_1.findDependency)("@firebase/app", { cwd: getProjectPath() });
         if (usesFirebaseAdminSdk) {
             process.env.GOOGLE_CLOUD_PROJECT = project;
             if (account && !process.env.GOOGLE_APPLICATION_CREDENTIALS) {
@@ -264,11 +170,12 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
             process.env.__FIREBASE_DEFAULTS__ = JSON.stringify(firebaseDefaults);
         }
         const results = await discover(getProjectPath());
-        if (!results)
-            throw new error_1.FirebaseError("Unable to detect the web framework in use, check firebase-debug.log for more info.");
+        if (!results) {
+            throw new error_1.FirebaseError((0, utils_1.frameworksCallToAction)("Unable to detect the web framework in use, check firebase-debug.log for more info."));
+        }
         const { framework, mayWantBackend, publicDirectory } = results;
-        const { build, ɵcodegenPublicDirectory, ɵcodegenFunctionsDirectory: codegenProdModeFunctionsDirectory, getDevModeHandle, name, support, } = exports.WebFrameworks[framework];
-        console.log(`Detected a ${name} codebase. ${SupportLevelWarnings[support] || ""}\n`);
+        const { build, ɵcodegenPublicDirectory, ɵcodegenFunctionsDirectory: codegenProdModeFunctionsDirectory, getDevModeHandle, name, support, docsUrl, } = constants_2.WebFrameworks[framework];
+        console.log(`\n${(0, utils_1.frameworksCallToAction)(constants_2.SupportLevelWarnings[support](name), docsUrl, "   ")}\n`);
         const isDevMode = context._name === "serve" || context._name === "emulators:start";
         const hostingEmulatorInfo = emulators.find((e) => e.name === types_1.Emulators.HOSTING);
         const devModeHandle = isDevMode &&
@@ -302,16 +209,17 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
                 firebaseDefaults._authTokenSyncURL = "/__session";
                 process.env.__FIREBASE_DEFAULTS__ = JSON.stringify(firebaseDefaults);
             }
-            const rewrite = {
+            if (context.hostingChannel) {
+                experiments.assertEnabled("pintags", "deploy an app that requires a backend to a preview channel");
+            }
+            config.rewrites.push({
                 source: "**",
                 function: {
                     functionId,
+                    region: ssrRegion,
+                    pinTag: experiments.isEnabled("pintags"),
                 },
-            };
-            if (experiments.isEnabled("pintags")) {
-                rewrite.function.pinTag = true;
-            }
-            config.rewrites.push(rewrite);
+            });
             const codebase = `firebase-frameworks-${site}`;
             const existingFunctionsConfig = options.config.get("functions")
                 ? [].concat(options.config.get("functions"))
@@ -323,11 +231,16 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
                     codebase,
                 },
             ]);
-            if (!targetNames.includes("functions")) {
-                targetNames.unshift("functions");
-            }
-            if (options.only) {
-                options.only = (0, ensureTargeted_1.ensureTargeted)(options.only, codebase);
+            if (!experiments.isEnabled("pintags") ||
+                context._name === "serve" ||
+                context._name === "emulators:start" ||
+                context._name === "emulators:exec") {
+                if (!targetNames.includes("functions")) {
+                    targetNames.unshift("functions");
+                }
+                if (options.only) {
+                    options.only = (0, ensureTargeted_1.ensureTargeted)(options.only, codebase);
+                }
             }
             if (await (0, fs_extra_1.pathExists)(functionsDist)) {
                 const functionsDistStat = await (0, fs_extra_1.stat)(functionsDist);
@@ -348,13 +261,27 @@ async function prepareFrameworks(targetNames, context, options, emulators = [])
             const { packageJson, bootstrapScript, frameworksEntry = framework, } = await codegenFunctionsDirectory(getProjectPath(), functionsDist);
             process.env.__FIREBASE_FRAMEWORKS_ENTRY__ = frameworksEntry;
             packageJson.main = "server.js";
-            delete packageJson.devDependencies;
             packageJson.dependencies || (packageJson.dependencies = {});
-            (_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);
+            (_d = packageJson.dependencies)["firebase-frameworks"] || (_d["firebase-frameworks"] = constants_2.FIREBASE_FRAMEWORKS_VERSION);
+            (_e = packageJson.dependencies)["firebase-functions"] || (_e["firebase-functions"] = constants_2.FIREBASE_FUNCTIONS_VERSION);
+            (_f = packageJson.dependencies)["firebase-admin"] || (_f["firebase-admin"] = constants_2.FIREBASE_ADMIN_VERSION);
             packageJson.engines || (packageJson.engines = {});
-            (_g = packageJson.engines).node || (_g.node = exports.NODE_VERSION);
+            const validEngines = constants_2.VALID_ENGINES.node.filter((it) => it <= constants_2.NODE_VERSION);
+            const engine = validEngines[validEngines.length - 1] || constants_2.VALID_ENGINES.node[0];
+            if (engine !== constants_2.NODE_VERSION) {
+                (0, utils_2.logWarning)(`This integration expects Node version ${(0, utils_1.conjoinOptions)(constants_2.VALID_ENGINES.node, "or")}. You're running version ${constants_2.NODE_VERSION}, problems may be encountered.`);
+            }
+            (_g = packageJson.engines).node || (_g.node = engine.toString());
+            delete packageJson.scripts;
+            delete packageJson.devDependencies;
+            const bundledDependencies = packageJson.bundledDependencies || {};
+            if (Object.keys(bundledDependencies).length) {
+                (0, utils_2.logWarning)("Bundled dependencies aren't supported in Cloud Functions, converting to dependencies.");
+                for (const [dep, version] of Object.entries(bundledDependencies)) {
+                    (_h = packageJson.dependencies)[dep] || (_h[dep] = version);
+                }
+                delete packageJson.bundledDependencies;
+            }
             for (const [name, version] of Object.entries(packageJson.dependencies)) {
                 if (version.startsWith("file:")) {
                     const path = version.replace(/^file:/, "");

package/lib/frameworks/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/frameworks/next/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTES_MANIFEST = exports.PRERENDER_MANIFEST = exports.PAGES_MANIFEST = exports.MIDDLEWARE_MANIFEST = exports.IMAGES_MANIFEST = exports.EXPORT_MARKER = exports.APP_PATH_ROUTES_MANIFEST = void 0;
+exports.APP_PATHS_MANIFEST = exports.ROUTES_MANIFEST = exports.PRERENDER_MANIFEST = exports.PAGES_MANIFEST = exports.MIDDLEWARE_MANIFEST = exports.IMAGES_MANIFEST = exports.EXPORT_MARKER = exports.APP_PATH_ROUTES_MANIFEST = void 0;
 exports.APP_PATH_ROUTES_MANIFEST = "app-path-routes-manifest.json";
 exports.EXPORT_MARKER = "export-marker.json";
 exports.IMAGES_MANIFEST = "images-manifest.json";
@@ -8,3 +8,4 @@ exports.MIDDLEWARE_MANIFEST = "middleware-manifest.json";
 exports.PAGES_MANIFEST = "pages-manifest.json";
 exports.PRERENDER_MANIFEST = "prerender-manifest.json";
 exports.ROUTES_MANIFEST = "routes-manifest.json";
+exports.APP_PATHS_MANIFEST = "app-paths-manifest.json";