firebase-tools 11.5.0 → 11.6.0

package/lib/emulator/storage/files.js

@@ -17,6 +17,8 @@ const logger_1 = require("../../logger");
 const adminSdkConfig_1 = require("../adminSdkConfig");
 const types_1 = require("./rules/types");
 const upload_1 = require("./upload");
+const track_1 = require("../../track");
+const types_2 = require("../types");
 class StoredFile {
     constructor(metadata) {
         this.metadata = metadata;
@@ -292,7 +294,7 @@ class StorageLayer {
     get dirPath() {
         return this._persistence.dirPath;
     }
-    async export(storageExportPath) {
+    async export(storageExportPath, options) {
         var e_1, _a;
         const bucketsList = {
             buckets: [],
@@ -300,6 +302,11 @@ class StorageLayer {
         for (const b of await this.listBuckets()) {
             bucketsList.buckets.push({ id: b.id });
         }
+        void (0, track_1.trackEmulator)("emulator_export", {
+            initiated_by: options.initiatedBy,
+            emulator_name: types_2.Emulators.STORAGE,
+            count: bucketsList.buckets.length,
+        });
         const bucketsFilePath = path.join(storageExportPath, "buckets.json");
         await fse.writeFile(bucketsFilePath, JSON.stringify(bucketsList, undefined, 2));
         const blobsDirPath = path.join(storageExportPath, "blobs");
@@ -323,9 +330,14 @@ class StorageLayer {
             finally { if (e_1) throw e_1.error; }
         }
     }
-    import(storageExportPath) {
+    import(storageExportPath, options) {
         const bucketsFile = path.join(storageExportPath, "buckets.json");
         const bucketsList = JSON.parse((0, fs_1.readFileSync)(bucketsFile, "utf-8"));
+        void (0, track_1.trackEmulator)("emulator_import", {
+            initiated_by: options.initiatedBy,
+            emulator_name: types_2.Emulators.STORAGE,
+            count: bucketsList.buckets.length,
+        });
         for (const b of bucketsList.buckets) {
             const bucketMetadata = new metadata_1.CloudStorageBucketMetadata(b.id);
             this._buckets.set(b.id, bucketMetadata);

package/lib/emulator/storage/rules/runtime.js

@@ -65,12 +65,12 @@ class StorageRulesRuntime {
     get alive() {
         return this._alive;
     }
-    async start(auto_download = true) {
+    async start(autoDownload = true) {
         var _a, _b;
         const downloadDetails = downloadableEmulators_1.DownloadDetails[types_2.Emulators.STORAGE];
         const hasEmulator = fs.existsSync(downloadDetails.downloadPath);
         if (!hasEmulator) {
-            if (auto_download) {
+            if (autoDownload) {
                 if (process.env.CI) {
                     utils.logWarning(`It appears you are running in a CI environment. You can avoid downloading the ${constants_1.Constants.description(types_2.Emulators.STORAGE)} repeatedly by caching the ${downloadDetails.opts.cacheDir} directory.`);
                 }

package/lib/emulator/storage/server.js

@@ -36,12 +36,13 @@ function createApp(defaultProjectId, emulator) {
         type: ["application/json"],
     }));
     app.post("/internal/export", async (req, res) => {
+        const initiatedBy = req.body.initiatedBy || "unknown";
         const path = req.body.path;
         if (!path) {
             res.status(400).send("Export request body must include 'path'.");
             return;
         }
-        await storageLayer.export(path);
+        await storageLayer.export(path, { initiatedBy });
         res.sendStatus(200);
     });
     app.put("/internal/setRules", async (req, res) => {

package/lib/emulator/storage/upload.js

@@ -65,6 +65,7 @@ class UploadService {
         };
         this._uploads.set(upload.id, upload);
         this._persistence.deleteFile(upload.path, true);
+        this._persistence.appendBytes(upload.path, Buffer.alloc(0));
         return upload;
     }
     continueResumableUpload(uploadId, dataRaw) {

package/lib/emulator/types.js

@@ -14,6 +14,7 @@ var Emulators;
     Emulators["LOGGING"] = "logging";
     Emulators["STORAGE"] = "storage";
     Emulators["EXTENSIONS"] = "extensions";
+    Emulators["EVENTARC"] = "eventarc";
 })(Emulators = exports.Emulators || (exports.Emulators = {}));
 exports.DOWNLOADABLE_EMULATORS = [
     Emulators.FIRESTORE,
@@ -36,12 +37,14 @@ exports.ALL_SERVICE_EMULATORS = [
     Emulators.HOSTING,
     Emulators.PUBSUB,
     Emulators.STORAGE,
+    Emulators.EVENTARC,
 ].filter((v) => v);
 exports.EMULATORS_SUPPORTED_BY_FUNCTIONS = [
     Emulators.FIRESTORE,
     Emulators.DATABASE,
     Emulators.PUBSUB,
     Emulators.STORAGE,
+    Emulators.EVENTARC,
 ];
 exports.EMULATORS_SUPPORTED_BY_UI = [
     Emulators.AUTH,

package/lib/emulator/ui.js

@@ -6,6 +6,7 @@ const downloadableEmulators = require("./downloadableEmulators");
 const registry_1 = require("./registry");
 const error_1 = require("../error");
 const constants_1 = require("./constants");
+const track_1 = require("../track");
 class EmulatorUI {
     constructor(args) {
         this.args = args;
@@ -15,14 +16,18 @@ class EmulatorUI {
             throw new error_1.FirebaseError(`Cannot start ${constants_1.Constants.description(types_1.Emulators.UI)} without ${constants_1.Constants.description(types_1.Emulators.HUB)}!`);
         }
         const hubInfo = registry_1.EmulatorRegistry.get(types_1.Emulators.HUB).getInfo();
-        const { auto_download, host, port, projectId } = this.args;
+        const { auto_download: autoDownload, host, port, projectId } = this.args;
         const env = {
             HOST: host.toString(),
             PORT: port.toString(),
             GCLOUD_PROJECT: projectId,
             [constants_1.Constants.FIREBASE_EMULATOR_HUB]: registry_1.EmulatorRegistry.getInfoHostString(hubInfo),
         };
-        return downloadableEmulators.start(types_1.Emulators.UI, { auto_download }, env);
+        const session = (0, track_1.emulatorSession)();
+        if (session) {
+            env[constants_1.Constants.FIREBASE_GA_SESSION] = JSON.stringify(session);
+        }
+        return downloadableEmulators.start(types_1.Emulators.UI, { auto_download: autoDownload }, env);
     }
     connect() {
         return Promise.resolve();

package/lib/extensions/extensionsApi.js

@@ -291,13 +291,14 @@ async function listExtensions(publisherId) {
     return extensions;
 }
 exports.listExtensions = listExtensions;
-async function listExtensionVersions(ref, filter = "") {
+async function listExtensionVersions(ref, filter = "", showPrereleases = false) {
     const { publisherId, extensionId } = refs.parse(ref);
     const extensionVersions = [];
     const getNextPage = async (pageToken = "") => {
         const res = await apiClient.get(`/publishers/${publisherId}/extensions/${extensionId}/versions`, {
             queryParams: {
                 filter,
+                showPrereleases: String(showPrereleases),
                 pageSize: PAGE_SIZE_MAX,
                 pageToken,
             },

package/lib/extensions/extensionsHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.canonicalizeRefInput = exports.diagnoseAndFixProject = exports.confirm = exports.getSourceOrigin = exports.isLocalOrURLPath = exports.isLocalPath = exports.isUrlPath = exports.instanceIdExists = exports.promptForRepeatInstance = exports.promptForOfficialExtension = exports.displayReleaseNotes = exports.getPublisherProjectFromName = exports.createSourceFromLocation = exports.publishExtensionVersionFromLocalSource = exports.ensureExtensionsApiEnabled = exports.promptForValidInstanceId = exports.validateSpec = exports.validateCommandLineParams = exports.populateDefaultParams = exports.substituteParams = exports.getFirebaseProjectParams = exports.getDBInstanceFromURL = exports.resourceTypeToNiceName = exports.AUTOPOULATED_PARAM_PLACEHOLDERS = exports.EXTENSIONS_BUCKET_NAME = exports.URL_REGEX = exports.logPrefix = exports.SourceOrigin = exports.SpecParamType = void 0;
+exports.canonicalizeRefInput = exports.diagnoseAndFixProject = exports.confirm = exports.getSourceOrigin = exports.isLocalOrURLPath = exports.isLocalPath = exports.isUrlPath = exports.instanceIdExists = exports.promptForRepeatInstance = exports.promptForOfficialExtension = exports.displayReleaseNotes = exports.getPublisherProjectFromName = exports.createSourceFromLocation = exports.publishExtensionVersionFromLocalSource = exports.incrementPrereleaseVersion = exports.ensureExtensionsApiEnabled = exports.promptForValidInstanceId = exports.validateSpec = exports.validateCommandLineParams = exports.populateDefaultParams = exports.substituteParams = exports.getFirebaseProjectParams = exports.getDBInstanceFromURL = exports.resourceTypeToNiceName = exports.AUTOPOULATED_PARAM_PLACEHOLDERS = exports.EXTENSIONS_BUCKET_NAME = exports.URL_REGEX = exports.logPrefix = exports.SourceOrigin = exports.SpecParamType = void 0;
 const clc = require("colorette");
 const ora = require("ora");
 const semver = require("semver");
@@ -282,6 +282,33 @@ async function archiveAndUploadSource(extPath, bucketName) {
     const res = await (0, storage_1.uploadObject)(zippedSource, bucketName);
     return `/${res.bucket}/${res.object}`;
 }
+async function incrementPrereleaseVersion(ref, extensionVersion, stage) {
+    var _a;
+    const stageOptions = ["stable", "alpha", "beta", "rc"];
+    if (!stageOptions.includes(stage)) {
+        throw new error_1.FirebaseError(`--stage flag only supports the following values: ${stageOptions}`);
+    }
+    if (stage !== "stable") {
+        const version = semver.parse(extensionVersion);
+        if (version.prerelease.length > 0 || version.build.length > 0) {
+            throw new error_1.FirebaseError(`Cannot combine the --stage flag with a version with a prerelease annotation in extension.yaml.`);
+        }
+        let extensionVersions = [];
+        try {
+            extensionVersions = await (0, extensionsApi_1.listExtensionVersions)(ref, `id="${version.version}"`, true);
+        }
+        catch (e) {
+        }
+        const latestVersion = (_a = extensionVersions
+            .map((version) => semver.parse(version.spec.version))
+            .filter((version) => version.prerelease.length > 0 && version.prerelease[0] === stage)
+            .sort((v1, v2) => semver.compare(v1, v2))
+            .pop()) !== null && _a !== void 0 ? _a : `${version}-${stage}`;
+        return semver.inc(latestVersion, "prerelease", undefined, stage);
+    }
+    return extensionVersion;
+}
+exports.incrementPrereleaseVersion = incrementPrereleaseVersion;
 async function publishExtensionVersionFromLocalSource(args) {
     const extensionSpec = await (0, localHelper_1.getLocalExtensionSpec)(args.rootDirectory);
     if (extensionSpec.name !== args.extensionId) {
@@ -290,6 +317,7 @@ async function publishExtensionVersionFromLocalSource(args) {
     const subbedSpec = JSON.parse(JSON.stringify(extensionSpec));
     subbedSpec.params = substituteParams(extensionSpec.params || [], exports.AUTOPOULATED_PARAM_PLACEHOLDERS);
     validateSpec(subbedSpec);
+    extensionSpec.version = await incrementPrereleaseVersion(`${args.publisherId}/${args.extensionId}`, extensionSpec.version, args.stage);
     let extension;
     try {
         extension = await (0, extensionsApi_1.getExtension)(`${args.publisherId}/${args.extensionId}`);

package/lib/serve/index.js

@@ -4,6 +4,9 @@ exports.serve = void 0;
 const logger_1 = require("../logger");
 const frameworks_1 = require("../frameworks");
 const previews_1 = require("../previews");
+const track_1 = require("../track");
+const projectUtils_1 = require("../projectUtils");
+const constants_1 = require("../emulator/constants");
 const { FunctionsServer } = require("./functions");
 const TARGETS = {
     hosting: require("./hosting"),
@@ -17,12 +20,24 @@ async function serve(options) {
         [].concat(options.config.get("hosting")).some((it) => it.source)) {
         await (0, frameworks_1.prepareFrameworks)(targetNames, options, options);
     }
+    const isDemoProject = constants_1.Constants.isDemoProject((0, projectUtils_1.getProjectId)(options) || "");
+    targetNames.forEach((targetName) => {
+        void (0, track_1.trackEmulator)("emulator_run", {
+            emulator_name: targetName,
+            is_demo_project: String(isDemoProject),
+        });
+    });
     await Promise.all(targetNames.map((targetName) => {
         return TARGETS[targetName].start(options);
     }));
     await Promise.all(targetNames.map((targetName) => {
         return TARGETS[targetName].connect();
     }));
+    void (0, track_1.trackEmulator)("emulators_started", {
+        count: targetNames.length,
+        count_all: targetNames.length,
+        is_demo_project: String(isDemoProject),
+    });
     await new Promise((resolve) => {
         process.on("SIGINT", () => {
             logger_1.logger.info("Shutting down...");

package/lib/track.js

@@ -1,16 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.track = void 0;
+exports.emulatorSession = exports.trackEmulator = exports.track = exports.usageEnabled = exports.EMULATOR_GA4_MEASUREMENT_ID = void 0;
+const node_fetch_1 = require("node-fetch");
 const ua = require("universal-analytics");
 const uuid_1 = require("uuid");
+const auth_1 = require("./auth");
 const configstore_1 = require("./configstore");
+const logger_1 = require("./logger");
 const pkg = require("../package.json");
+exports.EMULATOR_GA4_MEASUREMENT_ID = process.env.FIREBASE_EMULATOR_GA4_MEASUREMENT_ID || "G-KYP2JMPFC0";
+function usageEnabled() {
+    return !!configstore_1.configstore.get("usage");
+}
+exports.usageEnabled = usageEnabled;
+const FIREBASE_ANALYTICS_UA = process.env.FIREBASE_ANALYTICS_UA || "UA-29174744-3";
 let anonId = configstore_1.configstore.get("analytics-uuid");
 if (!anonId) {
     anonId = (0, uuid_1.v4)();
     configstore_1.configstore.set("analytics-uuid", anonId);
 }
-const visitor = ua(process.env.FIREBASE_ANALYTICS_UA || "UA-29174744-3", anonId, {
+const visitor = ua(FIREBASE_ANALYTICS_UA, anonId, {
     strictCidFormat: false,
     https: true,
 });
@@ -19,7 +28,7 @@ visitor.set("cd2", process.version);
 visitor.set("cd3", process.env.FIREPIT_VERSION || "none");
 function track(action, label, duration = 0) {
     return new Promise((resolve) => {
-        if (configstore_1.configstore.get("tokens") && configstore_1.configstore.get("usage")) {
+        if (configstore_1.configstore.get("tokens") && usageEnabled()) {
             visitor.event("Firebase CLI " + pkg.version, action, label, duration).send(() => {
                 resolve();
             });
@@ -30,3 +39,110 @@ function track(action, label, duration = 0) {
     });
 }
 exports.track = track;
+const EMULATOR_GA4_API_SECRET = process.env.FIREBASE_EMULATOR_GA4_API_SECRET || "2V_zBYc4TdeoppzDaIu0zw";
+const EMULATOR_GA4_USER_PROPS = {
+    node_platform: {
+        value: process.platform,
+    },
+    node_version: {
+        value: process.version,
+    },
+    firepit_version: {
+        value: process.env.FIREPIT_VERSION || "none",
+    },
+};
+async function trackEmulator(eventName, params) {
+    const session = emulatorSession();
+    if (!session) {
+        return;
+    }
+    const oldTotalEngagementSeconds = session.totalEngagementSeconds;
+    session.totalEngagementSeconds = process.uptime();
+    session.commandName = (params === null || params === void 0 ? void 0 : params.command_name) || session.commandName;
+    const search = `?api_secret=${EMULATOR_GA4_API_SECRET}&measurement_id=${session.measurementId}`;
+    const validate = session.validateOnly ? "debug/" : "";
+    const url = `https://www.google-analytics.com/${validate}mp/collect${search}`;
+    const body = {
+        timestamp_micros: `${Date.now()}000`,
+        client_id: session.clientId,
+        user_properties: Object.assign(Object.assign({}, EMULATOR_GA4_USER_PROPS), { java_major_version: session.javaMajorVersion
+                ? { value: session.javaMajorVersion }
+                : undefined }),
+        validationBehavior: session.validateOnly ? "ENFORCE_RECOMMENDATIONS" : undefined,
+        events: [
+            {
+                name: eventName,
+                params: Object.assign({ session_id: session.sessionId, engagement_time_msec: (session.totalEngagementSeconds - oldTotalEngagementSeconds)
+                        .toFixed(3)
+                        .replace(".", "")
+                        .replace(/^0+/, ""), debug_mode: session.debugMode ? true : undefined, command_name: session.commandName }, params),
+            },
+        ],
+    };
+    if (session.validateOnly) {
+        logger_1.logger.info(`Sending Analytics for event ${eventName}`, params, body);
+    }
+    try {
+        const response = await (0, node_fetch_1.default)(url, {
+            method: "POST",
+            headers: {
+                "content-type": "application/json;charset=UTF-8",
+            },
+            body: JSON.stringify(body),
+        });
+        if (session.validateOnly) {
+            if (!response.ok) {
+                logger_1.logger.warn(`Analytics validation HTTP error: ${response.status}`);
+            }
+            const respBody = await response.text();
+            logger_1.logger.info(`Analytics validation result: ${respBody}`);
+        }
+    }
+    catch (e) {
+        if (session.validateOnly) {
+            throw e;
+        }
+        return;
+    }
+}
+exports.trackEmulator = trackEmulator;
+function emulatorSession() {
+    const validateOnly = !!process.env.FIREBASE_CLI_MP_VALIDATE;
+    if (!usageEnabled()) {
+        if (validateOnly) {
+            logger_1.logger.warn("Google Analytics is DISABLED. To enable, (re)login and opt in to collection.");
+        }
+        return;
+    }
+    if (!currentEmulatorSession) {
+        let clientId = configstore_1.configstore.get("emulator-analytics-clientId");
+        if (!clientId) {
+            clientId = (0, uuid_1.v4)();
+            configstore_1.configstore.set("emulator-analytics-clientId", clientId);
+        }
+        currentEmulatorSession = {
+            measurementId: exports.EMULATOR_GA4_MEASUREMENT_ID,
+            clientId,
+            sessionId: (Math.random() * Number.MAX_SAFE_INTEGER).toFixed(0),
+            totalEngagementSeconds: 0,
+            debugMode: isDebugMode(),
+            validateOnly,
+        };
+    }
+    return currentEmulatorSession;
+}
+exports.emulatorSession = emulatorSession;
+let currentEmulatorSession = undefined;
+function isDebugMode() {
+    const account = (0, auth_1.getGlobalDefaultAccount)();
+    if (account === null || account === void 0 ? void 0 : account.user.email.endsWith("@google.com")) {
+        try {
+            require("../tsconfig.json");
+            logger_1.logger.info(`Using Google Analytics in DEBUG mode. Emulators (+ UI) events will be shown in GA Debug View only.`);
+            return true;
+        }
+        catch (_a) {
+        }
+    }
+    return false;
+}

package/lib/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.randomInt = exports.debounce = exports.last = exports.cloneDeep = exports.groupBy = exports.assertIsStringOrUndefined = exports.assertIsNumber = exports.assertIsString = exports.assertDefined = exports.thirtyDaysFromNow = exports.isRunningInWSL = exports.isCloudEnvironment = exports.datetimeString = exports.createDestroyer = exports.promiseWithSpinner = exports.setupLoggers = exports.tryParse = exports.tryStringify = exports.promiseProps = 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.randomInt = exports.debounce = exports.last = exports.cloneDeep = exports.groupBy = exports.assertIsStringOrUndefined = exports.assertIsNumber = exports.assertIsString = exports.assertDefined = exports.thirtyDaysFromNow = exports.isRunningInWSL = 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 _ = require("lodash");
 const url = require("url");
 const clc = require("colorette");
@@ -248,6 +248,19 @@ async function promiseWhile(action, check, interval = 2500) {
     });
 }
 exports.promiseWhile = promiseWhile;
+function withTimeout(timeoutMs, promise) {
+    return new Promise((resolve, reject) => {
+        const timeout = setTimeout(() => reject(new Error("Timed out.")), timeoutMs);
+        promise.then((value) => {
+            clearTimeout(timeout);
+            resolve(value);
+        }, (err) => {
+            clearTimeout(timeout);
+            reject(err);
+        });
+    });
+}
+exports.withTimeout = withTimeout;
 async function promiseProps(obj) {
     const resultObj = {};
     const promises = Object.keys(obj).map(async (key) => {

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "firebase-tools",
-  "version": "11.5.0",
+  "version": "11.6.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "firebase-tools",
-      "version": "11.5.0",
+      "version": "11.6.0",
       "license": "MIT",
       "dependencies": {
         "@google-cloud/pubsub": "^3.0.1",

package/package.json

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

package/schema/firebase-config.json

@@ -174,6 +174,18 @@
                     },
                     "type": "object"
                 },
+                "eventarc": {
+                    "additionalProperties": false,
+                    "properties": {
+                        "host": {
+                            "type": "string"
+                        },
+                        "port": {
+                            "type": "number"
+                        }
+                    },
+                    "type": "object"
+                },
                 "extensions": {
                     "properties": {
                     },

package/templates/extensions/CHANGELOG.md

@@ -1,7 +1 @@
-CHANGELOG.md is how you tell users what has changed in each version of your extension.
-When you release a new version, add a new header and release notes for that version.
-When users update their instance, they will see the release notes for all versions
-between the one they were on and the one they are updating to.
-
-## Version 0.0.1
-First version
+- Added support for publishing pre-release Extension versions. (#4804)