Skip to content

Add QueryData.with() helpers #2148

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.

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

Merged
merged 1 commit into from
Sep 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 1 addition & 3 deletions packages/firestore/src/local/indexeddb_persistence.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1271,9 +1271,7 @@ export class IndexedDbLruDelegate implements ReferenceDelegate, LruDelegate {
txn: PersistenceTransaction,
queryData: QueryData
): PersistencePromise<void> {
const updated = queryData.copy({
sequenceNumber: txn.currentSequenceNumber
});
const updated = queryData.withSequenceNumber(txn.currentSequenceNumber);
return this.db.getQueryCache().updateQueryData(txn, updated);
}

Expand Down
4 changes: 2 additions & 2 deletions packages/firestore/src/local/local_store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -481,10 +481,10 @@ export class LocalStore {
const resumeToken = change.resumeToken;
// Update the resume token if the change includes one.
if (resumeToken.length > 0) {
const newQueryData = oldQueryData.copy({
const newQueryData = oldQueryData.withResumeToken(
resumeToken,
snapshotVersion
});
);
this.queryDataByTarget[targetId] = newQueryData;

// Update the query data if there are target changes (or if
Expand Down
4 changes: 1 addition & 3 deletions packages/firestore/src/local/memory_persistence.ts
Original file line number Diff line number Diff line change
Expand Up @@ -434,9 +434,7 @@ export class MemoryLruDelegate implements ReferenceDelegate, LruDelegate {
txn: PersistenceTransaction,
queryData: QueryData
): PersistencePromise<void> {
const updated = queryData.copy({
sequenceNumber: txn.currentSequenceNumber
});
const updated = queryData.withSequenceNumber(txn.currentSequenceNumber);
return this.persistence.getQueryCache().updateQueryData(txn, updated);
}

Expand Down
37 changes: 21 additions & 16 deletions packages/firestore/src/local/query_data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,28 +61,33 @@ export class QueryData {
readonly resumeToken: ProtoByteString = emptyByteString()
) {}

/** Creates a new query data instance with an updated sequence number. */
withSequenceNumber(sequenceNumber: number): QueryData {
return new QueryData(
this.query,
this.targetId,
this.purpose,
sequenceNumber,
this.snapshotVersion,
this.resumeToken
);
}

/**
* Creates a new query data instance with an updated snapshot version and
* resume token.
* Creates a new query data instance with an updated resume token and
* snapshot version.
*/
copy(overwrite: {
resumeToken?: ProtoByteString;
snapshotVersion?: SnapshotVersion;
sequenceNumber?: ListenSequenceNumber;
}): QueryData {
withResumeToken(
resumeToken: ProtoByteString,
snapshotVersion: SnapshotVersion
): QueryData {
return new QueryData(
this.query,
this.targetId,
this.purpose,
overwrite.sequenceNumber === undefined
? this.sequenceNumber
: overwrite.sequenceNumber,
overwrite.snapshotVersion === undefined
? this.snapshotVersion
: overwrite.snapshotVersion,
overwrite.resumeToken === undefined
? this.resumeToken
: overwrite.resumeToken
this.sequenceNumber,
snapshotVersion,
resumeToken
);
}

Expand Down
13 changes: 7 additions & 6 deletions packages/firestore/src/remote/remote_store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -429,10 +429,10 @@ export class RemoteStore implements TargetMetadataProvider {
const queryData = this.listenTargets[targetId];
// A watched target might have been removed already.
if (queryData) {
this.listenTargets[targetId] = queryData.copy({
resumeToken: change.resumeToken,
this.listenTargets[targetId] = queryData.withResumeToken(
change.resumeToken,
snapshotVersion
});
);
}
}
});
Expand All @@ -448,9 +448,10 @@ export class RemoteStore implements TargetMetadataProvider {

// Clear the resume token for the query, since we're in a known mismatch
// state.
this.listenTargets[targetId] = queryData.copy({
resumeToken: emptyByteString()
});
this.listenTargets[targetId] = queryData.withResumeToken(
emptyByteString(),
queryData.snapshotVersion
);

// Cause a hard reset by unwatching and rewatching immediately, but
// deliberately don't send a resume token so that we get a full update.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ apiDescribe('Database batch writes', (persistence: boolean) => {
});

it('can delete documents', () => {
// TODO(#1865): This test fails with node:persistence against Prod
return integrationHelpers.withTestDoc(persistence, doc => {
return doc
.set({ foo: 'bar' })
Expand Down
1 change: 1 addition & 0 deletions packages/firestore/test/integration/api/database.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ apiDescribe('Database', (persistence: boolean) => {
});

it('can delete a document', () => {
// TODO(#1865): This test fails with node:persistence against Prod
return withTestDoc(persistence, docRef => {
return docRef
.set({ foo: 'bar' })
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,7 @@ function genericLruGarbageCollectorTests(
txn: PersistenceTransaction,
queryData: QueryData
): PersistencePromise<void> {
const updated = queryData.copy({
sequenceNumber: txn.currentSequenceNumber
});
const updated = queryData.withSequenceNumber(txn.currentSequenceNumber);
return queryCache
.updateQueryData(txn, updated)
.next(() =>
Expand Down