firebase-tools 10.1.5 → 10.2.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.
- package/lib/api.js +1 -0
- package/lib/auth.js +62 -25
- package/lib/commands/ext-configure.js +1 -0
- package/lib/commands/ext-install.js +1 -0
- package/lib/commands/ext-uninstall.js +1 -0
- package/lib/commands/ext-update.js +1 -0
- package/lib/commands/functions-secrets-access.js +17 -0
- package/lib/commands/functions-secrets-destroy.js +40 -0
- package/lib/commands/functions-secrets-get.js +21 -0
- package/lib/commands/functions-secrets-prune.js +50 -0
- package/lib/commands/functions-secrets-set.js +46 -0
- package/lib/commands/index.js +7 -3
- package/lib/commands/login.js +1 -1
- package/lib/deploy/functions/backend.js +9 -1
- package/lib/deploy/functions/ensure.js +112 -0
- package/lib/deploy/functions/ensureCloudBuildEnabled.js +0 -49
- package/lib/deploy/functions/prepare.js +12 -18
- package/lib/deploy/functions/runtimes/discovery/v1alpha1.js +1 -0
- package/lib/deploy/functions/runtimes/node/parseTriggers.js +12 -0
- package/lib/deploy/functions/validate.js +56 -1
- package/lib/emulator/controller.js +3 -1
- package/lib/emulator/emulatorLogger.js +7 -0
- package/lib/emulator/functionsEmulator.js +110 -78
- package/lib/emulator/functionsEmulatorRuntime.js +100 -83
- package/lib/emulator/functionsEmulatorShared.js +51 -1
- package/lib/emulator/functionsEmulatorShell.js +1 -2
- package/lib/emulator/functionsRuntimeWorker.js +1 -1
- package/lib/extensions/askUserForParam.js +1 -1
- package/lib/extensions/diagnose.js +56 -0
- package/lib/extensions/extensionsHelper.js +10 -1
- package/lib/extensions/secretsUtils.js +1 -1
- package/lib/functions/env.js +5 -7
- package/lib/functions/secrets.js +112 -0
- package/lib/gcp/cloudfunctions.js +2 -2
- package/lib/gcp/secretManager.js +128 -46
- package/lib/previews.js +1 -1
- package/lib/serve/functions.js +2 -2
- package/lib/utils.js +6 -1
- package/npm-shrinkwrap.json +2 -2
- package/package.json +1 -1
|
@@ -56,6 +56,7 @@ function parseEndpoints(manifest, id, project, defaultRegion, runtime) {
|
|
|
56
56
|
labels: "object",
|
|
57
57
|
ingressSettings: "string",
|
|
58
58
|
environmentVariables: "object",
|
|
59
|
+
secretEnvironmentVariables: "array",
|
|
59
60
|
httpsTrigger: "object",
|
|
60
61
|
eventTrigger: "object",
|
|
61
62
|
scheduleTrigger: "object",
|
|
@@ -107,6 +107,18 @@ function addResourcesToBackend(projectId, runtime, annotation, want) {
|
|
|
107
107
|
}
|
|
108
108
|
endpoint.vpcConnector = maybeId;
|
|
109
109
|
}
|
|
110
|
+
if (annotation.secrets) {
|
|
111
|
+
const secretEnvs = [];
|
|
112
|
+
for (const secret of annotation.secrets) {
|
|
113
|
+
const secretEnv = {
|
|
114
|
+
secret,
|
|
115
|
+
projectId,
|
|
116
|
+
key: secret,
|
|
117
|
+
};
|
|
118
|
+
secretEnvs.push(secretEnv);
|
|
119
|
+
}
|
|
120
|
+
endpoint.secretEnvironmentVariables = secretEnvs;
|
|
121
|
+
}
|
|
110
122
|
proto.copyIfPresent(endpoint, annotation, "concurrency", "serviceAccountEmail", "labels", "vpcConnectorEgressSettings", "ingressSettings", "timeout", "maxInstances", "minInstances", "availableMemoryMb");
|
|
111
123
|
want.endpoints[region] = want.endpoints[region] || {};
|
|
112
124
|
want.endpoints[region][endpoint.id] = endpoint;
|
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.functionIdsAreValid = exports.functionsDirectoryExists = exports.endpointsAreValid = void 0;
|
|
3
|
+
exports.secretsAreValid = exports.functionIdsAreValid = exports.functionsDirectoryExists = exports.endpointsAreValid = void 0;
|
|
4
4
|
const path = require("path");
|
|
5
5
|
const clc = require("cli-color");
|
|
6
6
|
const error_1 = require("../../error");
|
|
7
|
+
const secretManager_1 = require("../../gcp/secretManager");
|
|
8
|
+
const logger_1 = require("../../logger");
|
|
7
9
|
const fsutils = require("../../fsutils");
|
|
8
10
|
const backend = require("./backend");
|
|
11
|
+
const utils = require("../../utils");
|
|
12
|
+
const secrets = require("../../functions/secrets");
|
|
9
13
|
function endpointsAreValid(wantBackend) {
|
|
10
14
|
functionIdsAreValid(backend.allEndpoints(wantBackend));
|
|
11
15
|
const gcfV1WithConcurrency = backend
|
|
@@ -62,3 +66,54 @@ function functionIdsAreValid(functions) {
|
|
|
62
66
|
}
|
|
63
67
|
}
|
|
64
68
|
exports.functionIdsAreValid = functionIdsAreValid;
|
|
69
|
+
async function secretsAreValid(projectId, wantBackend) {
|
|
70
|
+
const endpoints = backend
|
|
71
|
+
.allEndpoints(wantBackend)
|
|
72
|
+
.filter((e) => e.secretEnvironmentVariables && e.secretEnvironmentVariables.length > 0);
|
|
73
|
+
validatePlatformTargets(endpoints);
|
|
74
|
+
await validateSecretVersions(projectId, endpoints);
|
|
75
|
+
}
|
|
76
|
+
exports.secretsAreValid = secretsAreValid;
|
|
77
|
+
function validatePlatformTargets(endpoints) {
|
|
78
|
+
const supportedPlatforms = ["gcfv1"];
|
|
79
|
+
const unsupported = endpoints.filter((e) => !supportedPlatforms.includes(e.platform));
|
|
80
|
+
if (unsupported.length > 0) {
|
|
81
|
+
const errs = unsupported.map((e) => `${e.id}[platform=${e.platform}]`);
|
|
82
|
+
throw new error_1.FirebaseError(`Tried to set secret environment variables on ${errs.join(", ")}. ` +
|
|
83
|
+
`Only ${supportedPlatforms.join(", ")} support secret environments.`);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
async function validateSecretVersions(projectId, endpoints) {
|
|
87
|
+
const toResolve = new Set();
|
|
88
|
+
for (const s of secrets.of(endpoints)) {
|
|
89
|
+
toResolve.add(s.secret);
|
|
90
|
+
}
|
|
91
|
+
const results = await utils.allSettled(Array.from(toResolve).map(async (secret) => {
|
|
92
|
+
const sv = await (0, secretManager_1.getSecretVersion)(projectId, secret, "latest");
|
|
93
|
+
logger_1.logger.debug(`Resolved secret version of ${clc.bold(secret)} to ${clc.bold(sv.versionId)}.`);
|
|
94
|
+
return sv;
|
|
95
|
+
}));
|
|
96
|
+
const secretVersions = {};
|
|
97
|
+
const errs = [];
|
|
98
|
+
for (const result of results) {
|
|
99
|
+
if (result.status === "fulfilled") {
|
|
100
|
+
const sv = result.value;
|
|
101
|
+
if (sv.state != "ENABLED") {
|
|
102
|
+
errs.push(new error_1.FirebaseError(`Expected secret ${sv.secret.name}@${sv.versionId} to be in state ENABLED not ${sv.state}.`));
|
|
103
|
+
}
|
|
104
|
+
secretVersions[sv.secret.name] = sv;
|
|
105
|
+
}
|
|
106
|
+
else {
|
|
107
|
+
errs.push(new error_1.FirebaseError(result.reason.message));
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
if (errs.length) {
|
|
111
|
+
throw new error_1.FirebaseError("Failed to validate secret versions", { children: errs });
|
|
112
|
+
}
|
|
113
|
+
for (const s of secrets.of(endpoints)) {
|
|
114
|
+
s.version = secretVersions[s.secret].versionId;
|
|
115
|
+
if (!s.version) {
|
|
116
|
+
throw new error_1.FirebaseError("Secret version is unexpectedly undefined. This should never happen.");
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
}
|
|
@@ -246,7 +246,8 @@ async function startAll(options, showUI = true) {
|
|
|
246
246
|
utils.assertDefined(options.config.src.functions);
|
|
247
247
|
utils.assertDefined(options.config.src.functions.source, "Error: 'functions.source' is not defined");
|
|
248
248
|
utils.assertIsStringOrUndefined(options.extensionDir);
|
|
249
|
-
const
|
|
249
|
+
const projectDir = options.extensionDir || options.config.projectDir;
|
|
250
|
+
const functionsDir = path.join(projectDir, options.config.src.functions.source);
|
|
250
251
|
let inspectFunctions;
|
|
251
252
|
if (options.inspectFunctions) {
|
|
252
253
|
inspectFunctions = commandUtils.parseInspectionPort(options);
|
|
@@ -269,6 +270,7 @@ async function startAll(options, showUI = true) {
|
|
|
269
270
|
];
|
|
270
271
|
const functionsEmulator = new functionsEmulator_1.FunctionsEmulator({
|
|
271
272
|
projectId,
|
|
273
|
+
projectDir,
|
|
272
274
|
emulatableBackends,
|
|
273
275
|
account,
|
|
274
276
|
host: functionsAddr.host,
|
|
@@ -13,6 +13,7 @@ const TYPE_VERBOSITY = {
|
|
|
13
13
|
USER: 2,
|
|
14
14
|
WARN: 2,
|
|
15
15
|
WARN_ONCE: 2,
|
|
16
|
+
ERROR: 2,
|
|
16
17
|
};
|
|
17
18
|
var Verbosity;
|
|
18
19
|
(function (Verbosity) {
|
|
@@ -79,6 +80,9 @@ class EmulatorLogger {
|
|
|
79
80
|
case "SUCCESS":
|
|
80
81
|
utils.logSuccess(text, "info", mergedData);
|
|
81
82
|
break;
|
|
83
|
+
case "ERROR":
|
|
84
|
+
utils.logBullet(text, "error", mergedData);
|
|
85
|
+
break;
|
|
82
86
|
}
|
|
83
87
|
}
|
|
84
88
|
handleRuntimeLog(log, ignore = []) {
|
|
@@ -196,6 +200,9 @@ You can probably fix this by running "npm install ${systemLog.data.name}@latest"
|
|
|
196
200
|
EmulatorLogger.warnOnceCache.add(text);
|
|
197
201
|
}
|
|
198
202
|
break;
|
|
203
|
+
case "ERROR":
|
|
204
|
+
utils.logLabeledError(label, text, "error", mergedData);
|
|
205
|
+
break;
|
|
199
206
|
}
|
|
200
207
|
}
|
|
201
208
|
static shouldSupress(type) {
|
|
@@ -27,10 +27,14 @@ const workQueue_1 = require("./workQueue");
|
|
|
27
27
|
const utils_1 = require("../utils");
|
|
28
28
|
const defaultCredentials_1 = require("../defaultCredentials");
|
|
29
29
|
const adminSdkConfig_1 = require("./adminSdkConfig");
|
|
30
|
-
const functionsEnv = require("../functions/env");
|
|
31
30
|
const types_2 = require("./events/types");
|
|
32
31
|
const validate_1 = require("../deploy/functions/validate");
|
|
32
|
+
const runtimes_1 = require("../deploy/functions/runtimes");
|
|
33
|
+
const backend = require("../deploy/functions/backend");
|
|
34
|
+
const functionsEnv = require("../functions/env");
|
|
35
|
+
const secretManager_1 = require("../gcp/secretManager");
|
|
33
36
|
const EVENT_INVOKE = "functions:invoke";
|
|
37
|
+
const LOCAL_SECRETS_FILE = ".secret.local";
|
|
34
38
|
const DATABASE_PATH_PATTERN = new RegExp("^projects/[^/]+/instances/([^/]+)/refs(/.*)$");
|
|
35
39
|
class FunctionsEmulator {
|
|
36
40
|
constructor(args) {
|
|
@@ -44,9 +48,7 @@ class FunctionsEmulator {
|
|
|
44
48
|
this.args.disabledRuntimeFeatures = this.args.disabledRuntimeFeatures || {};
|
|
45
49
|
this.args.disabledRuntimeFeatures.timeout = true;
|
|
46
50
|
}
|
|
47
|
-
this.adminSdkConfig = {
|
|
48
|
-
projectId: this.args.projectId,
|
|
49
|
-
};
|
|
51
|
+
this.adminSdkConfig = Object.assign(Object.assign({}, this.args.adminSdkConfig), { projectId: this.args.projectId });
|
|
50
52
|
const mode = this.args.debugPort
|
|
51
53
|
? types_1.FunctionsExecutionMode.SEQUENTIAL
|
|
52
54
|
: types_1.FunctionsExecutionMode.AUTO;
|
|
@@ -159,25 +161,17 @@ class FunctionsEmulator {
|
|
|
159
161
|
});
|
|
160
162
|
return hub;
|
|
161
163
|
}
|
|
162
|
-
startFunctionRuntime(backend,
|
|
163
|
-
const bundleTemplate = this.getBaseBundle(
|
|
164
|
-
const runtimeBundle = Object.assign(Object.assign({}, bundleTemplate), {
|
|
165
|
-
firestore: this.getEmulatorInfo(types_1.Emulators.FIRESTORE),
|
|
166
|
-
database: this.getEmulatorInfo(types_1.Emulators.DATABASE),
|
|
167
|
-
pubsub: this.getEmulatorInfo(types_1.Emulators.PUBSUB),
|
|
168
|
-
auth: this.getEmulatorInfo(types_1.Emulators.AUTH),
|
|
169
|
-
storage: this.getEmulatorInfo(types_1.Emulators.STORAGE),
|
|
170
|
-
}, nodeMajorVersion: backend.nodeMajorVersion, proto,
|
|
171
|
-
triggerId,
|
|
172
|
-
targetName });
|
|
164
|
+
async startFunctionRuntime(backend, trigger, proto, runtimeOpts) {
|
|
165
|
+
const bundleTemplate = this.getBaseBundle();
|
|
166
|
+
const runtimeBundle = Object.assign(Object.assign({}, bundleTemplate), { proto });
|
|
173
167
|
if (!backend.nodeBinary) {
|
|
174
|
-
throw new error_1.FirebaseError(`No node binary for ${
|
|
168
|
+
throw new error_1.FirebaseError(`No node binary for ${trigger.id}. This should never happen.`);
|
|
175
169
|
}
|
|
176
170
|
const opts = runtimeOpts || {
|
|
177
171
|
nodeBinary: backend.nodeBinary,
|
|
178
172
|
extensionTriggers: backend.predefinedTriggers,
|
|
179
173
|
};
|
|
180
|
-
const worker = this.invokeRuntime(
|
|
174
|
+
const worker = await this.invokeRuntime(backend, trigger, runtimeBundle, opts);
|
|
181
175
|
return worker;
|
|
182
176
|
}
|
|
183
177
|
async start() {
|
|
@@ -188,13 +182,15 @@ class FunctionsEmulator {
|
|
|
188
182
|
for (const e of this.args.emulatableBackends) {
|
|
189
183
|
e.env = Object.assign(Object.assign({}, credentialEnv), e.env);
|
|
190
184
|
}
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
185
|
+
if (Object.keys(this.adminSdkConfig || {}).length <= 1) {
|
|
186
|
+
const adminSdkConfig = await (0, adminSdkConfig_1.getProjectAdminSdkConfigOrCached)(this.args.projectId);
|
|
187
|
+
if (adminSdkConfig) {
|
|
188
|
+
this.adminSdkConfig = adminSdkConfig;
|
|
189
|
+
}
|
|
190
|
+
else {
|
|
191
|
+
this.logger.logLabeled("WARN", "functions", "Unable to fetch project Admin SDK configuration, Admin SDK behavior in Cloud Functions emulator may be incorrect.");
|
|
192
|
+
this.adminSdkConfig = (0, adminSdkConfig_1.constructDefaultAdminSdkConfig)(this.args.projectId);
|
|
193
|
+
}
|
|
198
194
|
}
|
|
199
195
|
const { host, port } = this.getInfo();
|
|
200
196
|
this.workQueue.start();
|
|
@@ -242,14 +238,25 @@ class FunctionsEmulator {
|
|
|
242
238
|
if (!emulatableBackend.nodeBinary) {
|
|
243
239
|
throw new error_1.FirebaseError(`No node binary for ${emulatableBackend.functionsDir}. This should never happen.`);
|
|
244
240
|
}
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
}
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
241
|
+
let triggerDefinitions;
|
|
242
|
+
if (emulatableBackend.predefinedTriggers) {
|
|
243
|
+
triggerDefinitions = (0, functionsEmulatorShared_1.emulatedFunctionsByRegion)(emulatableBackend.predefinedTriggers);
|
|
244
|
+
}
|
|
245
|
+
else {
|
|
246
|
+
const runtimeDelegate = await (0, runtimes_1.getRuntimeDelegate)({
|
|
247
|
+
projectId: this.args.projectId,
|
|
248
|
+
projectDir: this.args.projectDir,
|
|
249
|
+
sourceDir: emulatableBackend.functionsDir,
|
|
250
|
+
});
|
|
251
|
+
logger_1.logger.debug(`Validating ${runtimeDelegate.name} source`);
|
|
252
|
+
await runtimeDelegate.validate();
|
|
253
|
+
logger_1.logger.debug(`Building ${runtimeDelegate.name} source`);
|
|
254
|
+
await runtimeDelegate.build();
|
|
255
|
+
logger_1.logger.debug(`Analyzing ${runtimeDelegate.name} backend spec`);
|
|
256
|
+
const discoveredBackend = await runtimeDelegate.discoverSpec({}, Object.assign(Object.assign(Object.assign(Object.assign({}, this.getSystemEnvs()), this.getEmulatorEnvs()), { FIREBASE_CONFIG: this.getFirebaseConfig() }), emulatableBackend.env));
|
|
257
|
+
const endpoints = backend.allEndpoints(discoveredBackend);
|
|
258
|
+
triggerDefinitions = (0, functionsEmulatorShared_1.emulatedFunctionsFromEndpoints)(endpoints);
|
|
259
|
+
}
|
|
253
260
|
const toSetup = triggerDefinitions.filter((definition) => {
|
|
254
261
|
if (force) {
|
|
255
262
|
return true;
|
|
@@ -305,7 +312,7 @@ class FunctionsEmulator {
|
|
|
305
312
|
}
|
|
306
313
|
}
|
|
307
314
|
else {
|
|
308
|
-
this.logger.log("WARN", `
|
|
315
|
+
this.logger.log("WARN", `Unsupported function type on ${definition.name}. Expected either httpsTrigger or eventTrigger.`);
|
|
309
316
|
}
|
|
310
317
|
const ignored = !added;
|
|
311
318
|
this.addTriggerRecord(definition, { backend: emulatableBackend, ignored, url });
|
|
@@ -331,7 +338,7 @@ class FunctionsEmulator {
|
|
|
331
338
|
}
|
|
332
339
|
const result = DATABASE_PATH_PATTERN.exec(eventTrigger.resource);
|
|
333
340
|
if (result === null || result.length !== 3) {
|
|
334
|
-
this.logger.log("WARN", `Event
|
|
341
|
+
this.logger.log("WARN", `Event function "${key}" has malformed "resource" member. ` + `${eventTrigger.resource}`);
|
|
335
342
|
return Promise.reject();
|
|
336
343
|
}
|
|
337
344
|
const instance = result[1];
|
|
@@ -347,7 +354,7 @@ class FunctionsEmulator {
|
|
|
347
354
|
setTriggersPath += `?ns=${instance}`;
|
|
348
355
|
}
|
|
349
356
|
else {
|
|
350
|
-
this.logger.log("WARN", `No project in use. Registering function
|
|
357
|
+
this.logger.log("WARN", `No project in use. Registering function for sentinel namespace '${constants_1.Constants.DEFAULT_DATABASE_EMULATOR_NAMESPACE}'`);
|
|
351
358
|
}
|
|
352
359
|
return api
|
|
353
360
|
.request("POST", setTriggersPath, {
|
|
@@ -362,7 +369,7 @@ class FunctionsEmulator {
|
|
|
362
369
|
return true;
|
|
363
370
|
})
|
|
364
371
|
.catch((err) => {
|
|
365
|
-
this.logger.log("WARN", "Error adding
|
|
372
|
+
this.logger.log("WARN", "Error adding Realtime Database function: " + err);
|
|
366
373
|
throw err;
|
|
367
374
|
});
|
|
368
375
|
}
|
|
@@ -371,7 +378,9 @@ class FunctionsEmulator {
|
|
|
371
378
|
if (!firestoreEmu) {
|
|
372
379
|
return Promise.resolve(false);
|
|
373
380
|
}
|
|
374
|
-
const bundle = JSON.stringify({
|
|
381
|
+
const bundle = JSON.stringify({
|
|
382
|
+
eventTrigger: Object.assign(Object.assign({}, eventTrigger), { service: "firestore.googleapis.com" }),
|
|
383
|
+
});
|
|
375
384
|
logger_1.logger.debug(`addFirestoreTrigger`, JSON.stringify(bundle));
|
|
376
385
|
return api
|
|
377
386
|
.request("PUT", `/emulator/v1/projects/${projectId}/triggers/${key}`, {
|
|
@@ -383,7 +392,7 @@ class FunctionsEmulator {
|
|
|
383
392
|
return true;
|
|
384
393
|
})
|
|
385
394
|
.catch((err) => {
|
|
386
|
-
this.logger.log("WARN", "Error adding
|
|
395
|
+
this.logger.log("WARN", "Error adding firestore function: " + err);
|
|
387
396
|
throw err;
|
|
388
397
|
});
|
|
389
398
|
}
|
|
@@ -452,7 +461,7 @@ class FunctionsEmulator {
|
|
|
452
461
|
const record = this.triggers[triggerKey];
|
|
453
462
|
if (!record) {
|
|
454
463
|
logger_1.logger.debug(`Could not find key=${triggerKey} in ${JSON.stringify(this.triggers)}`);
|
|
455
|
-
throw new error_1.FirebaseError(`No
|
|
464
|
+
throw new error_1.FirebaseError(`No function with key ${triggerKey}`);
|
|
456
465
|
}
|
|
457
466
|
return record;
|
|
458
467
|
}
|
|
@@ -475,30 +484,12 @@ class FunctionsEmulator {
|
|
|
475
484
|
setTriggersForTesting(triggers, backend) {
|
|
476
485
|
triggers.forEach((def) => this.addTriggerRecord(def, { backend, ignored: false }));
|
|
477
486
|
}
|
|
478
|
-
getBaseBundle(
|
|
487
|
+
getBaseBundle() {
|
|
479
488
|
return {
|
|
480
|
-
|
|
481
|
-
projectId: this.args.projectId,
|
|
482
|
-
triggerId: "",
|
|
483
|
-
targetName: "",
|
|
484
|
-
emulators: {
|
|
485
|
-
firestore: registry_1.EmulatorRegistry.getInfo(types_1.Emulators.FIRESTORE),
|
|
486
|
-
database: registry_1.EmulatorRegistry.getInfo(types_1.Emulators.DATABASE),
|
|
487
|
-
pubsub: registry_1.EmulatorRegistry.getInfo(types_1.Emulators.PUBSUB),
|
|
488
|
-
auth: registry_1.EmulatorRegistry.getInfo(types_1.Emulators.AUTH),
|
|
489
|
-
storage: registry_1.EmulatorRegistry.getInfo(types_1.Emulators.STORAGE),
|
|
490
|
-
},
|
|
491
|
-
adminSdkConfig: {
|
|
492
|
-
databaseURL: this.adminSdkConfig.databaseURL,
|
|
493
|
-
storageBucket: this.adminSdkConfig.storageBucket,
|
|
494
|
-
},
|
|
489
|
+
proto: {},
|
|
495
490
|
disabled_features: this.args.disabledRuntimeFeatures,
|
|
496
491
|
};
|
|
497
492
|
}
|
|
498
|
-
getRequestedNodeRuntimeVersion(frb) {
|
|
499
|
-
const pkg = require(path.join(frb.cwd, "package.json"));
|
|
500
|
-
return frb.nodeMajorVersion || (pkg.engines && pkg.engines.node);
|
|
501
|
-
}
|
|
502
493
|
getNodeBinary(backend) {
|
|
503
494
|
const pkg = require(path.join(backend.functionsDir, "package.json"));
|
|
504
495
|
if ((!pkg.engines || !pkg.engines.node) && !backend.nodeMajorVersion) {
|
|
@@ -546,16 +537,16 @@ class FunctionsEmulator {
|
|
|
546
537
|
}
|
|
547
538
|
return {};
|
|
548
539
|
}
|
|
549
|
-
getSystemEnvs(
|
|
540
|
+
getSystemEnvs(trigger) {
|
|
550
541
|
const envs = {};
|
|
551
542
|
envs.GCLOUD_PROJECT = this.args.projectId;
|
|
552
543
|
envs.K_REVISION = "1";
|
|
553
544
|
envs.PORT = "80";
|
|
554
|
-
if (
|
|
555
|
-
const service =
|
|
545
|
+
if (trigger) {
|
|
546
|
+
const service = trigger.name;
|
|
556
547
|
const target = service.replace(/-/g, ".");
|
|
557
548
|
envs.FUNCTION_TARGET = target;
|
|
558
|
-
envs.FUNCTION_SIGNATURE_TYPE =
|
|
549
|
+
envs.FUNCTION_SIGNATURE_TYPE = (0, functionsEmulatorShared_1.getSignatureType)(trigger);
|
|
559
550
|
envs.K_SERVICE = service;
|
|
560
551
|
}
|
|
561
552
|
return envs;
|
|
@@ -607,12 +598,50 @@ class FunctionsEmulator {
|
|
|
607
598
|
projectId: this.args.projectId,
|
|
608
599
|
});
|
|
609
600
|
}
|
|
610
|
-
getRuntimeEnvs(backend,
|
|
611
|
-
return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, this.getUserEnvs(backend)), this.getSystemEnvs(
|
|
601
|
+
getRuntimeEnvs(backend, trigger) {
|
|
602
|
+
return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, this.getUserEnvs(backend)), this.getSystemEnvs(trigger)), this.getEmulatorEnvs()), { FIREBASE_CONFIG: this.getFirebaseConfig() }), backend.env);
|
|
612
603
|
}
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
604
|
+
async resolveSecretEnvs(backend, trigger) {
|
|
605
|
+
let secretEnvs = {};
|
|
606
|
+
try {
|
|
607
|
+
const data = fs.readFileSync(path.join(backend.functionsDir, LOCAL_SECRETS_FILE), "utf8");
|
|
608
|
+
secretEnvs = functionsEnv.parseStrict(data);
|
|
609
|
+
}
|
|
610
|
+
catch (e) {
|
|
611
|
+
if (e.code !== "ENOENT") {
|
|
612
|
+
this.logger.logLabeled("ERROR", "functions", `Failed to read local secrets file ${LOCAL_SECRETS_FILE}: ${e.message}`);
|
|
613
|
+
}
|
|
614
|
+
}
|
|
615
|
+
const secrets = trigger.secretEnvironmentVariables || [];
|
|
616
|
+
const accesses = secrets
|
|
617
|
+
.filter((s) => !secretEnvs[s.secret])
|
|
618
|
+
.map(async (s) => {
|
|
619
|
+
this.logger.logLabeled("INFO", "functions", `Trying to access secret ${s.key}@latest`);
|
|
620
|
+
const value = await (0, secretManager_1.accessSecretVersion)(this.getProjectId(), s.key, "latest");
|
|
621
|
+
return [s.secret, value];
|
|
622
|
+
});
|
|
623
|
+
const accessResults = await (0, utils_1.allSettled)(accesses);
|
|
624
|
+
const errs = [];
|
|
625
|
+
for (const result of accessResults) {
|
|
626
|
+
if (result.status === "rejected") {
|
|
627
|
+
errs.push(result.reason);
|
|
628
|
+
}
|
|
629
|
+
else {
|
|
630
|
+
const [k, v] = result.value;
|
|
631
|
+
secretEnvs[k] = v;
|
|
632
|
+
}
|
|
633
|
+
}
|
|
634
|
+
if (errs.length > 0) {
|
|
635
|
+
this.logger.logLabeled("ERROR", "functions", "Unable to access secret environment variables from Google Cloud Secret Manager. " +
|
|
636
|
+
"Make sure the credential used for the Functions Emulator have access " +
|
|
637
|
+
`or provide override values in ${LOCAL_SECRETS_FILE}:\n\t` +
|
|
638
|
+
errs.join("\n\t"));
|
|
639
|
+
}
|
|
640
|
+
return secretEnvs;
|
|
641
|
+
}
|
|
642
|
+
async invokeRuntime(backend, trigger, frb, opts) {
|
|
643
|
+
if (this.workerPool.readyForWork(trigger.id)) {
|
|
644
|
+
return this.workerPool.submitWork(trigger.id, frb, opts);
|
|
616
645
|
}
|
|
617
646
|
const emitter = new events_1.EventEmitter();
|
|
618
647
|
const args = [path.join(__dirname, "functionsEmulatorRuntime")];
|
|
@@ -621,7 +650,7 @@ class FunctionsEmulator {
|
|
|
621
650
|
}
|
|
622
651
|
if (this.args.debugPort) {
|
|
623
652
|
if (process.env.FIREPIT_VERSION && process.execPath == opts.nodeBinary) {
|
|
624
|
-
const requestedMajorNodeVersion = this.
|
|
653
|
+
const requestedMajorNodeVersion = this.getNodeBinary(backend);
|
|
625
654
|
this.logger.log("WARN", `To enable function inspection, please run "${process.execPath} is:npm i node@${requestedMajorNodeVersion} --save-dev" in your functions directory`);
|
|
626
655
|
}
|
|
627
656
|
else {
|
|
@@ -629,15 +658,17 @@ class FunctionsEmulator {
|
|
|
629
658
|
args.unshift(`--inspect=${host}:${this.args.debugPort}`);
|
|
630
659
|
}
|
|
631
660
|
}
|
|
632
|
-
const pnpPath = path.join(
|
|
661
|
+
const pnpPath = path.join(backend.functionsDir, ".pnp.js");
|
|
633
662
|
if (fs.existsSync(pnpPath)) {
|
|
634
663
|
emulatorLogger_1.EmulatorLogger.forEmulator(types_1.Emulators.FUNCTIONS).logLabeled("WARN_ONCE", "functions", "Detected yarn@2 with PnP. " +
|
|
635
664
|
"Cloud Functions for Firebase requires a node_modules folder to work correctly and is therefore incompatible with PnP. " +
|
|
636
665
|
"See https://yarnpkg.com/getting-started/migration#step-by-step for more information.");
|
|
637
666
|
}
|
|
667
|
+
const runtimeEnv = this.getRuntimeEnvs(backend, trigger);
|
|
668
|
+
const secretEnvs = await this.resolveSecretEnvs(backend, trigger);
|
|
638
669
|
const childProcess = spawn(opts.nodeBinary, args, {
|
|
639
|
-
|
|
640
|
-
|
|
670
|
+
cwd: backend.functionsDir,
|
|
671
|
+
env: Object.assign(Object.assign(Object.assign({ node: opts.nodeBinary }, process.env), runtimeEnv), secretEnvs),
|
|
641
672
|
stdio: ["pipe", "pipe", "pipe", "ipc"],
|
|
642
673
|
});
|
|
643
674
|
if (!childProcess.stderr) {
|
|
@@ -668,6 +699,7 @@ class FunctionsEmulator {
|
|
|
668
699
|
childProcess.on("exit", resolve);
|
|
669
700
|
}),
|
|
670
701
|
events: emitter,
|
|
702
|
+
cwd: backend.functionsDir,
|
|
671
703
|
shutdown: () => {
|
|
672
704
|
childProcess.kill();
|
|
673
705
|
},
|
|
@@ -679,8 +711,8 @@ class FunctionsEmulator {
|
|
|
679
711
|
return childProcess.send(JSON.stringify(args));
|
|
680
712
|
},
|
|
681
713
|
};
|
|
682
|
-
this.workerPool.addWorker(
|
|
683
|
-
return this.workerPool.submitWork(
|
|
714
|
+
this.workerPool.addWorker(trigger.id, runtime);
|
|
715
|
+
return this.workerPool.submitWork(trigger.id, frb, opts);
|
|
684
716
|
}
|
|
685
717
|
async disableBackgroundTriggers() {
|
|
686
718
|
Object.values(this.triggers).forEach((record) => {
|
|
@@ -706,7 +738,7 @@ class FunctionsEmulator {
|
|
|
706
738
|
}
|
|
707
739
|
const trigger = record.def;
|
|
708
740
|
const service = (0, functionsEmulatorShared_1.getFunctionService)(trigger);
|
|
709
|
-
const worker = this.startFunctionRuntime(record.backend, trigger
|
|
741
|
+
const worker = await this.startFunctionRuntime(record.backend, trigger, proto);
|
|
710
742
|
return new Promise((resolve, reject) => {
|
|
711
743
|
if (projectId !== this.args.projectId) {
|
|
712
744
|
if (service !== constants_1.Constants.SERVICE_REALTIME_DATABASE) {
|
|
@@ -740,7 +772,7 @@ class FunctionsEmulator {
|
|
|
740
772
|
return registry_1.EmulatorRegistry.getInfo(emulator);
|
|
741
773
|
}
|
|
742
774
|
tokenFromAuthHeader(authHeader) {
|
|
743
|
-
const match =
|
|
775
|
+
const match = /^Bearer (.*)$/.exec(authHeader);
|
|
744
776
|
if (!match) {
|
|
745
777
|
return;
|
|
746
778
|
}
|
|
@@ -772,7 +804,7 @@ class FunctionsEmulator {
|
|
|
772
804
|
if (!this.triggers[triggerId]) {
|
|
773
805
|
res
|
|
774
806
|
.status(404)
|
|
775
|
-
.send(`Function ${triggerId} does not exist, valid
|
|
807
|
+
.send(`Function ${triggerId} does not exist, valid functions are: ${Object.keys(this.triggers).join(", ")}`);
|
|
776
808
|
return;
|
|
777
809
|
}
|
|
778
810
|
const record = this.getTriggerRecordByKey(triggerId);
|
|
@@ -793,7 +825,7 @@ class FunctionsEmulator {
|
|
|
793
825
|
req.headers[functionsEmulatorShared_1.HttpConstants.CALLABLE_AUTH_HEADER] = encodeURIComponent(JSON.stringify(contextAuth));
|
|
794
826
|
}
|
|
795
827
|
}
|
|
796
|
-
const worker = this.startFunctionRuntime(record.backend, trigger
|
|
828
|
+
const worker = await this.startFunctionRuntime(record.backend, trigger);
|
|
797
829
|
worker.onLogs((el) => {
|
|
798
830
|
if (el.level === "FATAL") {
|
|
799
831
|
res.status(500).send(el.text);
|