test: fix race condition if multiple invites are sent #863
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We have a test helper, `invite`, that invites people to projects. It works like this: 1. Tell the invitee(s) to accept any invite they receive. 2. Send the invite. This is fine for most of our tests, where only one invite will be sent to each manager. But we have [at least one test][0] where multiple invites are sent. That can cause a race condition. Imagine the following scenario where `invite` is called twice: 1. Tell the invitee to accept any invite they receive (listener 1). 2. Tell the invitee to accept any invite they receive (listener 2). 3. Send the first invite. 4. Both listeners fire, sending one valid "accept" response and one that gets dropped. 4. Send the second invite. There are no listeners, and the test hangs. This commit changes `invite`. Now, it works like this: 1. Generate an invite ID. 2. Tell the invitee(s) to accept any invite with that ID. 3. Send the invite. As far as I know, this isn't a problem today. But an [upcoming test change][1] causes this to happen much more reliably, so I think this is worth fixing. (I think it's worth fixing even without that upcoming change. Also, I tested this with those changes and it does, indeed, fix hung tests.) [0]: https://github.com/digidem/comapeo-core/blob/d2e5590aa749b690e5c07c3b64791db5e403ee29/test-e2e/sync.js#L530 [1]: #856
EvanHahn
commented
Sep 24, 2024
| @@ -89,6 +89,7 @@ export class MemberApi extends TypedEmitter { | |||
| * @param {import('./roles.js').RoleIdForNewInvite} opts.roleId | |||
| * @param {string} [opts.roleName] | |||
| * @param {string} [opts.roleDescription] | |||
| * @param {Buffer} [opts.__testOnlyInviteId] Hard-code the invite ID. Only for tests. | |||
There was a problem hiding this comment.
I don't love having a special test-only parameter here but I couldn't think of a more elegant solution.
This was referenced Sep 24, 2024
tomasciccola
approved these changes
Sep 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We have a test helper,
invite, that invites people to projects. It works like this:This is fine for most of our tests, where only one invite will be sent to each manager. But we have at least one test where multiple invites are sent.
That can cause a race condition. Imagine the following scenario where
inviteis called twice:This commit changes
invite. Now, it works like this:As far as I know, this isn't a problem today. But an upcoming test change causes this to happen much more reliably, so I think this is worth fixing. (I think it's worth fixing even without that upcoming change. Also, I tested this with those changes and it does, indeed, fix hung tests.)