feat(sdk): Add Client::server
#3908
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
Hywan
force-pushed
the
feat-sdk-client-builder-homeserver-config
branch
from
b2b8543 to
b1474f4
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3908 +/- ##
=======================================
Coverage 84.13% 84.14%
=======================================
Files 266 267 +1
Lines 28005 28027 +22
=======================================
+ Hits 23563 23583 +20
- Misses 4442 4444 +2 ☔ View full report in Codecov by Sentry. |
This patch adds `Client::server`: the URL of the server. Not to be confused with the `Client::homeserver`. The `server` holds some information, like the `.well-known` file, to discover the homeserver. The homeserver is the client-server Matrix API. `server` is usually the server part in a user ID, e.g. with `@mnt_io:matrix.org`, here `matrix.org` is the server, whilst `matrix-client.matrix.org` is the homeserver. This patch also moves the code about homeserver discovery in the `HomeserverConfig::discover` new method. A new struct is introduced to hold the result, to replace a 4-tuples. `Client::server` is also now a `Option<_>` because in the case of `HomeserverConfig::Url`, the server cannot be known. This patch also removes several clones here and there. Finally, this patch updates a test to quickly test the new behaviour. A next patch will introduce proper tests.
This patch moves `client/builder.rs` into `client/builder/mod.rs`. This patch also moves the `HomeserverConfig` type and its siblings (`discover_homeserver`, `UrlScheme` etc.) into its own module `client/ builder/homeserver_config.rs`. This is purely for cleaning up.
Hywan
force-pushed
the
feat-sdk-client-builder-homeserver-config
branch
from
b1474f4 to
5fedc09
Compare
This API is tested via `Client` and `ClientBuilder` but it's preferable to unit testing it too, it makes things clearer and cleaner.
Hywan
force-pushed
the
feat-sdk-client-builder-homeserver-config
branch
from
dfd78be to
171e06a
Compare
jmartinesp
reviewed
Sep 2, 2024
| @@ -30,14 +30,14 @@ use crate::{ | |||
| /// Configuration for the homeserver. | |||
| #[derive(Clone, Debug)] | |||
| pub(super) enum HomeserverConfig { | |||
| /// A precise URL, including the protocol. | |||
| /// A server name URL, including the protocol. | |||
There was a problem hiding this comment.
Should this be a homeserver URL?
There was a problem hiding this comment.
Indeed! I want to rename all these variants in another PR because it is so confusing.
This patch fixes an error where the `homeserver` is used for the `server` value.
Hywan
force-pushed
the
feat-sdk-client-builder-homeserver-config
branch
from
171e06a to
b073f28
Compare
jmartinesp
approved these changes
Sep 2, 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.
This patch adds
Client::serveras anOption<Url>. This should not be confused with thehomeserver. For example, in the case of Matrix,matrix.orgis the server, andmatrix-client.matrix.orgis the homeserver.This patch should be reviewed commit-by-commit for the sake of simplicity. Code is moved into their own module for clarity.