firebase-tools 11.2.2 → 11.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -93,7 +93,7 @@ function discoverTrigger(endpoint, paramValues) {
93
93
  if ("httpsTrigger" in endpoint) {
94
94
  const bkHttps = {};
95
95
  if (endpoint.httpsTrigger.invoker) {
96
- bkHttps.invoker = [endpoint.httpsTrigger.invoker];
96
+ bkHttps.invoker = endpoint.httpsTrigger.invoker;
97
97
  }
98
98
  trigger = { httpsTrigger: bkHttps };
99
99
  }
@@ -113,12 +113,22 @@ function discoverTrigger(endpoint, paramValues) {
113
113
  eventFilters: bkEventFilters,
114
114
  retry: resolveBoolean(endpoint.eventTrigger.retry || false),
115
115
  };
116
+ if (endpoint.eventTrigger.eventFilterPathPatterns) {
117
+ const bkEventFiltersPathPatterns = {};
118
+ for (const [key, value] of Object.entries(endpoint.eventTrigger.eventFilterPathPatterns)) {
119
+ bkEventFiltersPathPatterns[key] = params.resolveString(value, paramValues);
120
+ }
121
+ bkEvent.eventFilterPathPatterns = bkEventFiltersPathPatterns;
122
+ }
116
123
  if (endpoint.eventTrigger.serviceAccount) {
117
124
  bkEvent.serviceAccountEmail = endpoint.eventTrigger.serviceAccount;
118
125
  }
119
126
  if (endpoint.eventTrigger.region) {
120
127
  bkEvent.region = resolveString(endpoint.eventTrigger.region);
121
128
  }
129
+ if (endpoint.eventTrigger.channel) {
130
+ bkEvent.channel = endpoint.eventTrigger.channel;
131
+ }
122
132
  trigger = { eventTrigger: bkEvent };
123
133
  }
124
134
  else if ("scheduleTrigger" in endpoint) {
@@ -126,7 +126,7 @@ function addResourcesToBuild(projectId, runtime, annotation, want) {
126
126
  logger_1.logger.warn(`Ignoring retry policy for HTTPS function ${annotation.name}`);
127
127
  }
128
128
  if (annotation.httpsTrigger.invoker) {
129
- trigger.invoker = annotation.httpsTrigger.invoker[0];
129
+ trigger.invoker = annotation.httpsTrigger.invoker;
130
130
  }
131
131
  triggered = { httpsTrigger: trigger };
132
132
  }
@@ -20,7 +20,7 @@ async function downloadToTmp(remoteUrl) {
20
20
  resolveOnHTTPError: true,
21
21
  });
22
22
  if (res.status !== 200) {
23
- throw new error_1.FirebaseError(`download failed, status ${res.status}`, { exit: 1 });
23
+ throw new error_1.FirebaseError(`download failed, status ${res.status}: ${await res.response.text()}`);
24
24
  }
25
25
  const total = parseInt(res.response.headers.get("content-length") || "0", 10);
26
26
  const totalMb = Math.ceil(total / 1000000);
@@ -55,7 +55,7 @@ exports.DownloadDetails = {
55
55
  version: "SNAPSHOT",
56
56
  downloadPath: path.join(CACHE_DIR, "ui-vSNAPSHOT.zip"),
57
57
  unzipDir: path.join(CACHE_DIR, "ui-vSNAPSHOT"),
58
- binaryPath: path.join(CACHE_DIR, "ui-vSNAPSHOT", "server.bundle.js"),
58
+ binaryPath: path.join(CACHE_DIR, "ui-vSNAPSHOT", "server", "server.js"),
59
59
  opts: {
60
60
  cacheDir: CACHE_DIR,
61
61
  remoteUrl: "https://storage.googleapis.com/firebase-preview-drop/emulator/ui-vSNAPSHOT.zip",
@@ -67,15 +67,15 @@ exports.DownloadDetails = {
67
67
  },
68
68
  }
69
69
  : {
70
- version: "1.7.0",
71
- downloadPath: path.join(CACHE_DIR, "ui-v1.7.0.zip"),
72
- unzipDir: path.join(CACHE_DIR, "ui-v1.7.0"),
73
- binaryPath: path.join(CACHE_DIR, "ui-v1.7.0", "server.bundle.js"),
70
+ version: "1.8.1",
71
+ downloadPath: path.join(CACHE_DIR, "ui-v1.8.1.zip"),
72
+ unzipDir: path.join(CACHE_DIR, "ui-v1.8.1"),
73
+ binaryPath: path.join(CACHE_DIR, "ui-v1.8.1", "server", "server.js"),
74
74
  opts: {
75
75
  cacheDir: CACHE_DIR,
76
- remoteUrl: "https://storage.googleapis.com/firebase-preview-drop/emulator/ui-v1.7.0.zip",
77
- expectedSize: 4053708,
78
- expectedChecksum: "aea9ae19091df5974a88a8847aaf127c",
76
+ remoteUrl: "https://storage.googleapis.com/firebase-preview-drop/emulator/ui-v1.8.1.zip",
77
+ expectedSize: 3056552,
78
+ expectedChecksum: "92590fdda20f9883588438d9551111b5",
79
79
  namePrefix: "ui",
80
80
  },
81
81
  },
@@ -104,7 +104,7 @@ class Proxied {
104
104
  return this.proxy;
105
105
  }
106
106
  }
107
- async function resolveDeveloperNodeModule(frb, name) {
107
+ async function resolveDeveloperNodeModule(name) {
108
108
  const pkg = requirePackageJson();
109
109
  if (!pkg) {
110
110
  new types_1.EmulatorLog("SYSTEM", "missing-package-json", "").log();
@@ -130,20 +130,20 @@ async function resolveDeveloperNodeModule(frb, name) {
130
130
  logDebug(`Resolved module ${name}`, moduleResolution);
131
131
  return moduleResolution;
132
132
  }
133
- async function assertResolveDeveloperNodeModule(frb, name) {
134
- const resolution = await resolveDeveloperNodeModule(frb, name);
133
+ async function assertResolveDeveloperNodeModule(name) {
134
+ const resolution = await resolveDeveloperNodeModule(name);
135
135
  if (!(resolution.installed && resolution.declared && resolution.resolution && resolution.version)) {
136
136
  throw new Error(`Assertion failure: could not fully resolve ${name}: ${JSON.stringify(resolution)}`);
137
137
  }
138
138
  return resolution;
139
139
  }
140
- async function verifyDeveloperNodeModules(frb) {
140
+ async function verifyDeveloperNodeModules() {
141
141
  const modBundles = [
142
142
  { name: "firebase-admin", isDev: false, minVersion: "8.9.0" },
143
143
  { name: "firebase-functions", isDev: false, minVersion: "3.13.1" },
144
144
  ];
145
145
  for (const modBundle of modBundles) {
146
- const resolution = await resolveDeveloperNodeModule(frb, modBundle.name);
146
+ const resolution = await resolveDeveloperNodeModule(modBundle.name);
147
147
  if (!resolution.declared) {
148
148
  new types_1.EmulatorLog("SYSTEM", "missing-module", "", modBundle).log();
149
149
  return false;
@@ -240,8 +240,8 @@ function initializeNetworkFiltering() {
240
240
  });
241
241
  logDebug("Outgoing network have been stubbed.", results);
242
242
  }
243
- async function initializeFirebaseFunctionsStubs(frb) {
244
- const firebaseFunctionsResolution = await assertResolveDeveloperNodeModule(frb, "firebase-functions");
243
+ async function initializeFirebaseFunctionsStubs() {
244
+ const firebaseFunctionsResolution = await assertResolveDeveloperNodeModule("firebase-functions");
245
245
  const firebaseFunctionsRoot = (0, functionsEmulatorShared_1.findModuleRoot)("firebase-functions", firebaseFunctionsResolution.resolution);
246
246
  const httpsProviderResolution = path.join(firebaseFunctionsRoot, "lib/providers/https");
247
247
  const httpsProviderV1Resolution = path.join(firebaseFunctionsRoot, "lib/v1/providers/https");
@@ -343,10 +343,10 @@ function initializeRuntimeConfig() {
343
343
  }
344
344
  }
345
345
  }
346
- async function initializeFirebaseAdminStubs(frb) {
347
- const adminResolution = await assertResolveDeveloperNodeModule(frb, "firebase-admin");
346
+ async function initializeFirebaseAdminStubs() {
347
+ const adminResolution = await assertResolveDeveloperNodeModule("firebase-admin");
348
348
  const localAdminModule = require(adminResolution.resolution);
349
- const functionsResolution = await assertResolveDeveloperNodeModule(frb, "firebase-functions");
349
+ const functionsResolution = await assertResolveDeveloperNodeModule("firebase-functions");
350
350
  const localFunctionsModule = require(functionsResolution.resolution);
351
351
  const defaultConfig = getDefaultConfig();
352
352
  const adminModuleProxy = new Proxied(localAdminModule);
@@ -360,7 +360,7 @@ async function initializeFirebaseAdminStubs(frb) {
360
360
  new types_1.EmulatorLog("SYSTEM", "default-admin-app-used", `config=${defaultAppOptions}`, {
361
361
  opts: defaultAppOptions,
362
362
  }).log();
363
- const defaultApp = makeProxiedFirebaseApp(frb, adminModuleTarget.initializeApp(defaultAppOptions));
363
+ const defaultApp = makeProxiedFirebaseApp(adminModuleTarget.initializeApp(defaultAppOptions));
364
364
  logDebug("initializeApp(DEFAULT)", defaultAppOptions);
365
365
  localFunctionsModule.app.setEmulatedAdminApp(defaultApp);
366
366
  if (process.env[constants_1.Constants.FIREBASE_AUTH_EMULATOR_HOST]) {
@@ -405,7 +405,7 @@ async function initializeFirebaseAdminStubs(frb) {
405
405
  adminResolution,
406
406
  });
407
407
  }
408
- function makeProxiedFirebaseApp(frb, original) {
408
+ function makeProxiedFirebaseApp(original) {
409
409
  const appProxy = new Proxied(original);
410
410
  return appProxy
411
411
  .when("firestore", (target) => {
@@ -450,8 +450,8 @@ function warnAboutStorageProd() {
450
450
  }
451
451
  new types_1.EmulatorLog("WARN_ONCE", "runtime-status", "The Firebase Storage emulator is not running, so calls to Firebase Storage will affect production.").log();
452
452
  }
453
- async function initializeFunctionsConfigHelper(frb) {
454
- const functionsResolution = await assertResolveDeveloperNodeModule(frb, "firebase-functions");
453
+ async function initializeFunctionsConfigHelper() {
454
+ const functionsResolution = await assertResolveDeveloperNodeModule("firebase-functions");
455
455
  const localFunctionsModule = require(functionsResolution.resolution);
456
456
  logDebug("Checked functions.config()", {
457
457
  config: localFunctionsModule.config(),
@@ -487,27 +487,7 @@ function rawBodySaver(req, res, buf) {
487
487
  }
488
488
  async function processHTTPS(trigger) {
489
489
  const ephemeralServer = express();
490
- const functionRouter = express.Router();
491
490
  await new Promise((resolveEphemeralServer, rejectEphemeralServer) => {
492
- const handler = async (req, res) => {
493
- try {
494
- logDebug(`Ephemeral server handling ${req.method} request`);
495
- res.on("finish", () => {
496
- instance.close((err) => {
497
- if (err) {
498
- rejectEphemeralServer(err);
499
- }
500
- else {
501
- resolveEphemeralServer();
502
- }
503
- });
504
- });
505
- await runHTTPS(trigger, [req, res]);
506
- }
507
- catch (err) {
508
- rejectEphemeralServer(err);
509
- }
510
- };
511
491
  ephemeralServer.enable("trust proxy");
512
492
  ephemeralServer.use(bodyParser.json({
513
493
  limit: "10mb",
@@ -527,14 +507,39 @@ async function processHTTPS(trigger) {
527
507
  limit: "10mb",
528
508
  verify: rawBodySaver,
529
509
  }));
530
- functionRouter.all("*", handler);
531
- ephemeralServer.use([`/`, `/*`], functionRouter);
532
- logDebug(`Attempting to listen to port: ${process.env.PORT}`);
533
- const instance = ephemeralServer.listen(process.env.PORT, () => {
534
- logDebug(`Listening to port: ${process.env.PORT}`);
535
- new types_1.EmulatorLog("SYSTEM", "runtime-status", "ready", { state: "ready" }).log();
510
+ let server;
511
+ function closeServer() {
512
+ if (server) {
513
+ server.close((err) => {
514
+ if (err) {
515
+ rejectEphemeralServer(err);
516
+ }
517
+ else {
518
+ resolveEphemeralServer();
519
+ }
520
+ });
521
+ }
522
+ }
523
+ ephemeralServer.get("/__/health", (req, res) => {
524
+ res.status(200).send();
536
525
  });
537
- instance.on("error", rejectEphemeralServer);
526
+ ephemeralServer.all("/favicon.ico|/robots.txt", (req, res) => {
527
+ res.on("finish", closeServer);
528
+ res.status(404).send();
529
+ });
530
+ ephemeralServer.all(`/*`, async (req, res) => {
531
+ try {
532
+ logDebug(`Ephemeral server handling ${req.method} request`);
533
+ res.on("finish", closeServer);
534
+ await runHTTPS(trigger, [req, res]);
535
+ }
536
+ catch (err) {
537
+ rejectEphemeralServer(err);
538
+ }
539
+ });
540
+ logDebug(`Attempting to listen to port: ${process.env.PORT}`);
541
+ server = ephemeralServer.listen(process.env.PORT);
542
+ server.on("error", rejectEphemeralServer);
538
543
  });
539
544
  }
540
545
  async function processBackground(trigger, frb, signature) {
@@ -587,7 +592,7 @@ async function runHTTPS(trigger, args) {
587
592
  return trigger(args[0], args[1]);
588
593
  });
589
594
  }
590
- async function moduleResolutionDetective(frb, error) {
595
+ async function moduleResolutionDetective(error) {
591
596
  const clues = {
592
597
  tsconfigJSON: await requireAsync("./tsconfig.json", { paths: [process.cwd()] }).catch(noOp),
593
598
  packageJSON: await requireAsync("./package.json", { paths: [process.cwd()] }).catch(noOp),
@@ -645,7 +650,7 @@ async function invokeTrigger(trigger, frb) {
645
650
  clearInterval(timerId);
646
651
  new types_1.EmulatorLog("INFO", "runtime-status", `Finished "${FUNCTION_TARGET_NAME}" in ~${Math.max(seconds, 1)}s`).log();
647
652
  }
648
- async function initializeRuntime(frb) {
653
+ async function initializeRuntime() {
649
654
  FUNCTION_DEBUG_MODE = process.env.FUNCTION_DEBUG_MODE || "";
650
655
  if (!FUNCTION_DEBUG_MODE) {
651
656
  FUNCTION_TARGET_NAME = process.env.FUNCTION_TARGET || "";
@@ -659,19 +664,18 @@ async function initializeRuntime(frb) {
659
664
  await flushAndExit(1);
660
665
  }
661
666
  }
662
- logDebug(`Disabled runtime features: ${JSON.stringify(frb.disabled_features)}`);
663
- const verified = await verifyDeveloperNodeModules(frb);
667
+ const verified = await verifyDeveloperNodeModules();
664
668
  if (!verified) {
665
669
  new types_1.EmulatorLog("INFO", "runtime-status", `Your functions could not be parsed due to an issue with your node_modules (see above)`).log();
666
670
  return;
667
671
  }
668
672
  initializeRuntimeConfig();
669
673
  initializeNetworkFiltering();
670
- await initializeFunctionsConfigHelper(frb);
671
- await initializeFirebaseFunctionsStubs(frb);
672
- await initializeFirebaseAdminStubs(frb);
674
+ await initializeFunctionsConfigHelper();
675
+ await initializeFirebaseFunctionsStubs();
676
+ await initializeFirebaseAdminStubs();
673
677
  }
674
- async function loadTriggers(frb, serializedFunctionTrigger) {
678
+ async function loadTriggers(serializedFunctionTrigger) {
675
679
  let triggerModule;
676
680
  if (serializedFunctionTrigger) {
677
681
  triggerModule = eval(serializedFunctionTrigger)();
@@ -682,7 +686,7 @@ async function loadTriggers(frb, serializedFunctionTrigger) {
682
686
  }
683
687
  catch (err) {
684
688
  if (err.code !== "ERR_REQUIRE_ESM") {
685
- await moduleResolutionDetective(frb, err);
689
+ await moduleResolutionDetective(err);
686
690
  throw err;
687
691
  }
688
692
  const modulePath = require.resolve(process.cwd());
@@ -712,9 +716,8 @@ async function handleMessage(message) {
712
716
  }
713
717
  if (!functionModule) {
714
718
  try {
715
- await initializeRuntime(runtimeArgs.frb);
716
719
  const serializedTriggers = runtimeArgs.opts ? runtimeArgs.opts.serializedTriggers : undefined;
717
- functionModule = await loadTriggers(runtimeArgs.frb, serializedTriggers);
720
+ functionModule = await loadTriggers(serializedTriggers);
718
721
  }
719
722
  catch (e) {
720
723
  logDebug(e);
@@ -748,7 +751,7 @@ async function handleMessage(message) {
748
751
  await flushAndExit(1);
749
752
  }
750
753
  }
751
- function main() {
754
+ async function main() {
752
755
  let lastSignal = new Date().getTime();
753
756
  let signalCount = 0;
754
757
  process.on("SIGINT", () => {
@@ -762,10 +765,7 @@ function main() {
762
765
  process.exit(1);
763
766
  }
764
767
  });
765
- logDebug("Functions runtime initialized.", {
766
- cwd: process.cwd(),
767
- node_version: process.versions.node,
768
- });
768
+ await initializeRuntime();
769
769
  let messageHandlePromise = Promise.resolve();
770
770
  process.on("message", (message) => {
771
771
  messageHandlePromise = messageHandlePromise
@@ -780,5 +780,15 @@ function main() {
780
780
  });
781
781
  }
782
782
  if (require.main === module) {
783
- main();
783
+ main()
784
+ .then(() => {
785
+ logDebug("Functions runtime initialized.", {
786
+ cwd: process.cwd(),
787
+ node_version: process.versions.node,
788
+ });
789
+ })
790
+ .catch((err) => {
791
+ new types_1.EmulatorLog("FATAL", "runtime-error", err.message || err, err).log();
792
+ return flushAndExit(1);
793
+ });
784
794
  }
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.RuntimeWorkerPool = exports.RuntimeWorker = exports.RuntimeWorkerState = void 0;
4
+ const http = require("http");
4
5
  const uuid = require("uuid");
5
6
  const types_1 = require("./types");
6
7
  const events_1 = require("events");
@@ -49,17 +50,11 @@ class RuntimeWorker {
49
50
  return this._state;
50
51
  }
51
52
  set state(state) {
52
- if (state === RuntimeWorkerState.BUSY) {
53
- this.socketReady = types_1.EmulatorLog.waitForLog(this.runtime.events, "SYSTEM", "runtime-status", (el) => {
54
- return el.data.state === "ready";
55
- });
56
- }
57
53
  if (state === RuntimeWorkerState.IDLE) {
58
54
  for (const l of this.logListeners) {
59
55
  this.runtime.events.removeListener("log", l);
60
56
  }
61
57
  this.logListeners = [];
62
- this.socketReady = undefined;
63
58
  }
64
59
  if (state === RuntimeWorkerState.FINISHED) {
65
60
  this.runtime.events.removeAllListeners();
@@ -88,9 +83,40 @@ class RuntimeWorker {
88
83
  this.stateEvents.once(RuntimeWorkerState.FINISHED, listener);
89
84
  });
90
85
  }
91
- waitForSocketReady() {
92
- return (this.socketReady ||
93
- Promise.reject(new Error("Cannot call waitForSocketReady() if runtime is not BUSY")));
86
+ isSocketReady() {
87
+ return new Promise((resolve, reject) => {
88
+ const req = http
89
+ .request({
90
+ method: "GET",
91
+ path: "/__/health",
92
+ socketPath: this.runtime.socketPath,
93
+ }, () => resolve())
94
+ .end();
95
+ req.on("error", (error) => {
96
+ reject(error);
97
+ });
98
+ });
99
+ }
100
+ async waitForSocketReady() {
101
+ const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
102
+ const timeout = new Promise((resolve, reject) => {
103
+ setTimeout(() => {
104
+ reject(new error_1.FirebaseError("Failed to load function."));
105
+ }, 7000);
106
+ });
107
+ while (true) {
108
+ try {
109
+ await Promise.race([this.isSocketReady(), timeout]);
110
+ break;
111
+ }
112
+ catch (err) {
113
+ if (["ECONNREFUSED", "ENOENT"].includes(err === null || err === void 0 ? void 0 : err.code)) {
114
+ await sleep(100);
115
+ continue;
116
+ }
117
+ throw err;
118
+ }
119
+ }
94
120
  }
95
121
  log(msg) {
96
122
  emulatorLogger_1.EmulatorLogger.forEmulator(types_1.Emulators.FUNCTIONS).log("DEBUG", `[worker-${this.key}-${this.id}]: ${msg}`);
@@ -324,7 +324,7 @@ function sendFileBytes(md, data, req, res) {
324
324
  res.setHeader("Accept-Ranges", "bytes");
325
325
  res.setHeader("Content-Type", md.contentType);
326
326
  res.setHeader("Content-Disposition", md.contentDisposition);
327
- res.setHeader("Content-Encoding", md.contentEncoding);
327
+ res.setHeader("Content-Encoding", isGZipped ? "identity" : md.contentEncoding);
328
328
  res.setHeader("ETag", md.etag);
329
329
  res.setHeader("Cache-Control", md.cacheControl);
330
330
  res.setHeader("x-goog-generation", `${md.generation}`);
@@ -48,7 +48,7 @@ function listVariables(configPath) {
48
48
  retryCodes: [500, 503],
49
49
  })
50
50
  .then((resp) => {
51
- return Promise.resolve(resp.body.variables);
51
+ return Promise.resolve(resp.body.variables || []);
52
52
  });
53
53
  }
54
54
  function getVariable(varPath) {
@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.requireConfig = void 0;
4
4
  const error_1 = require("./error");
5
5
  async function requireConfig(options) {
6
- await Promise.resolve();
7
- if (!options.config) {
8
- throw options.configError
9
- ? options.configError
10
- : new error_1.FirebaseError("Not in a Firebase project directory (could not locate firebase.json)");
11
- }
6
+ return new Promise((resolve, reject) => {
7
+ var _a;
8
+ return options.config
9
+ ? resolve()
10
+ : reject((_a = options.configError) !== null && _a !== void 0 ? _a : new error_1.FirebaseError("Not in a Firebase project directory (could not locate firebase.json)"));
11
+ });
12
12
  }
13
13
  exports.requireConfig = requireConfig;
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "firebase-tools",
3
- "version": "11.2.2",
3
+ "version": "11.3.0",
4
4
  "lockfileVersion": 2,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "firebase-tools",
9
- "version": "11.2.2",
9
+ "version": "11.3.0",
10
10
  "license": "MIT",
11
11
  "dependencies": {
12
12
  "@google-cloud/pubsub": "^3.0.1",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "firebase-tools",
3
- "version": "11.2.2",
3
+ "version": "11.3.0",
4
4
  "description": "Command-Line Interface for Firebase",
5
5
  "main": "./lib/index.js",
6
6
  "bin": {