firebase-tools 13.0.0 → 13.0.2

package/lib/init/features/{frameworks → apphosting}/repo.js

@@ -1,16 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.listFrameworksConnections = exports.getOrCreateRepository = exports.getOrCreateConnection = exports.createConnection = exports.linkGitHubRepository = exports.parseConnectionName = void 0;
+exports.listAppHostingConnections = exports.getOrCreateRepository = exports.getOrCreateConnection = exports.createConnection = exports.linkGitHubRepository = exports.parseConnectionName = void 0;
 const clc = require("colorette");
 const gcb = require("../../../gcp/cloudbuild");
+const rm = require("../../../gcp/resourceManager");
 const poller = require("../../../operation-poller");
 const utils = require("../../../utils");
 const api_1 = require("../../../api");
 const error_1 = require("../../../error");
-const logger_1 = require("../../../logger");
 const prompt_1 = require("../../../prompt");
-const FRAMEWORKS_CONN_PATTERN = /.+\/frameworks-github-conn-.+$/;
-const FRAMEWORKS_OAUTH_CONN_NAME = "frameworks-github-oauth";
+const getProjectNumber_1 = require("../../../getProjectNumber");
+const APPHOSTING_CONN_PATTERN = /.+\/apphosting-github-conn-.+$/;
+const APPHOSTING_OAUTH_CONN_NAME = "apphosting-github-oauth";
 const CONNECTION_NAME_REGEX = /^projects\/(?<projectId>[^\/]+)\/locations\/(?<location>[^\/]+)\/connections\/(?<id>[^\/]+)$/;
 function parseConnectionName(name) {
     const match = name.match(CONNECTION_NAME_REGEX);
@@ -44,14 +45,18 @@ function generateRepositoryId(remoteUri) {
 }
 function generateConnectionId() {
     const randomHash = Math.random().toString(36).slice(6);
-    return `frameworks-github-conn-${randomHash}`;
+    return `apphosting-github-conn-${randomHash}`;
 }
 async function linkGitHubRepository(projectId, location) {
     var _a, _b, _c;
-    logger_1.logger.info(clc.bold(`\n${clc.yellow("===")} Connect a GitHub repository`));
-    const existingConns = await listFrameworksConnections(projectId);
+    utils.logBullet(clc.bold(`${clc.yellow("===")} Set up a GitHub connection`));
+    const existingConns = await listAppHostingConnections(projectId);
     if (existingConns.length < 1) {
-        let oauthConn = await getOrCreateConnection(projectId, location, FRAMEWORKS_OAUTH_CONN_NAME);
+        const grantSuccess = await promptSecretManagerAdminGrant(projectId);
+        if (!grantSuccess) {
+            throw new error_1.FirebaseError("Insufficient IAM permissions to create a new connection to GitHub");
+        }
+        let oauthConn = await getOrCreateConnection(projectId, location, APPHOSTING_OAUTH_CONN_NAME);
         while (oauthConn.installationState.stage === "PENDING_USER_OAUTH") {
             oauthConn = await promptConnectionAuth(oauthConn);
         }
@@ -65,14 +70,14 @@ async function linkGitHubRepository(projectId, location) {
         }
         existingConns.push(refreshedConn);
     }
-    let { remoteUri, connection } = await promptRepositoryUri(projectId, location, existingConns);
+    let { remoteUri, connection } = await promptRepositoryUri(projectId, existingConns);
     while (remoteUri === "") {
         await utils.openInBrowser("https://github.com/apps/google-cloud-build/installations/new");
         await (0, prompt_1.promptOnce)({
             type: "input",
             message: "Press ENTER once you have finished configuring your installation's access settings.",
         });
-        const selection = await promptRepositoryUri(projectId, location, existingConns);
+        const selection = await promptRepositoryUri(projectId, existingConns);
         remoteUri = selection.remoteUri;
         connection = selection.connection;
     }
@@ -82,17 +87,17 @@ async function linkGitHubRepository(projectId, location) {
         appInstallationId: (_c = connection.githubConfig) === null || _c === void 0 ? void 0 : _c.appInstallationId,
     });
     const repo = await getOrCreateRepository(projectId, location, connectionId, remoteUri);
-    logger_1.logger.info();
-    utils.logSuccess(`Successfully linked GitHub repository at remote URI:\n ${remoteUri}`);
+    utils.logSuccess(`Successfully linked GitHub repository at remote URI`);
+    utils.logSuccess(`\t${remoteUri}`);
     return repo;
 }
 exports.linkGitHubRepository = linkGitHubRepository;
-async function promptRepositoryUri(projectId, location, connections) {
+async function promptRepositoryUri(projectId, connections) {
     const remoteUriToConnection = {};
     for (const conn of connections) {
-        const { id } = parseConnectionName(conn.name);
+        const { location, id } = parseConnectionName(conn.name);
         const resp = await gcb.fetchLinkableRepositories(projectId, location, id);
-        if (resp.repositories && resp.repositories.length > 1) {
+        if (resp.repositories && resp.repositories.length > 0) {
             for (const repo of resp.repositories) {
                 remoteUriToConnection[repo.remoteUri] = conn;
             }
@@ -113,11 +118,35 @@ async function promptRepositoryUri(projectId, location, connections) {
     });
     return { remoteUri, connection: remoteUriToConnection[remoteUri] };
 }
+async function promptSecretManagerAdminGrant(projectId) {
+    const projectNumber = await (0, getProjectNumber_1.getProjectNumber)({ projectId });
+    const cbsaEmail = gcb.serviceAgentEmail(projectNumber);
+    const alreadyGranted = await rm.serviceAccountHasRoles(projectId, cbsaEmail, ["roles/secretmanager.admin"], true);
+    if (alreadyGranted) {
+        return true;
+    }
+    utils.logBullet("To create a new GitHub connection, Secret Manager Admin role (roles/secretmanager.admin) is required on the Cloud Build Service Agent.");
+    const grant = await (0, prompt_1.promptOnce)({
+        type: "confirm",
+        message: "Grant the required role to the Cloud Build Service Agent?",
+    });
+    if (!grant) {
+        utils.logBullet("You, or your project administrator, should run the following command to grant the required role:\n\n" +
+            "You, or your project adminstrator, can run the following command to grant the required role manually:\n\n" +
+            `\tgcloud projects add-iam-policy-binding ${projectId} \\\n` +
+            `\t  --member="serviceAccount:${cbsaEmail} \\\n` +
+            `\t  --role="roles/secretmanager.admin\n`);
+        return false;
+    }
+    await rm.addServiceAccountToRoles(projectId, cbsaEmail, ["roles/secretmanager.admin"], true);
+    utils.logSuccess("Successfully granted the required role to the Cloud Build Service Agent!");
+    return true;
+}
 async function promptConnectionAuth(conn) {
-    logger_1.logger.info("You must authorize the Cloud Build GitHub app.");
-    logger_1.logger.info();
-    logger_1.logger.info("First, sign in to GitHub and authorize Cloud Build GitHub app:");
-    const cleanup = await utils.openInBrowserPopup(conn.installationState.actionUri, "Authorize the GitHub app");
+    utils.logBullet("You must authorize the Cloud Build GitHub app.");
+    utils.logBullet("Sign in to GitHub and authorize Cloud Build GitHub app:");
+    const { url, cleanup } = await utils.openInBrowserPopup(conn.installationState.actionUri, "Authorize the GitHub app");
+    utils.logBullet(`\t${url}`);
     await (0, prompt_1.promptOnce)({
         type: "input",
         message: "Press Enter once you have authorized the app",
@@ -127,9 +156,9 @@ async function promptConnectionAuth(conn) {
     return await gcb.getConnection(projectId, location, id);
 }
 async function promptAppInstall(conn) {
-    logger_1.logger.info("Now, install the Cloud Build GitHub app:");
+    utils.logBullet("Install the Cloud Build GitHub app to enable access to GitHub repositories");
     const targetUri = conn.installationState.actionUri.replace("install_v2", "direct_install_v2");
-    logger_1.logger.info(targetUri);
+    utils.logBullet(targetUri);
     await utils.openInBrowser(targetUri);
     await (0, prompt_1.promptOnce)({
         type: "input",
@@ -168,10 +197,6 @@ async function getOrCreateRepository(projectId, location, connectionId, remoteUr
     let repo;
     try {
         repo = await gcb.getRepository(projectId, location, connectionId, repositoryId);
-        const repoSlug = extractRepoSlugFromUri(repo.remoteUri);
-        if (repoSlug) {
-            throw new error_1.FirebaseError(`${repoSlug} has already been linked.`);
-        }
     }
     catch (err) {
         if (err.status === 404) {
@@ -185,10 +210,10 @@ async function getOrCreateRepository(projectId, location, connectionId, remoteUr
     return repo;
 }
 exports.getOrCreateRepository = getOrCreateRepository;
-async function listFrameworksConnections(projectId) {
+async function listAppHostingConnections(projectId) {
     const conns = await gcb.listConnections(projectId, "-");
-    return conns.filter((conn) => FRAMEWORKS_CONN_PATTERN.test(conn.name) &&
+    return conns.filter((conn) => APPHOSTING_CONN_PATTERN.test(conn.name) &&
         conn.installationState.stage === "COMPLETE" &&
         !conn.disabled);
 }
-exports.listFrameworksConnections = listFrameworksConnections;
+exports.listAppHostingConnections = listAppHostingConnections;

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

@@ -124,7 +124,7 @@ async function doSetup(setup, config, options) {
             type: "list",
             message: "In which region would you like to host server-side content, if applicable?",
             default: constants_1.DEFAULT_REGION,
-            choices: constants_1.ALLOWED_SSR_REGIONS,
+            choices: constants_1.ALLOWED_SSR_REGIONS.filter((region) => region.recommended),
         }, setup.hosting);
         setup.config.hosting = {
             source: setup.hosting.source,

package/lib/init/features/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.frameworks = exports.hostingGithub = exports.remoteconfig = exports.project = exports.extensions = exports.emulators = exports.storage = exports.hosting = exports.functions = exports.firestore = exports.database = exports.account = void 0;
+exports.apphosting = exports.hostingGithub = exports.remoteconfig = exports.project = exports.extensions = 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");
@@ -23,5 +23,5 @@ 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; } });
-var frameworks_1 = require("./frameworks");
-Object.defineProperty(exports, "frameworks", { enumerable: true, get: function () { return frameworks_1.doSetup; } });
+var apphosting_1 = require("./apphosting");
+Object.defineProperty(exports, "apphosting", { enumerable: true, get: function () { return apphosting_1.doSetup; } });

package/lib/init/index.js

@@ -6,7 +6,6 @@ const clc = require("colorette");
 const error_1 = require("../error");
 const logger_1 = require("../logger");
 const features = require("./features");
-const experiments_1 = require("../experiments");
 const featureFns = new Map([
     ["account", features.account],
     ["database", features.database],
@@ -20,9 +19,6 @@ const featureFns = new Map([
     ["remoteconfig", features.remoteconfig],
     ["hosting:github", features.hostingGithub],
 ]);
-if ((0, experiments_1.isEnabled)("internalframeworks")) {
-    featureFns.set("internalframeworks", features.frameworks);
-}
 async function init(setup, config, options) {
     var _a;
     const nextFeature = (_a = setup.features) === null || _a === void 0 ? void 0 : _a.shift();

package/lib/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.openInBrowserPopup = exports.openInBrowser = exports.connectableHostname = exports.randomInt = exports.debounce = exports.last = exports.cloneDeep = exports.groupBy = exports.assertIsStringOrUndefined = exports.assertIsNumber = exports.assertIsString = exports.thirtyDaysFromNow = exports.isRunningInWSL = exports.isVSCodeExtension = exports.isCloudEnvironment = exports.datetimeString = exports.createDestroyer = exports.promiseWithSpinner = exports.setupLoggers = exports.tryParse = exports.tryStringify = exports.promiseProps = exports.withTimeout = exports.promiseWhile = exports.promiseAllSettled = exports.getFunctionsEventProvider = exports.endpoint = exports.makeActiveProject = exports.streamToString = exports.stringToStream = exports.explainStdin = exports.allSettled = exports.reject = exports.logLabeledError = exports.logLabeledWarning = exports.logWarning = exports.logLabeledBullet = exports.logBullet = exports.logLabeledSuccess = exports.logSuccess = exports.addSubdomain = exports.addDatabaseNamespace = exports.getDatabaseViewDataUrl = exports.getDatabaseUrl = exports.envOverride = exports.getInheritedOption = exports.consoleUrl = exports.envOverrides = void 0;
+exports.generateId = exports.getHostnameFromUrl = exports.openInBrowserPopup = exports.openInBrowser = exports.connectableHostname = exports.randomInt = exports.debounce = exports.last = exports.cloneDeep = exports.groupBy = exports.assertIsStringOrUndefined = exports.assertIsNumber = exports.assertIsString = exports.thirtyDaysFromNow = exports.isRunningInWSL = exports.isVSCodeExtension = exports.isCloudEnvironment = exports.datetimeString = exports.createDestroyer = exports.promiseWithSpinner = exports.setupLoggers = exports.tryParse = exports.tryStringify = exports.promiseProps = exports.withTimeout = exports.promiseWhile = exports.promiseAllSettled = exports.getFunctionsEventProvider = exports.endpoint = exports.makeActiveProject = exports.streamToString = exports.stringToStream = exports.explainStdin = exports.allSettled = exports.reject = exports.logLabeledError = exports.logLabeledWarning = exports.logWarning = exports.logLabeledBullet = exports.logBullet = exports.logLabeledSuccess = exports.logSuccess = exports.addSubdomain = exports.addDatabaseNamespace = exports.getDatabaseViewDataUrl = exports.getDatabaseUrl = exports.envOverride = exports.getInheritedOption = exports.consoleUrl = exports.envOverrides = void 0;
 const fs = require("node:fs");
 const path = require("node:path");
 const _ = require("lodash");
@@ -506,10 +506,32 @@ async function openInBrowserPopup(url, buttonText) {
     });
     server.listen(port);
     const popupPageUri = `http://localhost:${port}`;
-    logger_1.logger.info(popupPageUri);
     await openInBrowser(popupPageUri);
-    return () => {
-        server.close();
+    return {
+        url: popupPageUri,
+        cleanup: () => {
+            server.close();
+        },
     };
 }
 exports.openInBrowserPopup = openInBrowserPopup;
+function getHostnameFromUrl(url) {
+    try {
+        return new URL(url).hostname;
+    }
+    catch (e) {
+        return null;
+    }
+}
+exports.getHostnameFromUrl = getHostnameFromUrl;
+function generateId(n = 6) {
+    const letters = "abcdefghijklmnopqrstuvwxyz";
+    const allChars = "01234567890-abcdefghijklmnopqrstuvwxyz";
+    let id = letters[Math.floor(Math.random() * letters.length)];
+    for (let i = 1; i < n; i++) {
+        const idx = Math.floor(Math.random() * allChars.length);
+        id += allChars[idx];
+    }
+    return id;
+}
+exports.generateId = generateId;

package/package.json

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

package/lib/gcp/frameworks.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createBuild = exports.deleteBackend = exports.listBackends = exports.getBackend = exports.createBackend = exports.API_VERSION = void 0;
-const apiv2_1 = require("../apiv2");
-const api_1 = require("../api");
-exports.API_VERSION = "v1alpha";
-const client = new apiv2_1.Client({
-    urlPrefix: api_1.frameworksOrigin,
-    auth: true,
-    apiVersion: exports.API_VERSION,
-});
-async function createBackend(projectId, location, backendReqBoby, backendId) {
-    const res = await client.post(`projects/${projectId}/locations/${location}/backends`, backendReqBoby, { queryParams: { backendId } });
-    return res.body;
-}
-exports.createBackend = createBackend;
-async function getBackend(projectId, location, backendId) {
-    const name = `projects/${projectId}/locations/${location}/backends/${backendId}`;
-    const res = await client.get(name);
-    return res.body;
-}
-exports.getBackend = getBackend;
-async function listBackends(projectId, location) {
-    const name = `projects/${projectId}/locations/${location}/backends`;
-    const res = await client.get(name);
-    return res.body;
-}
-exports.listBackends = listBackends;
-async function deleteBackend(projectId, location, backendId) {
-    const name = `projects/${projectId}/locations/${location}/backends/${backendId}`;
-    const res = await client.delete(name);
-    return res.body;
-}
-exports.deleteBackend = deleteBackend;
-async function createBuild(projectId, location, backendId, buildInput) {
-    const buildId = buildInput.name;
-    const res = await client.post(`projects/${projectId}/locations/${location}/backends/${backendId}/builds`, buildInput, { queryParams: { buildId } });
-    return res.body;
-}
-exports.createBuild = createBuild;

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

@@ -1,116 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createBackend = exports.getOrCreateBackend = exports.doSetup = void 0;
-const clc = require("colorette");
-const utils = require("../../../utils");
-const repo = require("./repo");
-const poller = require("../../../operation-poller");
-const gcp = require("../../../gcp/frameworks");
-const api_1 = require("../../../api");
-const frameworks_1 = require("../../../gcp/frameworks");
-const error_1 = require("../../../error");
-const logger_1 = require("../../../logger");
-const prompt_1 = require("../../../prompt");
-const constants_1 = require("./constants");
-const frameworksPollerOptions = {
-    apiOrigin: api_1.frameworksOrigin,
-    apiVersion: frameworks_1.API_VERSION,
-    masterTimeout: 25 * 60 * 1000,
-    maxBackoff: 10000,
-};
-async function doSetup(setup, projectId) {
-    setup.frameworks = {};
-    utils.logBullet("First we need a few details to create your backend.");
-    await (0, prompt_1.promptOnce)({
-        name: "serviceName",
-        type: "input",
-        default: "acme-inc-web",
-        message: "Create a name for your backend [1-30 characters]",
-    }, setup.frameworks);
-    await (0, prompt_1.promptOnce)({
-        name: "region",
-        type: "list",
-        default: constants_1.DEFAULT_REGION,
-        message: "Please select a region " +
-            `(${clc.yellow("info")}: Your region determines where your backend is located):\n`,
-        choices: constants_1.ALLOWED_REGIONS,
-    }, setup.frameworks);
-    utils.logSuccess(`Region set to ${setup.frameworks.region}.`);
-    const backend = await getOrCreateBackend(projectId, setup);
-    if (backend) {
-        logger_1.logger.info();
-        utils.logSuccess(`Successfully created backend:\n ${backend.name}`);
-        logger_1.logger.info();
-        utils.logSuccess(`Your site is being deployed at:\n https://${backend.uri}`);
-        logger_1.logger.info();
-        utils.logSuccess(`View the rollout status by running:\n firebase backends:get --backend=${backend.name}`);
-        logger_1.logger.info();
-    }
-}
-exports.doSetup = doSetup;
-function toBackend(cloudBuildConnRepo) {
-    return {
-        codebase: {
-            repository: `${cloudBuildConnRepo.name}`,
-            rootDirectory: "/",
-        },
-        labels: {},
-    };
-}
-async function getOrCreateBackend(projectId, setup) {
-    const location = setup.frameworks.region;
-    try {
-        return await getExistingBackend(projectId, setup, location);
-    }
-    catch (err) {
-        if (err.status === 404) {
-            const cloudBuildConnRepo = await repo.linkGitHubRepository(projectId, location);
-            logger_1.logger.info();
-            await (0, prompt_1.promptOnce)({
-                name: "branchName",
-                type: "input",
-                default: "main",
-                message: "Which branch do you want to deploy?",
-            }, setup.frameworks);
-            const backendDetails = toBackend(cloudBuildConnRepo);
-            logger_1.logger.info(clc.bold(`\n${clc.white("===")} Creating your backend`));
-            return await createBackend(projectId, location, backendDetails, setup.frameworks.serviceName);
-        }
-        else {
-            throw new error_1.FirebaseError(`Failed to get or create a backend using the given initialization details: ${err}`);
-        }
-    }
-    return undefined;
-}
-exports.getOrCreateBackend = getOrCreateBackend;
-async function getExistingBackend(projectId, setup, location) {
-    let backend = await gcp.getBackend(projectId, location, setup.frameworks.serviceName);
-    while (backend) {
-        setup.frameworks.serviceName = undefined;
-        await (0, prompt_1.promptOnce)({
-            name: "existingBackend",
-            type: "confirm",
-            default: true,
-            message: "A backend already exists for the given serviceName, do you want to use existing backend? (yes/no)",
-        }, setup.frameworks);
-        if (setup.frameworks.existingBackend) {
-            logger_1.logger.info("Using the existing backend.");
-            return backend;
-        }
-        await (0, prompt_1.promptOnce)({
-            name: "serviceName",
-            type: "input",
-            default: "acme-inc-web",
-            message: "Please enter a new service name [1-30 characters]",
-        }, setup.frameworks);
-        backend = await gcp.getBackend(projectId, location, setup.frameworks.serviceName);
-        setup.frameworks.existingBackend = undefined;
-    }
-    return backend;
-}
-async function createBackend(projectId, location, backendReqBoby, backendId) {
-    const op = await gcp.createBackend(projectId, location, backendReqBoby, backendId);
-    const backend = await poller.pollOperation(Object.assign(Object.assign({}, frameworksPollerOptions), { pollerName: `create-${projectId}-${location}-${backendId}`, operationResourceName: op.name }));
-    return backend;
-}
-exports.createBackend = createBackend;