firebase-tools 13.20.1 → 13.21.0

package/lib/extensions/runtimes/common.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.longestCommonPrefix = exports.snakeToCamelCase = exports.lowercaseFirstLetter = exports.capitalizeFirstLetter = exports.toTitleCase = exports.getInstallPathPrefix = exports.getCodebaseDir = exports.writeSDK = exports.getCodebaseRuntime = exports.copyDirectory = exports.writeFile = exports.isTypescriptCodebase = exports.extensionMatchesAnyFilter = exports.extractExtensionsFromBuilds = exports.getErrorMessage = exports.fixDarkBlueText = void 0;
+exports.longestCommonPrefix = exports.snakeToCamelCase = exports.lowercaseFirstLetter = exports.capitalizeFirstLetter = exports.toTitleCase = exports.getInstallPathPrefix = exports.getCodebaseDir = exports.writeSDK = exports.getCodebaseRuntime = exports.copyDirectory = exports.writeFile = exports.isTypescriptCodebase = exports.extensionMatchesAnyFilter = exports.extractExtensionsFromBuilds = exports.fixDarkBlueText = void 0;
 const fs = require("fs");
 const path = require("path");
 const prompt_1 = require("../../prompt");
@@ -8,7 +8,6 @@ const fsutils = require("../../fsutils");
 const utils_1 = require("../../utils");
 const error_1 = require("../../error");
 const projectConfig_1 = require("../../functions/projectConfig");
-const types_1 = require("../types");
 const functionRuntimes = require("../../deploy/functions/runtimes");
 const nodeRuntime = require("./node");
 function fixDarkBlueText(txt) {
@@ -17,15 +16,6 @@ function fixDarkBlueText(txt) {
     return txt.replaceAll(DARK_BLUE, BRIGHT_CYAN);
 }
 exports.fixDarkBlueText = fixDarkBlueText;
-function getErrorMessage(err, defaultMsg) {
-    if ((0, types_1.isObject)(err) && err.message && typeof err.message === "string") {
-        return err.message;
-    }
-    else {
-        return defaultMsg;
-    }
-}
-exports.getErrorMessage = getErrorMessage;
 function extractExtensionsFromBuilds(builds, filters) {
     const extRecords = {};
     for (const [codebase, build] of Object.entries(builds)) {
@@ -80,7 +70,7 @@ async function writeFile(filePath, data, options) {
                 (0, utils_1.logLabeledBullet)("extensions", `successfully wrote ${shortFilePath}`);
             }
             catch (err) {
-                throw new error_1.FirebaseError(`Failed to write ${shortFilePath}:\n    ${err}`);
+                throw new error_1.FirebaseError(`Failed to write ${shortFilePath}:\n    ${(0, error_1.getErrMsg)(err)}`);
             }
         }
         else {
@@ -95,11 +85,11 @@ async function writeFile(filePath, data, options) {
                 (0, utils_1.logLabeledBullet)("extensions", `successfully created ${shortFilePath}`);
             }
             catch (err) {
-                throw new error_1.FirebaseError(`Failed to create ${shortFilePath}:\n    ${err}`);
+                throw new error_1.FirebaseError(`Failed to create ${shortFilePath}:\n    ${(0, error_1.getErrMsg)(err)}`);
             }
         }
         catch (err) {
-            throw new error_1.FirebaseError(`Error during SDK file creation:\n    ${err}`);
+            throw new error_1.FirebaseError(`Error during SDK file creation:\n    ${(0, error_1.getErrMsg)(err)}`);
         }
     }
 }
@@ -121,14 +111,14 @@ async function copyDirectory(src, dest, options) {
                     if (srcPath.includes("node_modules")) {
                         continue;
                     }
-                    await copyDirectory(srcPath, destPath, { force: true });
+                    await copyDirectory(srcPath, destPath, Object.assign(Object.assign({}, options), { force: true }));
                 }
                 else if (entry.isFile())
                     try {
                         await fs.promises.copyFile(srcPath, destPath);
                     }
                     catch (err) {
-                        throw new error_1.FirebaseError(`Failed to copy ${destPath.replace(process.cwd(), ".")}:\n    ${err}`);
+                        throw new error_1.FirebaseError(`Failed to copy ${destPath.replace(process.cwd(), ".")}:\n    ${(0, error_1.getErrMsg)(err)}`);
                     }
             }
         }
@@ -137,9 +127,8 @@ async function copyDirectory(src, dest, options) {
         }
     }
     else {
-        await fs.promises.mkdir(dest, { recursive: true }).then(async () => {
-            await copyDirectory(src, dest, { force: true });
-        });
+        await fs.promises.mkdir(dest, { recursive: true });
+        await copyDirectory(src, dest, Object.assign(Object.assign({}, options), { force: true }));
     }
 }
 exports.copyDirectory = copyDirectory;
@@ -177,6 +166,9 @@ async function writeSDK(extensionRef, localPath, spec, options) {
 }
 exports.writeSDK = writeSDK;
 function getCodebaseDir(options) {
+    if (!options.projectRoot) {
+        throw new error_1.FirebaseError("Unable to determine root directory of project");
+    }
     const config = (0, projectConfig_1.normalizeAndValidate)(options.config.src.functions);
     const codebaseConfig = (0, projectConfig_1.configForCodebase)(config, options.codebase || projectConfig_1.DEFAULT_CODEBASE);
     return `${options.projectRoot}/${codebaseConfig.source}/`;

package/lib/extensions/runtimes/node.js

@@ -1,18 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.writeSDK = exports.TYPESCRIPT_VERSION = exports.FIREBASE_FUNCTIONS_VERSION = exports.SDK_GENERATION_VERSION = void 0;
+const path = require("path");
+const child_process_1 = require("child_process");
+const marked_terminal_1 = require("marked-terminal");
+const marked_1 = require("marked");
 const types_1 = require("../types");
 const prompt_1 = require("../../prompt");
 const secretsUtils = require("../secretsUtils");
-const child_process_1 = require("child_process");
 const utils_1 = require("../../utils");
-const path = require("path");
 const common_1 = require("./common");
 const askUserForEventsConfig_1 = require("../askUserForEventsConfig");
 const extensionsHelper_1 = require("../extensionsHelper");
 const error_1 = require("../../error");
-const marked_terminal_1 = require("marked-terminal");
-const marked_1 = require("marked");
 marked_1.marked.use((0, marked_terminal_1.markedTerminal)());
 exports.SDK_GENERATION_VERSION = "1.0.0";
 exports.FIREBASE_FUNCTIONS_VERSION = ">=5.1.0";
@@ -67,7 +67,7 @@ function makeClassName(name) {
 function makeEventName(name, prefix) {
     let eventName;
     const versionedEvent = /^(?:[^.]+[.])+(?:[vV]\d+[.])(?<event>.*)$/;
-    const match = name.match(versionedEvent);
+    const match = versionedEvent.exec(name);
     if (match) {
         eventName = match[1];
     }
@@ -79,7 +79,7 @@ function makeEventName(name, prefix) {
         eventName = parts[parts.length - 1];
     }
     const allCaps = /^[A-Z._-]+$/;
-    eventName = eventName.match(allCaps) ? eventName : eventName.replace(/([A-Z])/g, " $1").trim();
+    eventName = allCaps.exec(eventName) ? eventName : eventName.replace(/([A-Z])/g, " $1").trim();
     eventName = eventName.replace(/[._-]/g, " ");
     eventName = eventName.toLowerCase().startsWith("on") ? eventName : "on " + eventName;
     eventName = eventName.replace(/\w\S*/g, common_1.toTitleCase);
@@ -87,6 +87,15 @@ function makeEventName(name, prefix) {
     eventName = eventName.charAt(0).toLowerCase() + eventName.substring(1);
     return eventName;
 }
+function addPeerDependency(pkgJson, dependency, version) {
+    if (!pkgJson.peerDependencies) {
+        pkgJson.peerDependencies = {};
+    }
+    if (!(0, types_1.isObject)(pkgJson.peerDependencies)) {
+        throw new error_1.FirebaseError("Internal error generating peer dependencies.");
+    }
+    pkgJson.peerDependencies[dependency] = version;
+}
 async function writeSDK(extensionRef, localPath, spec, options) {
     var _a, _b, _c;
     const sdkLines = [];
@@ -105,7 +114,7 @@ async function writeSDK(extensionRef, localPath, spec, options) {
         })) {
             const newLocalPath = path.join(dirPath, "src");
             await (0, common_1.copyDirectory)(localPath, newLocalPath, options);
-            localPath = newLocalPath.replace(options.projectRoot, ".");
+            localPath = newLocalPath.replace(options.projectRoot || ".", ".");
         }
     }
     if (!dirPath) {
@@ -115,7 +124,7 @@ async function writeSDK(extensionRef, localPath, spec, options) {
     const pkgJson = {
         name: packageName,
         version: `${exports.SDK_GENERATION_VERSION}`,
-        description: `Generated SDK for ${spec.displayName}@${spec.version}`,
+        description: `Generated SDK for ${spec.displayName || spec.name}@${spec.version}`,
         main: "./output/index.js",
         private: true,
         scripts: {
@@ -138,7 +147,7 @@ async function writeSDK(extensionRef, localPath, spec, options) {
         },
     };
     sdkLines.push("/**");
-    sdkLines.push(` * ${spec.displayName} SDK for ${spec.name}@${spec.version}`);
+    sdkLines.push(` * ${spec.displayName || spec.name} SDK for ${spec.name}@${spec.version}`);
     sdkLines.push(" *");
     sdkLines.push(" * When filing bugs or feature requests please specify:");
     if (extensionRef) {
@@ -155,18 +164,12 @@ async function writeSDK(extensionRef, localPath, spec, options) {
     if (hasEvents) {
         sdkLines.push(`import { CloudEvent } from "firebase-functions/v2";`);
         sdkLines.push(`import { onCustomEventPublished, EventarcTriggerOptions } from "firebase-functions/v2/eventarc";`);
-        if (!pkgJson.peerDependencies) {
-            pkgJson.peerDependencies = {};
-        }
-        pkgJson.peerDependencies["firebase-functions"] = exports.FIREBASE_FUNCTIONS_VERSION;
+        addPeerDependency(pkgJson, "firebase-functions", exports.FIREBASE_FUNCTIONS_VERSION);
     }
     const usesSecrets = secretsUtils.usesSecrets(spec);
     if (usesSecrets) {
         sdkLines.push(`import { defineSecret } from "firebase-functions/params";`);
-        if (!pkgJson.peerDependencies) {
-            pkgJson.peerDependencies = {};
-        }
-        pkgJson.peerDependencies["firebase-functions"] = exports.FIREBASE_FUNCTIONS_VERSION;
+        addPeerDependency(pkgJson, "firebase-functions", exports.FIREBASE_FUNCTIONS_VERSION);
     }
     if (hasEvents || usesSecrets) {
         sdkLines.push("");
@@ -289,7 +292,7 @@ async function writeSDK(extensionRef, localPath, spec, options) {
                 sdkLines.push(`  ${sysParam.param}${opt}: string;`);
                 break;
             default:
-                throw new error_1.FirebaseError(`Error: Unknown systemParam type: ${sysParam.type}.`);
+                throw new error_1.FirebaseError(`Error: Unknown systemParam type: ${sysParam.type || "undefined"}.`);
         }
         sdkLines.push("");
     }
@@ -299,7 +302,7 @@ async function writeSDK(extensionRef, localPath, spec, options) {
     sdkLines.push(`  return new ${className}(instanceId, params);`);
     sdkLines.push("}\n");
     sdkLines.push(`/**`);
-    sdkLines.push(` * ${spec.displayName}`);
+    sdkLines.push(` * ${spec.displayName || spec.name}`);
     (_c = spec.description) === null || _c === void 0 ? void 0 : _c.split("\n").forEach((val) => {
         sdkLines.push(` * ${val.replace(/\*\//g, "* /")}`);
     });
@@ -347,7 +350,7 @@ async function writeSDK(extensionRef, localPath, spec, options) {
         (0, child_process_1.execFileSync)("npm", ["--prefix", dirPath, "install"]);
     }
     catch (err) {
-        const errMsg = (0, common_1.getErrorMessage)(err, "unknown error");
+        const errMsg = (0, error_1.getErrMsg)(err, "unknown error");
         throw new error_1.FirebaseError(`Error during npm install in ${shortDirPath}: ${errMsg}`);
     }
     (0, utils_1.logLabeledBullet)("extensions", `running 'npm --prefix ${shortDirPath} run build'`);
@@ -355,7 +358,7 @@ async function writeSDK(extensionRef, localPath, spec, options) {
         (0, child_process_1.execFileSync)("npm", ["--prefix", dirPath, "run", "build"]);
     }
     catch (err) {
-        const errMsg = (0, common_1.getErrorMessage)(err, "unknown error");
+        const errMsg = (0, error_1.getErrMsg)(err, "unknown error");
         throw new error_1.FirebaseError(`Error during npm run build in ${shortDirPath}: ${errMsg}`);
     }
     const codebaseDir = (0, common_1.getCodebaseDir)(options);
@@ -372,7 +375,7 @@ async function writeSDK(extensionRef, localPath, spec, options) {
             (0, child_process_1.execFileSync)("npm", ["--prefix", codebaseDir, "install", "--save", dirPath]);
         }
         catch (err) {
-            const errMsg = (0, common_1.getErrorMessage)(err, "unknown error");
+            const errMsg = (0, error_1.getErrMsg)(err, "unknown error");
             throw new error_1.FirebaseError(`Error during npm install in ${codebaseDir}: ${errMsg}`);
         }
     }

package/lib/extensions/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isExtensionSpec = exports.isResource = exports.isParam = exports.isObject = exports.ParamType = exports.FUNCTIONS_V2_RESOURCE_TYPE = exports.FUNCTIONS_RESOURCE_TYPE = exports.Visibility = exports.RegistryLaunchStage = void 0;
+exports.isExtensionSpec = exports.isResource = exports.isParam = exports.isObject = exports.ParamType = exports.FUNCTIONS_V2_RESOURCE_TYPE = exports.FUNCTIONS_RESOURCE_TYPE = exports.isExtensionInstance = exports.Visibility = exports.RegistryLaunchStage = void 0;
 var RegistryLaunchStage;
 (function (RegistryLaunchStage) {
     RegistryLaunchStage["EXPERIMENTAL"] = "EXPERIMENTAL";
@@ -14,6 +14,21 @@ var Visibility;
     Visibility["UNLISTED"] = "unlisted";
     Visibility["PUBLIC"] = "public";
 })(Visibility = exports.Visibility || (exports.Visibility = {}));
+const extensionInstanceState = [
+    "STATE_UNSPECIFIED",
+    "DEPLOYING",
+    "UNINSTALLING",
+    "ACTIVE",
+    "ERRORED",
+    "PAUSED",
+];
+const isExtensionInstance = (value) => {
+    if (!isObject(value) || typeof value.name !== "string") {
+        return false;
+    }
+    return true;
+};
+exports.isExtensionInstance = isExtensionInstance;
 const lifecycleStages = ["STAGE_UNSPECIFIED", "ON_INSTALL", "ON_UPDATE", "ON_CONFIGURE"];
 exports.FUNCTIONS_RESOURCE_TYPE = "firebaseextensions.v1beta.function";
 exports.FUNCTIONS_V2_RESOURCE_TYPE = "firebaseextensions.v1beta.v2function";

package/lib/gcp/cloudmonitoring.js

@@ -57,19 +57,19 @@ var ValueType;
     ValueType["DOUBLE"] = "DOUBLE";
     ValueType["STRING"] = "STRING";
 })(ValueType = exports.ValueType || (exports.ValueType = {}));
-async function queryTimeSeries(query, projectNumber) {
+async function queryTimeSeries(query, project) {
     const client = new apiv2_1.Client({
         urlPrefix: (0, api_1.cloudMonitoringOrigin)(),
         apiVersion: exports.CLOUD_MONITORING_VERSION,
     });
     try {
-        const res = await client.get(`/projects/${projectNumber}/timeSeries/`, {
+        const res = await client.get(`/projects/${project}/timeSeries/`, {
             queryParams: query,
         });
         return res.body.timeSeries;
     }
     catch (err) {
-        throw new error_1.FirebaseError(`Failed to get extension usage: ${err}`, {
+        throw new error_1.FirebaseError(`Failed to get Cloud Monitoring metric: ${err}`, {
             status: err.status,
         });
     }

package/lib/gcp/cloudsql/cloudsqladmin.js

@@ -34,27 +34,34 @@ async function createInstance(projectId, location, instanceId, enableGoogleMlInt
     if (enableGoogleMlIntegration) {
         databaseFlags.push({ name: "cloudsql.enable_google_ml_integration", value: "on" });
     }
-    const op = await client.post(`projects/${projectId}/instances`, {
-        name: instanceId,
-        region: location,
-        databaseVersion: "POSTGRES_15",
-        settings: {
-            tier: "db-f1-micro",
-            edition: "ENTERPRISE",
-            ipConfiguration: {
-                authorizedNetworks: [],
-            },
-            enableGoogleMlIntegration,
-            databaseFlags,
-            storageAutoResize: false,
-            userLabels: { "firebase-data-connect": "ft" },
-            insightsConfig: {
-                queryInsightsEnabled: true,
-                queryPlansPerMinute: 5,
-                queryStringLength: 1024,
+    let op;
+    try {
+        op = await client.post(`projects/${projectId}/instances`, {
+            name: instanceId,
+            region: location,
+            databaseVersion: "POSTGRES_15",
+            settings: {
+                tier: "db-f1-micro",
+                edition: "ENTERPRISE",
+                ipConfiguration: {
+                    authorizedNetworks: [],
+                },
+                enableGoogleMlIntegration,
+                databaseFlags,
+                storageAutoResize: false,
+                userLabels: { "firebase-data-connect": "ft" },
+                insightsConfig: {
+                    queryInsightsEnabled: true,
+                    queryPlansPerMinute: 5,
+                    queryStringLength: 1024,
+                },
             },
-        },
-    });
+        });
+    }
+    catch (err) {
+        handleAllowlistError(err, location);
+        throw err;
+    }
     if (!waitForCreation) {
         return;
     }
@@ -94,6 +101,11 @@ async function updateInstanceForDataConnect(instance, enableGoogleMlIntegration)
     return pollRes;
 }
 exports.updateInstanceForDataConnect = updateInstanceForDataConnect;
+function handleAllowlistError(err, region) {
+    if (err.message.includes("Not allowed to set system label: firebase-data-connect")) {
+        throw new error_1.FirebaseError(`Cloud SQL free trial instances are not yet available in ${region}. Please check https://firebase.google.com/docs/data-connect/ for a full list of available regions.`);
+    }
+}
 function setDatabaseFlag(flag, flags = []) {
     const temp = flags.filter((f) => f.name !== flag.name);
     temp.push(flag);

package/lib/gcp/devConnect.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateP4SA = exports.serviceAgentEmail = exports.sortConnectionsByCreateTime = exports.getGitRepositoryLink = exports.createGitRepositoryLink = exports.fetchGitHubInstallations = exports.listAllBranches = exports.listAllLinkableGitRepositories = exports.listAllConnections = exports.getConnection = exports.deleteConnection = exports.createConnection = exports.client = void 0;
+exports.getRepoDetailsFromBackend = exports.extractGitRepositoryLinkComponents = exports.generateP4SA = exports.serviceAgentEmail = exports.sortConnectionsByCreateTime = exports.fetchGitRepositoryLinkReadToken = exports.getGitRepositoryLink = exports.createGitRepositoryLink = exports.fetchGitHubInstallations = exports.listAllBranches = exports.listAllLinkableGitRepositories = exports.listAllConnections = exports.getConnection = exports.deleteConnection = exports.createConnection = exports.client = void 0;
 const apiv2_1 = require("../apiv2");
 const api_1 = require("../api");
 const serviceusage_1 = require("./serviceusage");
+const error_1 = require("../error");
+const githubConnections_1 = require("../apphosting/githubConnections");
 const PAGE_SIZE_MAX = 1000;
 const LOCATION_OVERRIDE = process.env.FIREBASE_DEVELOPERCONNECT_LOCATION_OVERRIDE;
 exports.client = new apiv2_1.Client({
@@ -112,6 +114,12 @@ async function getGitRepositoryLink(projectId, location, connectionId, gitReposi
     return res.body;
 }
 exports.getGitRepositoryLink = getGitRepositoryLink;
+async function fetchGitRepositoryLinkReadToken(projectId, location, connectionId, gitRepositoryLinkId) {
+    const name = `projects/${projectId}/locations/${LOCATION_OVERRIDE !== null && LOCATION_OVERRIDE !== void 0 ? LOCATION_OVERRIDE : location}/connections/${connectionId}/gitRepositoryLinks/${gitRepositoryLinkId}:fetchReadToken`;
+    const res = await exports.client.post(name);
+    return res.body;
+}
+exports.fetchGitRepositoryLinkReadToken = fetchGitRepositoryLinkReadToken;
 function sortConnectionsByCreateTime(connections) {
     return connections.sort((a, b) => {
         return Date.parse(a.createTime) - Date.parse(b.createTime);
@@ -127,3 +135,32 @@ async function generateP4SA(projectNumber) {
     await (0, serviceusage_1.generateServiceIdentityAndPoll)(projectNumber, new URL(devConnectOrigin).hostname, "apphosting");
 }
 exports.generateP4SA = generateP4SA;
+function extractGitRepositoryLinkComponents(path) {
+    const connectionMatch = /connections\/([^\/]+)/.exec(path);
+    const repositoryMatch = /gitRepositoryLinks\/([^\/]+)/.exec(path);
+    const connection = connectionMatch ? connectionMatch[1] : null;
+    const gitRepoLink = repositoryMatch ? repositoryMatch[1] : null;
+    return { connection, gitRepoLink };
+}
+exports.extractGitRepositoryLinkComponents = extractGitRepositoryLinkComponents;
+async function getRepoDetailsFromBackend(projectId, location, gitRepoLinkPath) {
+    const { connection, gitRepoLink } = extractGitRepositoryLinkComponents(gitRepoLinkPath);
+    if (!connection || !gitRepoLink) {
+        throw new error_1.FirebaseError(`Failed to extract connection or repository resource names from backend repository name.`);
+    }
+    const repoLink = await getGitRepositoryLink(projectId, location, connection, gitRepoLink);
+    const repoSlug = (0, githubConnections_1.extractRepoSlugFromUri)(repoLink.cloneUri);
+    const owner = repoSlug === null || repoSlug === void 0 ? void 0 : repoSlug.split("/")[0];
+    const repo = repoSlug === null || repoSlug === void 0 ? void 0 : repoSlug.split("/")[1];
+    if (!owner || !repo) {
+        throw new error_1.FirebaseError("Failed to parse owner and repo from git repository link");
+    }
+    const readToken = await fetchGitRepositoryLinkReadToken(projectId, location, connection, gitRepoLink);
+    return {
+        repoLink,
+        owner,
+        repo,
+        readToken,
+    };
+}
+exports.getRepoDetailsFromBackend = getRepoDetailsFromBackend;