Skip to content

fix: map interactive UI query params to request headers for GET-based toggles #1225

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

Open
VarunKumar-05 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: map interactive UI query params to request headers for GET-based toggles #1225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae4b91d
registry: map common query params to request headers to support GET-b…
Oct 25, 2025
6e4c81e
registry: map common query params to request headers to support GET-b…
VarunKumar-05 Oct 25, 2025
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
1 change: 1 addition & 0 deletions src/api/crawler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,7 @@ export class CrawlerHost extends RPCHost {
crawlerOptionsHeaderOnly: CrawlerOptionsHeaderOnly,
crawlerOptionsParamsAllowed: CrawlerOptions,
) {
this.logger.debug('Incoming headers', { headers: ctx.request.headers });
const uid = await auth.solveUID();
let chargeAmount = 0;
const crawlerOptions = ctx.method === 'GET' ? crawlerOptionsHeaderOnly : crawlerOptionsParamsAllowed;
Expand Down
66 changes: 66 additions & 0 deletions src/services/registry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ export class RPCRegistry extends KoaRPCRegistry {

override koaMiddlewares = [
this.__CORSAllowAllMiddleware.bind(this),
// Map UI-friendly query params -> request headers so GET requests from interactive builder work
this.__mapQueryToHeaders.bind(this),
bodyParser({
encoding: 'utf-8',
enableTypes: ['json', 'form'],
Expand Down Expand Up @@ -53,6 +55,70 @@ export class RPCRegistry extends KoaRPCRegistry {
this.emit('ready');
}

/**
* Translate well-known query parameters into request headers so that:
* - GET requests (used by the interactive builder) can pass options in query params,
* - downstream code that inspects headers (x-respond-with, x-with-generated-alt, Accept, etc.)
* will behave identically.
*
* Example mappings:
* ?respond_with=markdown => x-respond-with: markdown
* ?with_generated_alt=true => x-with-generated-alt: true
* ?no_cache=true => x-no-cache: true
* ?wait_for_selector=#content => x-wait-for-selector: #content
* ?target_selector=.main => x-target-selector: .main
* ?proxy=https://proxy:3128 => x-proxy-url: https://proxy:3128
* ?cache_tolerance=120 => x-cache-tolerance: 120
* ?timeout=30 => x-timeout: 30
* ?accept=application/json => Accept: application/json
*/
async __mapQueryToHeaders(ctx: any, next: any) {
try {
const q = ctx.query || {};
const map: Record<string, string> = {
'respond_with': 'x-respond-with',
'respondWith': 'x-respond-with',
'with_generated_alt': 'x-with-generated-alt',
'withGeneratedAlt': 'x-with-generated-alt',
'no_cache': 'x-no-cache',
'noCache': 'x-no-cache',
'wait_for_selector': 'x-wait-for-selector',
'waitForSelector': 'x-wait-for-selector',
'target_selector': 'x-target-selector',
'targetSelector': 'x-target-selector',
'proxy': 'x-proxy-url',
'proxy_url': 'x-proxy-url',
'proxyUrl': 'x-proxy-url',
'cache_tolerance': 'x-cache-tolerance',
'cacheTolerance': 'x-cache-tolerance',
'timeout': 'x-timeout',
'accept': 'accept',
};

for (const [qp, headerName] of Object.entries(map)) {
const v = q[qp];
if (v !== undefined && v !== null && String(v) !== '') {
// Koa request headers object is normally readonly in types; cast to any to assign
(ctx.request.headers as any)[headerName] = String(v);
}
}

// Support boolean flags present without value (e.g. ?with_generated_alt)
const booleanFlags = ['with_generated_alt', 'withGeneratedAlt', 'no_cache', 'noCache'];
for (const f of booleanFlags) {
if (Object.prototype.hasOwnProperty.call(q, f) && (q[f] === '' || q[f] === undefined)) {
const headerName = map[f];
(ctx.request.headers as any)[headerName] = 'true';
}
}
} catch (err) {
// don't fail the request on mapping errors; log and continue
this.logger.warn(`Failed to map query params to headers: ${err}`, { err });
}

return next();
}

}

const instance = container.resolve(RPCRegistry);
Expand Down