Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(firestore): do not return idField on valueChanges if no document #2777

Closed
wants to merge 1 commit into from
Closed

fix(firestore): do not return idField on valueChanges if no document #2777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 23 additions & 27 deletions src/firestore/document/document.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ describe('AngularFirestoreDocument', () => {

describe('valueChanges()', () => {

it('should get unwrapped snapshot', async (done: any) => {
it('should get unwrapped snapshot', async (done: DoneFn) => {
const randomCollectionName = afs.firestore.collection('a').doc().id;
const ref = afs.firestore.doc(`${randomCollectionName}/FAKE`) as firebase.firestore.DocumentReference<Stock>;
const stock = new AngularFirestoreDocument(ref, afs);
const ref = afs.firestore.doc(`${randomCollectionName}/FAKE`) as DocumentReference<Stock>;
const stock = new AngularFirestoreDocument<Stock>(ref, afs);
await stock.set(FAKE_STOCK_DATA);
const obs$ = stock.valueChanges();
obs$.pipe(take(1)).subscribe(async data => {
Expand All @@ -46,10 +46,9 @@ describe('AngularFirestoreDocument', () => {
});
});

/* TODO(jamesdaniels): test is flaking, look into this
it('should optionally map the doc ID to the emitted data object', async (done: any) => {
it('should optionally map the doc ID to the emitted data object if doc exists', async (done: DoneFn) => {
const randomCollectionName = afs.firestore.collection('a').doc().id;
const ref = afs.firestore.doc(`${randomCollectionName}/FAKE`);
const ref = afs.firestore.doc(`${randomCollectionName}/FAKE`) as DocumentReference<Stock>;
const stock = new AngularFirestoreDocument<Stock>(ref, afs);
await stock.set(FAKE_STOCK_DATA);
const idField = 'myCustomID';
Expand All @@ -59,36 +58,33 @@ describe('AngularFirestoreDocument', () => {
expect(data).toEqual(jasmine.objectContaining(FAKE_STOCK_DATA));
stock.delete().then(done).catch(done.fail);
});
});*/
});

it('should not optionally map the doc ID to the emitted data object if doc does not exists', async (done: DoneFn) => {
const randomCollectionName = afs.firestore.collection('a').doc().id;
const ref = afs.firestore.doc(`${randomCollectionName}/FAKE`) as DocumentReference<Stock>;
const stock = new AngularFirestoreDocument<Stock>(ref, afs);
// await stock.set(FAKE_STOCK_DATA);
const idField = 'myCustomID';
const obs$ = stock.valueChanges({ idField });
obs$.pipe(take(1)).subscribe(async data => {
expect(data).toBeUndefined();
stock.delete().then(done).catch(done.fail);
});
});

});

describe('snapshotChanges()', () => {

it('should get action updates', async (done: any) => {
it('should get action updates', async (done: DoneFn) => {
const randomCollectionName = randomName(afs.firestore);
const ref = afs.firestore.doc(`${randomCollectionName}/FAKE`) as DocumentReference<Stock>;
const stock = new AngularFirestoreDocument<Stock>(ref, afs);
await stock.set(FAKE_STOCK_DATA);
const sub = stock
.snapshotChanges()
.subscribe(async a => {
sub.unsubscribe();
if (a.payload.exists) {
expect(a.payload.data()).toEqual(FAKE_STOCK_DATA);
stock.delete().then(done).catch(done.fail);
}
});
});

it('should get unwrapped snapshot', async (done: any) => {
const randomCollectionName = afs.firestore.collection('a').doc().id;
const ref = afs.firestore.doc(`${randomCollectionName}/FAKE`) as DocumentReference<Stock>;
const stock = new AngularFirestoreDocument<Stock>(ref, afs);
await stock.set(FAKE_STOCK_DATA);
const obs$ = stock.valueChanges();
obs$.pipe(take(1)).subscribe(async data => {
expect(data).toEqual(FAKE_STOCK_DATA);
const obs$ = stock.snapshotChanges();
obs$.pipe(take(1)).subscribe(async a => {
expect(a.payload.data()).toEqual(FAKE_STOCK_DATA);
stock.delete().then(done).catch(done.fail);
});
});
Expand Down
2 changes: 1 addition & 1 deletion src/firestore/document/document.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ export class AngularFirestoreDocument<T = DocumentData> {
valueChanges<K extends string>(options: { idField?: K } = {}): Observable<T | undefined> {
return this.snapshotChanges().pipe(
map(({ payload }) =>
options.idField ? {
options.idField && payload.exists ? {
...payload.data(),
...{ [options.idField]: payload.id }
} as T & { [T in K]: string } : payload.data()
Expand Down