firebase-tools 9.17.0 → 9.21.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/CHANGELOG.md +3 -7
- package/lib/api.js +1 -0
- package/lib/apiv2.js +5 -3
- package/lib/appdistribution/client.js +84 -72
- package/lib/appdistribution/distribution.js +8 -26
- package/lib/appdistribution/options-parser-util.js +51 -0
- package/lib/command.js +1 -1
- package/lib/commands/appdistribution-distribute.js +74 -91
- package/lib/commands/appdistribution-testers-add.js +18 -0
- package/lib/commands/appdistribution-testers-remove.js +32 -0
- package/lib/commands/crashlytics-symbols-upload.js +146 -0
- package/lib/commands/ext-configure.js +9 -1
- package/lib/commands/ext-dev-extension-delete.js +2 -1
- package/lib/commands/ext-dev-publish.js +11 -4
- package/lib/commands/ext-dev-unpublish.js +12 -4
- package/lib/commands/ext-install.js +115 -48
- package/lib/commands/ext-uninstall.js +6 -0
- package/lib/commands/ext-update.js +61 -18
- package/lib/commands/functions-config-export.js +115 -0
- package/lib/commands/functions-delete.js +45 -25
- package/lib/commands/functions-list.js +54 -0
- package/lib/commands/functions-log.js +5 -22
- package/lib/commands/hosting-channel-deploy.js +6 -4
- package/lib/commands/index.js +12 -0
- package/lib/deploy/functions/backend.js +118 -121
- package/lib/deploy/functions/checkIam.js +8 -8
- package/lib/deploy/functions/containerCleaner.js +5 -1
- package/lib/deploy/functions/deploy.js +11 -15
- package/lib/deploy/functions/functionsDeployHelper.js +3 -68
- package/lib/deploy/functions/prepare.js +67 -33
- package/lib/deploy/functions/pricing.js +17 -17
- package/lib/deploy/functions/prompts.js +24 -41
- package/lib/deploy/functions/release/executor.js +39 -0
- package/lib/deploy/functions/release/fabricator.js +362 -0
- package/lib/deploy/functions/release/index.js +69 -0
- package/lib/deploy/functions/release/planner.js +159 -0
- package/lib/deploy/functions/release/reporter.js +162 -0
- package/lib/deploy/functions/release/sourceTokenScraper.js +28 -0
- package/lib/deploy/functions/release/timer.js +14 -0
- package/lib/deploy/functions/runtimes/discovery/v1alpha1.js +102 -126
- package/lib/deploy/functions/runtimes/node/parseTriggers.js +34 -50
- package/lib/deploy/functions/triggerRegionHelper.js +40 -0
- package/lib/deploy/functions/validate.js +1 -24
- package/lib/downloadUtils.js +37 -0
- package/lib/emulator/auth/apiSpec.js +1788 -403
- package/lib/emulator/auth/handlers.js +6 -5
- package/lib/emulator/auth/operations.js +439 -40
- package/lib/emulator/auth/server.js +32 -11
- package/lib/emulator/auth/state.js +205 -5
- package/lib/emulator/auth/widget_ui.js +2 -2
- package/lib/emulator/download.js +2 -31
- package/lib/emulator/downloadableEmulators.js +7 -7
- package/lib/emulator/emulatorLogger.js +0 -3
- package/lib/emulator/events/types.js +16 -0
- package/lib/emulator/functionsEmulator.js +117 -20
- package/lib/emulator/functionsEmulatorRuntime.js +46 -121
- package/lib/emulator/functionsEmulatorShared.js +51 -7
- package/lib/emulator/functionsEmulatorShell.js +1 -1
- package/lib/emulator/pubsubEmulator.js +61 -40
- package/lib/emulator/storage/cloudFunctions.js +37 -7
- package/lib/extensions/askUserForConsent.js +16 -13
- package/lib/extensions/askUserForParam.js +72 -3
- package/lib/extensions/billingMigrationHelper.js +1 -11
- package/lib/extensions/changelog.js +2 -1
- package/lib/extensions/displayExtensionInfo.js +35 -33
- package/lib/extensions/emulator/optionsHelper.js +3 -3
- package/lib/extensions/emulator/triggerHelper.js +2 -32
- package/lib/extensions/extensionsApi.js +67 -94
- package/lib/extensions/extensionsHelper.js +49 -35
- package/lib/extensions/paramHelper.js +79 -36
- package/lib/extensions/refs.js +59 -0
- package/lib/extensions/secretsUtils.js +58 -0
- package/lib/extensions/updateHelper.js +21 -45
- package/lib/extensions/warnings.js +1 -7
- package/lib/functional.js +64 -0
- package/lib/functions/env.js +26 -13
- package/lib/functions/functionslog.js +40 -0
- package/lib/functions/runtimeConfigExport.js +137 -0
- package/lib/gcp/cloudfunctions.js +46 -38
- package/lib/gcp/cloudfunctionsv2.js +47 -47
- package/lib/gcp/cloudlogging.js +27 -21
- package/lib/gcp/cloudscheduler.js +22 -16
- package/lib/gcp/pubsub.js +1 -9
- package/lib/gcp/secretManager.js +111 -0
- package/lib/gcp/storage.js +16 -0
- package/lib/previews.js +1 -1
- package/lib/requireInteractive.js +12 -0
- package/lib/utils.js +30 -1
- package/package.json +5 -4
- package/lib/deploy/functions/deploymentPlanner.js +0 -113
- package/lib/deploy/functions/deploymentTimer.js +0 -23
- package/lib/deploy/functions/errorHandler.js +0 -75
- package/lib/deploy/functions/release.js +0 -116
- package/lib/deploy/functions/tasks.js +0 -324
- package/lib/functionsDelete.js +0 -60
|
@@ -19,8 +19,8 @@ class PubsubEmulator {
|
|
|
19
19
|
apiEndpoint: `${host}:${port}`,
|
|
20
20
|
projectId: this.args.projectId,
|
|
21
21
|
});
|
|
22
|
-
this.
|
|
23
|
-
this.
|
|
22
|
+
this.triggersForTopic = new Map();
|
|
23
|
+
this.subscriptionForTopic = new Map();
|
|
24
24
|
}
|
|
25
25
|
async start() {
|
|
26
26
|
return downloadableEmulators.start(types_1.Emulators.PUBSUB, this.args);
|
|
@@ -44,10 +44,11 @@ class PubsubEmulator {
|
|
|
44
44
|
getName() {
|
|
45
45
|
return types_1.Emulators.PUBSUB;
|
|
46
46
|
}
|
|
47
|
-
async addTrigger(topicName,
|
|
48
|
-
this.logger.logLabeled("DEBUG", "pubsub", `addTrigger(${topicName}, ${
|
|
49
|
-
const
|
|
50
|
-
if (
|
|
47
|
+
async addTrigger(topicName, triggerKey, signatureType) {
|
|
48
|
+
this.logger.logLabeled("DEBUG", "pubsub", `addTrigger(${topicName}, ${triggerKey}, ${signatureType})`);
|
|
49
|
+
const triggers = this.triggersForTopic.get(topicName) || [];
|
|
50
|
+
if (triggers.some((t) => t.triggerKey === triggerKey) &&
|
|
51
|
+
this.subscriptionForTopic.has(topicName)) {
|
|
51
52
|
this.logger.logLabeled("DEBUG", "pubsub", "Trigger already exists");
|
|
52
53
|
return;
|
|
53
54
|
}
|
|
@@ -82,53 +83,73 @@ class PubsubEmulator {
|
|
|
82
83
|
sub.on("message", (message) => {
|
|
83
84
|
this.onMessage(topicName, message);
|
|
84
85
|
});
|
|
85
|
-
|
|
86
|
-
this.
|
|
87
|
-
this.
|
|
86
|
+
triggers.push({ triggerKey, signatureType });
|
|
87
|
+
this.triggersForTopic.set(topicName, triggers);
|
|
88
|
+
this.subscriptionForTopic.set(topicName, sub);
|
|
89
|
+
}
|
|
90
|
+
getRequestOptions(topic, message, signatureType) {
|
|
91
|
+
const baseOpts = {
|
|
92
|
+
origin: `http://${registry_1.EmulatorRegistry.getInfoHostString(registry_1.EmulatorRegistry.get(types_1.Emulators.FUNCTIONS).getInfo())}`,
|
|
93
|
+
};
|
|
94
|
+
if (signatureType === "event") {
|
|
95
|
+
return Object.assign(Object.assign({}, baseOpts), { data: {
|
|
96
|
+
context: {
|
|
97
|
+
eventId: uuid.v4(),
|
|
98
|
+
resource: {
|
|
99
|
+
service: "pubsub.googleapis.com",
|
|
100
|
+
name: `projects/${this.args.projectId}/topics/${topic}`,
|
|
101
|
+
},
|
|
102
|
+
eventType: "google.pubsub.topic.publish",
|
|
103
|
+
timestamp: message.publishTime.toISOString(),
|
|
104
|
+
},
|
|
105
|
+
data: {
|
|
106
|
+
data: message.data,
|
|
107
|
+
attributes: message.attributes,
|
|
108
|
+
},
|
|
109
|
+
} });
|
|
110
|
+
}
|
|
111
|
+
else if (signatureType === "cloudevent") {
|
|
112
|
+
const data = {
|
|
113
|
+
message: {
|
|
114
|
+
messageId: message.id,
|
|
115
|
+
publishTime: message.publishTime,
|
|
116
|
+
attributes: message.attributes,
|
|
117
|
+
orderingKey: message.orderingKey,
|
|
118
|
+
data: message.data.toString("base64"),
|
|
119
|
+
},
|
|
120
|
+
subscription: this.subscriptionForTopic.get(topic).name,
|
|
121
|
+
};
|
|
122
|
+
const ce = {
|
|
123
|
+
specVersion: 1,
|
|
124
|
+
type: "google.cloud.pubsub.topic.v1.messagePublished",
|
|
125
|
+
source: `//pubsub.googleapis.com/projects/${this.args.projectId}/topics/${topic}`,
|
|
126
|
+
data,
|
|
127
|
+
};
|
|
128
|
+
return Object.assign(Object.assign({}, baseOpts), { headers: { "Content-Type": "application/cloudevents+json; charset=UTF-8" }, data: ce });
|
|
129
|
+
}
|
|
130
|
+
throw new error_1.FirebaseError(`Unsupported trigger signature: ${signatureType}`);
|
|
88
131
|
}
|
|
89
132
|
async onMessage(topicName, message) {
|
|
90
133
|
this.logger.logLabeled("DEBUG", "pubsub", `onMessage(${topicName}, ${message.id})`);
|
|
91
|
-
const
|
|
92
|
-
if (!
|
|
134
|
+
const triggers = this.triggersForTopic.get(topicName);
|
|
135
|
+
if (!triggers || triggers.length === 0) {
|
|
93
136
|
throw new error_1.FirebaseError(`No trigger for topic: ${topicName}`);
|
|
94
137
|
}
|
|
95
|
-
|
|
96
|
-
if (!functionsEmu) {
|
|
138
|
+
if (!registry_1.EmulatorRegistry.get(types_1.Emulators.FUNCTIONS)) {
|
|
97
139
|
throw new error_1.FirebaseError(`Attempted to execute pubsub trigger for topic ${topicName} but could not find Functions emulator`);
|
|
98
140
|
}
|
|
99
|
-
this.logger.logLabeled("DEBUG", "pubsub", `Executing ${
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
const body = {
|
|
103
|
-
context: {
|
|
104
|
-
eventId: uuid.v4(),
|
|
105
|
-
resource: {
|
|
106
|
-
service: "pubsub.googleapis.com",
|
|
107
|
-
name: `projects/${this.args.projectId}/topics/${topicName}`,
|
|
108
|
-
},
|
|
109
|
-
eventType: "google.pubsub.topic.publish",
|
|
110
|
-
timestamp: message.publishTime.toISOString(),
|
|
111
|
-
},
|
|
112
|
-
data: {
|
|
113
|
-
data: message.data,
|
|
114
|
-
attributes: message.attributes,
|
|
115
|
-
},
|
|
116
|
-
};
|
|
141
|
+
this.logger.logLabeled("DEBUG", "pubsub", `Executing ${triggers.length} matching triggers (${JSON.stringify(triggers.map((t) => t.triggerKey))})`);
|
|
142
|
+
for (const { triggerKey, signatureType } of triggers) {
|
|
143
|
+
const reqOpts = this.getRequestOptions(topicName, message, signatureType);
|
|
117
144
|
try {
|
|
118
|
-
await api.request("POST", `/functions/projects/${this.args.projectId}/triggers/${
|
|
119
|
-
origin: `http://${registry_1.EmulatorRegistry.getInfoHostString(functionsEmu.getInfo())}`,
|
|
120
|
-
data: body,
|
|
121
|
-
});
|
|
145
|
+
await api.request("POST", `/functions/projects/${this.args.projectId}/triggers/${triggerKey}`, reqOpts);
|
|
122
146
|
}
|
|
123
147
|
catch (e) {
|
|
124
148
|
this.logger.logLabeled("DEBUG", "pubsub", e);
|
|
125
149
|
}
|
|
126
|
-
remaining--;
|
|
127
|
-
if (remaining <= 0) {
|
|
128
|
-
this.logger.logLabeled("DEBUG", "pubsub", `Acking message ${message.id}`);
|
|
129
|
-
message.ack();
|
|
130
|
-
}
|
|
131
150
|
}
|
|
151
|
+
this.logger.logLabeled("DEBUG", "pubsub", `Acking message ${message.id}`);
|
|
152
|
+
message.ack();
|
|
132
153
|
}
|
|
133
154
|
}
|
|
134
155
|
exports.PubsubEmulator = PubsubEmulator;
|
|
@@ -6,6 +6,12 @@ const types_1 = require("../types");
|
|
|
6
6
|
const emulatorLogger_1 = require("../emulatorLogger");
|
|
7
7
|
const metadata_1 = require("./metadata");
|
|
8
8
|
const apiv2_1 = require("../../apiv2");
|
|
9
|
+
const STORAGE_V2_ACTION_MAP = {
|
|
10
|
+
finalize: "finalized",
|
|
11
|
+
metadataUpdate: "metadataUpdated",
|
|
12
|
+
delete: "deleted",
|
|
13
|
+
archive: "archived",
|
|
14
|
+
};
|
|
9
15
|
class StorageCloudFunctions {
|
|
10
16
|
constructor(projectId) {
|
|
11
17
|
this.projectId = projectId;
|
|
@@ -19,26 +25,37 @@ class StorageCloudFunctions {
|
|
|
19
25
|
this.functionsEmulatorInfo = functionsEmulator.getInfo();
|
|
20
26
|
this.multicastOrigin = `http://${registry_1.EmulatorRegistry.getInfoHostString(this.functionsEmulatorInfo)}`;
|
|
21
27
|
this.multicastPath = `/functions/projects/${projectId}/trigger_multicast`;
|
|
28
|
+
this.client = new apiv2_1.Client({ urlPrefix: this.multicastOrigin, auth: false });
|
|
22
29
|
}
|
|
23
30
|
}
|
|
24
31
|
async dispatch(action, object) {
|
|
25
|
-
if (!this.enabled)
|
|
32
|
+
if (!this.enabled) {
|
|
26
33
|
return;
|
|
27
|
-
|
|
28
|
-
const
|
|
29
|
-
let res;
|
|
34
|
+
}
|
|
35
|
+
const errStatus = [];
|
|
30
36
|
let err;
|
|
31
37
|
try {
|
|
32
|
-
|
|
38
|
+
const eventBody = this.createLegacyEventRequestBody(action, object);
|
|
39
|
+
const eventRes = await this.client.post(this.multicastPath, eventBody);
|
|
40
|
+
if (eventRes.status !== 200) {
|
|
41
|
+
errStatus.push(eventRes.status);
|
|
42
|
+
}
|
|
43
|
+
const cloudEventBody = this.createCloudEventRequestBody(action, object);
|
|
44
|
+
const cloudEventRes = await this.client.post(this.multicastPath, cloudEventBody, {
|
|
45
|
+
headers: { "Content-Type": "application/cloudevents+json; charset=UTF-8" },
|
|
46
|
+
});
|
|
47
|
+
if (cloudEventRes.status !== 200) {
|
|
48
|
+
errStatus.push(cloudEventRes.status);
|
|
49
|
+
}
|
|
33
50
|
}
|
|
34
51
|
catch (e) {
|
|
35
52
|
err = e;
|
|
36
53
|
}
|
|
37
|
-
if (err ||
|
|
54
|
+
if (err || errStatus.length > 0) {
|
|
38
55
|
this.logger.logLabeled("WARN", "functions", `Firebase Storage function was not triggered due to emulation error. Please file a bug.`);
|
|
39
56
|
}
|
|
40
57
|
}
|
|
41
|
-
|
|
58
|
+
createLegacyEventRequestBody(action, objectMetadataPayload) {
|
|
42
59
|
const timestamp = new Date();
|
|
43
60
|
return JSON.stringify({
|
|
44
61
|
eventId: `${timestamp.getTime()}`,
|
|
@@ -52,5 +69,18 @@ class StorageCloudFunctions {
|
|
|
52
69
|
data: objectMetadataPayload,
|
|
53
70
|
});
|
|
54
71
|
}
|
|
72
|
+
createCloudEventRequestBody(action, objectMetadataPayload) {
|
|
73
|
+
const ceAction = STORAGE_V2_ACTION_MAP[action];
|
|
74
|
+
if (!ceAction) {
|
|
75
|
+
throw new Error("Action is not definied as a CloudEvents action");
|
|
76
|
+
}
|
|
77
|
+
const data = objectMetadataPayload;
|
|
78
|
+
return JSON.stringify({
|
|
79
|
+
specVersion: 1,
|
|
80
|
+
type: `google.cloud.storage.object.v1.${ceAction}`,
|
|
81
|
+
source: `//storage.googleapis.com/projects/_/buckets/${objectMetadataPayload.bucket}/objects/${objectMetadataPayload.name}`,
|
|
82
|
+
data,
|
|
83
|
+
});
|
|
84
|
+
}
|
|
55
85
|
}
|
|
56
86
|
exports.StorageCloudFunctions = StorageCloudFunctions;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.promptForPublisherTOS = exports.
|
|
3
|
+
exports.promptForPublisherTOS = exports.displayApis = exports.displayRoles = exports.retrieveRoleInfo = exports.formatDescription = void 0;
|
|
4
4
|
const _ = require("lodash");
|
|
5
5
|
const clc = require("cli-color");
|
|
6
6
|
const marked = require("marked");
|
|
@@ -27,24 +27,27 @@ async function retrieveRoleInfo(role) {
|
|
|
27
27
|
return `- ${res.title} (${res.description})`;
|
|
28
28
|
}
|
|
29
29
|
exports.retrieveRoleInfo = retrieveRoleInfo;
|
|
30
|
-
async function
|
|
31
|
-
if (!roles
|
|
30
|
+
async function displayRoles(extensionName, projectId, roles) {
|
|
31
|
+
if (!roles.length) {
|
|
32
32
|
return;
|
|
33
33
|
}
|
|
34
34
|
const message = await formatDescription(extensionName, projectId, roles);
|
|
35
35
|
utils.logLabeledBullet(extensionsHelper_1.logPrefix, message);
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
};
|
|
42
|
-
const consented = await prompt_1.promptOnce(question);
|
|
43
|
-
if (!consented) {
|
|
44
|
-
throw new error_1.FirebaseError("Without explicit consent for the roles listed, we cannot deploy this extension.");
|
|
36
|
+
}
|
|
37
|
+
exports.displayRoles = displayRoles;
|
|
38
|
+
function displayApis(extensionName, projectId, apis) {
|
|
39
|
+
if (!apis.length) {
|
|
40
|
+
return;
|
|
45
41
|
}
|
|
42
|
+
const question = `${clc.bold(extensionName)} will enable the following APIs for project ${clc.bold(projectId)}`;
|
|
43
|
+
const results = apis.map((api) => {
|
|
44
|
+
return `- ${api.apiName}: ${api.reason}`;
|
|
45
|
+
});
|
|
46
|
+
results.unshift(question);
|
|
47
|
+
const message = results.join("\n");
|
|
48
|
+
utils.logLabeledBullet(extensionsHelper_1.logPrefix, message);
|
|
46
49
|
}
|
|
47
|
-
exports.
|
|
50
|
+
exports.displayApis = displayApis;
|
|
48
51
|
async function promptForPublisherTOS() {
|
|
49
52
|
const termsOfServiceMsg = "By registering as a publisher, you confirm that you have read the Firebase Extensions Publisher Terms and Conditions (linked below) and you, on behalf of yourself and the organization you represent, agree to comply with it. Here is a brief summary of the highlights of our terms and conditions:\n" +
|
|
50
53
|
" - You ensure extensions you publish comply with all laws and regulations; do not include any viruses, spyware, Trojan horses, or other malicious code; and do not violate any person’s rights, including intellectual property, privacy, and security rights.\n" +
|
|
@@ -5,11 +5,18 @@ const _ = require("lodash");
|
|
|
5
5
|
const clc = require("cli-color");
|
|
6
6
|
const marked = require("marked");
|
|
7
7
|
const extensionsApi_1 = require("./extensionsApi");
|
|
8
|
+
const secretManagerApi = require("../gcp/secretManager");
|
|
9
|
+
const secretsUtils = require("./secretsUtils");
|
|
8
10
|
const extensionsHelper_1 = require("./extensionsHelper");
|
|
9
11
|
const utils_1 = require("./utils");
|
|
10
12
|
const logger_1 = require("../logger");
|
|
11
13
|
const prompt_1 = require("../prompt");
|
|
12
14
|
const utils = require("../utils");
|
|
15
|
+
var SecretUpdateAction;
|
|
16
|
+
(function (SecretUpdateAction) {
|
|
17
|
+
SecretUpdateAction[SecretUpdateAction["LEAVE"] = 0] = "LEAVE";
|
|
18
|
+
SecretUpdateAction[SecretUpdateAction["SET_NEW"] = 1] = "SET_NEW";
|
|
19
|
+
})(SecretUpdateAction || (SecretUpdateAction = {}));
|
|
13
20
|
function checkResponse(response, spec) {
|
|
14
21
|
let valid = true;
|
|
15
22
|
let responses;
|
|
@@ -48,7 +55,7 @@ function checkResponse(response, spec) {
|
|
|
48
55
|
return valid;
|
|
49
56
|
}
|
|
50
57
|
exports.checkResponse = checkResponse;
|
|
51
|
-
async function askForParam(paramSpec) {
|
|
58
|
+
async function askForParam(projectId, instanceId, paramSpec, reconfiguring) {
|
|
52
59
|
let valid = false;
|
|
53
60
|
let response = "";
|
|
54
61
|
const description = paramSpec.description || "";
|
|
@@ -89,6 +96,11 @@ async function askForParam(paramSpec) {
|
|
|
89
96
|
choices: utils_1.convertExtensionOptionToLabeledList(paramSpec.options),
|
|
90
97
|
});
|
|
91
98
|
break;
|
|
99
|
+
case extensionsApi_1.ParamType.SECRET:
|
|
100
|
+
response = reconfiguring
|
|
101
|
+
? await promptReconfigureSecret(projectId, instanceId, paramSpec)
|
|
102
|
+
: await promptCreateSecret(projectId, instanceId, paramSpec);
|
|
103
|
+
break;
|
|
92
104
|
default:
|
|
93
105
|
response = await prompt_1.promptOnce({
|
|
94
106
|
name: paramSpec.param,
|
|
@@ -102,6 +114,63 @@ async function askForParam(paramSpec) {
|
|
|
102
114
|
return response;
|
|
103
115
|
}
|
|
104
116
|
exports.askForParam = askForParam;
|
|
117
|
+
async function promptReconfigureSecret(projectId, instanceId, paramSpec) {
|
|
118
|
+
const action = await prompt_1.promptOnce({
|
|
119
|
+
type: "list",
|
|
120
|
+
message: `Choose what you would like to do with this secret:`,
|
|
121
|
+
choices: [
|
|
122
|
+
{ name: "Leave unchanged", value: SecretUpdateAction.LEAVE },
|
|
123
|
+
{ name: "Set new value", value: SecretUpdateAction.SET_NEW },
|
|
124
|
+
],
|
|
125
|
+
});
|
|
126
|
+
switch (action) {
|
|
127
|
+
case SecretUpdateAction.SET_NEW:
|
|
128
|
+
let secret;
|
|
129
|
+
let secretName;
|
|
130
|
+
if (paramSpec.default) {
|
|
131
|
+
secret = secretManagerApi.parseSecretResourceName(paramSpec.default);
|
|
132
|
+
secretName = secret.name;
|
|
133
|
+
}
|
|
134
|
+
else {
|
|
135
|
+
secretName = await generateSecretName(projectId, instanceId, paramSpec.param);
|
|
136
|
+
}
|
|
137
|
+
const secretValue = await prompt_1.promptOnce({
|
|
138
|
+
name: paramSpec.param,
|
|
139
|
+
type: "password",
|
|
140
|
+
message: `This secret will be stored in Cloud Secret Manager as ${secretName}.\nEnter new value for ${paramSpec.label.trim()}:`,
|
|
141
|
+
});
|
|
142
|
+
if (!secret) {
|
|
143
|
+
secret = await secretManagerApi.createSecret(projectId, secretName, secretsUtils.getSecretLabels(instanceId));
|
|
144
|
+
}
|
|
145
|
+
return addNewSecretVersion(projectId, instanceId, secret, paramSpec, secretValue);
|
|
146
|
+
case SecretUpdateAction.LEAVE:
|
|
147
|
+
default:
|
|
148
|
+
return paramSpec.default || "";
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
async function promptCreateSecret(projectId, instanceId, paramSpec) {
|
|
152
|
+
const secretName = await generateSecretName(projectId, instanceId, paramSpec.param);
|
|
153
|
+
const secretValue = await prompt_1.promptOnce({
|
|
154
|
+
name: paramSpec.param,
|
|
155
|
+
type: "password",
|
|
156
|
+
default: paramSpec.default,
|
|
157
|
+
message: `This secret will be stored in Cloud Secret Manager (https://cloud.google.com/secret-manager/pricing) as ${secretName} and managed by Firebase Extensions (Firebase Extensions Service Agent will be granted Secret Admin role on this secret).\nEnter a value for ${paramSpec.label.trim()}:`,
|
|
158
|
+
});
|
|
159
|
+
const secret = await secretManagerApi.createSecret(projectId, secretName, secretsUtils.getSecretLabels(instanceId));
|
|
160
|
+
return addNewSecretVersion(projectId, instanceId, secret, paramSpec, secretValue);
|
|
161
|
+
}
|
|
162
|
+
async function generateSecretName(projectId, instanceId, paramName) {
|
|
163
|
+
let secretName = `ext-${instanceId}-${paramName}`;
|
|
164
|
+
while (await secretManagerApi.secretExists(projectId, secretName)) {
|
|
165
|
+
secretName += `-${utils_1.getRandomString(3)}`;
|
|
166
|
+
}
|
|
167
|
+
return secretName;
|
|
168
|
+
}
|
|
169
|
+
async function addNewSecretVersion(projectId, instanceId, secret, paramSpec, secretValue) {
|
|
170
|
+
const version = await secretManagerApi.addVersion(secret, secretValue);
|
|
171
|
+
await secretsUtils.grantFirexServiceAgentSecretAdminRole(secret);
|
|
172
|
+
return `projects/${version.secret.projectId}/secrets/${version.secret.name}/versions/${version.versionId}`;
|
|
173
|
+
}
|
|
105
174
|
function getInquirerDefault(options, def) {
|
|
106
175
|
const defaultOption = _.find(options, (option) => {
|
|
107
176
|
return option.value === def;
|
|
@@ -109,7 +178,7 @@ function getInquirerDefault(options, def) {
|
|
|
109
178
|
return defaultOption ? defaultOption.label || defaultOption.value : "";
|
|
110
179
|
}
|
|
111
180
|
exports.getInquirerDefault = getInquirerDefault;
|
|
112
|
-
async function ask(paramSpecs, firebaseProjectParams) {
|
|
181
|
+
async function ask(projectId, instanceId, paramSpecs, firebaseProjectParams, reconfiguring) {
|
|
113
182
|
if (_.isEmpty(paramSpecs)) {
|
|
114
183
|
logger_1.logger.debug("No params were specified for this extension.");
|
|
115
184
|
return {};
|
|
@@ -119,7 +188,7 @@ async function ask(paramSpecs, firebaseProjectParams) {
|
|
|
119
188
|
const result = {};
|
|
120
189
|
const promises = _.map(substituted, (paramSpec) => {
|
|
121
190
|
return async () => {
|
|
122
|
-
result[paramSpec.param] = await askForParam(paramSpec);
|
|
191
|
+
result[paramSpec.param] = await askForParam(projectId, instanceId, paramSpec, reconfiguring);
|
|
123
192
|
};
|
|
124
193
|
});
|
|
125
194
|
await promises.reduce((prev, cur) => prev.then(cur), Promise.resolve());
|
|
@@ -36,19 +36,9 @@ function hasRuntime(spec, runtime) {
|
|
|
36
36
|
const resources = spec.resources || [];
|
|
37
37
|
return resources.some((r) => { var _a; return runtime === (((_a = r.properties) === null || _a === void 0 ? void 0 : _a.runtime) || defaultRuntime); });
|
|
38
38
|
}
|
|
39
|
-
|
|
39
|
+
function displayNode10UpdateBillingNotice(curSpec, newSpec) {
|
|
40
40
|
if (hasRuntime(curSpec, "nodejs8") && hasRuntime(newSpec, "nodejs10")) {
|
|
41
41
|
utils.logLabeledWarning(extensionsHelper_1.logPrefix, marked(billingMsgUpdate));
|
|
42
|
-
if (prompt) {
|
|
43
|
-
const continueUpdate = await prompt_1.promptOnce({
|
|
44
|
-
type: "confirm",
|
|
45
|
-
message: "Do you wish to continue?",
|
|
46
|
-
default: true,
|
|
47
|
-
});
|
|
48
|
-
if (!continueUpdate) {
|
|
49
|
-
throw new error_1.FirebaseError(`Cancelled.`, { exit: 2 });
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
42
|
}
|
|
53
43
|
}
|
|
54
44
|
exports.displayNode10UpdateBillingNotice = displayNode10UpdateBillingNotice;
|
|
@@ -10,6 +10,7 @@ const Table = require("cli-table");
|
|
|
10
10
|
const extensionsApi_1 = require("./extensionsApi");
|
|
11
11
|
const localHelper_1 = require("./localHelper");
|
|
12
12
|
const logger_1 = require("../logger");
|
|
13
|
+
const refs = require("./refs");
|
|
13
14
|
const utils_1 = require("../utils");
|
|
14
15
|
marked.setOptions({
|
|
15
16
|
renderer: new TerminalRenderer(),
|
|
@@ -25,7 +26,7 @@ async function getReleaseNotesForUpdate(args) {
|
|
|
25
26
|
});
|
|
26
27
|
for (const extensionVersion of extensionVersions) {
|
|
27
28
|
if (extensionVersion.releaseNotes) {
|
|
28
|
-
const version =
|
|
29
|
+
const version = refs.parse(extensionVersion.ref).version;
|
|
29
30
|
releaseNotes[version] = extensionVersion.releaseNotes;
|
|
30
31
|
}
|
|
31
32
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.printSourceDownloadLink = exports.
|
|
3
|
+
exports.printSourceDownloadLink = exports.displayUpdateChangesRequiringConfirmation = exports.displayUpdateChangesNoInput = exports.displayExtInfo = void 0;
|
|
4
4
|
const _ = require("lodash");
|
|
5
5
|
const clc = require("cli-color");
|
|
6
6
|
const marked = require("marked");
|
|
@@ -9,7 +9,6 @@ const utils = require("../utils");
|
|
|
9
9
|
const extensionsHelper_1 = require("./extensionsHelper");
|
|
10
10
|
const logger_1 = require("../logger");
|
|
11
11
|
const error_1 = require("../error");
|
|
12
|
-
const prompt_1 = require("../prompt");
|
|
13
12
|
marked.setOptions({
|
|
14
13
|
renderer: new TerminalRenderer(),
|
|
15
14
|
});
|
|
@@ -69,17 +68,22 @@ function displayUpdateChangesNoInput(spec, newSpec) {
|
|
|
69
68
|
return lines;
|
|
70
69
|
}
|
|
71
70
|
exports.displayUpdateChangesNoInput = displayUpdateChangesNoInput;
|
|
72
|
-
async function displayUpdateChangesRequiringConfirmation(
|
|
73
|
-
|
|
71
|
+
async function displayUpdateChangesRequiringConfirmation(args) {
|
|
72
|
+
const equals = (a, b) => {
|
|
73
|
+
return _.isEqual(a, b);
|
|
74
|
+
};
|
|
75
|
+
if (args.spec.license !== args.newSpec.license) {
|
|
74
76
|
const message = "\n" +
|
|
75
77
|
"**License**\n" +
|
|
76
|
-
deletionColor(spec.license ? `- ${spec.license}\n` : "- None\n") +
|
|
77
|
-
additionColor(newSpec.license ? `+ ${newSpec.license}\n` : "+ None\n")
|
|
78
|
-
|
|
79
|
-
await
|
|
78
|
+
deletionColor(args.spec.license ? `- ${args.spec.license}\n` : "- None\n") +
|
|
79
|
+
additionColor(args.newSpec.license ? `+ ${args.newSpec.license}\n` : "+ None\n");
|
|
80
|
+
logger_1.logger.info(message);
|
|
81
|
+
if (!(await extensionsHelper_1.confirm({ nonInteractive: args.nonInteractive, force: args.force, default: true }))) {
|
|
82
|
+
throw new error_1.FirebaseError("Unable to update this extension instance without explicit consent for the change to 'License'.");
|
|
83
|
+
}
|
|
80
84
|
}
|
|
81
|
-
const apisDiffDeletions = _.differenceWith(spec.apis, _.get(newSpec, "apis", []),
|
|
82
|
-
const apisDiffAdditions = _.differenceWith(newSpec.apis, _.get(spec, "apis", []),
|
|
85
|
+
const apisDiffDeletions = _.differenceWith(args.spec.apis, _.get(args.newSpec, "apis", []), equals);
|
|
86
|
+
const apisDiffAdditions = _.differenceWith(args.newSpec.apis, _.get(args.spec, "apis", []), equals);
|
|
83
87
|
if (apisDiffDeletions.length || apisDiffAdditions.length) {
|
|
84
88
|
let message = "\n**APIs:**\n";
|
|
85
89
|
apisDiffDeletions.forEach((api) => {
|
|
@@ -88,11 +92,13 @@ async function displayUpdateChangesRequiringConfirmation(spec, newSpec) {
|
|
|
88
92
|
apisDiffAdditions.forEach((api) => {
|
|
89
93
|
message += additionColor(`+ ${api.apiName} (${api.reason})\n`);
|
|
90
94
|
});
|
|
91
|
-
message
|
|
92
|
-
await
|
|
95
|
+
logger_1.logger.info(message);
|
|
96
|
+
if (!(await extensionsHelper_1.confirm({ nonInteractive: args.nonInteractive, force: args.force, default: true }))) {
|
|
97
|
+
throw new error_1.FirebaseError("Unable to update this extension instance without explicit consent for the change to 'APIs'.");
|
|
98
|
+
}
|
|
93
99
|
}
|
|
94
|
-
const resourcesDiffDeletions = _.differenceWith(spec.resources, _.get(newSpec, "resources", []), compareResources);
|
|
95
|
-
const resourcesDiffAdditions = _.differenceWith(newSpec.resources, _.get(spec, "resources", []), compareResources);
|
|
100
|
+
const resourcesDiffDeletions = _.differenceWith(args.spec.resources, _.get(args.newSpec, "resources", []), compareResources);
|
|
101
|
+
const resourcesDiffAdditions = _.differenceWith(args.newSpec.resources, _.get(args.spec, "resources", []), compareResources);
|
|
96
102
|
if (resourcesDiffDeletions.length || resourcesDiffAdditions.length) {
|
|
97
103
|
let message = "\n**Resources:**\n";
|
|
98
104
|
resourcesDiffDeletions.forEach((resource) => {
|
|
@@ -101,11 +107,13 @@ async function displayUpdateChangesRequiringConfirmation(spec, newSpec) {
|
|
|
101
107
|
resourcesDiffAdditions.forEach((resource) => {
|
|
102
108
|
message += additionColor(`+ ${getResourceReadableName(resource)}`);
|
|
103
109
|
});
|
|
104
|
-
message
|
|
105
|
-
await
|
|
110
|
+
logger_1.logger.info(message);
|
|
111
|
+
if (!(await extensionsHelper_1.confirm({ nonInteractive: args.nonInteractive, force: args.force, default: true }))) {
|
|
112
|
+
throw new error_1.FirebaseError("Unable to update this extension instance without explicit consent for the change to 'Resources'.");
|
|
113
|
+
}
|
|
106
114
|
}
|
|
107
|
-
const rolesDiffDeletions = _.differenceWith(spec.roles, _.get(newSpec, "roles", []),
|
|
108
|
-
const rolesDiffAdditions = _.differenceWith(newSpec.roles, _.get(spec, "roles", []),
|
|
115
|
+
const rolesDiffDeletions = _.differenceWith(args.spec.roles, _.get(args.newSpec, "roles", []), equals);
|
|
116
|
+
const rolesDiffAdditions = _.differenceWith(args.newSpec.roles, _.get(args.spec, "roles", []), equals);
|
|
109
117
|
if (rolesDiffDeletions.length || rolesDiffAdditions.length) {
|
|
110
118
|
let message = "\n**Permissions:**\n";
|
|
111
119
|
rolesDiffDeletions.forEach((role) => {
|
|
@@ -114,11 +122,16 @@ async function displayUpdateChangesRequiringConfirmation(spec, newSpec) {
|
|
|
114
122
|
rolesDiffAdditions.forEach((role) => {
|
|
115
123
|
message += additionColor(`+ ${role.role} (${role.reason})\n`);
|
|
116
124
|
});
|
|
117
|
-
message
|
|
118
|
-
await
|
|
125
|
+
logger_1.logger.info(message);
|
|
126
|
+
if (!(await extensionsHelper_1.confirm({ nonInteractive: args.nonInteractive, force: args.force, default: true }))) {
|
|
127
|
+
throw new error_1.FirebaseError("Unable to update this extension instance without explicit consent for the change to 'Permissions'.");
|
|
128
|
+
}
|
|
119
129
|
}
|
|
120
|
-
if (!spec.billingRequired && newSpec.billingRequired) {
|
|
121
|
-
|
|
130
|
+
if (!args.spec.billingRequired && args.newSpec.billingRequired) {
|
|
131
|
+
logger_1.logger.info("Billing is now required for the new version of this extension.");
|
|
132
|
+
if (!(await extensionsHelper_1.confirm({ nonInteractive: args.nonInteractive, force: args.force, default: true }))) {
|
|
133
|
+
throw new error_1.FirebaseError("Unable to update this extension instance without explicit consent for the change to 'BillingRequired'.");
|
|
134
|
+
}
|
|
122
135
|
}
|
|
123
136
|
}
|
|
124
137
|
exports.displayUpdateChangesRequiringConfirmation = displayUpdateChangesRequiringConfirmation;
|
|
@@ -130,17 +143,6 @@ function getResourceReadableName(resource) {
|
|
|
130
143
|
? `${resource.name} (Cloud Function): ${resource.description}\n`
|
|
131
144
|
: `${resource.name} (${resource.type})\n`;
|
|
132
145
|
}
|
|
133
|
-
async function getConsent(field, message) {
|
|
134
|
-
const consent = await prompt_1.promptOnce({
|
|
135
|
-
type: "confirm",
|
|
136
|
-
message,
|
|
137
|
-
default: true,
|
|
138
|
-
});
|
|
139
|
-
if (!consent) {
|
|
140
|
-
throw new error_1.FirebaseError(`Without explicit consent for the change to ${field}, we cannot update this extension instance.`, { exit: 2 });
|
|
141
|
-
}
|
|
142
|
-
}
|
|
143
|
-
exports.getConsent = getConsent;
|
|
144
146
|
function printSourceDownloadLink(sourceDownloadUri) {
|
|
145
147
|
const sourceDownloadMsg = `Want to review the source code that will be installed? Download it here: ${sourceDownloadUri}`;
|
|
146
148
|
utils.logBullet(marked(sourceDownloadMsg));
|
|
@@ -19,7 +19,7 @@ async function buildOptions(options) {
|
|
|
19
19
|
options.extensionDir = extensionDir;
|
|
20
20
|
const spec = await specHelper.readExtensionYaml(extensionDir);
|
|
21
21
|
extensionsHelper.validateSpec(spec);
|
|
22
|
-
const params =
|
|
22
|
+
const params = getParams(options, spec);
|
|
23
23
|
extensionsHelper.validateCommandLineParams(params, spec.params);
|
|
24
24
|
const functionResources = specHelper.getFunctionResourcesWithParamSubstitution(spec, params);
|
|
25
25
|
let testConfig;
|
|
@@ -35,9 +35,9 @@ async function buildOptions(options) {
|
|
|
35
35
|
return options;
|
|
36
36
|
}
|
|
37
37
|
exports.buildOptions = buildOptions;
|
|
38
|
-
|
|
38
|
+
function getParams(options, extensionSpec) {
|
|
39
39
|
const projectId = projectUtils_1.needProjectId(options);
|
|
40
|
-
const userParams =
|
|
40
|
+
const userParams = paramHelper.readEnvFile(options.testParams);
|
|
41
41
|
const autoParams = {
|
|
42
42
|
PROJECT_ID: projectId,
|
|
43
43
|
EXT_INSTANCE_ID: extensionSpec.name,
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.functionResourceToEmulatedTriggerDefintion = void 0;
|
|
4
4
|
const _ = require("lodash");
|
|
5
|
-
const
|
|
5
|
+
const functionsEmulatorShared_1 = require("../../emulator/functionsEmulatorShared");
|
|
6
6
|
const emulatorLogger_1 = require("../../emulator/emulatorLogger");
|
|
7
7
|
const types_1 = require("../../emulator/types");
|
|
8
8
|
function functionResourceToEmulatedTriggerDefintion(resource) {
|
|
@@ -24,7 +24,7 @@ function functionResourceToEmulatedTriggerDefintion(resource) {
|
|
|
24
24
|
etd.httpsTrigger = properties.httpsTrigger;
|
|
25
25
|
}
|
|
26
26
|
else if (properties.eventTrigger) {
|
|
27
|
-
properties.eventTrigger.service = getServiceFromEventType(properties.eventTrigger.eventType);
|
|
27
|
+
properties.eventTrigger.service = functionsEmulatorShared_1.getServiceFromEventType(properties.eventTrigger.eventType);
|
|
28
28
|
etd.eventTrigger = properties.eventTrigger;
|
|
29
29
|
}
|
|
30
30
|
else {
|
|
@@ -33,33 +33,3 @@ function functionResourceToEmulatedTriggerDefintion(resource) {
|
|
|
33
33
|
return etd;
|
|
34
34
|
}
|
|
35
35
|
exports.functionResourceToEmulatedTriggerDefintion = functionResourceToEmulatedTriggerDefintion;
|
|
36
|
-
function getServiceFromEventType(eventType) {
|
|
37
|
-
if (eventType.includes("firestore")) {
|
|
38
|
-
return constants_1.Constants.SERVICE_FIRESTORE;
|
|
39
|
-
}
|
|
40
|
-
if (eventType.includes("database")) {
|
|
41
|
-
return constants_1.Constants.SERVICE_REALTIME_DATABASE;
|
|
42
|
-
}
|
|
43
|
-
if (eventType.includes("pubsub")) {
|
|
44
|
-
return constants_1.Constants.SERVICE_PUBSUB;
|
|
45
|
-
}
|
|
46
|
-
if (eventType.includes("storage")) {
|
|
47
|
-
return constants_1.Constants.SERVICE_STORAGE;
|
|
48
|
-
}
|
|
49
|
-
if (eventType.includes("analytics")) {
|
|
50
|
-
return constants_1.Constants.SERVICE_ANALYTICS;
|
|
51
|
-
}
|
|
52
|
-
if (eventType.includes("auth")) {
|
|
53
|
-
return constants_1.Constants.SERVICE_AUTH;
|
|
54
|
-
}
|
|
55
|
-
if (eventType.includes("crashlytics")) {
|
|
56
|
-
return constants_1.Constants.SERVICE_CRASHLYTICS;
|
|
57
|
-
}
|
|
58
|
-
if (eventType.includes("remoteconfig")) {
|
|
59
|
-
return constants_1.Constants.SERVICE_REMOTE_CONFIG;
|
|
60
|
-
}
|
|
61
|
-
if (eventType.includes("testing")) {
|
|
62
|
-
return constants_1.Constants.SERVICE_TEST_LAB;
|
|
63
|
-
}
|
|
64
|
-
return "";
|
|
65
|
-
}
|