firebase-tools 11.16.0 → 11.16.1

package/lib/deploy/functions/build.js

@@ -160,6 +160,9 @@ function toBackend(build, paramValues) {
     const bkEndpoints = [];
     for (const endpointId of Object.keys(build.endpoints)) {
         const bdEndpoint = build.endpoints[endpointId];
+        if (r.resolveBoolean(bdEndpoint.omit || false)) {
+            continue;
+        }
         let regions = bdEndpoint.region;
         if (typeof regions === "undefined") {
             regions = [api.functionsDefaultRegion];

package/lib/deploy/functions/release/fabricator.js

@@ -167,9 +167,9 @@ class Fabricator {
         if (apiFunction.httpsTrigger) {
             apiFunction.httpsTrigger.securityLevel = "SECURE_ALWAYS";
         }
-        apiFunction.sourceToken = await scraper.tokenPromise();
         const resultFunction = await this.functionExecutor
             .run(async () => {
+            apiFunction.sourceToken = await scraper.getToken();
             const op = await gcf.createFunction(apiFunction);
             return poller.pollOperation(Object.assign(Object.assign({}, gcfV1PollerOptions), { pollerName: `create-${endpoint.codebase}-${endpoint.region}-${endpoint.id}`, operationResourceName: op.name, onPoll: scraper.poller }));
         })
@@ -301,9 +301,9 @@ class Fabricator {
             throw new Error("Precondition failed");
         }
         const apiFunction = gcf.functionFromEndpoint(endpoint, sourceUrl);
-        apiFunction.sourceToken = await scraper.tokenPromise();
         const resultFunction = await this.functionExecutor
             .run(async () => {
+            apiFunction.sourceToken = await scraper.getToken();
             const op = await gcf.updateFunction(apiFunction);
             return await poller.pollOperation(Object.assign(Object.assign({}, gcfV1PollerOptions), { pollerName: `update-${endpoint.codebase}-${endpoint.region}-${endpoint.id}`, operationResourceName: op.name, onPoll: scraper.poller }));
         })

package/lib/deploy/functions/release/sourceTokenScraper.js

@@ -1,18 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SourceTokenScraper = void 0;
+const error_1 = require("../../../error");
+const functional_1 = require("../../../functional");
 const logger_1 = require("../../../logger");
 class SourceTokenScraper {
-    constructor() {
-        this.firstCall = true;
+    constructor(validDurationMs = 1500000) {
+        this.tokenValidDurationMs = validDurationMs;
         this.promise = new Promise((resolve) => (this.resolve = resolve));
+        this.fetchState = "NONE";
     }
-    tokenPromise() {
-        if (this.firstCall) {
-            this.firstCall = false;
-            return Promise.resolve(undefined);
+    async getToken() {
+        if (this.fetchState === "NONE") {
+            this.fetchState = "FETCHING";
+            return undefined;
         }
-        return this.promise;
+        else if (this.fetchState === "FETCHING") {
+            return this.promise;
+        }
+        else if (this.fetchState === "VALID") {
+            if (this.isTokenExpired()) {
+                this.fetchState = "FETCHING";
+                this.promise = new Promise((resolve) => (this.resolve = resolve));
+                return undefined;
+            }
+            return this.promise;
+        }
+        else {
+            (0, functional_1.assertExhaustive)(this.fetchState);
+        }
+    }
+    isTokenExpired() {
+        if (this.expiry === undefined) {
+            throw new error_1.FirebaseError("Your deployment is checking the expiration of a source token that has not yet been polled. " +
+                "Hitting this case should never happen and should be considered a bug. " +
+                "Please file an issue at https://github.com/firebase/firebase-tools/issues " +
+                "and try deploying your functions again.");
+        }
+        return Date.now() >= this.expiry;
     }
     get poller() {
         return (op) => {
@@ -21,6 +46,8 @@ class SourceTokenScraper {
                 const [, , , region] = ((_c = (_b = op.metadata) === null || _b === void 0 ? void 0 : _b.target) === null || _c === void 0 ? void 0 : _c.split("/")) || [];
                 logger_1.logger.debug(`Got source token ${(_d = op.metadata) === null || _d === void 0 ? void 0 : _d.sourceToken} for region ${region}`);
                 this.resolve((_e = op.metadata) === null || _e === void 0 ? void 0 : _e.sourceToken);
+                this.fetchState = "VALID";
+                this.expiry = Date.now() + this.tokenValidDurationMs;
             }
         };
     }

package/lib/deploy/functions/runtimes/discovery/v1alpha1.js

@@ -51,6 +51,7 @@ function assertBuildEndpoint(ep, id) {
         region: "array",
         platform: (platform) => build.AllFunctionsPlatforms.includes(platform),
         entryPoint: "string",
+        omit: "Field<boolean>?",
         availableMemoryMb: (mem) => mem === null || isCEL(mem) || build.isValidMemoryOption(mem),
         maxInstances: "Field<number>?",
         minInstances: "Field<number>?",
@@ -259,7 +260,7 @@ function parseEndpointForBuild(id, ep, project, defaultRegion, runtime) {
     if ("serviceAccountEmail" in ep) {
         parsed.serviceAccount = ep.serviceAccountEmail;
     }
-    (0, proto_1.copyIfPresent)(parsed, ep, "availableMemoryMb", "cpu", "maxInstances", "minInstances", "concurrency", "timeoutSeconds", "vpc", "labels", "ingressSettings", "environmentVariables", "serviceAccount");
+    (0, proto_1.copyIfPresent)(parsed, ep, "omit", "availableMemoryMb", "cpu", "maxInstances", "minInstances", "concurrency", "timeoutSeconds", "vpc", "labels", "ingressSettings", "environmentVariables", "serviceAccount");
     (0, proto_1.convertIfPresent)(parsed, ep, "secretEnvironmentVariables", (senvs) => {
         if (!senvs) {
             return null;

package/lib/emulator/download.js

@@ -27,6 +27,7 @@ async function downloadEmulator(name) {
     if (emulator.unzipDir) {
         await unzip(emulator.downloadPath, emulator.unzipDir);
     }
+    await new Promise((f) => setTimeout(f, 2000));
     const executablePath = emulator.binaryPath || emulator.downloadPath;
     fs.chmodSync(executablePath, 0o755);
     removeOldFiles(name, emulator);
@@ -54,7 +55,7 @@ function unzip(zipPath, unzipDir) {
         fs.createReadStream(zipPath)
             .pipe(unzipper.Extract({ path: unzipDir }))
             .on("error", reject)
-            .on("finish", resolve);
+            .on("close", resolve);
     });
 }
 function removeOldFiles(name, emulator, removeAllVersions = false) {

package/lib/emulator/downloadableEmulators.js

@@ -40,9 +40,9 @@ const EMULATOR_UPDATE_DETAILS = {
             expectedChecksum: "a4944414518be206280b495f526f18bf",
         },
     pubsub: {
-        version: "0.1.0",
-        expectedSize: 36623622,
-        expectedChecksum: "81704b24737d4968734d3e175f4cde71",
+        version: "0.7.1",
+        expectedSize: 65137179,
+        expectedChecksum: "b59a6e705031a54a69e5e1dced7ca9bf",
     },
 };
 exports.DownloadDetails = {

package/lib/emulator/extensionsEmulator.js

@@ -44,7 +44,7 @@ class ExtensionsEmulator {
         if (!functionsEmulator) {
             throw new error_1.FirebaseError("Extensions Emulator is running but Functions emulator is not. This should never happen.");
         }
-        return functionsEmulator.getInfo();
+        return Object.assign(Object.assign({}, functionsEmulator.getInfo()), { name: this.getName() });
     }
     getName() {
         return types_1.Emulators.EXTENSIONS;

package/lib/emulator/functionsEmulator.js

@@ -137,10 +137,11 @@ class FunctionsEmulator {
                             method: req.method,
                             path: `/functions/projects/${projectId}/triggers/${triggerId}`,
                             headers: req.headers,
-                        }, resolve);
+                        });
                         trigReq.on("error", reject);
                         trigReq.write(rawBody);
                         trigReq.end();
+                        resolve();
                     });
                 });
             });

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

@@ -4,9 +4,9 @@ exports.createFirebaseEndpoints = void 0;
 const emulatorLogger_1 = require("../../emulatorLogger");
 const types_1 = require("../../types");
 const uuid = require("uuid");
-const zlib_1 = require("zlib");
 const metadata_1 = require("../metadata");
 const express_1 = require("express");
+const shared_1 = require("./shared");
 const registry_1 = require("../../registry");
 const multipart_1 = require("../multipart");
 const errors_1 = require("../errors");
@@ -17,7 +17,7 @@ function createFirebaseEndpoints(emulator) {
     const { storageLayer, uploadService } = emulator;
     if (process.env.STORAGE_EMULATOR_DEBUG) {
         firebaseStorageAPI.use((req, res, next) => {
-            console.log("--------------INCOMING REQUEST--------------");
+            console.log("--------------INCOMING FIREBASE REQUEST--------------");
             console.log(`${req.method.toUpperCase()} ${req.path}`);
             console.log("-- query:");
             console.log(JSON.stringify(req.query, undefined, 2));
@@ -98,24 +98,7 @@ function createFirebaseEndpoints(emulator) {
             metadata.addDownloadToken(true);
         }
         if (req.query.alt === "media") {
-            const isGZipped = metadata.contentEncoding === "gzip";
-            if (isGZipped) {
-                data = (0, zlib_1.gunzipSync)(data);
-            }
-            res.setHeader("Accept-Ranges", "bytes");
-            res.setHeader("Content-Type", metadata.contentType || "application/octet-stream");
-            res.setHeader("Content-Disposition", metadata.contentDisposition || "inline");
-            setObjectHeaders(res, metadata, { "Content-Encoding": isGZipped ? "identity" : undefined });
-            const byteRange = req.range(data.byteLength, { combine: true });
-            if (Array.isArray(byteRange) && byteRange.type === "bytes" && byteRange.length > 0) {
-                const range = byteRange[0];
-                res.setHeader("Content-Range", `${byteRange.type} ${range.start}-${range.end}/${data.byteLength}`);
-                res.status(206).end(data.slice(range.start, range.end + 1));
-            }
-            else {
-                res.end(data);
-            }
-            return;
+            return (0, shared_1.sendFileBytes)(metadata, data, req, res);
         }
         return res.json(new metadata_1.OutgoingFirebaseMetadata(metadata));
     });
@@ -215,7 +198,7 @@ function createFirebaseEndpoints(emulator) {
                 const upload = uploadService.startResumableUpload({
                     bucketId,
                     objectId,
-                    metadataRaw: JSON.stringify(req.body),
+                    metadata: req.body,
                     authorization: req.header("authorization"),
                 });
                 res.header("x-goog-upload-chunk-granularity", "10000");
@@ -330,7 +313,7 @@ function createFirebaseEndpoints(emulator) {
             const upload = uploadService.multipartUpload({
                 bucketId,
                 objectId,
-                metadataRaw,
+                metadata: JSON.parse(metadataRaw),
                 dataRaw: dataRaw,
                 authorization: req.header("authorization"),
             });
@@ -480,14 +463,11 @@ function createFirebaseEndpoints(emulator) {
     return firebaseStorageAPI;
 }
 exports.createFirebaseEndpoints = createFirebaseEndpoints;
-function setObjectHeaders(res, metadata, headerOverride = { "Content-Encoding": undefined }) {
+function setObjectHeaders(res, metadata) {
     if (metadata.contentDisposition) {
         res.setHeader("Content-Disposition", metadata.contentDisposition);
     }
-    if (headerOverride["Content-Encoding"]) {
-        res.setHeader("Content-Encoding", headerOverride["Content-Encoding"]);
-    }
-    else if (metadata.contentEncoding) {
+    if (metadata.contentEncoding) {
         res.setHeader("Content-Encoding", metadata.contentEncoding);
     }
     if (metadata.cacheControl) {

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

@@ -2,12 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCloudEndpoints = void 0;
 const express_1 = require("express");
-const zlib_1 = require("zlib");
 const types_1 = require("../../types");
 const metadata_1 = require("../metadata");
+const shared_1 = require("./shared");
 const registry_1 = require("../../registry");
 const emulatorLogger_1 = require("../../emulatorLogger");
-const crc_1 = require("../crc");
 const multipart_1 = require("../multipart");
 const upload_1 = require("../upload");
 const errors_1 = require("../errors");
@@ -17,7 +16,7 @@ function createCloudEndpoints(emulator) {
     const { adminStorageLayer, uploadService } = emulator;
     if (process.env.STORAGE_EMULATOR_DEBUG) {
         gcloudStorageAPI.use((req, res, next) => {
-            console.log("--------------INCOMING REQUEST--------------");
+            console.log("--------------INCOMING GCS REQUEST--------------");
             console.log(`${req.method.toUpperCase()} ${req.path}`);
             console.log("-- query:");
             console.log(JSON.stringify(req.query, undefined, 2));
@@ -86,7 +85,7 @@ function createCloudEndpoints(emulator) {
             throw err;
         }
         if (req.query.alt === "media") {
-            return sendFileBytes(getObjectResponse.metadata, getObjectResponse.data, req, res);
+            return (0, shared_1.sendFileBytes)(getObjectResponse.metadata, getObjectResponse.data, req, res);
         }
         return res.json(new metadata_1.CloudStorageObjectMetadata(getObjectResponse.metadata));
     });
@@ -110,7 +109,7 @@ function createCloudEndpoints(emulator) {
         }
         return res.json(new metadata_1.CloudStorageObjectMetadata(updatedMetadata));
     });
-    gcloudStorageAPI.get("/b/:bucketId/o", async (req, res) => {
+    gcloudStorageAPI.get(["/b/:bucketId/o", "/storage/v1/b/:bucketId/o"], async (req, res) => {
         var _a;
         let listResponse;
         try {
@@ -228,10 +227,11 @@ function createCloudEndpoints(emulator) {
                 res.sendStatus(400);
                 return;
             }
+            const contentType = req.header("x-upload-content-type");
             const upload = uploadService.startResumableUpload({
                 bucketId: req.params.bucketId,
                 objectId: name,
-                metadataRaw: JSON.stringify(req.body),
+                metadata: Object.assign({ contentType }, req.body),
                 authorization: req.header("authorization"),
             });
             const uploadUrl = registry_1.EmulatorRegistry.url(types_1.Emulators.STORAGE, req);
@@ -256,6 +256,7 @@ function createCloudEndpoints(emulator) {
         }
         if (uploadType === "multipart") {
             const contentTypeHeader = req.header("content-type") || req.header("x-upload-content-type");
+            const contentType = req.header("x-upload-content-type");
             if (!contentTypeHeader) {
                 return res.sendStatus(400);
             }
@@ -283,7 +284,7 @@ function createCloudEndpoints(emulator) {
             const upload = uploadService.multipartUpload({
                 bucketId: req.params.bucketId,
                 objectId: name,
-                metadataRaw: metadataRaw,
+                metadata: Object.assign({ contentType }, JSON.parse(metadataRaw)),
                 dataRaw: dataRaw,
                 authorization: req.header("authorization"),
             });
@@ -318,7 +319,7 @@ function createCloudEndpoints(emulator) {
             }
             throw err;
         }
-        return sendFileBytes(getObjectResponse.metadata, getObjectResponse.data, req, res);
+        return (0, shared_1.sendFileBytes)(getObjectResponse.metadata, getObjectResponse.data, req, res);
     });
     gcloudStorageAPI.post("/b/:bucketId/o/:objectId/:method(rewriteTo|copyTo)/b/:destBucketId/o/:destObjectId", (req, res, next) => {
         if (req.params.method === "rewriteTo" && req.query.rewriteToken) {
@@ -375,31 +376,6 @@ function createCloudEndpoints(emulator) {
     return gcloudStorageAPI;
 }
 exports.createCloudEndpoints = createCloudEndpoints;
-function sendFileBytes(md, data, req, res) {
-    const isGZipped = md.contentEncoding === "gzip";
-    if (isGZipped) {
-        data = (0, zlib_1.gunzipSync)(data);
-    }
-    res.setHeader("Accept-Ranges", "bytes");
-    res.setHeader("Content-Type", md.contentType || "application/octet-stream");
-    res.setHeader("Content-Disposition", md.contentDisposition || "attachment");
-    res.setHeader("Content-Encoding", isGZipped ? "identity" : md.contentEncoding || "");
-    res.setHeader("ETag", md.etag);
-    res.setHeader("Cache-Control", md.cacheControl || "");
-    res.setHeader("x-goog-generation", `${md.generation}`);
-    res.setHeader("x-goog-metadatageneration", `${md.metageneration}`);
-    res.setHeader("x-goog-storage-class", md.storageClass);
-    res.setHeader("x-goog-hash", `crc32c=${(0, crc_1.crc32cToString)(md.crc32c)},md5=${md.md5Hash}`);
-    const byteRange = req.range(data.byteLength, { combine: true });
-    if (Array.isArray(byteRange) && byteRange.type === "bytes" && byteRange.length > 0) {
-        const range = byteRange[0];
-        res.setHeader("Content-Range", `${byteRange.type} ${range.start}-${range.end}/${data.byteLength}`);
-        res.status(206).end(data.slice(range.start, range.end + 1));
-    }
-    else {
-        res.end(data);
-    }
-}
 function sendObjectNotFound(req, res) {
     res.status(404);
     const message = `No such object: ${req.params.bucketId}/${req.params.objectId}`;

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendFileBytes = void 0;
+const zlib_1 = require("zlib");
+const crc_1 = require("../crc");
+function sendFileBytes(md, data, req, res) {
+    let didGunzip = false;
+    if (md.contentEncoding === "gzip") {
+        const acceptEncoding = req.header("accept-encoding") || "";
+        const shouldGunzip = !acceptEncoding.includes("gzip");
+        if (shouldGunzip) {
+            data = (0, zlib_1.gunzipSync)(data);
+            didGunzip = true;
+        }
+    }
+    res.setHeader("Accept-Ranges", "bytes");
+    res.setHeader("Content-Type", md.contentType || "application/octet-stream");
+    res.setHeader("Content-Disposition", md.contentDisposition || "attachment");
+    if (didGunzip) {
+        res.setHeader("Transfer-Encoding", "chunked");
+    }
+    else {
+        res.setHeader("Content-Encoding", md.contentEncoding || "");
+    }
+    res.setHeader("ETag", md.etag);
+    res.setHeader("Cache-Control", md.cacheControl || "");
+    res.setHeader("x-goog-generation", `${md.generation}`);
+    res.setHeader("x-goog-metadatageneration", `${md.metageneration}`);
+    res.setHeader("x-goog-storage-class", md.storageClass);
+    res.setHeader("x-goog-hash", `crc32c=${(0, crc_1.crc32cToString)(md.crc32c)},md5=${md.md5Hash}`);
+    const shouldRespectContentRange = !didGunzip;
+    if (shouldRespectContentRange) {
+        const byteRange = req.range(data.byteLength, { combine: true });
+        if (Array.isArray(byteRange) && byteRange.type === "bytes" && byteRange.length > 0) {
+            const range = byteRange[0];
+            res.setHeader("Content-Range", `${byteRange.type} ${range.start}-${range.end}/${data.byteLength}`);
+            res.status(206).end(data.slice(range.start, range.end + 1));
+            return;
+        }
+    }
+    res.end(data);
+}
+exports.sendFileBytes = sendFileBytes;

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

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getStorageRulesConfig = void 0;
 const error_1 = require("../../../error");
 const fsutils_1 = require("../../../fsutils");
+const constants_1 = require("../../constants");
+const types_1 = require("../../types");
+const emulatorLogger_1 = require("../../emulatorLogger");
 function getSourceFile(rules, options) {
     const path = options.config.path(rules);
     return { name: path, content: (0, fsutils_1.readFile)(path) };
@@ -10,6 +13,12 @@ function getSourceFile(rules, options) {
 function getStorageRulesConfig(projectId, options) {
     const storageConfig = options.config.data.storage;
     if (!storageConfig) {
+        if (constants_1.Constants.isDemoProject(projectId)) {
+            const storageLogger = emulatorLogger_1.EmulatorLogger.forEmulator(types_1.Emulators.STORAGE);
+            storageLogger.logLabeled("BULLET", "storage", `Detected demo project ID "${projectId}", using a default (open) rules configuration.`);
+            const path = __dirname + "/../../../../templates/emulators/default_storage.rules";
+            return { name: path, content: (0, fsutils_1.readFile)(path) };
+        }
         throw new error_1.FirebaseError("Cannot start the Storage emulator without rules file specified in firebase.json: run 'firebase init' and set up your Storage configuration");
     }
     if (!Array.isArray(storageConfig)) {

package/lib/emulator/storage/upload.js

@@ -50,7 +50,7 @@ class UploadService {
             objectId: request.objectId,
             uploadType: UploadType.MULTIPART,
             dataRaw: request.dataRaw,
-            metadata: JSON.parse(request.metadataRaw),
+            metadata: request.metadata,
             authorization: request.authorization,
         });
         this._persistence.deleteFile(upload.path, true);
@@ -82,7 +82,7 @@ class UploadService {
             type: UploadType.RESUMABLE,
             path: this.getStagingFileName(id, request.bucketId, request.objectId),
             status: UploadStatus.ACTIVE,
-            metadata: JSON.parse(request.metadataRaw),
+            metadata: request.metadata,
             size: 0,
             authorization: request.authorization,
         };

package/npm-shrinkwrap.json

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

package/package.json

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

package/templates/emulators/default_storage.rules

@@ -0,0 +1,8 @@
+rules_version = '2';
+service firebase.storage {
+  match /b/{bucket}/o {
+    match /{allPaths=**} {
+      allow read, write;
+    }
+  }
+}

package/templates/init/functions/golang/functions.go

@@ -1,7 +1,7 @@
 package PACKAGE
 
 // Welcome to Cloud Functions for Firebase for Golang!
-// To get started, simply uncomment the below code or create your own.
+// To get started, uncomment the below code or create your own.
 // Deploy with `firebase deploy`
 
 /*

package/templates/init/functions/javascript/index.js

@@ -1,7 +1,7 @@
 const functions = require("firebase-functions");
 
-// // Create and Deploy Your First Cloud Functions
-// // https://firebase.google.com/docs/functions/write-firebase-functions
+// // Create and deploy your first functions
+// // https://firebase.google.com/docs/functions/get-started
 //
 // exports.helloWorld = functions.https.onRequest((request, response) => {
 //   functions.logger.info("Hello logs!", {structuredData: true});

package/templates/init/functions/typescript/index.ts

@@ -1,6 +1,6 @@
 import * as functions from "firebase-functions";
 
-// // Start writing Firebase Functions
+// // Start writing functions
 // // https://firebase.google.com/docs/functions/typescript
 //
 // export const helloWorld = functions.https.onRequest((request, response) => {