firebase-tools 10.2.0 → 10.3.0

package/lib/emulator/download.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadEmulator = void 0;
+exports.downloadExtensionVersion = exports.downloadEmulator = void 0;
 const crypto = require("crypto");
 const fs = require("fs-extra");
 const path = require("path");
@@ -32,6 +32,23 @@ async function downloadEmulator(name) {
     removeOldFiles(name, emulator);
 }
 exports.downloadEmulator = downloadEmulator;
+async function downloadExtensionVersion(extensionVersionRef, sourceDownloadUri, targetDir) {
+    const emulatorLogger = emulatorLogger_1.EmulatorLogger.forExtension({ ref: extensionVersionRef });
+    emulatorLogger.logLabeled("BULLET", "extensions", `Starting download for ${extensionVersionRef} source code...`);
+    try {
+        fs.mkdirSync(targetDir);
+    }
+    catch (err) {
+        emulatorLogger.logLabeled("BULLET", "extensions", `cache directory for ${extensionVersionRef} already exists...`);
+    }
+    emulatorLogger.logLabeled("BULLET", "extensions", `downloading ${sourceDownloadUri}...`);
+    const sourceCodeZip = await downloadUtils.downloadToTmp(sourceDownloadUri);
+    await unzip(sourceCodeZip, targetDir);
+    fs.chmodSync(targetDir, 0o755);
+    emulatorLogger.logLabeled("BULLET", "extensions", `Downloaded to ${targetDir}...`);
+    await new Promise((resolve) => setTimeout(resolve, 1000));
+}
+exports.downloadExtensionVersion = downloadExtensionVersion;
 function unzip(zipPath, unzipDir) {
     return new Promise((resolve, reject) => {
         fs.createReadStream(zipPath)

package/lib/emulator/downloadableEmulators.js

@@ -13,6 +13,7 @@ const path = require("path");
 const os = require("os");
 const registry_1 = require("./registry");
 const download_1 = require("../emulator/download");
+const previews_1 = require("../previews");
 const EMULATOR_INSTANCE_KILL_TIMEOUT = 4000;
 const CACHE_DIR = process.env.FIREBASE_EMULATORS_PATH || path.join(os.homedir(), ".cache", "firebase", "emulators");
 exports.DownloadDetails = {
@@ -49,19 +50,35 @@ exports.DownloadDetails = {
             namePrefix: "cloud-storage-rules-emulator",
         },
     },
-    ui: {
-        version: "1.6.4",
-        downloadPath: path.join(CACHE_DIR, "ui-v1.6.4.zip"),
-        unzipDir: path.join(CACHE_DIR, "ui-v1.6.4"),
-        binaryPath: path.join(CACHE_DIR, "ui-v1.6.4", "server.bundle.js"),
-        opts: {
-            cacheDir: CACHE_DIR,
-            remoteUrl: "https://storage.googleapis.com/firebase-preview-drop/emulator/ui-v1.6.4.zip",
-            expectedSize: 3757300,
-            expectedChecksum: "20d4ee71e4ff7527b1843b6a8636142e",
-            namePrefix: "ui",
+    ui: previews_1.previews.emulatoruisnapshot
+        ? {
+            version: "SNAPSHOT",
+            downloadPath: path.join(CACHE_DIR, "ui-vSNAPSHOT.zip"),
+            unzipDir: path.join(CACHE_DIR, "ui-vSNAPSHOT"),
+            binaryPath: path.join(CACHE_DIR, "ui-vSNAPSHOT", "server.bundle.js"),
+            opts: {
+                cacheDir: CACHE_DIR,
+                remoteUrl: "https://storage.googleapis.com/firebase-preview-drop/emulator/ui-vSNAPSHOT.zip",
+                expectedSize: -1,
+                expectedChecksum: "",
+                skipCache: true,
+                skipChecksumAndSize: true,
+                namePrefix: "ui",
+            },
+        }
+        : {
+            version: "1.6.5",
+            downloadPath: path.join(CACHE_DIR, "ui-v1.6.5.zip"),
+            unzipDir: path.join(CACHE_DIR, "ui-v1.6.5"),
+            binaryPath: path.join(CACHE_DIR, "ui-v1.6.5", "server.bundle.js"),
+            opts: {
+                cacheDir: CACHE_DIR,
+                remoteUrl: "https://storage.googleapis.com/firebase-preview-drop/emulator/ui-v1.6.5.zip",
+                expectedSize: 3816994,
+                expectedChecksum: "92dfff4b2ef8ab616e8a60cc93e0a00b",
+                namePrefix: "ui",
+            },
         },
-    },
     pubsub: {
         downloadPath: path.join(CACHE_DIR, "pubsub-emulator-0.1.0.zip"),
         version: "0.1.0",
@@ -131,8 +148,8 @@ const Commands = {
     storage: {
         binary: "java",
         args: [
-            "-jar",
             "-Duser.language=en",
+            "-jar",
             getExecPath(types_1.Emulators.STORAGE),
             "serve",
         ],

package/lib/emulator/emulatorLogger.js

@@ -34,7 +34,7 @@ class EmulatorLogger {
             },
         });
     }
-    static forFunction(functionName) {
+    static forFunction(functionName, extensionLogInfo) {
         return new EmulatorLogger({
             metadata: {
                 emulator: {
@@ -43,6 +43,17 @@ class EmulatorLogger {
                 function: {
                     name: functionName,
                 },
+                extension: extensionLogInfo,
+            },
+        });
+    }
+    static forExtension(extensionLogInfo) {
+        return new EmulatorLogger({
+            metadata: {
+                emulator: {
+                    name: "extensions",
+                },
+                extension: extensionLogInfo,
             },
         });
     }

package/lib/emulator/extensions/validation.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkForUnemulatedTriggerTypes = exports.getUnemulatedAPIs = void 0;
+const planner = require("../../deploy/extensions/planner");
+const controller_1 = require("../controller");
+const constants_1 = require("../constants");
+const ensureApiEnabled_1 = require("../../ensureApiEnabled");
+const functionsEmulatorShared_1 = require("../functionsEmulatorShared");
+const types_1 = require("../types");
+const EMULATED_APIS = [
+    "storage-component.googleapis.com",
+    "firestore.googleapis.com",
+    "pubsub.googleapis.com",
+    "identitytoolkit.googleapis.com",
+];
+async function getUnemulatedAPIs(projectId, instances) {
+    var _a;
+    const unemulatedAPIs = {};
+    for (const i of instances) {
+        const extensionVersion = await planner.getExtensionVersion(i);
+        for (const api of (_a = extensionVersion.spec.apis) !== null && _a !== void 0 ? _a : []) {
+            if (!EMULATED_APIS.includes(api.apiName)) {
+                if (unemulatedAPIs[api.apiName]) {
+                    unemulatedAPIs[api.apiName].instanceIds.push(i.instanceId);
+                }
+                else {
+                    const enabled = !constants_1.Constants.isDemoProject(projectId) &&
+                        (await (0, ensureApiEnabled_1.check)(projectId, api.apiName, "extensions", true));
+                    unemulatedAPIs[api.apiName] = {
+                        apiName: api.apiName,
+                        instanceIds: [i.instanceId],
+                        enabled,
+                    };
+                }
+            }
+        }
+    }
+    return Object.values(unemulatedAPIs);
+}
+exports.getUnemulatedAPIs = getUnemulatedAPIs;
+function checkForUnemulatedTriggerTypes(backend, options) {
+    var _a;
+    const triggers = (_a = backend.predefinedTriggers) !== null && _a !== void 0 ? _a : [];
+    const unemulatedTriggers = triggers
+        .filter((definition) => {
+        if (definition.httpsTrigger) {
+            return false;
+        }
+        if (definition.eventTrigger) {
+            const service = (0, functionsEmulatorShared_1.getFunctionService)(definition);
+            switch (service) {
+                case constants_1.Constants.SERVICE_FIRESTORE:
+                    return !(0, controller_1.shouldStart)(options, types_1.Emulators.FIRESTORE);
+                case constants_1.Constants.SERVICE_REALTIME_DATABASE:
+                    return !(0, controller_1.shouldStart)(options, types_1.Emulators.DATABASE);
+                case constants_1.Constants.SERVICE_PUBSUB:
+                    return !(0, controller_1.shouldStart)(options, types_1.Emulators.PUBSUB);
+                case constants_1.Constants.SERVICE_AUTH:
+                    return !(0, controller_1.shouldStart)(options, types_1.Emulators.AUTH);
+                case constants_1.Constants.SERVICE_STORAGE:
+                    return !(0, controller_1.shouldStart)(options, types_1.Emulators.STORAGE);
+                default:
+                    return true;
+            }
+        }
+    })
+        .map((definition) => constants_1.Constants.getServiceName((0, functionsEmulatorShared_1.getFunctionService)(definition)));
+    return [...new Set(unemulatedTriggers)];
+}
+exports.checkForUnemulatedTriggerTypes = checkForUnemulatedTriggerTypes;

package/lib/emulator/extensionsEmulator.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtensionsEmulator = void 0;
+const fs = require("fs-extra");
+const os = require("os");
+const path = require("path");
+const clc = require("cli-color");
+const Table = require("cli-table");
+const child_process_1 = require("child_process");
+const planner = require("../deploy/extensions/planner");
+const error_1 = require("../error");
+const refs_1 = require("../extensions/refs");
+const download_1 = require("./download");
+const optionsHelper_1 = require("../extensions/emulator/optionsHelper");
+const emulatorLogger_1 = require("./emulatorLogger");
+const types_1 = require("./types");
+const validation_1 = require("./extensions/validation");
+const ensureApiEnabled_1 = require("../ensureApiEnabled");
+const shortenUrl_1 = require("../shortenUrl");
+const constants_1 = require("./constants");
+class ExtensionsEmulator {
+    constructor(args) {
+        this.want = [];
+        this.logger = emulatorLogger_1.EmulatorLogger.forEmulator(types_1.Emulators.EXTENSIONS);
+        this.pendingDownloads = new Map();
+        this.args = args;
+    }
+    async readManifest() {
+        var _a;
+        this.want = await planner.want({
+            projectId: this.args.projectId,
+            projectNumber: this.args.projectNumber,
+            aliases: (_a = this.args.aliases) !== null && _a !== void 0 ? _a : [],
+            projectDir: this.args.projectDir,
+            extensions: this.args.extensions,
+            emulatorMode: true,
+        });
+    }
+    async ensureSourceCode(instance) {
+        if (!instance.ref) {
+            throw new error_1.FirebaseError(`No ref found for ${instance.instanceId}. Emulating local extensions is not yet supported.`);
+        }
+        const ref = (0, refs_1.toExtensionVersionRef)(instance.ref);
+        const cacheDir = process.env.FIREBASE_EXTENSIONS_CACHE_PATH ||
+            path.join(os.homedir(), ".cache", "firebase", "extensions");
+        const sourceCodePath = path.join(cacheDir, ref);
+        if (this.pendingDownloads.get(ref)) {
+            await this.pendingDownloads.get(ref);
+        }
+        if (!this.hasValidSource({ path: sourceCodePath, extRef: ref })) {
+            const promise = this.downloadSource(instance, ref, sourceCodePath);
+            this.pendingDownloads.set(ref, promise);
+            await promise;
+        }
+        return sourceCodePath;
+    }
+    async downloadSource(instance, ref, sourceCodePath) {
+        const extensionVersion = await planner.getExtensionVersion(instance);
+        await (0, download_1.downloadExtensionVersion)(ref, extensionVersion.sourceDownloadUri, sourceCodePath);
+        this.installAndBuildSourceCode(sourceCodePath);
+    }
+    hasValidSource(args) {
+        const requiredFiles = [
+            "./extension.yaml",
+            "./functions/package.json",
+            "./functions/node_modules",
+        ];
+        for (const requiredFile of requiredFiles) {
+            const f = path.join(args.path, requiredFile);
+            if (!fs.existsSync(f)) {
+                emulatorLogger_1.EmulatorLogger.forExtension({ ref: args.extRef }).logLabeled("BULLET", "extensions", `Detected invalid source code for ${args.extRef}, expected to find ${f}`);
+                return false;
+            }
+        }
+        return true;
+    }
+    installAndBuildSourceCode(sourceCodePath) {
+        const npmInstall = (0, child_process_1.spawnSync)("npm", ["--prefix", `/${sourceCodePath}/functions/`, "install"], {
+            encoding: "utf8",
+        });
+        if (npmInstall.error) {
+            throw npmInstall.error;
+        }
+        const npmRunGCPBuild = (0, child_process_1.spawnSync)("npm", ["--prefix", `/${sourceCodePath}/functions/`, "run", "gcp-build"], { encoding: "utf8" });
+        if (npmRunGCPBuild.error) {
+            throw npmRunGCPBuild.error;
+        }
+    }
+    async getExtensionBackends() {
+        await this.readManifest();
+        await this.checkAndWarnAPIs(this.want);
+        return Promise.all(this.want.map((i) => {
+            return this.toEmulatableBackend(i);
+        }));
+    }
+    async toEmulatableBackend(instance) {
+        const extensionDir = await this.ensureSourceCode(instance);
+        const functionsDir = path.join(extensionDir, "functions");
+        const env = Object.assign(this.autoPopulatedParams(instance), instance.params);
+        const { extensionTriggers, nodeMajorVersion, nonSecretEnv, secretEnvVariables } = await (0, optionsHelper_1.getExtensionFunctionInfo)(extensionDir, instance.instanceId, env);
+        const extension = await planner.getExtension(instance);
+        const extensionVersion = await planner.getExtensionVersion(instance);
+        return {
+            functionsDir,
+            env: nonSecretEnv,
+            secretEnv: secretEnvVariables,
+            predefinedTriggers: extensionTriggers,
+            nodeMajorVersion: nodeMajorVersion,
+            extensionInstanceId: instance.instanceId,
+            extension,
+            extensionVersion,
+        };
+    }
+    autoPopulatedParams(instance) {
+        const projectId = this.args.projectId;
+        return {
+            PROJECT_ID: projectId !== null && projectId !== void 0 ? projectId : "",
+            EXT_INSTANCE_ID: instance.instanceId,
+            DATABASE_INSTANCE: projectId !== null && projectId !== void 0 ? projectId : "",
+            DATABASE_URL: `https://${projectId}.firebaseio.com`,
+            STORAGE_BUCKET: `${projectId}.appspot.com`,
+        };
+    }
+    async checkAndWarnAPIs(instances) {
+        const apisToWarn = await (0, validation_1.getUnemulatedAPIs)(this.args.projectId, instances);
+        if (apisToWarn.length) {
+            const table = new Table({
+                head: [
+                    "API Name",
+                    "Instances using this API",
+                    `Enabled on ${this.args.projectId}`,
+                    `Enable this API`,
+                ],
+                style: { head: ["yellow"] },
+            });
+            for (const apiToWarn of apisToWarn) {
+                const enablementUri = await (0, shortenUrl_1.shortenUrl)((0, ensureApiEnabled_1.enableApiURI)(this.args.projectId, apiToWarn.apiName));
+                table.push([
+                    apiToWarn.apiName,
+                    apiToWarn.instanceIds,
+                    apiToWarn.enabled ? "Yes" : "No",
+                    apiToWarn.enabled ? "" : clc.bold.underline(enablementUri),
+                ]);
+            }
+            if (constants_1.Constants.isDemoProject(this.args.projectId)) {
+                this.logger.logLabeled("WARN", "Extensions", "The following Extensions make calls to Google Cloud APIs that do not have Emulators. " +
+                    `${clc.bold(this.args.projectId)} is a demo project, so these Extensions may not work as expected.\n` +
+                    table.toString());
+            }
+            else {
+                this.logger.logLabeled("WARN", "Extensions", "The following Extensions make calls to Google Cloud APIs that do not have Emulators. " +
+                    `These calls will go to production Google Cloud APIs which may have real effects on ${clc.bold(this.args.projectId)}.\n` +
+                    table.toString());
+            }
+        }
+    }
+    filterUnemulatedTriggers(options, backends) {
+        let foundUnemulatedTrigger = false;
+        const filteredBackends = backends.filter((backend) => {
+            const unemulatedServices = (0, validation_1.checkForUnemulatedTriggerTypes)(backend, options);
+            if (unemulatedServices.length) {
+                foundUnemulatedTrigger = true;
+                const msg = ` ignored becuase it includes ${unemulatedServices.join(", ")} triggered functions, and the ${unemulatedServices.join(", ")} emulator does not exist or is not running.`;
+                this.logger.logLabeled("WARN", `extensions[${backend.extensionInstanceId}]`, msg);
+            }
+            return unemulatedServices.length === 0;
+        });
+        if (foundUnemulatedTrigger) {
+            const msg = "No Cloud Functions for these instances will be emulated, because partially emulating an Extension can lead to unexpected behavior. ";
+            this.logger.log("WARN", msg);
+        }
+        return filteredBackends;
+    }
+}
+exports.ExtensionsEmulator = ExtensionsEmulator;