firebase-tools 10.4.2 → 10.7.0

package/lib/emulator/functionsEmulatorShared.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toBackendInfo = exports.getSecretLocalPath = exports.getSignatureType = exports.formatHost = exports.findModuleRoot = exports.waitForBody = exports.getServiceFromEventType = exports.getFunctionService = exports.getTemporarySocketPath = exports.getEmulatedTriggersFromDefinitions = exports.emulatedFunctionsByRegion = exports.emulatedFunctionsFromEndpoints = exports.EmulatedTrigger = exports.HttpConstants = void 0;
+exports.toBackendInfo = exports.getSecretLocalPath = exports.getSignatureType = exports.formatHost = exports.findModuleRoot = exports.waitForBody = exports.getServiceFromEventType = exports.getFunctionService = exports.getTemporarySocketPath = exports.getEmulatedTriggersFromDefinitions = exports.emulatedFunctionsByRegion = exports.emulatedFunctionsFromEndpoints = exports.prepareEndpoints = exports.EmulatedTrigger = exports.HttpConstants = void 0;
 const _ = require("lodash");
 const os = require("os");
 const path = require("path");
@@ -8,9 +8,11 @@ const fs = require("fs");
 const backend = require("../deploy/functions/backend");
 const constants_1 = require("./constants");
 const proto_1 = require("../gcp/proto");
-const logger_1 = require("../logger");
 const manifest_1 = require("../extensions/manifest");
 const extensionsHelper_1 = require("../extensions/extensionsHelper");
+const postinstall_1 = require("./extensions/postinstall");
+const services_1 = require("../deploy/functions/services");
+const prepare_1 = require("../deploy/functions/prepare");
 const memoryLookup = {
     "128MB": 128,
     "256MB": 256,
@@ -33,12 +35,7 @@ class EmulatedTrigger {
         return memoryLookup[this.definition.availableMemoryMb || "128MB"] * 1024 * 1024;
     }
     get timeoutMs() {
-        if (typeof this.definition.timeout === "number") {
-            return this.definition.timeout * 1000;
-        }
-        else {
-            return parseInt((this.definition.timeout || "60s").split("s")[0], 10) * 1000;
-        }
+        return (this.definition.timeoutSeconds || 60) * 1000;
     }
     getRawFunction() {
         if (!this.module) {
@@ -49,6 +46,14 @@ class EmulatedTrigger {
     }
 }
 exports.EmulatedTrigger = EmulatedTrigger;
+function prepareEndpoints(endpoints) {
+    const bkend = backend.of(...endpoints);
+    for (const ep of endpoints) {
+        (0, services_1.serviceForEndpoint)(ep).validateTrigger(ep, bkend);
+    }
+    (0, prepare_1.inferBlockingDetails)(bkend);
+}
+exports.prepareEndpoints = prepareEndpoints;
 function emulatedFunctionsFromEndpoints(endpoints) {
     const regionDefinitions = [];
     for (const endpoint of endpoints) {
@@ -62,7 +67,7 @@ function emulatedFunctionsFromEndpoints(endpoints) {
             name: endpoint.id,
             id: `${endpoint.region}-${endpoint.id}`,
         };
-        (0, proto_1.copyIfPresent)(def, endpoint, "timeout", "availableMemoryMb", "labels", "platform", "secretEnvironmentVariables");
+        (0, proto_1.copyIfPresent)(def, endpoint, "availableMemoryMb", "labels", "timeoutSeconds", "platform", "secretEnvironmentVariables");
         if (backend.isHttpsTriggered(endpoint)) {
             def.httpsTrigger = endpoint.httpsTrigger;
         }
@@ -73,25 +78,20 @@ function emulatedFunctionsFromEndpoints(endpoints) {
         else if (backend.isEventTriggered(endpoint)) {
             const eventTrigger = endpoint.eventTrigger;
             if (endpoint.platform === "gcfv1") {
-                const resourceFilter = backend.findEventFilter(endpoint, "resource");
-                if (!resourceFilter) {
-                    logger_1.logger.debug(`Invalid event trigger ${JSON.stringify(endpoint)}, expected event filter with resource attribute. Skipping.`);
-                    continue;
-                }
                 def.eventTrigger = {
                     eventType: eventTrigger.eventType,
-                    resource: resourceFilter.value,
+                    resource: eventTrigger.eventFilters.resource,
                 };
             }
             else {
-                const [eventFilter] = endpoint.eventTrigger.eventFilters;
-                if (!eventFilter) {
-                    logger_1.logger.debug(`Invalid event trigger ${JSON.stringify(endpoint)}, expected at least one event filter. Skipping.`);
+                const { resource, topic, bucket } = endpoint.eventTrigger.eventFilters;
+                const eventResource = resource || topic || bucket;
+                if (!eventResource) {
                     continue;
                 }
                 def.eventTrigger = {
                     eventType: eventTrigger.eventType,
-                    resource: eventFilter.value,
+                    resource: eventResource,
                 };
             }
         }
@@ -99,6 +99,12 @@ function emulatedFunctionsFromEndpoints(endpoints) {
             def.eventTrigger = { eventType: "pubsub", resource: "" };
             def.schedule = endpoint.scheduleTrigger;
         }
+        else if (backend.isBlockingTriggered(endpoint)) {
+            def.blockingTrigger = {
+                eventType: endpoint.blockingTrigger.eventType,
+                options: endpoint.blockingTrigger.options || {},
+            };
+        }
         else {
         }
         regionDefinitions.push(def);
@@ -146,6 +152,9 @@ function getFunctionService(def) {
     if (def.eventTrigger) {
         return (_a = def.eventTrigger.service) !== null && _a !== void 0 ? _a : getServiceFromEventType(def.eventTrigger.eventType);
     }
+    if (def.blockingTrigger) {
+        return def.blockingTrigger.eventType;
+    }
     return "unknown";
 }
 exports.getFunctionService = getFunctionService;
@@ -244,7 +253,7 @@ function getSecretLocalPath(backend, projectDir) {
 }
 exports.getSecretLocalPath = getSecretLocalPath;
 function toBackendInfo(e, cf3Triggers) {
-    var _a;
+    var _a, _b;
     const envWithSecrets = Object.assign({}, e.env);
     for (const s of e.secretEnv) {
         envWithSecrets[s.key] = backend.secretVersionName(s);
@@ -252,10 +261,16 @@ function toBackendInfo(e, cf3Triggers) {
     let extensionVersion = e.extensionVersion;
     if (extensionVersion) {
         extensionVersion = (0, extensionsHelper_1.substituteParams)(extensionVersion, e.env);
+        if ((_a = extensionVersion.spec) === null || _a === void 0 ? void 0 : _a.postinstallContent) {
+            extensionVersion.spec.postinstallContent = (0, postinstall_1.replaceConsoleLinks)(extensionVersion.spec.postinstallContent);
+        }
     }
     let extensionSpec = e.extensionSpec;
     if (extensionSpec) {
         extensionSpec = (0, extensionsHelper_1.substituteParams)(extensionSpec, e.env);
+        if (extensionSpec === null || extensionSpec === void 0 ? void 0 : extensionSpec.postinstallContent) {
+            extensionSpec.postinstallContent = (0, postinstall_1.replaceConsoleLinks)(extensionSpec.postinstallContent);
+        }
     }
     return JSON.parse(JSON.stringify({
         directory: e.functionsDir,
@@ -264,7 +279,7 @@ function toBackendInfo(e, cf3Triggers) {
         extension: e.extension,
         extensionVersion: extensionVersion,
         extensionSpec: extensionSpec,
-        functionTriggers: (_a = e.predefinedTriggers) !== null && _a !== void 0 ? _a : cf3Triggers,
+        functionTriggers: (_b = e.predefinedTriggers) !== null && _b !== void 0 ? _b : cf3Triggers,
     }));
 }
 exports.toBackendInfo = toBackendInfo;

package/lib/emulator/registry.js

@@ -14,11 +14,10 @@ class EmulatorRegistry {
         }
         this.set(instance.getName(), instance);
         await instance.start();
-        const info = instance.getInfo();
-        await portUtils.waitForPortClosed(info.port, info.host);
-    }
-    static registerExtensionsEmulator() {
-        this.extensionsEmulatorRegistered = true;
+        if (instance.getName() !== types_1.Emulators.EXTENSIONS) {
+            const info = instance.getInfo();
+            await portUtils.waitForPortClosed(info.port, info.host);
+        }
     }
     static async stop(name) {
         emulatorLogger_1.EmulatorLogger.forEmulator(name).logLabeled("BULLET", name, `Stopping ${constants_1.Constants.description(name)}`);
@@ -57,7 +56,7 @@ class EmulatorRegistry {
     }
     static isRunning(emulator) {
         if (emulator === types_1.Emulators.EXTENSIONS) {
-            return this.extensionsEmulatorRegistered && this.isRunning(types_1.Emulators.FUNCTIONS);
+            return this.INSTANCES.get(emulator) !== undefined && this.isRunning(types_1.Emulators.FUNCTIONS);
         }
         const instance = this.INSTANCES.get(emulator);
         return instance !== undefined;
@@ -89,12 +88,36 @@ class EmulatorRegistry {
             return `${host}:${port}`;
         }
     }
-    static getPort(emulator) {
-        const instance = this.INSTANCES.get(emulator);
-        if (!instance) {
-            return undefined;
+    static url(emulator, req) {
+        const url = new URL("http://unknown/");
+        if (req) {
+            url.protocol = req.protocol;
+            const host = req.headers.host;
+            if (host) {
+                url.host = host;
+                return url;
+            }
+        }
+        const info = EmulatorRegistry.getInfo(emulator);
+        if (info) {
+            if (info.host === "0.0.0.0") {
+                url.hostname = "127.0.0.1";
+            }
+            else if (info.host === "::") {
+                url.hostname = "[::1]";
+            }
+            else if (info.host.includes(":")) {
+                url.hostname = `[${info.host}]`;
+            }
+            else {
+                url.hostname = info.host;
+            }
+            url.port = info.port.toString();
+        }
+        else {
+            console.warn(`Cannot determine host and port of ${emulator}`);
         }
-        return instance.getInfo().port;
+        return url;
     }
     static set(emulator, instance) {
         this.INSTANCES.set(emulator, instance);
@@ -104,5 +127,4 @@ class EmulatorRegistry {
     }
 }
 exports.EmulatorRegistry = EmulatorRegistry;
-EmulatorRegistry.extensionsEmulatorRegistered = false;
 EmulatorRegistry.INSTANCES = new Map();

package/lib/emulator/shared/request.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reqBodyToBuffer = void 0;
+async function reqBodyToBuffer(req) {
+    if (req.body instanceof Buffer) {
+        return Buffer.from(req.body);
+    }
+    const bufs = [];
+    req.on("data", (data) => {
+        bufs.push(data);
+    });
+    await new Promise((resolve) => {
+        req.on("end", () => {
+            resolve();
+        });
+    });
+    return Buffer.concat(bufs);
+}
+exports.reqBodyToBuffer = reqBodyToBuffer;

package/lib/emulator/storage/apis/firebase.js

@@ -10,6 +10,7 @@ const registry_1 = require("../../registry");
 const multipart_1 = require("../multipart");
 const errors_1 = require("../errors");
 const upload_1 = require("../upload");
+const request_1 = require("../../shared/request");
 function createFirebaseEndpoints(emulator) {
     const firebaseStorageAPI = (0, express_1.Router)();
     const { storageLayer, uploadService } = emulator;
@@ -71,7 +72,7 @@ function createFirebaseEndpoints(emulator) {
         let metadata;
         let data;
         try {
-            ({ metadata, data } = await storageLayer.handleGetObject({
+            ({ metadata, data } = await storageLayer.getObject({
                 bucketId: req.params.bucketId,
                 decodedObjectId: decodeURIComponent(req.params.objectId),
                 authorization: req.header("authorization"),
@@ -117,11 +118,11 @@ function createFirebaseEndpoints(emulator) {
         return res.json(new metadata_1.OutgoingFirebaseMetadata(metadata));
     });
     firebaseStorageAPI.get("/b/:bucketId/o", async (req, res) => {
-        var _a, _b;
+        var _a, _b, _c, _d, _e;
         const maxResults = (_a = req.query.maxResults) === null || _a === void 0 ? void 0 : _a.toString();
-        let response;
+        let listResponse;
         try {
-            response = await storageLayer.handleListObjects({
+            listResponse = await storageLayer.listObjects({
                 bucketId: req.params.bucketId,
                 prefix: req.query.prefix ? req.query.prefix.toString() : "",
                 delimiter: req.query.delimiter ? req.query.delimiter.toString() : "",
@@ -141,23 +142,14 @@ function createFirebaseEndpoints(emulator) {
             }
             throw err;
         }
-        return res.json(response);
-    });
-    const reqBodyToBuffer = async (req) => {
-        if (req.body instanceof Buffer) {
-            return Buffer.from(req.body);
-        }
-        const bufs = [];
-        req.on("data", (data) => {
-            bufs.push(data);
+        return res.status(200).json({
+            nextPageToken: listResponse.nextPageToken,
+            prefixes: (_c = listResponse.prefixes) !== null && _c !== void 0 ? _c : [],
+            items: (_e = (_d = listResponse.items) === null || _d === void 0 ? void 0 : _d.map((item) => {
+                return { name: item.name, bucket: item.bucket };
+            })) !== null && _e !== void 0 ? _e : [],
         });
-        await new Promise((resolve) => {
-            req.on("end", () => {
-                resolve();
-            });
-        });
-        return Buffer.concat(bufs);
-    };
+    });
     const handleUpload = async (req, res) => {
         if (!req.query.name) {
             res.sendStatus(400);
@@ -174,14 +166,14 @@ function createFirebaseEndpoints(emulator) {
             let metadataRaw;
             let dataRaw;
             try {
-                ({ metadataRaw, dataRaw } = (0, multipart_1.parseObjectUploadMultipartRequest)(contentTypeHeader, await reqBodyToBuffer(req)));
+                ({ metadataRaw, dataRaw } = (0, multipart_1.parseObjectUploadMultipartRequest)(contentTypeHeader, await (0, request_1.reqBodyToBuffer)(req)));
             }
             catch (err) {
                 if (err instanceof Error) {
                     return res.status(400).json({
                         error: {
                             code: 400,
-                            message: err.toString(),
+                            message: err.message,
                         },
                     });
                 }
@@ -196,7 +188,7 @@ function createFirebaseEndpoints(emulator) {
             });
             let metadata;
             try {
-                metadata = await storageLayer.handleUploadObject(upload);
+                metadata = await storageLayer.uploadObject(upload);
             }
             catch (err) {
                 if (err instanceof errors_1.ForbiddenError) {
@@ -209,7 +201,7 @@ function createFirebaseEndpoints(emulator) {
                 }
                 throw err;
             }
-            metadata.addDownloadToken();
+            metadata.addDownloadToken(false);
             return res.status(200).json(new metadata_1.OutgoingFirebaseMetadata(metadata));
         }
         const uploadCommand = req.header("x-goog-upload-command");
@@ -227,9 +219,13 @@ function createFirebaseEndpoints(emulator) {
             res.header("x-goog-upload-chunk-granularity", "10000");
             res.header("x-goog-upload-control-url", "");
             res.header("x-goog-upload-status", "active");
-            const emulatorInfo = registry_1.EmulatorRegistry.getInfo(types_1.Emulators.STORAGE);
-            res.header("x-goog-upload-url", `http://${req.hostname}:${emulatorInfo === null || emulatorInfo === void 0 ? void 0 : emulatorInfo.port}/v0/b/${bucketId}/o?name=${objectId}&upload_id=${upload.id}&upload_protocol=resumable`);
             res.header("x-gupload-uploadid", upload.id);
+            const uploadUrl = registry_1.EmulatorRegistry.url(types_1.Emulators.STORAGE, req);
+            uploadUrl.pathname = `/v0/b/${bucketId}/o`;
+            uploadUrl.searchParams.set("name", objectId);
+            uploadUrl.searchParams.set("upload_id", upload.id);
+            uploadUrl.searchParams.set("upload_protocol", "resumable");
+            res.header("x-goog-upload-url", uploadUrl.toString());
             return res.sendStatus(200);
         }
         if (!req.query.upload_id) {
@@ -268,7 +264,7 @@ function createFirebaseEndpoints(emulator) {
         if (uploadCommand.includes("upload")) {
             let upload;
             try {
-                upload = uploadService.continueResumableUpload(uploadId, await reqBodyToBuffer(req));
+                upload = uploadService.continueResumableUpload(uploadId, await (0, request_1.reqBodyToBuffer)(req));
             }
             catch (err) {
                 if (err instanceof errors_1.NotFoundError) {
@@ -299,9 +295,9 @@ function createFirebaseEndpoints(emulator) {
                 }
                 throw err;
             }
-            let metadata;
+            let storedMetadata;
             try {
-                metadata = await storageLayer.handleUploadObject(upload);
+                storedMetadata = await storageLayer.uploadObject(upload);
             }
             catch (err) {
                 if (err instanceof errors_1.ForbiddenError) {
@@ -314,8 +310,9 @@ function createFirebaseEndpoints(emulator) {
                 }
                 throw err;
             }
-            metadata.addDownloadToken();
-            return res.status(200).json(new metadata_1.OutgoingFirebaseMetadata(metadata));
+            res.header("x-goog-upload-status", "final");
+            storedMetadata.addDownloadToken(false);
+            return res.status(200).json(new metadata_1.OutgoingFirebaseMetadata(storedMetadata));
         }
         return res.sendStatus(400);
     };
@@ -333,7 +330,7 @@ function createFirebaseEndpoints(emulator) {
                 return res.sendStatus(400);
             }
             try {
-                metadata = storageLayer.handleCreateDownloadToken({
+                metadata = storageLayer.createDownloadToken({
                     bucketId,
                     decodedObjectId,
                     authorization,
@@ -356,7 +353,7 @@ function createFirebaseEndpoints(emulator) {
         }
         else {
             try {
-                metadata = storageLayer.handleDeleteDownloadToken({
+                metadata = storageLayer.deleteDownloadToken({
                     bucketId,
                     decodedObjectId,
                     token: (_b = (_a = req.query["delete_token"]) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "",
@@ -390,7 +387,7 @@ function createFirebaseEndpoints(emulator) {
     const handleMetadataUpdate = async (req, res) => {
         let metadata;
         try {
-            metadata = await storageLayer.handleUpdateObjectMetadata({
+            metadata = await storageLayer.updateObjectMetadata({
                 bucketId: req.params.bucketId,
                 decodedObjectId: decodeURIComponent(req.params.objectId),
                 metadata: req.body,
@@ -427,7 +424,7 @@ function createFirebaseEndpoints(emulator) {
     firebaseStorageAPI.post("/b/:bucketId/o/:objectId?", handleObjectPostRequest);
     firebaseStorageAPI.delete("/b/:bucketId/o/:objectId", async (req, res) => {
         try {
-            await storageLayer.handleDeleteObject({
+            await storageLayer.deleteObject({
                 bucketId: req.params.bucketId,
                 decodedObjectId: decodeURIComponent(req.params.objectId),
                 authorization: req.header("authorization"),