Skip to content

feat(utils): always announce as Convert SDK via ConvertAgent User-Agent #387

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

Merged
JosephSamirL merged 2 commits into from
May 25, 2026
Merged

feat(utils): always announce as Convert SDK via ConvertAgent User-Agent #387

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa7e6f9
feat(utils): always announce as Convert SDK via ConvertAgent User-Agent
abbaseya May 22, 2026
652073f
refactor(utils): extract CONVERT_AGENT_USER_AGENT as a module constant
abbaseya May 22, 2026
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
21 changes: 20 additions & 1 deletion packages/utils/src/http-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ import {ERROR_MESSAGES, MESSAGES} from '@convertcom/js-sdk-enums';
import type {RequestOptions} from 'https';
import {objectNotEmpty} from './object-utils';

/**
* Server-side User-Agent advertised by the SDK so the metrics-endpoint
* bot filter recognises Convert traffic via its `isConvertAgentUA` bypass.
*/
const CONVERT_AGENT_USER_AGENT = 'ConvertAgent/1.0';

export type HttpMethod =
| 'GET'
| 'DELETE'
Expand Down Expand Up @@ -204,6 +210,16 @@ export const HttpClient = {
keepalive: true // to allow the request to complete even if the page unloads
};
if (config?.headers) options.headers = config.headers;
// Always announce as Convert SDK traffic on server-side so the
// metrics-endpoint bot filter recognises us via its
// `isConvertAgentUA` bypass. Skip in browser — browsers strip
// User-Agent per the W3C forbidden-header list, and a browser's
// natural UA does not trigger isbot.
if (runtimeResult.runtime !== 'browser') {
if (!options.headers) options.headers = {};
(options.headers as Record<string, string>)['User-Agent'] =
CONVERT_AGENT_USER_AGENT;
}
if (config?.data && supportsRequestBody(method)) {
options.body = JSON.stringify(config.data);
}
Expand Down Expand Up @@ -317,8 +333,11 @@ export const HttpClient = {
? JSON.stringify(config.data)
: null;
if (config?.headers) options.headers = config.headers;
// See note in the fetch branch above. old-nodejs is always
// server-side, so the UA announcement always applies.
if (!options.headers) options.headers = {};
options.headers['User-Agent'] = CONVERT_AGENT_USER_AGENT;
if (postData) {
if (!options.headers) options.headers = {};
options.headers['Content-Length'] = Buffer.byteLength(postData);
}
const req = client.request(options, (res) => {
Expand Down
Loading