Skip to content

Fix racy promises in SpecTestRunner #2693

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

Merged
merged 5 commits into from
Mar 9, 2020
Merged

Fix racy promises in SpecTestRunner #2693

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5c3b0b3
add iterative drain on AQ
Mar 2, 2020
a584393
make comments gud
Mar 4, 2020
9add026
modify drain
Mar 4, 2020
5068b66
removing counter for async queue operations
Mar 4, 2020
2a0dc71
add comment as per sebastian
Mar 4, 2020
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
20 changes: 17 additions & 3 deletions packages/firestore/src/util/async_queue.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,9 @@ export class AsyncQueue {
// visible for testing
failure: Error | null = null;

// Number of unexecuted operations remaining on the AsyncQueue.
private operationsCount = 0;

// Flag set while there's an outstanding AsyncQueue operation, used for
// assertion sanity-checks.
private operationInProgress = false;
Expand All @@ -219,6 +222,11 @@ export class AsyncQueue {
return this._isShuttingDown;
}

// Visible for testing
isEmpty(): boolean {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should be able to make this private or remove it entirely.

return this.operationsCount === 0;
}

/**
* Adds a new operation to the queue without waiting for it to complete (i.e.
* we ignore the Promise result).
Expand Down Expand Up @@ -280,6 +288,7 @@ export class AsyncQueue {
}

private enqueueInternal<T extends unknown>(op: () => Promise<T>): Promise<T> {
this.operationsCount += 1;
const newTail = this.tail.then(() => {
this.operationInProgress = true;
return op()
Expand All @@ -305,6 +314,7 @@ export class AsyncQueue {
})
.then(result => {
this.operationInProgress = false;
this.operationsCount -= 1;
return result;
});
});
Expand Down Expand Up @@ -372,9 +382,13 @@ export class AsyncQueue {
* Waits until all currently queued tasks are finished executing. Delayed
* operations are not run.
*/
drain(): Promise<void> {
// It should still be possible to drain the queue after it is shutting down.
return this.enqueueEvenAfterShutdown(() => Promise.resolve());
async drain(): Promise<void> {
// Operations in the queue prior to draining may have enqueued additional
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if this works, but if it does you could get rid of all size accounting:

let currentTail : Promise<void>;
do (
  currentTail = this.tail;
  await currentTail;
} while (currentTail !== this.tail);

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done.

// operations. Keep draining the queue until there are no more.
while (this.operationsCount > 0) {
// It should still be possible to drain the queue after it is shutting down.
await this.enqueueEvenAfterShutdown(() => Promise.resolve());
}
}

/**
Expand Down
2 changes: 1 addition & 1 deletion packages/firestore/test/unit/specs/limbo_spec.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,12 +476,12 @@ describeSpec('Limbo Documents:', [], () => {
.expectLimboDocs(docB.key, docC.key)
.client(1)
.stealPrimaryLease()
.expectListen(query, 'resume-token-1000000')
.client(0)
.runTimer(TimerId.ClientMetadataRefresh)
.expectPrimaryState(false)
.expectLimboDocs()
.client(1)
.expectListen(query, 'resume-token-1000000')
.watchAcksFull(query, 3 * 1e6)
.expectLimboDocs(docB.key, docC.key)
.ackLimbo(3 * 1e6, deletedDocB)
Expand Down