test: cross-version sync with @comapeo/core@2.0.1
#941
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
Our tests currenly connect `MapeoManager`s in two ways: 1. By starting peer discovery servers and connecting. This is similar to what the real app does. 2. By manually creating streams and connecting them in tests. This is less realistic. This commit removes the second way because: - it is less realistic - it lets us remove some test-only code in the `src/` directory - it will make an upcoming change easier I also tried to fix a possible (test-only) race condition, which *could* have been a reason for the less realistic option: 1. Start connecting peers by calling `connectPeers()`. This begins the process of starting peer discovery servers. 2. Disconnect them by calling the callback returned by `connectPeers()`. 3. The peer discovery servers start, and begin connecting. *This is bad* because we already wanted to disconnect!
This tests that we can connect and sync between the current version and `@comapeo/core@2.0.1`. Notably, it required several changes to our test utilities to support the current `MapeoManager` and older ones. (One of these changes allowed us to remove a test-only method from `MapeoManager`.)
EvanHahn
commented
Oct 28, 2024
Comment on lines
-224
to
-229
| /** | ||
| * MapeoRPC instance, used for tests | ||
| */ | ||
| get [kRPC]() { | ||
| return this.#localPeers | ||
| } |
| managers.every((manager) => { | ||
| const unconnectedDeviceIds = new Set(deviceIds) | ||
| unconnectedDeviceIds.delete(manager.deviceId) | ||
| for (const peer of manager[kRPC].peers) { |
There was a problem hiding this comment.
Had to do a small amount of work to stop calling a private method.
gmaclennan
approved these changes
Oct 29, 2024
There was a problem hiding this comment.
ok looks good. For maintainability, it could be helpful to change this later to be an option of createManager, e.g. createManager({ managerConstructor: MapeoManager2_0_1 }). However to do this, we need to have defaults for the migrations folders. Having it as a constructor option allows us to write tests as we develop to test specific changes between versions, without needing to keep adding test utils.
|
I'll do that the moment we start testing with another older version. |
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.
Depends on #856.
I recommend reviewing this with whitespace changes disabled.
This tests that we can connect and sync between the current version and
@comapeo/core@2.0.1.Notably, it required several changes to our test utilities to support the current
MapeoManagerand older ones. (One of these changes allowed us to remove a test-only method fromMapeoManager.)