firebase-tools 10.4.0 → 10.5.0

package/lib/emulator/functionsEmulator.js

@@ -289,7 +289,7 @@ class FunctionsEmulator {
         });
         for (const definition of toSetup) {
             try {
-                (0, validate_1.functionIdsAreValid)([definition]);
+                (0, validate_1.functionIdsAreValid)([Object.assign(Object.assign({}, definition), { id: definition.name })]);
             }
             catch (e) {
                 this.logger.logLabeled("WARN", `functions[${definition.id}]`, `Invalid function id: ${e.message}`);
@@ -488,26 +488,16 @@ class FunctionsEmulator {
         return def.eventTrigger ? `${def.id}-${this.triggerGeneration}` : def.id;
     }
     getBackendInfo() {
-        const cf3Triggers = Object.values(this.triggers)
-            .filter((t) => !t.backend.extensionInstanceId)
-            .map((t) => t.def);
+        const cf3Triggers = this.getCF3Triggers();
         return this.args.emulatableBackends.map((e) => {
-            var _a;
-            const envWithSecrets = Object.assign({}, e.env);
-            for (const s of e.secretEnv) {
-                envWithSecrets[s.key] = backend.secretVersionName(s);
-            }
-            return {
-                directory: e.functionsDir,
-                env: envWithSecrets,
-                extensionInstanceId: e.extensionInstanceId,
-                extension: e.extension,
-                extensionVersion: e.extensionVersion,
-                extensionSpec: e.extensionSpec,
-                functionTriggers: (_a = e.predefinedTriggers) !== null && _a !== void 0 ? _a : cf3Triggers,
-            };
+            return (0, functionsEmulatorShared_1.toBackendInfo)(e, cf3Triggers);
         });
     }
+    getCF3Triggers() {
+        return Object.values(this.triggers)
+            .filter((t) => !t.backend.extensionInstanceId)
+            .map((t) => t.def);
+    }
     addTriggerRecord(def, opts) {
         const key = this.getTriggerKey(def);
         this.triggers[key] = {

package/lib/emulator/functionsEmulatorShared.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.EmulatedTrigger = exports.HttpConstants = void 0;
 const _ = require("lodash");
 const os = require("os");
 const path = require("path");
@@ -10,6 +10,7 @@ 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 memoryLookup = {
     "128MB": 128,
     "256MB": 256,
@@ -242,3 +243,28 @@ function getSecretLocalPath(backend, projectDir) {
     return path.join(secretDirectory, secretsFile);
 }
 exports.getSecretLocalPath = getSecretLocalPath;
+function toBackendInfo(e, cf3Triggers) {
+    var _a;
+    const envWithSecrets = Object.assign({}, e.env);
+    for (const s of e.secretEnv) {
+        envWithSecrets[s.key] = backend.secretVersionName(s);
+    }
+    let extensionVersion = e.extensionVersion;
+    if (extensionVersion) {
+        extensionVersion = (0, extensionsHelper_1.substituteParams)(extensionVersion, e.env);
+    }
+    let extensionSpec = e.extensionSpec;
+    if (extensionSpec) {
+        extensionSpec = (0, extensionsHelper_1.substituteParams)(extensionSpec, e.env);
+    }
+    return JSON.parse(JSON.stringify({
+        directory: e.functionsDir,
+        env: envWithSecrets,
+        extensionInstanceId: e.extensionInstanceId,
+        extension: e.extension,
+        extensionVersion: extensionVersion,
+        extensionSpec: extensionSpec,
+        functionTriggers: (_a = e.predefinedTriggers) !== null && _a !== void 0 ? _a : cf3Triggers,
+    }));
+}
+exports.toBackendInfo = toBackendInfo;

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,7 +166,7 @@ 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) {
@@ -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) {
@@ -268,7 +260,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) {
@@ -301,7 +293,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) {
@@ -333,7 +325,7 @@ function createFirebaseEndpoints(emulator) {
                 return res.sendStatus(400);
             }
             try {
-                metadata = storageLayer.handleCreateDownloadToken({
+                metadata = storageLayer.createDownloadToken({
                     bucketId,
                     decodedObjectId,
                     authorization,
@@ -356,7 +348,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 +382,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 +419,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"),

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

@@ -11,33 +11,34 @@ const crc_1 = require("../crc");
 const multipart_1 = require("../multipart");
 const upload_1 = require("../upload");
 const errors_1 = require("../errors");
+const request_1 = require("../../shared/request");
 function createCloudEndpoints(emulator) {
     const gcloudStorageAPI = (0, express_1.Router)();
-    const { storageLayer, uploadService } = emulator;
+    const { adminStorageLayer, uploadService } = emulator;
     gcloudStorageAPI.use(/.*\/b\/(.+?)\/.*/, (req, res, next) => {
-        storageLayer.createBucket(req.params[0]);
+        adminStorageLayer.createBucket(req.params[0]);
         next();
     });
     gcloudStorageAPI.get("/b", async (req, res) => {
         res.json({
             kind: "storage#buckets",
-            items: await storageLayer.listBuckets(),
+            items: await adminStorageLayer.listBuckets(),
         });
     });
     gcloudStorageAPI.get(["/b/:bucketId/o/:objectId", "/download/storage/v1/b/:bucketId/o/:objectId"], async (req, res) => {
         let getObjectResponse;
         try {
-            getObjectResponse = await storageLayer.handleGetObject({
+            getObjectResponse = await adminStorageLayer.getObject({
                 bucketId: req.params.bucketId,
                 decodedObjectId: req.params.objectId,
-            }, true);
+            });
         }
         catch (err) {
             if (err instanceof errors_1.NotFoundError) {
                 return sendObjectNotFound(req, res);
             }
             if (err instanceof errors_1.ForbiddenError) {
-                throw new Error("Request failed unexpectedly due to Firebase Rules.");
+                return res.sendStatus(403);
             }
             throw err;
         }
@@ -49,67 +50,67 @@ function createCloudEndpoints(emulator) {
     gcloudStorageAPI.patch("/b/:bucketId/o/:objectId", async (req, res) => {
         let updatedMetadata;
         try {
-            updatedMetadata = await storageLayer.handleUpdateObjectMetadata({
+            updatedMetadata = await adminStorageLayer.updateObjectMetadata({
                 bucketId: req.params.bucketId,
                 decodedObjectId: req.params.objectId,
                 metadata: req.body,
-            }, true);
+            });
         }
         catch (err) {
             if (err instanceof errors_1.NotFoundError) {
                 return sendObjectNotFound(req, res);
             }
             if (err instanceof errors_1.ForbiddenError) {
-                throw new Error("Request failed unexpectedly due to Firebase Rules.");
+                return res.sendStatus(403);
             }
             throw err;
         }
         return res.json(new metadata_1.CloudStorageObjectMetadata(updatedMetadata));
     });
-    gcloudStorageAPI.get("/b/:bucketId/o", (req, res) => {
-        let maxRes = undefined;
-        if (req.query.maxResults) {
-            maxRes = +req.query.maxResults.toString();
-        }
-        const delimiter = req.query.delimiter ? req.query.delimiter.toString() : "";
-        const pageToken = req.query.pageToken ? req.query.pageToken.toString() : undefined;
-        const prefix = req.query.prefix ? req.query.prefix.toString() : "";
-        const listResult = storageLayer.listItems(req.params.bucketId, prefix, delimiter, pageToken, maxRes);
-        res.json(Object.assign(Object.assign({}, listResult), { kind: "#storage/objects" }));
+    gcloudStorageAPI.get("/b/:bucketId/o", async (req, res) => {
+        var _a;
+        let listResponse;
+        try {
+            listResponse = await adminStorageLayer.listObjects({
+                bucketId: req.params.bucketId,
+                prefix: req.query.prefix ? req.query.prefix.toString() : "",
+                delimiter: req.query.delimiter ? req.query.delimiter.toString() : "",
+                pageToken: req.query.pageToken ? req.query.pageToken.toString() : undefined,
+                maxResults: req.query.maxResults ? +req.query.maxResults.toString() : undefined,
+                authorization: req.header("authorization"),
+            });
+        }
+        catch (err) {
+            if (err instanceof errors_1.ForbiddenError) {
+                return res.sendStatus(403);
+            }
+            throw err;
+        }
+        return res.status(200).json({
+            kind: "#storage/objects",
+            nextPageToken: listResponse.nextPageToken,
+            prefixes: listResponse.prefixes,
+            items: (_a = listResponse.items) === null || _a === void 0 ? void 0 : _a.map((item) => new metadata_1.CloudStorageObjectMetadata(item)),
+        });
     });
     gcloudStorageAPI.delete("/b/:bucketId/o/:objectId", async (req, res) => {
         try {
-            await storageLayer.handleDeleteObject({
+            await adminStorageLayer.deleteObject({
                 bucketId: req.params.bucketId,
                 decodedObjectId: req.params.objectId,
-            }, true);
+            });
         }
         catch (err) {
             if (err instanceof errors_1.NotFoundError) {
                 return sendObjectNotFound(req, res);
             }
             if (err instanceof errors_1.ForbiddenError) {
-                throw new Error("Request failed unexpectedly due to Firebase Rules.");
+                return res.sendStatus(403);
             }
             throw err;
         }
         return res.sendStatus(204);
     });
-    const reqBodyToBuffer = async (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);
-    };
     gcloudStorageAPI.put("/upload/storage/v1/b/:bucketId/o", async (req, res) => {
         if (!req.query.upload_id) {
             res.sendStatus(400);
@@ -118,7 +119,7 @@ function createCloudEndpoints(emulator) {
         const uploadId = req.query.upload_id.toString();
         let upload;
         try {
-            uploadService.continueResumableUpload(uploadId, await reqBodyToBuffer(req));
+            uploadService.continueResumableUpload(uploadId, await (0, request_1.reqBodyToBuffer)(req));
             upload = uploadService.finalizeResumableUpload(uploadId);
         }
         catch (err) {
@@ -132,11 +133,11 @@ function createCloudEndpoints(emulator) {
         }
         let metadata;
         try {
-            metadata = await storageLayer.handleUploadObject(upload, true);
+            metadata = await adminStorageLayer.uploadObject(upload);
         }
         catch (err) {
             if (err instanceof errors_1.ForbiddenError) {
-                throw new Error("Request failed unexpectedly due to Firebase Rules.");
+                return res.sendStatus(403);
             }
             throw err;
         }
@@ -147,17 +148,17 @@ function createCloudEndpoints(emulator) {
         emulatorLogger_1.EmulatorLogger.forEmulator(types_1.Emulators.STORAGE).log("WARN_ONCE", "Cloud Storage ACLs are not supported in the Storage Emulator. All related methods will succeed, but have no effect.");
         let getObjectResponse;
         try {
-            getObjectResponse = await storageLayer.handleGetObject({
+            getObjectResponse = await adminStorageLayer.getObject({
                 bucketId: req.params.bucketId,
                 decodedObjectId: req.params.objectId,
-            }, true);
+            });
         }
         catch (err) {
             if (err instanceof errors_1.NotFoundError) {
                 return sendObjectNotFound(req, res);
             }
             if (err instanceof errors_1.ForbiddenError) {
-                throw new Error("Request failed unexpectedly due to Firebase Rules.");
+                return res.sendStatus(403);
             }
             throw err;
         }
@@ -206,7 +207,7 @@ function createCloudEndpoints(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) {
             return res.status(400).json({
@@ -225,11 +226,11 @@ function createCloudEndpoints(emulator) {
         });
         let metadata;
         try {
-            metadata = await storageLayer.handleUploadObject(upload, true);
+            metadata = await adminStorageLayer.uploadObject(upload);
         }
         catch (err) {
             if (err instanceof errors_1.ForbiddenError) {
-                throw new Error("Request failed unexpectedly due to Firebase Rules.");
+                return res.sendStatus(403);
             }
             throw err;
         }
@@ -238,34 +239,45 @@ function createCloudEndpoints(emulator) {
     gcloudStorageAPI.get("/:bucketId/:objectId(**)", async (req, res) => {
         let getObjectResponse;
         try {
-            getObjectResponse = await storageLayer.handleGetObject({
+            getObjectResponse = await adminStorageLayer.getObject({
                 bucketId: req.params.bucketId,
                 decodedObjectId: req.params.objectId,
-            }, true);
+            });
         }
         catch (err) {
             if (err instanceof errors_1.NotFoundError) {
                 return sendObjectNotFound(req, res);
             }
             if (err instanceof errors_1.ForbiddenError) {
-                throw new Error("Request failed unexpectedly due to Firebase Rules.");
+                return res.sendStatus(403);
             }
             throw err;
         }
         return sendFileBytes(getObjectResponse.metadata, getObjectResponse.data, req, res);
     });
     gcloudStorageAPI.post("/b/:bucketId/o/:objectId/:method(rewriteTo|copyTo)/b/:destBucketId/o/:destObjectId", (req, res, next) => {
-        const md = storageLayer.getMetadata(req.params.bucketId, req.params.objectId);
-        if (!md) {
-            return sendObjectNotFound(req, res);
-        }
         if (req.params.method === "rewriteTo" && req.query.rewriteToken) {
             return next();
         }
-        const metadata = storageLayer.copyFile(md, req.params.destBucketId, req.params.destObjectId, req.body);
-        if (!metadata) {
-            res.sendStatus(400);
-            return;
+        let metadata;
+        try {
+            metadata = adminStorageLayer.copyObject({
+                sourceBucket: req.params.bucketId,
+                sourceObject: req.params.objectId,
+                destinationBucket: req.params.destBucketId,
+                destinationObject: req.params.destObjectId,
+                incomingMetadata: req.body,
+                authorization: "Bearer owner",
+            });
+        }
+        catch (err) {
+            if (err instanceof errors_1.NotFoundError) {
+                return sendObjectNotFound(req, res);
+            }
+            if (err instanceof errors_1.ForbiddenError) {
+                return res.sendStatus(403);
+            }
+            throw err;
         }
         const resource = new metadata_1.CloudStorageObjectMetadata(metadata);
         res.status(200);