/
index.ts
1203 lines (1082 loc) · 33.7 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
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 LLC
//
// 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 {expect, use} from 'chai';
import * as chaiAsPromised from 'chai-as-promised';
import * as extend from 'extend';
import * as gax from 'google-gax';
import {google} from '../protos/firestore_v1_proto_api';
import * as Firestore from '../src';
import {DocumentSnapshot, FieldPath} from '../src';
import {QualifiedResourcePath} from '../src/path';
import {GrpcError} from '../src/types';
import {
ApiOverride,
createInstance,
document,
DOCUMENT_NAME,
found,
InvalidApiUsage,
missing,
stream,
verifyInstance,
} from './util/helpers';
import api = google.firestore.v1;
use(chaiAsPromised);
const {grpc} = new gax.GrpcClient({});
const PROJECT_ID = 'test-project';
const DATABASE_ROOT = `projects/${PROJECT_ID}/databases/(default)`;
const DEFAULT_SETTINGS = {
projectId: PROJECT_ID,
sslCreds: grpc.credentials.createInsecure(),
keyFilename: __dirname + '/fake-certificate.json',
};
// Change the argument to 'console.log' to enable debug output.
Firestore.setLogFunction(() => {});
const bytesData = Buffer.from('AQI=', 'base64');
const allSupportedTypesProtobufJs = document(
'documentId',
'arrayValue',
{
arrayValue: {
values: [
{
stringValue: 'foo',
},
{
integerValue: 42,
},
{
stringValue: 'bar',
},
],
},
},
'emptyArray',
{
arrayValue: {},
},
'dateValue',
{
timestampValue: {
nanos: 123000000,
seconds: 479978400,
},
},
'timestampValue',
{
timestampValue: {
nanos: 123000000,
seconds: 479978400,
},
},
'doubleValue',
{
doubleValue: 0.1,
},
'falseValue',
{
booleanValue: false,
},
'infinityValue',
{
doubleValue: Infinity,
},
'integerValue',
{
integerValue: 0,
},
'negativeInfinityValue',
{
doubleValue: -Infinity,
},
'nilValue',
{
nullValue: 'NULL_VALUE',
},
'objectValue',
{
mapValue: {
fields: {
foo: {
stringValue: 'bar',
},
},
},
},
'emptyObject',
{
mapValue: {},
},
'pathValue',
{
referenceValue: `${DATABASE_ROOT}/documents/collection/document`,
},
'stringValue',
{
stringValue: 'a',
},
'trueValue',
{
booleanValue: true,
},
'geoPointValue',
{
geoPointValue: {
latitude: 50.1430847,
longitude: -122.947778,
},
},
'bytesValue',
{
bytesValue: Buffer.from('AQI=', 'base64'),
}
);
const allSupportedTypesJson = {
name: `${DOCUMENT_NAME}`,
fields: {
arrayValue: {
arrayValue: {
values: [
{
stringValue: 'foo',
},
{
integerValue: 42,
},
{
stringValue: 'bar',
},
],
},
},
emptyArray: {
arrayValue: {},
},
dateValue: {
timestampValue: '1985-03-18T07:20:00.123000000Z',
},
timestampValue: {
timestampValue: '1985-03-18T07:20:00.123000000Z',
},
doubleValue: {
doubleValue: 0.1,
},
falseValue: {
booleanValue: false,
},
infinityValue: {
doubleValue: Infinity,
},
integerValue: {
integerValue: 0,
},
negativeInfinityValue: {
doubleValue: -Infinity,
},
nilValue: {
nullValue: 'NULL_VALUE',
},
objectValue: {
mapValue: {
fields: {
foo: {
stringValue: 'bar',
},
},
},
},
emptyObject: {
mapValue: {},
},
pathValue: {
referenceValue: `${DATABASE_ROOT}/documents/collection/document`,
},
stringValue: {
stringValue: 'a',
},
trueValue: {
booleanValue: true,
},
geoPointValue: {
geoPointValue: {
latitude: 50.1430847,
longitude: -122.947778,
},
},
bytesValue: {
bytesValue: 'AQI=',
},
},
createTime: {seconds: 1, nanos: 2},
updateTime: {seconds: 3, nanos: 4},
};
const allSupportedTypesInput = {
stringValue: 'a',
trueValue: true,
falseValue: false,
integerValue: 0,
doubleValue: 0.1,
infinityValue: Infinity,
negativeInfinityValue: -Infinity,
objectValue: {foo: 'bar'},
emptyObject: {},
dateValue: new Date('Mar 18, 1985 08:20:00.123 GMT+0100 (CET)'),
timestampValue: Firestore.Timestamp.fromDate(
new Date('Mar 18, 1985 08:20:00.123 GMT+0100 (CET)')
),
pathValue: new Firestore.DocumentReference(
{
formattedName: DATABASE_ROOT,
_getProjectId: () => ({projectId: PROJECT_ID, databaseId: '(default)'}),
} as any, // tslint:disable-line no-any
new QualifiedResourcePath(PROJECT_ID, '(default)', 'collection', 'document')
),
arrayValue: ['foo', 42, 'bar'],
emptyArray: [],
nilValue: null,
geoPointValue: new Firestore.GeoPoint(50.1430847, -122.947778),
bytesValue: Buffer.from([0x1, 0x2]),
};
const allSupportedTypesOutput = {
stringValue: 'a',
trueValue: true,
falseValue: false,
integerValue: 0,
doubleValue: 0.1,
infinityValue: Infinity,
negativeInfinityValue: -Infinity,
objectValue: {foo: 'bar'},
emptyObject: {},
dateValue: Firestore.Timestamp.fromDate(
new Date('Mar 18, 1985 08:20:00.123 GMT+0100 (CET)')
),
timestampValue: Firestore.Timestamp.fromDate(
new Date('Mar 18, 1985 08:20:00.123 GMT+0100 (CET)')
),
pathValue: new Firestore.DocumentReference(
{
formattedName: DATABASE_ROOT,
_getProjectId: () => ({projectId: PROJECT_ID, databaseId: '(default)'}),
} as any, // tslint:disable-line no-any
new QualifiedResourcePath(PROJECT_ID, '(default)', 'collection', 'document')
),
arrayValue: ['foo', 42, 'bar'],
emptyArray: [],
nilValue: null,
geoPointValue: new Firestore.GeoPoint(50.1430847, -122.947778),
bytesValue: Buffer.from([0x1, 0x2]),
};
describe('instantiation', () => {
it('creates instance', () => {
const firestore = new Firestore.Firestore(DEFAULT_SETTINGS);
expect(firestore).to.be.an.instanceOf(Firestore.Firestore);
});
it('merges settings', () => {
const firestore = new Firestore.Firestore(DEFAULT_SETTINGS);
firestore.settings({foo: 'bar'});
/* tslint:disable:no-any */
expect((firestore as any)._settings.projectId).to.equal(PROJECT_ID);
expect((firestore as any)._settings.foo).to.equal('bar');
/* tslint:enable:no-any */
});
it('can only call settings() once', () => {
const firestore = new Firestore.Firestore(DEFAULT_SETTINGS);
firestore.settings({});
expect(() => firestore.settings({})).to.throw(
'Firestore has already been initialized. You can only call settings() once, and only before calling any other methods on a Firestore object.'
);
});
it('cannot change settings after client initialized', async () => {
const firestore = new Firestore.Firestore(DEFAULT_SETTINGS);
await firestore.initializeIfNeeded('tag');
expect(() => firestore.settings({})).to.throw(
'Firestore has already been initialized. You can only call settings() once, and only before calling any other methods on a Firestore object.'
);
});
it('validates project ID is string', () => {
expect(() => {
const settings = {...DEFAULT_SETTINGS, projectId: 1337};
new Firestore.Firestore(settings as InvalidApiUsage);
}).to.throw(
'Value for argument "settings.projectId" is not a valid string.'
);
expect(() => {
new Firestore.Firestore(DEFAULT_SETTINGS).settings({
projectId: 1337,
} as InvalidApiUsage);
}).to.throw(
'Value for argument "settings.projectId" is not a valid string.'
);
});
it('validates ssl is a boolean', () => {
const invalidValues = ['true', 1337];
for (const value of invalidValues) {
expect(() => {
const settings = {...DEFAULT_SETTINGS, ssl: value};
new Firestore.Firestore(settings as InvalidApiUsage);
}).to.throw('Value for argument "settings.ssl" is not a valid boolean.');
}
new Firestore.Firestore({ssl: true});
});
it('validates host is a valid host', () => {
const invalidValues = [
'foo://bar',
'foobar/foobaz',
'foobar/?foo',
'foo@foobar',
'foo:80:81',
];
for (const value of invalidValues) {
expect(() => {
new Firestore.Firestore({host: value});
}).to.throw('Value for argument "settings.host" is not a valid host.');
}
const validValues = [
'127.0.0.1',
'127.0.0.1:8080',
'[::1]',
'[::1]:8080',
'foo',
'foo:8080',
];
for (const value of validValues) {
new Firestore.Firestore({host: value});
}
});
it('validates FIRESTORE_EMULATOR_HOST is a valid host', () => {
const oldValue = process.env.FIRESTORE_EMULATOR_HOST;
try {
const invalidValues = [
'foo://bar',
'foobar/foobaz',
'foobar/?foo',
'foo@foobar',
'foo:80:81',
];
for (const value of invalidValues) {
expect(() => {
process.env.FIRESTORE_EMULATOR_HOST = value;
new Firestore.Firestore();
}).to.throw(
'Value for argument "FIRESTORE_EMULATOR_HOST" is not a valid host.'
);
}
const validValues = [
'127.0.0.1',
'127.0.0.1:8080',
'[::1]',
'[::1]:8080',
'foo',
'foo:8080',
];
for (const value of validValues) {
process.env.FIRESTORE_EMULATOR_HOST = value;
new Firestore.Firestore();
}
} finally {
if (oldValue) {
process.env.FIRESTORE_EMULATOR_HOST = oldValue;
} else {
delete process.env.FIRESTORE_EMULATOR_HOST;
}
}
});
it('validates only one endpoint is provided', () => {
expect(() => {
new Firestore.Firestore({host: 'foo', apiEndpoint: 'foo'});
}).to.throw('Cannot set both "settings.host" and "settings.apiEndpoint".');
expect(() => {
new Firestore.Firestore({host: 'foo', servicePath: 'foo'});
}).to.throw('Cannot set both "settings.host" and "settings.servicePath".');
});
it('FIRESTORE_EMULATOR_HOST ignores servicePath', () => {
const oldValue = process.env.FIRESTORE_EMULATOR_HOST;
try {
process.env.FIRESTORE_EMULATOR_HOST = 'foo';
const firestore = new Firestore.Firestore({servicePath: 'bar'});
// The call to `settings()` used to throw ("Cannot set both 'settings.host' and 'settings.servicePath'").
// See https://github.com/googleapis/nodejs-firestore/pull/696#issuecomment-505822099
firestore.settings({});
} finally {
if (oldValue) {
process.env.FIRESTORE_EMULATOR_HOST = oldValue;
} else {
delete process.env.FIRESTORE_EMULATOR_HOST;
}
}
});
it('FIRESTORE_EMULATOR_HOST overrides other endpoint', done => {
const oldValue = process.env.FIRESTORE_EMULATOR_HOST;
try {
process.env.FIRESTORE_EMULATOR_HOST = 'new';
const firestore = new Firestore.Firestore({servicePath: 'old'});
firestore['validateAndApplySettings'] = settings => {
expect(settings.servicePath).to.equal('new');
done();
};
firestore.settings({});
} finally {
if (oldValue) {
process.env.FIRESTORE_EMULATOR_HOST = oldValue;
} else {
delete process.env.FIRESTORE_EMULATOR_HOST;
}
}
});
it('FIRESTORE_EMULATOR_HOST keeps user-provided headers', done => {
const oldValue = process.env.FIRESTORE_EMULATOR_HOST;
try {
process.env.FIRESTORE_EMULATOR_HOST = 'new';
const firestore = new Firestore.Firestore({customHeaders: {foo: 'bar'}});
firestore['validateAndApplySettings'] = settings => {
expect(settings.customHeaders.foo).to.equal('bar');
done();
};
firestore.settings({});
} finally {
if (oldValue) {
process.env.FIRESTORE_EMULATOR_HOST = oldValue;
} else {
delete process.env.FIRESTORE_EMULATOR_HOST;
}
}
});
it('validates maxIdleChannels', () => {
const invalidValues = [-1, 'foo', 1.3];
for (const value of invalidValues) {
expect(() => {
const settings = {...DEFAULT_SETTINGS, maxIdleChannels: value};
new Firestore.Firestore(settings as InvalidApiUsage);
}).to.throw();
}
new Firestore.Firestore({maxIdleChannels: 1});
});
it('uses project id from constructor', () => {
const firestore = new Firestore.Firestore({projectId: 'foo'});
return expect(firestore.formattedName).to.equal(
`projects/foo/databases/(default)`
);
});
it('uses project id from gapic client', async () => {
return createInstance(
{
getProjectId: callback => {
callback(null, 'foo');
},
},
{projectId: undefined}
).then(async firestore => {
await firestore.initializeIfNeeded('tag');
expect(firestore.projectId).to.equal('foo');
expect(firestore.formattedName).to.equal(
`projects/foo/databases/(default)`
);
});
});
it('uses project ID from settings()', () => {
const firestore = new Firestore.Firestore({
sslCreds: grpc.credentials.createInsecure(),
keyFilename: './test/fake-certificate.json',
});
firestore.settings({projectId: PROJECT_ID});
expect(firestore.formattedName).to.equal(
`projects/${PROJECT_ID}/databases/(default)`
);
});
it('handles error from project ID detection', () => {
return createInstance(
{
getProjectId: callback => {
callback(new Error('Injected Error'), null);
},
},
{projectId: undefined}
).then(firestore => {
return expect(
firestore.collection('foo').add({})
).to.eventually.be.rejectedWith('Injected Error');
});
});
it('can instantiate client with ssl:false', async () => {
const firestore = new Firestore.Firestore({
ssl: false,
projectId: 'foo',
});
await firestore['_clientPool'].run('tag', () => Promise.resolve());
});
it('exports all types', () => {
// Ordering as per firestore.d.ts
expect(Firestore.Firestore).to.exist;
expect(Firestore.Firestore.name).to.equal('Firestore');
expect(Firestore.Timestamp).to.exist;
expect(Firestore.Timestamp.name).to.equal('Timestamp');
expect(Firestore.GeoPoint).to.exist;
expect(Firestore.GeoPoint.name).to.equal('GeoPoint');
expect(Firestore.Transaction).to.exist;
expect(Firestore.Transaction.name).to.equal('Transaction');
expect(Firestore.WriteBatch).to.exist;
expect(Firestore.WriteBatch.name).to.equal('WriteBatch');
expect(Firestore.DocumentReference).to.exist;
expect(Firestore.DocumentReference.name).to.equal('DocumentReference');
expect(Firestore.WriteResult).to.exist;
expect(Firestore.WriteResult.name).to.equal('WriteResult');
expect(Firestore.DocumentSnapshot).to.exist;
expect(Firestore.DocumentSnapshot.name).to.equal('DocumentSnapshot');
expect(Firestore.QueryDocumentSnapshot).to.exist;
expect(Firestore.QueryDocumentSnapshot.name).to.equal(
'QueryDocumentSnapshot'
);
expect(Firestore.Query).to.exist;
expect(Firestore.Query.name).to.equal('Query');
expect(Firestore.QuerySnapshot).to.exist;
expect(Firestore.QuerySnapshot.name).to.equal('QuerySnapshot');
expect(Firestore.CollectionReference).to.exist;
expect(Firestore.CollectionReference.name).to.equal('CollectionReference');
expect(Firestore.FieldValue).to.exist;
expect(Firestore.FieldValue.name).to.equal('FieldValue');
expect(Firestore.FieldPath).to.exist;
expect(Firestore.Firestore.name).to.equal('Firestore');
expect(
Firestore.FieldValue.serverTimestamp().isEqual(
Firestore.FieldValue.delete()
)
).to.be.false;
});
});
describe('serializer', () => {
it('supports all types', () => {
const overrides: ApiOverride = {
commit: (request, options, callback) => {
expect(allSupportedTypesProtobufJs.fields).to.deep.eq(
request.writes![0].update!.fields
);
callback(null, {
commitTime: {},
writeResults: [
{
updateTime: {},
},
],
});
},
};
return createInstance(overrides).then(firestore => {
return firestore.collection('coll').add(allSupportedTypesInput);
});
});
});
describe('snapshot_() method', () => {
let firestore: Firestore.Firestore;
function verifyAllSupportedTypes(actualObject: DocumentSnapshot) {
const expected = extend(true, {}, allSupportedTypesOutput);
// Deep Equal doesn't support matching instances of DocumentRefs, so we
// compare them manually and remove them from the resulting object.
expect(actualObject.get('pathValue').formattedName).to.equal(
expected.pathValue.formattedName
);
const data = actualObject.data()!;
delete data.pathValue;
delete expected.pathValue;
expect(data).to.deep.eq(expected);
// We specifically test the GeoPoint properties to ensure 100% test
// coverage.
expect(data.geoPointValue.latitude).to.equal(50.1430847);
expect(data.geoPointValue.longitude).to.equal(-122.947778);
expect(
data.geoPointValue.isEqual(
new Firestore.GeoPoint(50.1430847, -122.947778)
)
).to.be.true;
}
beforeEach(() => {
// Unlike most other tests, we don't call `ensureClient` since the
// `snapshot_` method does not require a GAPIC client.
firestore = new Firestore.Firestore({
projectId: PROJECT_ID,
sslCreds: grpc.credentials.createInsecure(),
keyFilename: './test/fake-certificate.json',
});
});
afterEach(() => verifyInstance(firestore));
it('handles ProtobufJS', () => {
const doc = firestore.snapshot_(
document('doc', 'foo', {bytesValue: bytesData}),
{seconds: 5, nanos: 6}
);
expect(doc.exists).to.be.true;
expect({foo: bytesData}).to.deep.eq(doc.data());
expect(doc.createTime!.isEqual(new Firestore.Timestamp(1, 2))).to.be.true;
expect(doc.updateTime!.isEqual(new Firestore.Timestamp(3, 4))).to.be.true;
expect(doc.readTime.isEqual(new Firestore.Timestamp(5, 6))).to.be.true;
});
it('handles Proto3 JSON together with existing types', () => {
// Google Cloud Functions must be able to call snapshot_() with Proto3 JSON
// data.
const doc = firestore.snapshot_(
{
name: `${DATABASE_ROOT}/documents/collectionId/doc`,
fields: {
a: {bytesValue: 'AQI='},
b: {timestampValue: '1985-03-18T07:20:00.000Z'},
c: {
valueType: 'bytesValue',
bytesValue: Buffer.from('AQI=', 'base64'),
},
},
createTime: '1970-01-01T00:00:01.002Z',
updateTime: '1970-01-01T00:00:03.000004Z',
},
'1970-01-01T00:00:05.000000006Z',
'json'
);
expect(doc.exists).to.be.true;
expect(doc.data()).to.deep.eq({
a: bytesData,
b: Firestore.Timestamp.fromDate(new Date('1985-03-18T07:20:00.000Z')),
c: bytesData,
});
expect(doc.createTime!.isEqual(new Firestore.Timestamp(1, 2000000))).to.be
.true;
expect(doc.updateTime!.isEqual(new Firestore.Timestamp(3, 4000))).to.be
.true;
expect(doc.readTime.isEqual(new Firestore.Timestamp(5, 6))).to.be.true;
});
it('deserializes all supported types from Protobuf JS', () => {
const doc = firestore.snapshot_(allSupportedTypesProtobufJs, {
seconds: 5,
nanos: 6,
});
verifyAllSupportedTypes(doc);
});
it('deserializes all supported types from Proto3 JSON', () => {
const doc = firestore.snapshot_(
allSupportedTypesJson,
'1970-01-01T00:00:05.000000006Z',
'json'
);
verifyAllSupportedTypes(doc);
});
it('handles invalid Proto3 JSON', () => {
expect(() => {
firestore.snapshot_(
{
name: `${DATABASE_ROOT}/documents/collectionId/doc`,
fields: {foo: {}},
createTime: '1970-01-01T00:00:01.000000002Z',
updateTime: '1970-01-01T00:00:03.000000004Z',
},
'1970-01-01T00:00:05.000000006Z',
'json'
);
}).to.throw("Unable to infer type value fom '{}'.");
expect(() => {
firestore.snapshot_(
{
name: `${DATABASE_ROOT}/documents/collectionId/doc`,
fields: {foo: {stringValue: 'bar', integerValue: 42}},
createTime: '1970-01-01T00:00:01.000000002Z',
updateTime: '1970-01-01T00:00:03.000000004Z',
},
'1970-01-01T00:00:05.000000006Z',
'json'
);
}).to.throw(
'Unable to infer type value fom \'{"stringValue":"bar","integerValue":42}\'.'
);
expect(() => {
firestore.snapshot_(
{
name: `${DATABASE_ROOT}/documents/collectionId/doc`,
fields: {foo: {stringValue: 'bar'}},
createTime: '1970-01-01T00:00:01.NaNZ',
updateTime: '1970-01-01T00:00:03.000000004Z',
},
'1970-01-01T00:00:05.000000006Z',
'json'
);
}).to.throw(
'Specify a valid ISO 8601 timestamp for "documentOrName.createTime".'
);
});
it('handles missing document ', () => {
const doc = firestore.snapshot_(
`${DATABASE_ROOT}/documents/collectionId/doc`,
'1970-01-01T00:00:05.000000006Z',
'json'
);
expect(doc.exists).to.be.false;
expect(doc.readTime.isEqual(new Firestore.Timestamp(5, 6))).to.be.true;
});
it('handles invalid encoding format ', () => {
expect(() => {
firestore.snapshot_(
`${DATABASE_ROOT}/documents/collectionId/doc`,
'1970-01-01T00:00:05.000000006Z',
'ascii' as InvalidApiUsage
);
}).to.throw(
'Unsupported encoding format. Expected "json" or "protobufJS", but was "ascii".'
);
});
});
describe('doc() method', () => {
let firestore: Firestore.Firestore;
beforeEach(() => {
return createInstance().then(firestoreInstance => {
firestore = firestoreInstance;
});
});
afterEach(() => verifyInstance(firestore));
it('returns DocumentReference', () => {
const documentRef = firestore.doc('collectionId/documentId');
expect(documentRef).to.be.an.instanceOf(Firestore.DocumentReference);
});
it('requires document path', () => {
expect(() => (firestore as InvalidApiUsage).doc()).to.throw(
'Value for argument "documentPath" is not a valid resource path. Path must be a non-empty string.'
);
});
it("doesn't accept empty components", () => {
expect(() => firestore.doc('coll//doc')).to.throw(
'Value for argument "documentPath" is not a valid resource path. Paths must not contain //.'
);
});
it('must point to document', () => {
expect(() => firestore.doc('collectionId')).to.throw(
'Value for argument "documentPath" must point to a document, but was "collectionId". Your path does not contain an even number of components.'
);
});
it('exposes properties', () => {
const documentRef = firestore.doc('collectionId/documentId');
expect(documentRef.id).to.equal('documentId');
expect(documentRef.firestore).to.equal(firestore);
});
});
describe('collection() method', () => {
let firestore: Firestore.Firestore;
beforeEach(() => {
return createInstance().then(firestoreInstance => {
firestore = firestoreInstance;
});
});
afterEach(() => verifyInstance(firestore));
it('returns collection', () => {
const collection = firestore.collection('col1/doc1/col2');
expect(collection).to.be.an.instanceOf(Firestore.CollectionReference);
});
it('requires collection id', () => {
expect(() => (firestore as InvalidApiUsage).collection()).to.throw(
'Value for argument "collectionPath" is not a valid resource path. Path must be a non-empty string.'
);
});
it('must point to a collection', () => {
expect(() => firestore.collection('collectionId/documentId')).to.throw(
'Value for argument "collectionPath" must point to a collection, but was "collectionId/documentId". Your path does not contain an odd number of components.'
);
});
it('exposes properties', () => {
const collection = firestore.collection('collectionId');
expect(collection.id).to.exist;
expect(collection.doc).to.exist;
expect(collection.id).to.equal('collectionId');
});
});
describe('listCollections() method', () => {
it('returns collections', () => {
const overrides: ApiOverride = {
listCollectionIds: (request, options, callback) => {
expect(request).to.deep.eq({
parent: `projects/${PROJECT_ID}/databases/(default)/documents`,
pageSize: 65535,
});
callback(null, ['first', 'second']);
},
};
return createInstance(overrides).then(firestore => {
return firestore.listCollections().then(collections => {
expect(collections[0].path).to.equal('first');
expect(collections[1].path).to.equal('second');
});
});
});
});
describe('getAll() method', () => {
function resultEquals(
result: DocumentSnapshot[],
...docs: api.IBatchGetDocumentsResponse[]
) {
expect(result.length).to.equal(arguments.length - 1);
for (let i = 0; i < result.length; ++i) {
const doc = arguments[i + 1];
if (doc.found) {
expect(result[i].exists).to.be.true;
expect(result[i].ref.formattedName).to.equal(doc.found.name);
} else {
expect(result[i].exists).to.be.false;
expect(result[i].ref.formattedName).to.equal(doc.missing);
}
}
}
it('accepts single document', () => {
const overrides: ApiOverride = {
batchGetDocuments: () => {
return stream(found('documentId'));
},
};
return createInstance(overrides).then(firestore => {
return firestore
.getAll(firestore.doc('collectionId/documentId'))
.then(result => {
resultEquals(result, found('documentId'));
});
});
});
it('verifies response', () => {
const overrides: ApiOverride = {
batchGetDocuments: () => {
return stream(found('documentId2'));
},
};
return createInstance(overrides).then(firestore => {
return firestore
.getAll(firestore.doc('collectionId/documentId'))
.then(() => {
throw new Error('Unexpected success in Promise');
})
.catch(err => {
expect(err.message).to.equal(
'Did not receive document for "collectionId/documentId".'
);
});
});
});
it('handles stream exception during initialization', () => {
const overrides: ApiOverride = {
batchGetDocuments: () => {
return stream(new Error('Expected exception'));
},
};
return createInstance(overrides).then(firestore => {
return firestore
.getAll(firestore.doc('collectionId/documentId'))
.then(() => {
throw new Error('Unexpected success in Promise');
})
.catch(err => {
expect(err.message).to.equal('Expected exception');
});
});
});
it('handles stream exception after initialization', () => {
const overrides: ApiOverride = {
batchGetDocuments: () => {
return stream(found('documentId'), new Error('Expected exception'));
},
};
return createInstance(overrides).then(firestore => {
return firestore
.getAll(firestore.doc('collectionId/documentId'))
.then(() => {
throw new Error('Unexpected success in Promise');
})
.catch(err => {
expect(err.message).to.equal('Expected exception');
});
});
});
it('handles serialization error', () => {
const overrides: ApiOverride = {
batchGetDocuments: () => {