Split the Client API in two #146
Merged
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 want the Client API to be as small as possible, to make it as easy as possible to implement clients which can work with complement-crypto. However, we also want to use that same API when writing tests, where it is desirable to have helper functions (typically of the form `MustXXX`). To satisfy both, split the API in two, where the SDK authors implement the simple `Client` and the test suite then wraps that in another API called `TestClient` which handles all the nice helper functions. For now, just convert `MustStartSyncing` to illustrate the design change. Next PR will move the remaining Must functions.
andybalaam
approved these changes
Oct 2, 2024
Convert remaining Must functions to TestClient
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 want the Client API to be as small as possible, to make it as easy as possible to implement clients which can work with complement-crypto.
However, we also want to use that same API when writing tests, where it is desirable to have helper functions (typically of the form
MustXXX).To satisfy both, split the API in two, where the SDK authors implement the simple
Clientand the test suite then wraps that in another API calledTestClientwhich handles all the nice helper functions.For now, just convert
MustStartSyncingto illustrate the design change. Next PR will move the remaining Must functions.