/
index.ts
462 lines (425 loc) · 14.3 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
import * as repo from "./repo";
import * as poller from "../operation-poller";
import * as apphosting from "../gcp/apphosting";
import * as githubConnections from "./githubConnections";
import { logBullet, logSuccess, logWarning } from "../utils";
import {
apphostingOrigin,
artifactRegistryDomain,
cloudRunApiOrigin,
cloudbuildOrigin,
consoleOrigin,
developerConnectOrigin,
iamOrigin,
secretManagerOrigin,
} from "../api";
import { Backend, BackendOutputOnlyFields, API_VERSION, Build, Rollout } from "../gcp/apphosting";
import { addServiceAccountToRoles } from "../gcp/resourceManager";
import * as iam from "../gcp/iam";
import { Repository } from "../gcp/cloudbuild";
import { FirebaseError } from "../error";
import { promptOnce } from "../prompt";
import { DEFAULT_LOCATION } from "./constants";
import { ensure } from "../ensureApiEnabled";
import * as deploymentTool from "../deploymentTool";
import { DeepOmit } from "../metaprogramming";
import * as apps from "./app";
import { GitRepositoryLink } from "../gcp/devConnect";
import * as ora from "ora";
const DEFAULT_COMPUTE_SERVICE_ACCOUNT_NAME = "firebase-app-hosting-compute";
const apphostingPollerOptions: Omit<poller.OperationPollerOptions, "operationResourceName"> = {
apiOrigin: apphostingOrigin(),
apiVersion: API_VERSION,
masterTimeout: 25 * 60 * 1_000,
maxBackoff: 10_000,
};
/**
* Set up a new App Hosting backend.
*/
export async function doSetup(
projectId: string,
webAppName: string | null,
location: string | null,
serviceAccount: string | null,
withDevConnect: boolean,
): Promise<void> {
await Promise.all([
...(withDevConnect ? [ensure(projectId, developerConnectOrigin(), "apphosting", true)] : []),
ensure(projectId, cloudbuildOrigin(), "apphosting", true),
ensure(projectId, secretManagerOrigin(), "apphosting", true),
ensure(projectId, cloudRunApiOrigin(), "apphosting", true),
ensure(projectId, artifactRegistryDomain(), "apphosting", true),
ensure(projectId, iamOrigin(), "apphosting", true),
]);
logBullet("First we need a few details to create your backend.\n");
// Hack: Because IAM can take ~45 seconds to propagate, we provision the service account as soon as
// possible to reduce the likelihood that the subsequent Cloud Build fails. See b/336862200.
await ensureAppHostingComputeServiceAccount(projectId, serviceAccount);
const allowedLocations = (await apphosting.listLocations(projectId)).map((loc) => loc.locationId);
if (location) {
if (!allowedLocations.includes(location)) {
throw new FirebaseError(
`Invalid location ${location}. Valid choices are ${allowedLocations.join(", ")}`,
);
}
}
location =
location || (await promptLocation(projectId, "Select a location to host your backend:\n"));
logSuccess(`Location set to ${location}.\n`);
const backendId = await promptNewBackendId(projectId, location, {
name: "backendId",
type: "input",
default: "my-web-app",
message: "Create a name for your backend [1-30 characters]",
});
const webApp = await apps.getOrCreateWebApp(projectId, webAppName, backendId);
if (webApp) {
logSuccess(`Firebase web app set to ${webApp.name}.\n`);
} else {
logWarning(`Firebase web app not set`);
}
const gitRepositoryConnection: Repository | GitRepositoryLink = withDevConnect
? await githubConnections.linkGitHubRepository(projectId, location)
: await repo.linkGitHubRepository(projectId, location);
const rootDir = await promptOnce({
name: "rootDir",
type: "input",
default: "/",
message: "Specify your app's root directory relative to your repository",
});
const createBackendSpinner = ora("Creating your new backend...").start();
const backend = await createBackend(
projectId,
location,
backendId,
gitRepositoryConnection,
serviceAccount,
webApp?.id,
rootDir,
);
createBackendSpinner.succeed(`Successfully created backend:\n\t${backend.name}\n`);
// TODO: Once tag patterns are implemented, prompt which method the user
// prefers. We could reduce the number of questions asked by letting people
// enter tag:<pattern>?
const branch = await promptOnce({
name: "branch",
type: "input",
default: "main",
message: "Pick a branch for continuous deployment",
});
await setDefaultTrafficPolicy(projectId, location, backendId, branch);
const confirmRollout = await promptOnce({
type: "confirm",
name: "rollout",
default: true,
message: "Do you want to deploy now?",
});
if (!confirmRollout) {
logSuccess(`Your backend will be deployed at:\n\thttps://${backend.uri}`);
return;
}
logBullet(
`You may also track this rollout at:\n\t${consoleOrigin()}/project/${projectId}/apphosting`,
);
const createRolloutSpinner = ora(
"Starting a new rollout... This make take a few minutes. It's safe to exit now.",
).start();
await orchestrateRollout(projectId, location, backendId, {
source: {
codebase: {
branch,
},
},
});
createRolloutSpinner.succeed(`Your backend is now deployed at:\n\thttps://${backend.uri}`);
}
/**
* Ensures the service account is present the user has permissions to use it by
* checking the `iam.serviceAccounts.actAs` permission. If the permissions
* check fails, this returns an error. If the permission check fails with a
* "not found" error, this attempts to provision the service account.
*/
export async function ensureAppHostingComputeServiceAccount(
projectId: string,
serviceAccount: string | null,
): Promise<void> {
const sa = serviceAccount || defaultComputeServiceAccountEmail(projectId);
const name = `projects/${projectId}/serviceAccounts/${sa}`;
try {
await iam.testResourceIamPermissions(
iamOrigin(),
"v1",
name,
["iam.serviceAccounts.actAs"],
`projects/${projectId}`,
);
} catch (err: unknown) {
if (!(err instanceof FirebaseError)) {
throw err;
}
if (err.status === 404) {
await provisionDefaultComputeServiceAccount(projectId);
} else if (err.status === 403) {
throw new FirebaseError(
`Failed to create backend due to missing delegation permissions for ${sa}. Make sure you have the iam.serviceAccounts.actAs permission.`,
{ original: err },
);
}
}
}
/**
* Prompts the user for a backend id and verifies that it doesn't match a pre-existing backend.
*/
async function promptNewBackendId(
projectId: string,
location: string,
prompt: any,
): Promise<string> {
while (true) {
const backendId = await promptOnce(prompt);
try {
await apphosting.getBackend(projectId, location, backendId);
} catch (err: any) {
if (err.status === 404) {
return backendId;
}
throw new FirebaseError(
`Failed to check if backend with id ${backendId} already exists in ${location}`,
{ original: err },
);
}
logWarning(`Backend with id ${backendId} already exists in ${location}`);
}
}
function defaultComputeServiceAccountEmail(projectId: string): string {
return `${DEFAULT_COMPUTE_SERVICE_ACCOUNT_NAME}@${projectId}.iam.gserviceaccount.com`;
}
/**
* Creates (and waits for) a new backend. Optionally may create the default compute service account if
* it was requested and doesn't exist.
*/
export async function createBackend(
projectId: string,
location: string,
backendId: string,
repository: Repository | GitRepositoryLink,
serviceAccount: string | null,
webAppId: string | undefined,
rootDir = "/",
): Promise<Backend> {
const defaultServiceAccount = defaultComputeServiceAccountEmail(projectId);
const backendReqBody: Omit<Backend, BackendOutputOnlyFields> = {
servingLocality: "GLOBAL_ACCESS",
codebase: {
repository: `${repository.name}`,
rootDirectory: rootDir,
},
labels: deploymentTool.labels(),
serviceAccount: serviceAccount || defaultServiceAccount,
appId: webAppId,
};
async function createBackendAndPoll(): Promise<apphosting.Backend> {
const op = await apphosting.createBackend(projectId, location, backendReqBody, backendId);
return await poller.pollOperation<Backend>({
...apphostingPollerOptions,
pollerName: `create-${projectId}-${location}-${backendId}`,
operationResourceName: op.name,
});
}
return await createBackendAndPoll();
}
async function provisionDefaultComputeServiceAccount(projectId: string): Promise<void> {
try {
await iam.createServiceAccount(
projectId,
DEFAULT_COMPUTE_SERVICE_ACCOUNT_NAME,
"Default service account used to run builds and deploys for Firebase App Hosting",
"Firebase App Hosting compute service account",
);
} catch (err: any) {
// 409 Already Exists errors can safely be ignored.
if (err.status !== 409) {
throw err;
}
}
await addServiceAccountToRoles(
projectId,
defaultComputeServiceAccountEmail(projectId),
[
"roles/firebaseapphosting.computeRunner",
"roles/firebase.sdkAdminServiceAgent",
"roles/developerconnect.tokenAccessor",
],
/* skipAccountLookup= */ true,
);
}
/**
* Sets the default rollout policy to route 100% of traffic to the latest deploy.
*/
export async function setDefaultTrafficPolicy(
projectId: string,
location: string,
backendId: string,
codebaseBranch: string,
): Promise<void> {
const traffic: DeepOmit<apphosting.Traffic, apphosting.TrafficOutputOnlyFields | "name"> = {
rolloutPolicy: {
codebaseBranch: codebaseBranch,
stages: [
{
progression: "IMMEDIATE",
targetPercent: 100,
},
],
},
};
const op = await apphosting.updateTraffic(projectId, location, backendId, traffic);
await poller.pollOperation<apphosting.Traffic>({
...apphostingPollerOptions,
pollerName: `updateTraffic-${projectId}-${location}-${backendId}`,
operationResourceName: op.name,
});
}
function delay(ms: number): Promise<number> {
return new Promise((resolve) => setTimeout(resolve, ms));
}
/**
* Creates a new build and rollout and polls both to completion.
*/
export async function orchestrateRollout(
projectId: string,
location: string,
backendId: string,
buildInput: DeepOmit<Build, apphosting.BuildOutputOnlyFields | "name">,
): Promise<{ rollout: Rollout; build: Build }> {
await delay(45 * 1000);
const buildId = await apphosting.getNextRolloutId(projectId, location, backendId, 1);
const buildOp = await apphosting.createBuild(projectId, location, backendId, buildId, buildInput);
const rolloutBody = {
build: `projects/${projectId}/locations/${location}/backends/${backendId}/builds/${buildId}`,
};
let tries = 0;
let done = false;
while (!done) {
tries++;
try {
const validateOnly = true;
await apphosting.createRollout(
projectId,
location,
backendId,
buildId,
rolloutBody,
validateOnly,
);
done = true;
} catch (err: unknown) {
if (err instanceof FirebaseError && err.status === 400) {
if (tries >= 5) {
throw err;
}
await new Promise((resolve) => setTimeout(resolve, 1000));
} else {
throw err;
}
}
}
const rolloutOp = await apphosting.createRollout(
projectId,
location,
backendId,
buildId,
rolloutBody,
);
const rolloutPoll = poller.pollOperation<Rollout>({
...apphostingPollerOptions,
pollerName: `create-${projectId}-${location}-backend-${backendId}-rollout-${buildId}`,
operationResourceName: rolloutOp.name,
});
const buildPoll = poller.pollOperation<Build>({
...apphostingPollerOptions,
pollerName: `create-${projectId}-${location}-backend-${backendId}-build-${buildId}`,
operationResourceName: buildOp.name,
});
const [rollout, build] = await Promise.all([rolloutPoll, buildPoll]);
if (build.state !== "READY") {
if (!build.buildLogsUri) {
throw new FirebaseError(
"Failed to build your app, but failed to get build logs as well. " +
"This is an internal error and should be reported",
);
}
throw new FirebaseError(
`Failed to build your app. Please inspect the build logs at ${build.buildLogsUri}.`,
{ children: [build.error] },
);
}
return { rollout, build };
}
/**
* Deletes the given backend. Polls till completion.
*/
export async function deleteBackendAndPoll(
projectId: string,
location: string,
backendId: string,
): Promise<void> {
const op = await apphosting.deleteBackend(projectId, location, backendId);
await poller.pollOperation<void>({
...apphostingPollerOptions,
pollerName: `delete-${projectId}-${location}-${backendId}`,
operationResourceName: op.name,
});
}
/**
* Prompts the user for a location.
*/
export async function promptLocation(
projectId: string,
prompt = "Please select a location:",
): Promise<string> {
const allowedLocations = (await apphosting.listLocations(projectId)).map((loc) => loc.locationId);
return (await promptOnce({
name: "location",
type: "list",
default: DEFAULT_LOCATION,
message: prompt,
choices: allowedLocations,
})) as string;
}
/**
* Fetches a backend from the server. If there are multiple backends with that name (ie multi-regional backends),
* prompts the user to disambiguate.
*/
export async function getBackendForAmbiguousLocation(
projectId: string,
backendId: string,
): Promise<apphosting.Backend> {
let { unreachable, backends } = await apphosting.listBackends(projectId, "-");
if (unreachable && unreachable.length !== 0) {
logWarning(
`The following locations are currently unreachable: ${unreachable}.\n` +
"If your backend is in one of these regions, please try again later.",
);
}
backends = backends.filter(
(backend) => apphosting.parseBackendName(backend.name).id === backendId,
);
if (backends.length === 0) {
throw new FirebaseError(`No backend named "${backendId}" found.`);
}
if (backends.length === 1) {
return backends[0];
}
const backendsByLocation = new Map<string, apphosting.Backend>();
backends.forEach((backend) =>
backendsByLocation.set(apphosting.parseBackendName(backend.name).location, backend),
);
const location = await promptOnce({
name: "location",
type: "list",
message: "Please select the location of the backend you'd like to delete:",
choices: [...backendsByLocation.keys()],
});
return backendsByLocation.get(location)!;
}