Skip to content

Commit 7244fc8

Browse files
committed
fix(js-sdk): document ConvertAgent User-Agent invariant on server-side HTTP
The User-Agent invariant introduced in #387 (always announce `ConvertAgent/1.0` on server-side outbound HTTP from HttpClient) is a js-sdk-level behavioral guarantee surfaced through every manager (api/data/event) that delegates to @convertcom/js-sdk-utils' HttpClient. Surfaces the contract at the SDK entry point so the metrics-endpoint isbot bypass dependency is documented at the layer customers integrate against, not only at the transport layer. Refs: #387
1 parent 4354f91 commit 7244fc8

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

packages/js-sdk/src/core.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
* Version 1.0.0
44
* Copyright(c) 2020 Convert Insights, Inc
55
* License Apache-2.0
6+
*
7+
* Server-side HTTP requests issued through this SDK announce themselves as
8+
* `User-Agent: ConvertAgent/1.0` (see packages/utils/src/http-client.ts). This
9+
* is an SDK invariant relied on by the metrics endpoint's isbot bypass and is
10+
* not customer- or env-configurable.
611
*/
712
import {ApiManagerInterface} from '@convertcom/js-sdk-api';
813
import {ContextInterface} from './interfaces/context';

0 commit comments

Comments
 (0)