thibaud-lclr/api-client
1
0
Fork 0
Code Packages Activity Actions

feat(relay): control redirect follow (#5508)

Browse source 
Add per-domain toggle to disable automatic HTTP redirect following in
 the Native and Agent interceptors. When disabled, requests return the
 redirect response (status code, headers, body) without following the
 Location header.

 Previously HTTP redirects were always followed (on browser, can't do
 much about that, see
 https://fetch.spec.whatwg.org/#atomic-http-redirect-handling) without
 option to inspect the redirect response itself. This prevented
 developers from accessing redirect metadata needed when testing OAuth
 flows (PKCE where intermediate responses contain authorization tokens),
 authentication endpoints that return codes in Location headers with 302
 status, and debugging API redirect chains. But on the desktop app,
 redirects were just never followed, creating the opposite effect.

 The browser's fetch API applies atomic HTTP redirect handling per spec,
 making it impossible to intercept redirects and inspect their responses.
 The Native and Agent interceptors use curl and native HTTP clients
 respectively, both supporting redirect control, making this feature
 viable for these specific interceptors. (Proxyscotch tbd).
This commit is contained in:
Shreyas 2025-10-27 17:41:58 +05:30 committed by GitHub
parent 567344a9e3
commit ecf7d2507a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
18 changed files with 254 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
packages/hoppscotch-agent/src-tauri/Cargo.lock generated
View file

@ -1202,7 +1202,7 @@ dependencies = [
"libc",
"option-ext",
"redox_users 0.5.0",
"windows-sys 0.59.0",
"windows-sys 0.60.2",
]
[[package]]
@ -4125,7 +4125,7 @@ checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
[[package]]
name = "relay"
version = "0.1.1"
source = "git+https://github.com/CuriousCorrelation/relay.git#7270b956321972269eea7cecdccbb2ae839bd0ff"
source = "git+https://github.com/CuriousCorrelation/relay.git#ed2329e4ebb71bb984c4705aa950cb9c3f9ff931"
dependencies = [
"bytes",
"curl",
@ -6295,7 +6295,7 @@ version = "0.1.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb"
dependencies = [
"windows-sys 0.59.0",
"windows-sys 0.48.0",
]
[[package]]

1
packages/hoppscotch-common/locales/en.json
View file

@ -1045,6 +1045,7 @@
"validate_certificates": "Validate SSL/TLS Certificates",
"verify_host": "Verify Host",
"verify_peer": "Verify Peer",
"follow_redirects": "Follow Redirects",
"client_certificates": "Client Certificates",
"certificate_settings": "Certificate Settings",
"certificate": "Certificate",

23
packages/hoppscotch-common/src/components/settings/Agent.vue
View file

@ -31,6 +31,14 @@
{{ t("settings.verify_peer") }}
</div>
<div class="flex items-center">
<HoppSmartToggle
:on="domainSettings[selectedDomain]?.options?.followRedirects ?? true"
@change="toggleFollowRedirects"
/>
{{ t("settings.follow_redirects") }}
</div>
<div class="flex space-x-4">
<HoppButtonSecondary
:icon="IconFileBadge"
@ -517,6 +525,10 @@ function updateDomainSettings(newSettings: any) {
...newSettings.security?.certificates,
},
},
options: {
...currentSettings?.options,
...newSettings.options,
},
}
store.saveDomainSettings(domain, domainSettings[domain])
@ -538,6 +550,17 @@ function toggleVerifyPeer() {
})
}
function toggleFollowRedirects() {
const currentValue =
domainSettings[selectedDomain.value]?.options?.followRedirects ?? true
updateDomainSettings({
options: {
followRedirects: !currentValue,
},
})
}
function toggleProxy() {
updateDomainSettings({
proxy: domainSettings[selectedDomain.value]?.proxy

23
packages/hoppscotch-common/src/components/settings/Native.vue
View file

@ -31,6 +31,14 @@
{{ t("settings.verify_peer") }}
</div>
<div class="flex items-center">
<HoppSmartToggle
:on="domainSettings[selectedDomain]?.options?.followRedirects ?? true"
@change="toggleFollowRedirects"
/>
{{ t("settings.follow_redirects") }}
</div>
<div class="flex space-x-4">
<HoppButtonSecondary
:icon="IconFileBadge"
@ -513,6 +521,10 @@ function updateDomainSettings(newSettings: any) {
...newSettings.security?.certificates,
},
},
options: {
...currentSettings?.options,
...newSettings.options,
},
}
store.saveDomainSettings(domain, domainSettings[domain])
@ -534,6 +546,17 @@ function toggleVerifyPeer() {
})
}
function toggleFollowRedirects() {
const currentValue =
domainSettings[selectedDomain.value]?.options?.followRedirects ?? true
updateDomainSettings({
options: {
followRedirects: !currentValue,
},
})
}
function toggleProxy() {
updateDomainSettings({
proxy: domainSettings[selectedDomain.value]?.proxy

34
packages/hoppscotch-common/src/helpers/functional/domain-settings.ts
View file

@ -44,6 +44,14 @@ export type InputDomainSetting = {
}
}
}
options?: {
followRedirects?: boolean
maxRedirects?: number
timeout?: number
decompress?: boolean
cookies?: boolean
keepAlive?: boolean
}
}
const convertStoreFile = (file: StoreFile): O.Option<Uint8Array> =>
@ -207,19 +215,41 @@ const convertProxy = (
})
)
const convertOptions = (
options?: InputDomainSetting["options"]
): O.Option<NonNullable<RelayRequest["meta"]>["options"]> =>
pipe(
O.fromNullable(options),
O.map((opts) => ({
...(opts.followRedirects !== undefined && {
followRedirects: opts.followRedirects,
}),
...(opts.maxRedirects !== undefined && {
maxRedirects: Math.min(opts.maxRedirects, 10),
}),
...(opts.timeout !== undefined && { timeout: opts.timeout }),
...(opts.decompress !== undefined && { decompress: opts.decompress }),
...(opts.cookies !== undefined && { cookies: opts.cookies }),
...(opts.keepAlive !== undefined && { keepAlive: opts.keepAlive }),
})),
O.filter((opts) => Object.keys(opts).length > 0)
)
export const convertDomainSetting = (
input: InputDomainSetting
): E.Either<Error, Pick<RelayRequest, "proxy" | "security">> => {
): E.Either<Error, Pick<RelayRequest, "proxy" | "security" | "meta">> => {
if (input.version !== "v1") {
return E.left(new Error("Invalid version"))
}
const security = convertSecurity(input.security)
const proxy = convertProxy(input.proxy)
const options = convertOptions(input.options)
const result: Pick<RelayRequest, "proxy" | "security"> = {
const result: Pick<RelayRequest, "proxy" | "security" | "meta"> = {
proxy: O.isSome(proxy) ? proxy.value : undefined,
security: O.isSome(security) ? security.value : undefined,
meta: O.isSome(options) ? { options: options.value } : undefined,
}
return E.right(result)

18
packages/hoppscotch-common/src/platform/std/kernel-interceptors/agent/store.ts
View file

@ -34,6 +34,9 @@ const defaultDomainConfig: InputDomainSetting = {
verifyPeer: true,
},
proxy: undefined,
options: {
followRedirects: true,
},
}
export class KernelInterceptorAgentStore extends Service {
@ -147,6 +150,15 @@ export class KernelInterceptorAgentStore extends Service {
)
}
private mergeOptions(
...settings: (Required<InputDomainSetting>["options"] | undefined)[]
): Required<InputDomainSetting>["options"] | undefined {
return settings.reduce(
(acc, setting) => (setting ? { ...acc, ...setting } : acc),
undefined as Required<InputDomainSetting>["options"] | undefined
)
}
private getMergedSettings(domain: string): InputDomainSetting {
const domainSettings = this.domainSettings.get(domain)
const globalSettings =
@ -160,13 +172,17 @@ export class KernelInterceptorAgentStore extends Service {
domainSettings?.security
),
proxy: this.mergeProxy(globalSettings?.proxy, domainSettings?.proxy),
options: this.mergeOptions(
globalSettings?.options,
domainSettings?.options
),
}
return { version: "v1", ...result }
}
public completeRequest(
request: Omit<PluginRequest, "proxy" | "security">
request: Omit<RelayRequest, "proxy" | "security" | "meta">
): PluginRequest {
const host = new URL(request.url).host
const settings = this.getMergedSettings(host)

18
packages/hoppscotch-common/src/platform/std/kernel-interceptors/native/store.ts
View file

@ -26,6 +26,9 @@ const defaultDomainConfig: InputDomainSetting = {
verifyPeer: true,
},
proxy: undefined,
options: {
followRedirects: true,
},
}
export class KernelInterceptorNativeStore extends Service {
@ -117,6 +120,15 @@ export class KernelInterceptorNativeStore extends Service {
)
}
private mergeOptions(
...settings: (Required<InputDomainSetting>["options"] | undefined)[]
): Required<InputDomainSetting>["options"] | undefined {
return settings.reduce(
(acc, setting) => (setting ? { ...acc, ...setting } : acc),
undefined as Required<InputDomainSetting>["options"] | undefined
)
}
private getMergedSettings(domain: string): InputDomainSetting {
const domainSettings = this.domainSettings.get(domain)
const globalSettings =
@ -130,13 +142,17 @@ export class KernelInterceptorNativeStore extends Service {
domainSettings?.security
),
proxy: this.mergeProxy(globalSettings?.proxy, domainSettings?.proxy),
options: this.mergeOptions(
globalSettings?.options,
domainSettings?.options
),
}
return { version: "v1", ...result }
}
public completeRequest(
request: Omit<RelayRequest, "proxy" | "security">
request: Omit<RelayRequest, "proxy" | "security" | "meta">
): RelayRequest {
const host = new URL(request.url).host
const settings = this.getMergedSettings(host)

17
packages/hoppscotch-desktop/plugin-workspace/relay/src/interop.rs
View file

@ -313,6 +313,22 @@ pub struct CertificateConfig {
pub ca: Option<Vec<Bytes>>,
}
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct RequestMeta {
pub options: Option<RequestOptions>,
}
#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct RequestOptions {
pub timeout: Option<u64>,
pub follow_redirects: Option<bool>,
pub max_redirects: Option<u32>,
pub decompress: Option<bool>,
pub cookies: Option<bool>,
pub keep_alive: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct Request {
pub id: i64,
@ -327,6 +343,7 @@ pub struct Request {
pub auth: Option<AuthType>,
pub security: Option<SecurityConfig>,
pub proxy: Option<ProxyConfig>,
pub meta: Option<RequestMeta>,
}
#[derive(Debug, Serialize, Deserialize, Clone)]

82
packages/hoppscotch-desktop/plugin-workspace/relay/src/request.rs
View file

@ -113,6 +113,88 @@ impl<'a> CurlRequest<'a> {
}
})?;
let Some(ref meta) = self.request.meta else {
tracing::debug!("No meta configuration provided");
return Ok(());
};
let Some(ref options) = meta.options else {
tracing::debug!("No options in meta configuration");
return Ok(());
};
if let Some(follow) = options.follow_redirects {
tracing::debug!(follow_redirects = follow, "Setting redirect behavior");
self.handle.follow_location(follow).map_err(|e| {
tracing::error!(error = %e, "Failed to set follow_location");
RelayError::Network {
message: "Failed to set redirect behavior".into(),
cause: Some(e.to_string()),
}
})?;
}
if let Some(max) = options.max_redirects {
tracing::debug!(max_redirects = max, "Setting maximum redirects");
self.handle.max_redirections(max).map_err(|e| {
tracing::error!(error = %e, "Failed to set max_redirections");
RelayError::Network {
message: "Failed to set maximum redirects".into(),
cause: Some(e.to_string()),
}
})?;
}
if let Some(timeout_ms) = options.timeout {
tracing::debug!(timeout_ms = timeout_ms, "Setting request timeout");
self.handle
.timeout(std::time::Duration::from_millis(timeout_ms))
.map_err(|e| {
tracing::error!(error = %e, "Failed to set timeout");
RelayError::Network {
message: "Failed to set timeout".into(),
cause: Some(e.to_string()),
}
})?;
}
if let Some(decompress) = options.decompress {
if !decompress {
tracing::debug!("Disabling automatic decompression");
self.handle.accept_encoding("identity").map_err(|e| {
tracing::error!(error = %e, "Failed to disable decompression");
RelayError::Network {
message: "Failed to disable decompression".into(),
cause: Some(e.to_string()),
}
})?;
}
}
if let Some(enable_cookies) = options.cookies {
tracing::debug!(enable_cookies = enable_cookies, "Setting cookie handling");
if enable_cookies {
self.handle.cookie_file("").map_err(|e| {
tracing::error!(error = %e, "Failed to enable cookies");
RelayError::Network {
message: "Failed to enable cookie handling".into(),
cause: Some(e.to_string()),
}
})?;
}
}
if let Some(keep_alive) = options.keep_alive {
tracing::debug!(keep_alive = keep_alive, "Setting keep-alive");
self.handle.tcp_keepalive(keep_alive).map_err(|e| {
tracing::error!(error = %e, "Failed to set keep-alive");
RelayError::Network {
message: "Failed to set keep-alive".into(),
cause: Some(e.to_string()),
}
})?;
}
tracing::debug!("Basic request parameters set successfully");
Ok(())
}

2
packages/hoppscotch-desktop/plugin-workspace/tauri-plugin-relay/Cargo.lock generated
View file

@ -2888,7 +2888,7 @@ checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
[[package]]
name = "relay"
version = "0.1.1"
source = "git+https://github.com/CuriousCorrelation/relay.git#7270b956321972269eea7cecdccbb2ae839bd0ff"
source = "git+https://github.com/CuriousCorrelation/relay.git#ed2329e4ebb71bb984c4705aa950cb9c3f9ff931"
dependencies = [
"bytes",
"curl",

12
packages/hoppscotch-desktop/plugin-workspace/tauri-plugin-relay/dist-js/index.d.ts vendored
View file

@ -130,6 +130,17 @@ export type CertificateType = {
data: Uint8Array;
password: string;
};
export interface RequestOptions {
timeout?: number;
followRedirects?: boolean;
maxRedirects?: number;
decompress?: boolean;
cookies?: boolean;
keepAlive?: boolean;
}
export interface RequestMeta {
options?: RequestOptions;
}
export interface Request {
id: number;
url: string;
@ -154,6 +165,7 @@ export interface Request {
password: string;
};
};
meta?: RequestMeta;
}
export interface Response {
id: number;

2
packages/hoppscotch-desktop/plugin-workspace/tauri-plugin-relay/dist-js/index.d.ts.map
View file

File diff suppressed because one or more lines are too long

15
packages/hoppscotch-desktop/plugin-workspace/tauri-plugin-relay/guest-js/index.ts
View file

@ -187,6 +187,19 @@ export type CertificateType =
password: string
}
export interface RequestOptions {
timeout?: number
followRedirects?: boolean
maxRedirects?: number
decompress?: boolean
cookies?: boolean
keepAlive?: boolean
}
export interface RequestMeta {
options?: RequestOptions
}
export interface Request {
id: number
url: string
@ -213,6 +226,8 @@ export interface Request {
password: string
}
}
meta?: RequestMeta
}
export interface Response {

4
packages/hoppscotch-desktop/src-tauri/Cargo.lock generated
View file

@ -4486,7 +4486,7 @@ checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
[[package]]
name = "relay"
version = "0.1.1"
source = "git+https://github.com/CuriousCorrelation/relay.git#7270b956321972269eea7cecdccbb2ae839bd0ff"
source = "git+https://github.com/CuriousCorrelation/relay.git#ed2329e4ebb71bb984c4705aa950cb9c3f9ff931"
dependencies = [
"bytes",
"curl",
@ -5696,7 +5696,7 @@ dependencies = [
[[package]]
name = "tauri-plugin-relay"
version = "0.1.0"
source = "git+https://github.com/CuriousCorrelation/tauri-plugin-relay?rev=5d59b97fe331ca62e8be0454ff3f4e5f6185ae70#5d59b97fe331ca62e8be0454ff3f4e5f6185ae70"
source = "git+https://github.com/CuriousCorrelation/tauri-plugin-relay?rev=7cf09c1ad31e228758738c2f4e1c8fe9cc141291#7cf09c1ad31e228758738c2f4e1c8fe9cc141291"
dependencies = [
"relay",
"serde",

2
packages/hoppscotch-desktop/src-tauri/Cargo.toml
View file

@ -30,7 +30,7 @@ tauri-plugin-dialog = "2.2.0"
tauri-plugin-fs = "2.2.0"
tauri-plugin-deep-link = "2.2.0"
tauri-plugin-appload = { git = "https://github.com/CuriousCorrelation/tauri-plugin-appload", rev = "e05861959938b57479a1a81fa796735ebbd08c7c" }
tauri-plugin-relay = { git = "https://github.com/CuriousCorrelation/tauri-plugin-relay", rev = "5d59b97fe331ca62e8be0454ff3f4e5f6185ae70" }
tauri-plugin-relay = { git = "https://github.com/CuriousCorrelation/tauri-plugin-relay", rev = "7cf09c1ad31e228758738c2f4e1c8fe9cc141291" }
axum = "0.8.1"
tower-http = { version = "0.6.2", features = ["cors"] }
random-port = "0.1.1"

2
packages/hoppscotch-kernel/package.json
View file

@ -48,7 +48,7 @@
}
},
"dependencies": {
"@hoppscotch/plugin-relay": "github:CuriousCorrelation/tauri-plugin-relay#5d59b97fe331ca62e8be0454ff3f4e5f6185ae70",
"@hoppscotch/plugin-relay": "github:CuriousCorrelation/tauri-plugin-relay#7cf09c1ad31e228758738c2f4e1c8fe9cc141291",
"@tauri-apps/plugin-dialog": "2.0.1",
"@tauri-apps/plugin-fs": "2.0.2",
"@tauri-apps/plugin-shell": "2.2.1",

1
packages/hoppscotch-kernel/src/relay/impl/desktop/v/1.ts
View file

@ -154,6 +154,7 @@ export const implementation: VersionedAPI<RelayV1> = {
auth: request.auth,
security: request.security,
proxy: request.proxy,
meta: request.meta,
}
return execute(pluginRequest)

10
pnpm-lock.yaml
View file

@ -1223,8 +1223,8 @@ importers:
packages/hoppscotch-kernel:
dependencies:
'@hoppscotch/plugin-relay':
specifier: github:CuriousCorrelation/tauri-plugin-relay#5d59b97fe331ca62e8be0454ff3f4e5f6185ae70
version: '@CuriousCorrelation/plugin-relay@https://codeload.github.com/CuriousCorrelation/tauri-plugin-relay/tar.gz/5d59b97fe331ca62e8be0454ff3f4e5f6185ae70'
specifier: github:CuriousCorrelation/tauri-plugin-relay#7cf09c1ad31e228758738c2f4e1c8fe9cc141291
version: '@CuriousCorrelation/plugin-relay@https://codeload.github.com/CuriousCorrelation/tauri-plugin-relay/tar.gz/7cf09c1ad31e228758738c2f4e1c8fe9cc141291'
'@tauri-apps/api':
specifier: 2.1.1
version: 2.1.1
@ -1859,8 +1859,8 @@ packages:
resolution: {tarball: https://codeload.github.com/CuriousCorrelation/tauri-plugin-appload/tar.gz/e05861959938b57479a1a81fa796735ebbd08c7c}
version: 0.1.0
'@CuriousCorrelation/plugin-relay@https://codeload.github.com/CuriousCorrelation/tauri-plugin-relay/tar.gz/5d59b97fe331ca62e8be0454ff3f4e5f6185ae70':
resolution: {tarball: https://codeload.github.com/CuriousCorrelation/tauri-plugin-relay/tar.gz/5d59b97fe331ca62e8be0454ff3f4e5f6185ae70}
'@CuriousCorrelation/plugin-relay@https://codeload.github.com/CuriousCorrelation/tauri-plugin-relay/tar.gz/7cf09c1ad31e228758738c2f4e1c8fe9cc141291':
resolution: {tarball: https://codeload.github.com/CuriousCorrelation/tauri-plugin-relay/tar.gz/7cf09c1ad31e228758738c2f4e1c8fe9cc141291}
version: 0.1.0
'@alloc/quick-lru@5.2.0':
@ -16014,7 +16014,7 @@ snapshots:
dependencies:
'@tauri-apps/api': 2.1.1
'@CuriousCorrelation/plugin-relay@https://codeload.github.com/CuriousCorrelation/tauri-plugin-relay/tar.gz/5d59b97fe331ca62e8be0454ff3f4e5f6185ae70':
'@CuriousCorrelation/plugin-relay@https://codeload.github.com/CuriousCorrelation/tauri-plugin-relay/tar.gz/7cf09c1ad31e228758738c2f4e1c8fe9cc141291':
dependencies:
'@tauri-apps/api': 2.1.1