[go: nahoru, domu]
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

Jump to bottom

Fix Firestore failing to return empty results from the local cache #6624

Merged
merged 20 commits into from
Oct 7, 2022
Merged

Fix Firestore failing to return empty results from the local cache #6624

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
e5abb85
add resumeToken to viewSnapshot and raiseInitialEvent condition check
milaGGL Sep 22, 2022
7bb2cfa
update test helper with resume token, remove it.only
milaGGL Sep 22, 2022
0ae4afc
modify failing tests
milaGGL Sep 23, 2022
d18be98
Merge remote-tracking branch 'origin/master' into mila/fix-cache-empt…
dconeybe Sep 23, 2022
2e388bc
fix spec tests in listen_spec.test.ts and recovery_spec.test.ts
dconeybe Sep 23, 2022
7050b29
format to pass lint test
milaGGL Sep 23, 2022
fdb8f4b
add more test cases
milaGGL Sep 27, 2022
f9f6ff8
update tests
milaGGL Sep 27, 2022
4651a5b
reformat to pass lint
milaGGL Sep 27, 2022
016cc8f
Merge remote-tracking branch 'origin/master' into mila/fix-cache-empt…
dconeybe Sep 28, 2022
a1cf3d1
resolve comments
milaGGL Sep 29, 2022
f06eb5f
Add two spec tests for raising initial empty snapshot from cache
dconeybe Sep 30, 2022
da6dcc0
resolve part of the comments
milaGGL Oct 3, 2022
ffe6711
add spec test for multi-tab
milaGGL Oct 4, 2022
dc88dd5
resolve comments
milaGGL Oct 5, 2022
67d0ee7
add firebase to changeset, remove unnecessary resume token
milaGGL Oct 6, 2022
9f25aab
use hasCachedResults instead of resumeToken
milaGGL Oct 6, 2022
a9bee4e
add hasCachedResults to viewSnapshot equality
milaGGL Oct 6, 2022
91f720d
remove unnecessary resumeToken test
milaGGL Oct 6, 2022
3e1495b
resolve comments
milaGGL Oct 7, 2022
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
Prev Previous commit
Next Next commit
remove unnecessary resumeToken test
  • Loading branch information
@milaGGL
milaGGL committed Oct 6, 2022
commit 91f720d3a7765303d9f81bf7243db8c5ff4a0585
2 changes: 1 addition & 1 deletion packages/firestore/src/core/event_manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ export class QueryListener {
return false;
}

// Raise data from cache if we have any documents or resume token,
// Raise data from cache if we have any documents, have cached results before,
// or we are offline.
return (
dconeybe marked this conversation as resolved.
Show resolved Hide resolved
!snap.docs.isEmpty() ||
Expand Down
89 changes: 45 additions & 44 deletions packages/firestore/test/unit/api/database.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ import {
} from '../../../src';
import { EmulatorAuthCredentialsProvider } from '../../../src/api/credentials';
import { User } from '../../../src/auth/user';
import { encodeBase64 } from '../../../src/platform/base64';
import { ByteString } from '../../../src/util/byte_string';
import {
collectionReference,
documentReference,
Expand Down Expand Up @@ -179,48 +177,51 @@ describe('QuerySnapshot', () => {
querySnapshot('foo', {}, { a: { a: 1 } }, keys('foo/a'), false, true)
)
).to.be.false;
});

it('resume token should not effect querySnapshot equality', () => {
const resumeToken1 = ByteString.fromBase64String(
encodeBase64('ResumeToken1')
);
const resumeToken1Copy = ByteString.fromBase64String(
encodeBase64('ResumeToken1')
);
const resumeToken2 = ByteString.fromBase64String(
encodeBase64('ResumeToken2')
);

const snapshot1 = querySnapshot(
'foo',
{},
{ a: { a: 1 } },
keys(),
false,
false,
resumeToken1
);
const snapshot1Copy = querySnapshot(
'foo',
{},
{ a: { a: 1 } },
keys(),
false,
false,
resumeToken1Copy
);
const snapshot2 = querySnapshot(
'foo',
{},
{ a: { a: 1 } },
keys(),
false,
false,
resumeToken2
);
expect(snapshotEqual(snapshot1, snapshot1Copy)).to.be.true;
expect(snapshotEqual(snapshot1, snapshot2)).to.be.true;
// hasCachedResults should effect querySnapshot equality
dconeybe marked this conversation as resolved.
Show resolved Hide resolved
expect(
snapshotEqual(
querySnapshot(
'foo',
{},
{ a: { a: 1 } },
keys('foo/a'),
false,
false,
true
),
querySnapshot(
'foo',
{},
{ a: { a: 1 } },
keys('foo/a'),
false,
false,
true
)
)
).to.be.true;
expect(
snapshotEqual(
querySnapshot(
'foo',
{},
{ a: { a: 1 } },
keys('foo/a'),
false,
false,
true
),
querySnapshot(
'foo',
{},
{ a: { a: 1 } },
keys('foo/a'),
false,
false,
false
)
)
).to.be.false;
});

it('JSON.stringify() does not throw', () => {
Expand Down
5 changes: 2 additions & 3 deletions packages/firestore/test/util/api_helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ import {
import { DocumentKeySet } from '../../src/model/collections';
import { DocumentSet } from '../../src/model/document_set';
import { JsonObject } from '../../src/model/object_value';
import { ByteString } from '../../src/util/byte_string';
import { TEST_PROJECT } from '../unit/local/persistence_test_helpers';

import { doc, key, path as pathFrom } from './helpers';
Expand Down Expand Up @@ -132,7 +131,7 @@ export function querySnapshot(
mutatedKeys: DocumentKeySet,
fromCache: boolean,
syncStateChanged: boolean,
resumeToken?: ByteString
hasCachedResults?: boolean
): QuerySnapshot {
const query: InternalQuery = newQueryForPath(pathFrom(path));
let oldDocuments: DocumentSet = new DocumentSet();
Expand All @@ -155,7 +154,7 @@ export function querySnapshot(
fromCache,
syncStateChanged,
false,
resumeToken !== undefined && resumeToken.approximateByteSize() > 0
hasCachedResults ?? false
);
const db = firestore();
return new QuerySnapshot(
Expand Down