canvasing/node_modules/firebase-tools/lib/init/features/database.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.doSetup = void 0;
const clc = require("colorette");
const prompt_1 = require("../../prompt");
const logger_1 = require("../../logger");
const utils = require("../../utils");
const fsutils = require("../../fsutils");
const database_1 = require("../../management/database");
const ora = require("ora");
const ensureApiEnabled_1 = require("../../ensureApiEnabled");
const getDefaultDatabaseInstance_1 = require("../../getDefaultDatabaseInstance");
const error_1 = require("../../error");
const apiv2_1 = require("../../apiv2");
const DEFAULT_RULES = JSON.stringify({ rules: { ".read": "auth != null", ".write": "auth != null" } }, null, 2);
async function getDBRules(instanceDetails) {
    if (!instanceDetails || !instanceDetails.name) {
        return DEFAULT_RULES;
    }
    const client = new apiv2_1.Client({ urlPrefix: instanceDetails.databaseUrl });
    const response = await client.request({
        method: "GET",
        path: "/.settings/rules.json",
        responseType: "stream",
        resolveOnHTTPError: true,
    });
    if (response.status !== 200) {
        throw new error_1.FirebaseError(`Failed to fetch current rules. Code: ${response.status}`);
    }
    return await response.response.text();
}
function writeDBRules(rules, logMessagePrefix, filename, config) {
    config.writeProjectFile(filename, rules);
    utils.logSuccess(`${logMessagePrefix} have been written to ${clc.bold(filename)}.`);
    logger_1.logger.info(`Future modifications to ${clc.bold(filename)} will update Realtime Database Security Rules when you run`);
    logger_1.logger.info(clc.bold("firebase deploy") + ".");
}
async function createDefaultDatabaseInstance(project) {
    const selectedLocation = await (0, prompt_1.promptOnce)({
        type: "list",
        message: "Please choose the location for your default Realtime Database instance:",
        choices: [
            { name: "us-central1", value: database_1.DatabaseLocation.US_CENTRAL1 },
            { name: "europe-west1", value: database_1.DatabaseLocation.EUROPE_WEST1 },
            { name: "asia-southeast1", value: database_1.DatabaseLocation.ASIA_SOUTHEAST1 },
        ],
    });
    let instanceName = `${project}-default-rtdb`;
    const checkOutput = await (0, database_1.checkInstanceNameAvailable)(project, instanceName, database_1.DatabaseInstanceType.DEFAULT_DATABASE, selectedLocation);
    if (!checkOutput.available) {
        if (!checkOutput.suggestedIds || checkOutput.suggestedIds.length === 0) {
            logger_1.logger.debug(`No instance names were suggested instead of conventional instance name: ${instanceName}`);
            throw new error_1.FirebaseError("Failed to create default RTDB instance");
        }
        instanceName = checkOutput.suggestedIds[0];
        logger_1.logger.info(`${clc.yellow("WARNING:")} your project ID has the legacy name format, so your default Realtime Database instance will be named differently: ${instanceName}`);
    }
    const spinner = ora(`Creating your default Realtime Database instance: ${instanceName}`).start();
    try {
        const createdInstance = await (0, database_1.createInstance)(project, instanceName, selectedLocation, database_1.DatabaseInstanceType.DEFAULT_DATABASE);
        spinner.succeed();
        return createdInstance;
    }
    catch (err) {
        spinner.fail();
        throw err;
    }
}
async function doSetup(setup, config) {
    setup.config = setup.config || {};
    let instanceDetails;
    if (setup.projectId) {
        await (0, ensureApiEnabled_1.ensure)(setup.projectId, "firebasedatabase.googleapis.com", "database", false);
        logger_1.logger.info();
        setup.instance =
            setup.instance || (await (0, getDefaultDatabaseInstance_1.getDefaultDatabaseInstance)({ project: setup.projectId }));
        if (setup.instance !== "") {
            instanceDetails = await (0, database_1.getDatabaseInstanceDetails)(setup.projectId, setup.instance);
        }
        else {
            const confirm = await (0, prompt_1.promptOnce)({
                type: "confirm",
                name: "confirm",
                default: true,
                message: "It seems like you haven’t initialized Realtime Database in your project yet. Do you want to set it up?",
            });
            if (confirm) {
                instanceDetails = await createDefaultDatabaseInstance(setup.projectId);
            }
        }
    }
    setup.config.database = setup.config.database || {};
    logger_1.logger.info();
    logger_1.logger.info("Firebase Realtime Database Security Rules allow you to define how your data should be");
    logger_1.logger.info("structured and when your data can be read from and written to.");
    logger_1.logger.info();
    await (0, prompt_1.prompt)(setup.config.database, [
        {
            type: "input",
            name: "rules",
            message: "What file should be used for Realtime Database Security Rules?",
            default: "database.rules.json",
        },
    ]);
    const filename = setup.config.database.rules;
    if (!filename) {
        throw new error_1.FirebaseError("Must specify location for Realtime Database rules file.");
    }
    let writeRules = true;
    if (fsutils.fileExistsSync(filename)) {
        const rulesDescription = instanceDetails
            ? `the Realtime Database Security Rules for ${clc.bold(instanceDetails.name)} from the Firebase console`
            : "default rules";
        const msg = `File ${clc.bold(filename)} already exists. Do you want to overwrite it with ${rulesDescription}?`;
        writeRules = await (0, prompt_1.promptOnce)({
            type: "confirm",
            message: msg,
            default: false,
        });
    }
    if (writeRules) {
        if (instanceDetails) {
            writeDBRules(await getDBRules(instanceDetails), `Database Rules for ${instanceDetails.name}`, filename, config);
            return;
        }
        writeDBRules(DEFAULT_RULES, "Default rules", filename, config);
        return;
    }
    logger_1.logger.info("Skipping overwrite of Realtime Database Security Rules.");
    logger_1.logger.info(`The security rules defined in ${clc.bold(filename)} will be published when you run ${clc.bold("firebase deploy")}.`);
    return;
}
exports.doSetup = doSetup;