-
Notifications
You must be signed in to change notification settings - Fork 889
/
database.ts
2277 lines (2096 loc) · 68.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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Copyright 2017 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as firestore from '@firebase/firestore-types';
import { FirebaseApp } from '@firebase/app-types';
import { FirebaseService } from '@firebase/app-types/private';
import { DatabaseId, DatabaseInfo } from '../core/database_info';
import { ListenOptions } from '../core/event_manager';
import {
FirestoreClient,
IndexedDbPersistenceSettings,
InternalPersistenceSettings,
MemoryPersistenceSettings
} from '../core/firestore_client';
import {
Bound,
Direction,
Filter,
OrderBy,
Query as InternalQuery,
RelationFilter,
RelationOp
} from '../core/query';
import { Transaction as InternalTransaction } from '../core/transaction';
import { ChangeType, ViewSnapshot } from '../core/view_snapshot';
import { LruParams } from '../local/lru_garbage_collector';
import { Document, MaybeDocument, NoDocument } from '../model/document';
import { DocumentKey } from '../model/document_key';
import {
ArrayValue,
FieldValue,
FieldValueOptions,
ObjectValue,
RefValue
} from '../model/field_value';
import { DeleteMutation, Mutation, Precondition } from '../model/mutation';
import { FieldPath, ResourcePath } from '../model/path';
import { PlatformSupport } from '../platform/platform';
import { makeConstructorPrivate } from '../util/api';
import { assert, fail } from '../util/assert';
import { AsyncObserver } from '../util/async_observer';
import { AsyncQueue } from '../util/async_queue';
import { Code, FirestoreError } from '../util/error';
import {
invalidClassError,
validateArgType,
validateAtLeastNumberOfArgs,
validateBetweenNumberOfArgs,
validateDefined,
validateExactNumberOfArgs,
validateNamedOptionalPropertyEquals,
validateNamedOptionalType,
validateNamedType,
validateOptionalArgType,
validateOptionalArrayElements,
validateOptionNames,
valueDescription
} from '../util/input_validation';
import * as log from '../util/log';
import { LogLevel } from '../util/log';
import { AnyJs, AutoId } from '../util/misc';
import * as objUtils from '../util/obj';
import { Rejecter, Resolver } from '../util/promise';
import { FieldPath as ExternalFieldPath } from './field_path';
import {
CredentialsProvider,
CredentialsSettings,
EmptyCredentialsProvider,
FirebaseCredentialsProvider,
makeCredentialsProvider
} from './credentials';
import {
CompleteFn,
ErrorFn,
isPartialObserver,
NextFn,
PartialObserver,
Unsubscribe
} from './observer';
import {
DocumentKeyReference,
fieldPathFromArgument,
UserDataConverter
} from './user_data_converter';
// The objects that are a part of this API are exposed to third-parties as
// compiled javascript so we want to flag our private members with a leading
// underscore to discourage their use.
// tslint:disable:strip-private-property-underscore
// settings() defaults:
const DEFAULT_HOST = 'firestore.googleapis.com';
const DEFAULT_SSL = true;
const DEFAULT_TIMESTAMPS_IN_SNAPSHOTS = true;
/**
* Constant used to indicate the LRU garbage collection should be disabled.
* Set this value as the `cacheSizeBytes` on the settings passed to the
* `Firestore` instance.
*/
export const CACHE_SIZE_UNLIMITED = LruParams.COLLECTION_DISABLED;
// enablePersistence() defaults:
const DEFAULT_SYNCHRONIZE_TABS = false;
/** Undocumented, private additional settings not exposed in our public API. */
interface PrivateSettings extends firestore.Settings {
// Can be a google-auth-library or gapi client.
credentials?: CredentialsSettings;
}
/**
* Options that can be provided in the Firestore constructor when not using
* Firebase (aka standalone mode).
*/
export interface FirestoreDatabase {
projectId: string;
database?: string;
}
/**
* A concrete type describing all the values that can be applied via a
* user-supplied firestore.Settings object. This is a separate type so that
* defaults can be supplied and the value can be checked for equality.
*/
class FirestoreSettings {
/** The hostname to connect to. */
readonly host: string;
/** Whether to use SSL when connecting. */
readonly ssl: boolean;
readonly timestampsInSnapshots: boolean;
readonly cacheSizeBytes: number;
// Can be a google-auth-library or gapi client.
// tslint:disable-next-line:no-any
credentials?: any;
constructor(settings: PrivateSettings) {
if (settings.host === undefined) {
if (settings.ssl !== undefined) {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
"Can't provide ssl option if host option is not set"
);
}
this.host = DEFAULT_HOST;
this.ssl = DEFAULT_SSL;
} else {
validateNamedType('settings', 'non-empty string', 'host', settings.host);
this.host = settings.host;
validateNamedOptionalType('settings', 'boolean', 'ssl', settings.ssl);
this.ssl = objUtils.defaulted(settings.ssl, DEFAULT_SSL);
}
validateOptionNames('settings', settings, [
'host',
'ssl',
'credentials',
'timestampsInSnapshots',
'cacheSizeBytes'
]);
validateNamedOptionalType(
'settings',
'object',
'credentials',
settings.credentials
);
this.credentials = settings.credentials;
validateNamedOptionalType(
'settings',
'boolean',
'timestampsInSnapshots',
settings.timestampsInSnapshots
);
// Nobody should set timestampsInSnapshots anymore, but the error depends on
// whether they set it to true or false...
if (settings.timestampsInSnapshots === true) {
log.error(`
The timestampsInSnapshots setting now defaults to true and you no
longer need to explicitly set it. In a future release, the setting
will be removed entirely and so it is recommended that you remove it
from your firestore.settings() call now.`);
} else if (settings.timestampsInSnapshots === false) {
log.error(`
The timestampsInSnapshots setting will soon be removed. YOU MUST UPDATE
YOUR CODE.
To hide this warning, stop using the timestampsInSnapshots setting in your
firestore.settings({ ... }) call.
Once you remove the setting, Timestamps stored in Cloud Firestore will be
read back as Firebase Timestamp objects instead of as system Date objects.
So you will also need to update code expecting a Date to instead expect a
Timestamp. For example:
// Old:
const date = snapshot.get('created_at');
// New:
const timestamp = snapshot.get('created_at'); const date =
timestamp.toDate();
Please audit all existing usages of Date when you enable the new
behavior.`);
}
this.timestampsInSnapshots = objUtils.defaulted(
settings.timestampsInSnapshots,
DEFAULT_TIMESTAMPS_IN_SNAPSHOTS
);
validateNamedOptionalType(
'settings',
'number',
'cacheSizeBytes',
settings.cacheSizeBytes
);
if (settings.cacheSizeBytes === undefined) {
this.cacheSizeBytes = LruParams.DEFAULT_CACHE_SIZE_BYTES;
} else {
if (
settings.cacheSizeBytes !== CACHE_SIZE_UNLIMITED &&
settings.cacheSizeBytes < LruParams.MINIMUM_CACHE_SIZE_BYTES
) {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
`cacheSizeBytes must be at least ${
LruParams.MINIMUM_CACHE_SIZE_BYTES
}`
);
} else {
this.cacheSizeBytes = settings.cacheSizeBytes;
}
}
}
isEqual(other: FirestoreSettings): boolean {
return (
this.host === other.host &&
this.ssl === other.ssl &&
this.timestampsInSnapshots === other.timestampsInSnapshots &&
this.credentials === other.credentials &&
this.cacheSizeBytes === other.cacheSizeBytes
);
}
}
class FirestoreConfig {
databaseId: DatabaseId;
persistenceKey: string;
credentials: CredentialsProvider;
firebaseApp: FirebaseApp;
settings: FirestoreSettings;
persistence: boolean;
}
/**
* The root reference to the database.
*/
export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
private readonly _config: FirestoreConfig;
readonly _databaseId: DatabaseId;
// The firestore client instance. This will be available as soon as
// configureClient is called, but any calls against it will block until
// setup has completed.
//
// Operations on the _firestoreClient don't block on _firestoreReady. Those
// are already set to synchronize on the async queue.
private _firestoreClient: FirestoreClient | undefined;
// Public for use in tests.
// TODO(mikelehen): Use modularized initialization instead.
readonly _queue = new AsyncQueue();
_dataConverter: UserDataConverter;
constructor(databaseIdOrApp: FirestoreDatabase | FirebaseApp) {
const config = new FirestoreConfig();
if (typeof (databaseIdOrApp as FirebaseApp).options === 'object') {
// This is very likely a Firebase app object
// TODO(b/34177605): Can we somehow use instanceof?
const app = databaseIdOrApp as FirebaseApp;
config.firebaseApp = app;
config.databaseId = Firestore.databaseIdFromApp(app);
config.persistenceKey = config.firebaseApp.name;
config.credentials = new FirebaseCredentialsProvider(app);
} else {
const external = databaseIdOrApp as FirestoreDatabase;
if (!external.projectId) {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
'Must provide projectId'
);
}
config.databaseId = new DatabaseId(external.projectId, external.database);
// Use a default persistenceKey that lines up with FirebaseApp.
config.persistenceKey = '[DEFAULT]';
config.credentials = new EmptyCredentialsProvider();
}
config.settings = new FirestoreSettings({});
this._config = config;
this._databaseId = config.databaseId;
}
settings(settingsLiteral: firestore.Settings): void {
validateExactNumberOfArgs('Firestore.settings', arguments, 1);
validateArgType('Firestore.settings', 'object', 1, settingsLiteral);
if (
objUtils.contains(settingsLiteral as objUtils.Dict<{}>, 'persistence')
) {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
'"persistence" is now specified with a separate call to ' +
'firestore.enablePersistence().'
);
}
const newSettings = new FirestoreSettings(settingsLiteral);
if (this._firestoreClient && !this._config.settings.isEqual(newSettings)) {
throw new FirestoreError(
Code.FAILED_PRECONDITION,
'Firestore has already been started and its settings can no longer ' +
'be changed. You can only call settings() before calling any other ' +
'methods on a Firestore object.'
);
}
this._config.settings = newSettings;
if (newSettings.credentials !== undefined) {
this._config.credentials = makeCredentialsProvider(
newSettings.credentials
);
}
}
enableNetwork(): Promise<void> {
this.ensureClientConfigured();
return this._firestoreClient!.enableNetwork();
}
disableNetwork(): Promise<void> {
this.ensureClientConfigured();
return this._firestoreClient!.disableNetwork();
}
enablePersistence(settings?: firestore.PersistenceSettings): Promise<void> {
if (this._firestoreClient) {
throw new FirestoreError(
Code.FAILED_PRECONDITION,
'Firestore has already been started and persistence can no longer ' +
'be enabled. You can only call enablePersistence() before calling ' +
'any other methods on a Firestore object.'
);
}
return this.configureClient(
new IndexedDbPersistenceSettings(
this._config.settings.cacheSizeBytes,
settings !== undefined &&
objUtils.defaulted(
settings.experimentalTabSynchronization,
DEFAULT_SYNCHRONIZE_TABS
)
)
);
}
ensureClientConfigured(): FirestoreClient {
if (!this._firestoreClient) {
// Kick off starting the client but don't actually wait for it.
// tslint:disable-next-line:no-floating-promises
this.configureClient(new MemoryPersistenceSettings());
}
return this._firestoreClient as FirestoreClient;
}
private configureClient(
persistenceSettings: InternalPersistenceSettings
): Promise<void> {
assert(
!!this._config.settings.host,
'FirestoreSettings.host cannot be falsey'
);
assert(!this._firestoreClient, 'configureClient() called multiple times');
const databaseInfo = new DatabaseInfo(
this._config.databaseId,
this._config.persistenceKey,
this._config.settings.host,
this._config.settings.ssl
);
const preConverter = (value: AnyJs) => {
if (value instanceof DocumentReference) {
const thisDb = this._config.databaseId;
const otherDb = value.firestore._config.databaseId;
if (!otherDb.isEqual(thisDb)) {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
'Document reference is for database ' +
`${otherDb.projectId}/${otherDb.database} but should be ` +
`for database ${thisDb.projectId}/${thisDb.database}`
);
}
return new DocumentKeyReference(this._config.databaseId, value._key);
} else {
return value;
}
};
this._dataConverter = new UserDataConverter(preConverter);
this._firestoreClient = new FirestoreClient(
PlatformSupport.getPlatform(),
databaseInfo,
this._config.credentials,
this._queue
);
return this._firestoreClient.start(persistenceSettings);
}
private static databaseIdFromApp(app: FirebaseApp): DatabaseId {
const options = app.options as objUtils.Dict<{}>;
if (!objUtils.contains(options, 'projectId')) {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
'"projectId" not provided in firebase.initializeApp.'
);
}
const projectId = options['projectId'];
if (!projectId || typeof projectId !== 'string') {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
'projectId must be a string in FirebaseApp.options'
);
}
return new DatabaseId(projectId);
}
get app(): FirebaseApp {
if (!this._config.firebaseApp) {
throw new FirestoreError(
Code.FAILED_PRECONDITION,
"Firestore was not initialized using the Firebase SDK. 'app' is " +
'not available'
);
}
return this._config.firebaseApp;
}
INTERNAL = {
delete: async (options?: {
purgePersistenceWithDataLoss?: boolean;
}): Promise<void> => {
if (this._firestoreClient) {
return this._firestoreClient.shutdown(options);
}
}
};
collection(pathString: string): firestore.CollectionReference {
validateExactNumberOfArgs('Firestore.collection', arguments, 1);
validateArgType('Firestore.collection', 'non-empty string', 1, pathString);
if (!pathString) {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
'Must provide a non-empty collection path to collection()'
);
}
this.ensureClientConfigured();
return new CollectionReference(ResourcePath.fromString(pathString), this);
}
doc(pathString: string): firestore.DocumentReference {
validateExactNumberOfArgs('Firestore.doc', arguments, 1);
validateArgType('Firestore.doc', 'non-empty string', 1, pathString);
if (!pathString) {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
'Must provide a non-empty document path to doc()'
);
}
this.ensureClientConfigured();
return DocumentReference.forPath(ResourcePath.fromString(pathString), this);
}
runTransaction<T>(
updateFunction: (transaction: firestore.Transaction) => Promise<T>
): Promise<T> {
validateExactNumberOfArgs('Firestore.runTransaction', arguments, 1);
validateArgType('Firestore.runTransaction', 'function', 1, updateFunction);
return this.ensureClientConfigured().transaction(
(transaction: InternalTransaction) => {
return updateFunction(new Transaction(this, transaction));
}
);
}
batch(): firestore.WriteBatch {
this.ensureClientConfigured();
return new WriteBatch(this);
}
static get logLevel(): firestore.LogLevel {
switch (log.getLogLevel()) {
case LogLevel.DEBUG:
return 'debug';
case LogLevel.ERROR:
return 'error';
case LogLevel.SILENT:
return 'silent';
default:
return fail('Unknown log level: ' + log.getLogLevel());
}
}
static setLogLevel(level: firestore.LogLevel): void {
validateExactNumberOfArgs('Firestore.setLogLevel', arguments, 1);
validateArgType('Firestore.setLogLevel', 'non-empty string', 1, level);
switch (level) {
case 'debug':
log.setLogLevel(log.LogLevel.DEBUG);
break;
case 'error':
log.setLogLevel(log.LogLevel.ERROR);
break;
case 'silent':
log.setLogLevel(log.LogLevel.SILENT);
break;
default:
throw new FirestoreError(
Code.INVALID_ARGUMENT,
'Invalid log level: ' + level
);
}
}
// Note: this is not a property because the minifier can't work correctly with
// the way TypeScript compiler outputs properties.
_areTimestampsInSnapshotsEnabled(): boolean {
return this._config.settings.timestampsInSnapshots;
}
}
/**
* A reference to a transaction.
*/
export class Transaction implements firestore.Transaction {
constructor(
private _firestore: Firestore,
private _transaction: InternalTransaction
) {}
get(
documentRef: firestore.DocumentReference
): Promise<firestore.DocumentSnapshot> {
validateExactNumberOfArgs('Transaction.get', arguments, 1);
const ref = validateReference(
'Transaction.get',
documentRef,
this._firestore
);
return this._transaction
.lookup([ref._key])
.then((docs: MaybeDocument[]) => {
if (!docs || docs.length !== 1) {
return fail('Mismatch in docs returned from document lookup.');
}
const doc = docs[0];
if (doc instanceof NoDocument) {
return new DocumentSnapshot(
this._firestore,
ref._key,
null,
/* fromCache= */ false,
/* hasPendingWrites= */ false
);
} else if (doc instanceof Document) {
return new DocumentSnapshot(
this._firestore,
ref._key,
doc,
/* fromCache= */ false,
/* hasPendingWrites= */ false
);
} else {
throw fail(
`BatchGetDocumentsRequest returned unexpected document type: ${
doc.constructor.name
}`
);
}
});
}
set(
documentRef: firestore.DocumentReference,
value: firestore.DocumentData,
options?: firestore.SetOptions
): Transaction {
validateBetweenNumberOfArgs('Transaction.set', arguments, 2, 3);
const ref = validateReference(
'Transaction.set',
documentRef,
this._firestore
);
options = validateSetOptions('Transaction.set', options);
const parsed =
options.merge || options.mergeFields
? this._firestore._dataConverter.parseMergeData(
'Transaction.set',
value,
options.mergeFields
)
: this._firestore._dataConverter.parseSetData('Transaction.set', value);
this._transaction.set(ref._key, parsed);
return this;
}
update(
documentRef: firestore.DocumentReference,
value: firestore.UpdateData
): Transaction;
update(
documentRef: firestore.DocumentReference,
field: string | ExternalFieldPath,
value: AnyJs,
...moreFieldsAndValues: AnyJs[]
): Transaction;
update(
documentRef: firestore.DocumentReference,
fieldOrUpdateData: string | ExternalFieldPath | firestore.UpdateData,
value?: AnyJs,
...moreFieldsAndValues: AnyJs[]
): Transaction {
let ref;
let parsed;
if (
typeof fieldOrUpdateData === 'string' ||
fieldOrUpdateData instanceof ExternalFieldPath
) {
validateAtLeastNumberOfArgs('Transaction.update', arguments, 3);
ref = validateReference(
'Transaction.update',
documentRef,
this._firestore
);
parsed = this._firestore._dataConverter.parseUpdateVarargs(
'Transaction.update',
fieldOrUpdateData,
value,
moreFieldsAndValues
);
} else {
validateExactNumberOfArgs('Transaction.update', arguments, 2);
ref = validateReference(
'Transaction.update',
documentRef,
this._firestore
);
parsed = this._firestore._dataConverter.parseUpdateData(
'Transaction.update',
fieldOrUpdateData
);
}
this._transaction.update(ref._key, parsed);
return this;
}
delete(documentRef: firestore.DocumentReference): Transaction {
validateExactNumberOfArgs('Transaction.delete', arguments, 1);
const ref = validateReference(
'Transaction.delete',
documentRef,
this._firestore
);
this._transaction.delete(ref._key);
return this;
}
}
export class WriteBatch implements firestore.WriteBatch {
private _mutations = [] as Mutation[];
private _committed = false;
constructor(private _firestore: Firestore) {}
set(
documentRef: firestore.DocumentReference,
value: firestore.DocumentData,
options?: firestore.SetOptions
): WriteBatch {
validateBetweenNumberOfArgs('WriteBatch.set', arguments, 2, 3);
this.verifyNotCommitted();
const ref = validateReference(
'WriteBatch.set',
documentRef,
this._firestore
);
options = validateSetOptions('WriteBatch.set', options);
const parsed =
options.merge || options.mergeFields
? this._firestore._dataConverter.parseMergeData(
'WriteBatch.set',
value,
options.mergeFields
)
: this._firestore._dataConverter.parseSetData('WriteBatch.set', value);
this._mutations = this._mutations.concat(
parsed.toMutations(ref._key, Precondition.NONE)
);
return this;
}
update(
documentRef: firestore.DocumentReference,
value: firestore.UpdateData
): WriteBatch;
update(
documentRef: firestore.DocumentReference,
field: string | ExternalFieldPath,
value: AnyJs,
...moreFieldsAndValues: AnyJs[]
): WriteBatch;
update(
documentRef: firestore.DocumentReference,
fieldOrUpdateData: string | ExternalFieldPath | firestore.UpdateData,
value?: AnyJs,
...moreFieldsAndValues: AnyJs[]
): WriteBatch {
this.verifyNotCommitted();
let ref;
let parsed;
if (
typeof fieldOrUpdateData === 'string' ||
fieldOrUpdateData instanceof ExternalFieldPath
) {
validateAtLeastNumberOfArgs('WriteBatch.update', arguments, 3);
ref = validateReference(
'WriteBatch.update',
documentRef,
this._firestore
);
parsed = this._firestore._dataConverter.parseUpdateVarargs(
'WriteBatch.update',
fieldOrUpdateData,
value,
moreFieldsAndValues
);
} else {
validateExactNumberOfArgs('WriteBatch.update', arguments, 2);
ref = validateReference(
'WriteBatch.update',
documentRef,
this._firestore
);
parsed = this._firestore._dataConverter.parseUpdateData(
'WriteBatch.update',
fieldOrUpdateData
);
}
this._mutations = this._mutations.concat(
parsed.toMutations(ref._key, Precondition.exists(true))
);
return this;
}
delete(documentRef: firestore.DocumentReference): WriteBatch {
validateExactNumberOfArgs('WriteBatch.delete', arguments, 1);
this.verifyNotCommitted();
const ref = validateReference(
'WriteBatch.delete',
documentRef,
this._firestore
);
this._mutations = this._mutations.concat(
new DeleteMutation(ref._key, Precondition.NONE)
);
return this;
}
async commit(): Promise<void> {
this.verifyNotCommitted();
this._committed = true;
if (this._mutations.length > 0) {
return this._firestore.ensureClientConfigured().write(this._mutations);
}
}
private verifyNotCommitted(): void {
if (this._committed) {
throw new FirestoreError(
Code.FAILED_PRECONDITION,
'A write batch can no longer be used after commit() ' +
'has been called.'
);
}
}
}
/**
* A reference to a particular document in a collection in the database.
*/
export class DocumentReference implements firestore.DocumentReference {
private _firestoreClient: FirestoreClient;
constructor(public _key: DocumentKey, readonly firestore: Firestore) {
this._firestoreClient = this.firestore.ensureClientConfigured();
}
static forPath(path: ResourcePath, firestore: Firestore): DocumentReference {
if (path.length % 2 !== 0) {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
'Invalid document reference. Document ' +
'references must have an even number of segments, but ' +
`${path.canonicalString()} has ${path.length}`
);
}
return new DocumentReference(new DocumentKey(path), firestore);
}
get id(): string {
return this._key.path.lastSegment();
}
get parent(): firestore.CollectionReference {
return new CollectionReference(this._key.path.popLast(), this.firestore);
}
get path(): string {
return this._key.path.canonicalString();
}
collection(pathString: string): firestore.CollectionReference {
validateExactNumberOfArgs('DocumentReference.collection', arguments, 1);
validateArgType(
'DocumentReference.collection',
'non-empty string',
1,
pathString
);
if (!pathString) {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
'Must provide a non-empty collection name to collection()'
);
}
const path = ResourcePath.fromString(pathString);
return new CollectionReference(this._key.path.child(path), this.firestore);
}
isEqual(other: firestore.DocumentReference): boolean {
if (!(other instanceof DocumentReference)) {
throw invalidClassError('isEqual', 'DocumentReference', 1, other);
}
return this.firestore === other.firestore && this._key.isEqual(other._key);
}
set(
value: firestore.DocumentData,
options?: firestore.SetOptions
): Promise<void> {
validateBetweenNumberOfArgs('DocumentReference.set', arguments, 1, 2);
options = validateSetOptions('DocumentReference.set', options);
const parsed =
options.merge || options.mergeFields
? this.firestore._dataConverter.parseMergeData(
'DocumentReference.set',
value,
options.mergeFields
)
: this.firestore._dataConverter.parseSetData(
'DocumentReference.set',
value
);
return this._firestoreClient.write(
parsed.toMutations(this._key, Precondition.NONE)
);
}
update(value: firestore.UpdateData): Promise<void>;
update(
field: string | ExternalFieldPath,
value: AnyJs,
...moreFieldsAndValues: AnyJs[]
): Promise<void>;
update(
fieldOrUpdateData: string | ExternalFieldPath | firestore.UpdateData,
value?: AnyJs,
...moreFieldsAndValues: AnyJs[]
): Promise<void> {
let parsed;
if (
typeof fieldOrUpdateData === 'string' ||
fieldOrUpdateData instanceof ExternalFieldPath
) {
validateAtLeastNumberOfArgs('DocumentReference.update', arguments, 2);
parsed = this.firestore._dataConverter.parseUpdateVarargs(
'DocumentReference.update',
fieldOrUpdateData,
value,
moreFieldsAndValues
);
} else {
validateExactNumberOfArgs('DocumentReference.update', arguments, 1);
parsed = this.firestore._dataConverter.parseUpdateData(
'DocumentReference.update',
fieldOrUpdateData
);
}
return this._firestoreClient.write(
parsed.toMutations(this._key, Precondition.exists(true))
);
}
delete(): Promise<void> {
validateExactNumberOfArgs('DocumentReference.delete', arguments, 0);
return this._firestoreClient.write([
new DeleteMutation(this._key, Precondition.NONE)
]);
}
onSnapshot(
observer: PartialObserver<firestore.DocumentSnapshot>
): Unsubscribe;
onSnapshot(
options: firestore.SnapshotListenOptions,
observer: PartialObserver<firestore.DocumentSnapshot>
): Unsubscribe;
onSnapshot(
onNext: NextFn<firestore.DocumentSnapshot>,
onError?: ErrorFn,
onCompletion?: CompleteFn
): Unsubscribe;
onSnapshot(
options: firestore.SnapshotListenOptions,
onNext: NextFn<firestore.DocumentSnapshot>,
onError?: ErrorFn,
onCompletion?: CompleteFn
): Unsubscribe;
onSnapshot(...args: AnyJs[]): Unsubscribe {
validateBetweenNumberOfArgs(
'DocumentReference.onSnapshot',
arguments,
1,
4
);
let options: firestore.SnapshotListenOptions = {
includeMetadataChanges: false
};
let observer: PartialObserver<firestore.DocumentSnapshot>;
let currArg = 0;
if (
typeof args[currArg] === 'object' &&
!isPartialObserver(args[currArg])
) {
options = args[currArg] as firestore.SnapshotListenOptions;
validateOptionNames('DocumentReference.onSnapshot', options, [
'includeMetadataChanges'
]);
validateNamedOptionalType(
'DocumentReference.onSnapshot',
'boolean',
'includeMetadataChanges',
options.includeMetadataChanges