1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
// Copyright 2023 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#![deny(unreachable_pub)]
use std::{fmt::Debug, future::IntoFuture};
use eyeball::SharedObservable;
#[cfg(not(target_arch = "wasm32"))]
use eyeball::Subscriber;
#[cfg(feature = "experimental-oidc")]
use mas_oidc_client::{
error::{
Error as OidcClientError, ErrorBody as OidcErrorBody, HttpError as OidcHttpError,
TokenRefreshError, TokenRequestError,
},
types::errors::ClientErrorCode,
};
use matrix_sdk_common::boxed_into_future;
use ruma::api::{client::error::ErrorKind, error::FromHttpResponseError, OutgoingRequest};
#[cfg(feature = "experimental-oidc")]
use tracing::error;
use tracing::trace;
use super::super::Client;
#[cfg(feature = "experimental-oidc")]
use crate::oidc::OidcError;
use crate::{
config::RequestConfig,
error::{HttpError, HttpResult},
RefreshTokenError, TransmissionProgress,
};
/// `IntoFuture` returned by [`Client::send`].
#[allow(missing_debug_implementations)]
pub struct SendRequest<R> {
pub(crate) client: Client,
pub(crate) homeserver_override: Option<String>,
pub(crate) request: R,
pub(crate) config: Option<RequestConfig>,
pub(crate) send_progress: SharedObservable<TransmissionProgress>,
}
impl<R> SendRequest<R> {
/// Replace the default `SharedObservable` used for tracking upload
/// progress.
///
/// Note that any subscribers obtained from
/// [`subscribe_to_send_progress`][Self::subscribe_to_send_progress]
/// will be invalidated by this.
pub fn with_send_progress_observable(
mut self,
send_progress: SharedObservable<TransmissionProgress>,
) -> Self {
self.send_progress = send_progress;
self
}
/// Replace this request's target (homeserver) with a custom one.
///
/// This is useful at the moment because the current sliding sync
/// implementation uses a proxy server.
#[cfg(feature = "experimental-sliding-sync")]
pub fn with_homeserver_override(mut self, homeserver_override: Option<String>) -> Self {
self.homeserver_override = homeserver_override;
self
}
/// Get a subscriber to observe the progress of sending the request
/// body.
#[cfg(not(target_arch = "wasm32"))]
pub fn subscribe_to_send_progress(&self) -> Subscriber<TransmissionProgress> {
self.send_progress.subscribe()
}
}
impl<R> IntoFuture for SendRequest<R>
where
R: OutgoingRequest + Clone + Debug + Send + Sync + 'static,
R::IncomingResponse: Send + Sync,
HttpError: From<FromHttpResponseError<R::EndpointError>>,
{
type Output = HttpResult<R::IncomingResponse>;
boxed_into_future!();
fn into_future(self) -> Self::IntoFuture {
let Self { client, request, config, send_progress, homeserver_override } = self;
Box::pin(async move {
let res = Box::pin(client.send_inner(
request.clone(),
config,
homeserver_override.clone(),
send_progress.clone(),
))
.await;
// An `M_UNKNOWN_TOKEN` error can potentially be fixed with a token refresh.
if let Err(Some(ErrorKind::UnknownToken { soft_logout })) =
res.as_ref().map_err(HttpError::client_api_error_kind)
{
trace!("Token refresh: Unknown token error received.");
// If automatic token refresh isn't supported, there is nothing more to do.
if !client.inner.auth_ctx.handle_refresh_tokens {
trace!("Token refresh: Automatic refresh disabled.");
client.broadcast_unknown_token(soft_logout);
return res;
}
// Try to refresh the token and retry the request.
if let Err(refresh_error) = client.refresh_access_token().await {
match &refresh_error {
RefreshTokenError::RefreshTokenRequired => {
trace!("Token refresh: The session doesn't have a refresh token.");
// Refreshing access tokens is not supported by this `Session`, ignore.
client.broadcast_unknown_token(soft_logout);
}
#[cfg(feature = "experimental-oidc")]
RefreshTokenError::Oidc(oidc_error) => {
match **oidc_error {
OidcError::Oidc(OidcClientError::TokenRefresh(
TokenRefreshError::Token(TokenRequestError::Http(
OidcHttpError {
body:
Some(OidcErrorBody {
error: ClientErrorCode::InvalidGrant,
..
}),
..
},
)),
)) => {
error!("Token refresh: OIDC refresh_token rejected with invalid grant");
// The refresh was denied, signal to sign out the user.
client.broadcast_unknown_token(soft_logout);
}
_ => {
trace!("Token refresh: OIDC refresh encountered a problem.");
// The refresh failed for other reasons, no
// need to sign out.
}
};
return Err(HttpError::RefreshToken(refresh_error));
}
_ => {
trace!("Token refresh: Token refresh failed.");
// This isn't necessarily correct, but matches the behaviour when
// implementing OIDC.
client.broadcast_unknown_token(soft_logout);
return Err(HttpError::RefreshToken(refresh_error));
}
}
} else {
trace!("Token refresh: Refresh succeeded, retrying request.");
return Box::pin(client.send_inner(
request,
config,
homeserver_override,
send_progress,
))
.await;
}
}
res
})
}
}