/
database.ts
507 lines (449 loc) · 17.8 KB
/
database.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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
// The MIT License (MIT)
//
// Copyright (c) 2022 Firebase
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
import { getApp } from "../../common/app";
import { Change } from "../../common/change";
import { ParamsOf } from "../../common/params";
import { ResetValue } from "../../common/options";
import { DataSnapshot } from "../../common/providers/database";
import { normalizePath } from "../../common/utilities/path";
import { PathPattern } from "../../common/utilities/path-pattern";
import { applyChange } from "../../common/utilities/utils";
import { initV2Endpoint, ManifestEndpoint } from "../../runtime/manifest";
import { CloudEvent, CloudFunction } from "../core";
import { Expression } from "../../params";
import { wrapTraceContext } from "../trace";
import * as options from "../options";
import { SecretParam } from "../../params/types";
export { DataSnapshot };
/** @internal */
export const writtenEventType = "google.firebase.database.ref.v1.written";
/** @internal */
export const createdEventType = "google.firebase.database.ref.v1.created";
/** @internal */
export const updatedEventType = "google.firebase.database.ref.v1.updated";
/** @internal */
export const deletedEventType = "google.firebase.database.ref.v1.deleted";
/** @hidden */
export interface RawRTDBCloudEventData {
["@type"]: "type.googleapis.com/google.events.firebase.database.v1.ReferenceEventData";
data: any;
delta: any;
}
/** @hidden */
export interface RawRTDBCloudEvent extends CloudEvent<RawRTDBCloudEventData> {
firebasedatabasehost: string;
instance: string;
ref: string;
location: string;
}
/** A CloudEvent that contains a DataSnapshot or a Change<DataSnapshot> */
export interface DatabaseEvent<T, Params = Record<string, string>> extends CloudEvent<T> {
/** The domain of the database instance */
firebaseDatabaseHost: string;
/** The instance ID portion of the fully qualified resource name */
instance: string;
/** The database reference path */
ref: string;
/** The location of the database */
location: string;
/**
* An object containing the values of the path patterns.
* Only named capture groups will be populated - {key}, {key=*}, {key=**}
*/
params: Params;
}
/** ReferenceOptions extend EventHandlerOptions with provided ref and optional instance */
export interface ReferenceOptions<Ref extends string = string> extends options.EventHandlerOptions {
/**
* Specify the handler to trigger on a database reference(s).
* This value can either be a single reference or a pattern.
* Examples: '/foo/bar', '/foo/{bar}'
*/
ref: Ref;
/**
* Specify the handler to trigger on a database instance(s).
* If present, this value can either be a single instance or a pattern.
* Examples: 'my-instance-1', 'my-instance-*'
* Note: The capture syntax cannot be used for 'instance'.
*/
instance?: string;
/**
* If true, do not deploy or emulate this function.
*/
omit?: boolean | Expression<boolean>;
/**
* Region where functions should be deployed.
*/
region?: options.SupportedRegion | string;
/**
* Amount of memory to allocate to a function.
*/
memory?: options.MemoryOption | Expression<number> | ResetValue;
/**
* Timeout for the function in seconds, possible values are 0 to 540.
* HTTPS functions can specify a higher timeout.
*
* @remarks
* The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
* function depends on the type of function: Event handling functions have a
* maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
* maximum timeout of 36,00s (1 hour). Task queue functions have a maximum
* timeout of 1,800s (30 minutes)
*/
timeoutSeconds?: number | Expression<number> | ResetValue;
/**
* Min number of actual instances to be running at a given time.
*
* @remarks
* Instances will be billed for memory allocation and 10% of CPU allocation
* while idle.
*/
minInstances?: number | Expression<number> | ResetValue;
/**
* Max number of instances to be running in parallel.
*/
maxInstances?: number | Expression<number> | ResetValue;
/**
* Number of requests a function can serve at once.
*
* @remarks
* Can only be applied to functions running on Cloud Functions v2.
* A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise).
* Concurrency cannot be set to any value other than 1 if `cpu` is less than 1.
* The maximum value for concurrency is 1,000.
*/
concurrency?: number | Expression<number> | ResetValue;
/**
* Fractional number of CPUs to allocate to a function.
*
* @remarks
* Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes.
* This is different from the defaults when using the gcloud utility and is different from
* the fixed amount assigned in Google Cloud Functions generation 1.
* To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this
* to the value "gcf_gen1"
*/
cpu?: number | "gcf_gen1";
/**
* Connect cloud function to specified VPC connector.
*/
vpcConnector?: string | ResetValue;
/**
* Egress settings for VPC connector.
*/
vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;
/**
* Specific service account for the function to run as.
*/
serviceAccount?: string | ResetValue;
/**
* Ingress settings which control where this function can be called from.
*/
ingressSettings?: options.IngressSetting | ResetValue;
/**
* User labels to set on the function.
*/
labels?: Record<string, string>;
/*
* Secrets to bind to a function.
*/
secrets?: (string | SecretParam)[];
/** Whether failed executions should be delivered again. */
retry?: boolean | Expression<boolean> | ResetValue;
}
/**
* Event handler which triggers when data is created, updated, or deleted in Realtime Database.
*
* @param reference - The database reference path to trigger on.
* @param handler - Event handler which is run every time a Realtime Database create, update, or delete occurs.
*/
export function onValueWritten<Ref extends string>(
ref: Ref,
handler: (event: DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>>;
/**
* Event handler which triggers when data is created, updated, or deleted in Realtime Database.
*
* @param opts - Options that can be set on an individual event-handling function.
* @param handler - Event handler which is run every time a Realtime Database create, update, or delete occurs.
*/
export function onValueWritten<Ref extends string>(
opts: ReferenceOptions<Ref>,
handler: (event: DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>>;
/**
* Event handler which triggers when data is created, updated, or deleted in Realtime Database.
*
* @param referenceOrOpts - Options or a string reference.
* @param handler - Event handler which is run every time a Realtime Database create, update, or delete occurs.
*/
export function onValueWritten<Ref extends string>(
referenceOrOpts: Ref | ReferenceOptions<Ref>,
handler: (event: DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>> {
return onChangedOperation(writtenEventType, referenceOrOpts, handler);
}
/**
* Event handler which triggers when data is created in Realtime Database.
*
* @param reference - The database reference path to trigger on.
* @param handler - Event handler which is run every time a Realtime Database create occurs.
*/
export function onValueCreated<Ref extends string>(
ref: Ref,
handler: (event: DatabaseEvent<DataSnapshot, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>;
/**
* Event handler which triggers when data is created in Realtime Database.
*
* @param opts - Options that can be set on an individual event-handling function.
* @param handler - Event handler which is run every time a Realtime Database create occurs.
*/
export function onValueCreated<Ref extends string>(
opts: ReferenceOptions<Ref>,
handler: (event: DatabaseEvent<DataSnapshot, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>;
/**
* Event handler which triggers when data is created in Realtime Database.
*
* @param referenceOrOpts - Options or a string reference.
* @param handler - Event handler which is run every time a Realtime Database create occurs.
*/
export function onValueCreated<Ref extends string>(
referenceOrOpts: Ref | ReferenceOptions<Ref>,
handler: (event: DatabaseEvent<DataSnapshot, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>> {
return onOperation(createdEventType, referenceOrOpts, handler);
}
/**
* Event handler which triggers when data is updated in Realtime Database.
*
* @param reference - The database reference path to trigger on.
* @param handler - Event handler which is run every time a Realtime Database update occurs.
*/
export function onValueUpdated<Ref extends string>(
ref: Ref,
handler: (event: DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>>;
/**
* Event handler which triggers when data is updated in Realtime Database.
*
* @param opts - Options that can be set on an individual event-handling function.
* @param handler - Event handler which is run every time a Realtime Database update occurs.
*/
export function onValueUpdated<Ref extends string>(
opts: ReferenceOptions<Ref>,
handler: (event: DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>>;
/**
* Event handler which triggers when data is updated in Realtime Database.
*
* @param referenceOrOpts - Options or a string reference.
* @param handler - Event handler which is run every time a Realtime Database update occurs.
*/
export function onValueUpdated<Ref extends string>(
referenceOrOpts: Ref | ReferenceOptions<Ref>,
handler: (event: DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>> {
return onChangedOperation(updatedEventType, referenceOrOpts, handler);
}
/**
* Event handler which triggers when data is deleted in Realtime Database.
*
* @param reference - The database reference path to trigger on.
* @param handler - Event handler which is run every time a Realtime Database deletion occurs.
*/
export function onValueDeleted<Ref extends string>(
ref: Ref,
handler: (event: DatabaseEvent<DataSnapshot, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>;
/**
* Event handler which triggers when data is deleted in Realtime Database.
*
* @param opts - Options that can be set on an individual event-handling function.
* @param handler - Event handler which is run every time a Realtime Database deletion occurs.
*/
export function onValueDeleted<Ref extends string>(
opts: ReferenceOptions<Ref>,
handler: (event: DatabaseEvent<DataSnapshot, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>>;
/**
* Event handler which triggers when data is deleted in Realtime Database.
*
* @param referenceOrOpts - Options or a string reference.
* @param handler - Event handler which is run every time a Realtime Database deletion occurs.
*/
export function onValueDeleted<Ref extends string>(
referenceOrOpts: Ref | ReferenceOptions<Ref>,
handler: (event: DatabaseEvent<DataSnapshot, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>> {
// TODO - need to use event.data.delta
return onOperation(deletedEventType, referenceOrOpts, handler);
}
/** @internal */
export function getOpts(referenceOrOpts: string | ReferenceOptions) {
let path: string;
let instance: string;
let opts: options.EventHandlerOptions;
if (typeof referenceOrOpts === "string") {
path = normalizePath(referenceOrOpts);
instance = "*";
opts = {};
} else {
path = normalizePath(referenceOrOpts.ref);
instance = referenceOrOpts.instance || "*";
opts = { ...referenceOrOpts };
delete (opts as any).ref;
delete (opts as any).instance;
}
return {
path,
instance,
opts,
};
}
/** @internal */
export function makeParams(event: RawRTDBCloudEvent, path: PathPattern, instance: PathPattern) {
return {
...path.extractMatches(event.ref),
...instance.extractMatches(event.instance),
};
}
/** @hidden */
function makeDatabaseEvent<Params>(
event: RawRTDBCloudEvent,
data: any,
instance: string,
params: Params
): DatabaseEvent<DataSnapshot, Params> {
const snapshot = new DataSnapshot(data, event.ref, getApp(), instance);
const databaseEvent: DatabaseEvent<DataSnapshot, Params> = {
...event,
firebaseDatabaseHost: event.firebasedatabasehost,
data: snapshot,
params,
};
delete (databaseEvent as any).firebasedatabasehost;
return databaseEvent;
}
/** @hidden */
function makeChangedDatabaseEvent<Params>(
event: RawRTDBCloudEvent,
instance: string,
params: Params
): DatabaseEvent<Change<DataSnapshot>, Params> {
const before = new DataSnapshot(event.data.data, event.ref, getApp(), instance);
const after = new DataSnapshot(
applyChange(event.data.data, event.data.delta),
event.ref,
getApp(),
instance
);
const databaseEvent: DatabaseEvent<Change<DataSnapshot>, Params> = {
...event,
firebaseDatabaseHost: event.firebasedatabasehost,
data: {
before,
after,
},
params,
};
delete (databaseEvent as any).firebasedatabasehost;
return databaseEvent;
}
/** @internal */
export function makeEndpoint(
eventType: string,
opts: options.EventHandlerOptions,
path: PathPattern,
instance: PathPattern
): ManifestEndpoint {
const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
const specificOpts = options.optionsToEndpoint(opts);
const eventFilters: Record<string, string> = {};
const eventFilterPathPatterns: Record<string, string> = {
// Note: Eventarc always treats ref as a path pattern
ref: path.getValue(),
};
instance.hasWildcards()
? (eventFilterPathPatterns.instance = instance.getValue())
: (eventFilters.instance = instance.getValue());
return {
...initV2Endpoint(options.getGlobalOptions(), opts),
platform: "gcfv2",
...baseOpts,
...specificOpts,
labels: {
...baseOpts?.labels,
...specificOpts?.labels,
},
eventTrigger: {
eventType,
eventFilters,
eventFilterPathPatterns,
retry: false,
},
};
}
/** @internal */
export function onChangedOperation<Ref extends string>(
eventType: string,
referenceOrOpts: Ref | ReferenceOptions<Ref>,
handler: (event: DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<Change<DataSnapshot>, ParamsOf<Ref>>> {
const { path, instance, opts } = getOpts(referenceOrOpts);
const pathPattern = new PathPattern(path);
const instancePattern = new PathPattern(instance);
// wrap the handler
const func = (raw: CloudEvent<unknown>) => {
const event = raw as RawRTDBCloudEvent;
const instanceUrl = `https://${event.instance}.${event.firebasedatabasehost}`;
const params = makeParams(event, pathPattern, instancePattern) as unknown as ParamsOf<Ref>;
const databaseEvent = makeChangedDatabaseEvent(event, instanceUrl, params);
return wrapTraceContext(handler)(databaseEvent);
};
func.run = handler;
func.__endpoint = makeEndpoint(eventType, opts, pathPattern, instancePattern);
return func;
}
/** @internal */
export function onOperation<Ref extends string>(
eventType: string,
referenceOrOpts: Ref | ReferenceOptions<Ref>,
handler: (event: DatabaseEvent<DataSnapshot, ParamsOf<Ref>>) => any | Promise<any>
): CloudFunction<DatabaseEvent<DataSnapshot, ParamsOf<Ref>>> {
const { path, instance, opts } = getOpts(referenceOrOpts);
const pathPattern = new PathPattern(path);
const instancePattern = new PathPattern(instance);
// wrap the handler
const func = (raw: CloudEvent<unknown>) => {
const event = raw as RawRTDBCloudEvent;
const instanceUrl = `https://${event.instance}.${event.firebasedatabasehost}`;
const params = makeParams(event, pathPattern, instancePattern) as unknown as ParamsOf<Ref>;
const data = eventType === deletedEventType ? event.data.data : event.data.delta;
const databaseEvent = makeDatabaseEvent(event, data, instanceUrl, params);
return handler(databaseEvent);
};
func.run = handler;
func.__endpoint = makeEndpoint(eventType, opts, pathPattern, instancePattern);
return func;
}