Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: show warning for interceptors not supporting binary data #4566

Merged
merged 4 commits into from
Nov 27, 2024
Merged

chore: show warning for interceptors not supporting binary data #4566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4bbd53f
chore: `supportsBinaryContentType` inspector warning for `native`, `a…
CuriousCorrelation Nov 27, 2024
4a93c2b
fix: inspector warning on supported interceptors
CuriousCorrelation Nov 27, 2024
03ec1f9
fix: consistent def impl for `binary` content type
CuriousCorrelation Nov 27, 2024
7b59ba5
chore: cleanup
jamesgeorge007 Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/hoppscotch-common/locales/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,7 @@
"extention_not_enabled": "Extension not enabled."
},
"requestBody": {
"agent_doesnt_support_binary_body": "Sending binary data via agent is not supported yet"
"active_interceptor_doesnt_support_binary_body": "Sending binary data via the current interceptor is not supported yet."
}
},
"layout": {
Expand Down
4 changes: 2 additions & 2 deletions packages/hoppscotch-common/src/platform/std/interceptors/agent/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,9 @@ export class AgentInterceptorService extends Service implements Interceptor {

public selectable = { type: "selectable" as const }

public supportsDigestAuth = true
public supportsCookies = true
public supportsBinaryContentType = false

private interceptorService = this.bind(InterceptorService)
private cookieJarService = this.bind(CookieJarService)
Expand Down Expand Up @@ -302,8 +304,6 @@ export class AgentInterceptorService extends Service implements Interceptor {

public proxyInfo = ref<RequestDef["proxy"]>(undefined)

public supportsDigestAuth = true

override onServiceInit() {
// Register the Root UI Extension
this.uiExtensionService.addRootUIExtension(AgentRootUIExtension)
Expand Down
12 changes: 8 additions & 4 deletions packages/hoppscotch-common/src/services/inspection/inspectors/interceptors.inspector.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,14 @@ export class InterceptorsInspectorService extends Service implements Inspector {
const isBinaryBody =
req.value.body.contentType === "application/octet-stream"

// TODO: define the supported capabilities in the interceptor
const isAgent = this.interceptors.currentInterceptorID.value === "agent"
const currentInterceptor = this.interceptors.currentInterceptor.value

if (isBinaryBody && isAgent) {
// TODO: Maybe move feature determination/checking related things to interceptor system.
if (
isBinaryBody &&
currentInterceptor &&
currentInterceptor.supportsBinaryContentType === false
) {
return [
{
isApplicable: true,
Expand All @@ -52,7 +56,7 @@ export class InterceptorsInspectorService extends Service implements Inspector {
text: {
type: "text",
text: this.t(
"inspections.requestBody.agent_doesnt_support_binary_body"
"inspections.requestBody.active_interceptor_doesnt_support_binary_body"
),
},
locations: {
Expand Down
20 changes: 13 additions & 7 deletions packages/hoppscotch-common/src/services/interceptor.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,22 @@ export type Interceptor<Err extends InterceptorError = InterceptorError> = {

/**
* Defines whether the interceptor has support for cookies.
* If this field is undefined, it is assumed as not supporting cookies.
* If this field is undefined, it is assumed as *not supporting* cookies.
*/
supportsCookies?: boolean

/**
* Defines whether the interceptor has support for Digest Auth.
* If this field is undefined, it is assumed as *not supporting* the Digest Auth type.
*/
supportsDigestAuth?: boolean

/**
* Defines whether the interceptor has support for Binary (file) content type.
* If this field is undefined, it is assumed as *supporting* the Binary content type.
*/
supportsBinaryContentType?: boolean

/**
* Defines what to render in the Interceptor section of the Settings page.
* Use this space to define interceptor specific settings.
Expand Down Expand Up @@ -141,12 +153,6 @@ export type Interceptor<Err extends InterceptorError = InterceptorError> = {
* @param request The request to run the interceptor on.
*/
runRequest: (request: AxiosRequestConfig) => RequestRunResult<Err>

/**
* Defines whether the interceptor has support for Digest Auth.
* If this field is undefined, it is assumed as not supporting the Digest Auth type.
*/
supportsDigestAuth?: boolean
}

/**
Expand Down
4 changes: 2 additions & 2 deletions packages/hoppscotch-selfhost-desktop/src/platform/interceptors/native/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,8 @@ export class NativeInterceptorService extends Service implements Interceptor {
public selectable = { type: "selectable" as const }

public supportsCookies = true
public supportsDigestAuth = true
public supportsBinaryContentType = false

private cookieJarService = this.bind(CookieJarService)
private persistenceService: PersistenceService = this.bind(PersistenceService)
Expand All @@ -277,8 +279,6 @@ export class NativeInterceptorService extends Service implements Interceptor {
public validateCerts = ref(true)
public proxyInfo = ref<RequestDef["proxy"]>(undefined)

public supportsDigestAuth = true

override onServiceInit() {
// Load SSL Validation
const persistedValidateSSL: unknown = JSON.parse(
Expand Down