Repository navigation
Expand file tree
/
Copy pathresolveDataCollectionOptions.ts
More file actions
61 lines (57 loc) · 2.5 KB
/
Copy pathresolveDataCollectionOptions.ts
File metadata and controls
61 lines (57 loc) · 2.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
import type { DataCollection, ResolvedDataCollection } from '../../types/datacollection';
import { defaultPiiToCollectionOptions } from './defaultPiiToCollectionOptions';
const DEFAULTS: ResolvedDataCollection = {
userInfo: true,
cookies: true,
httpHeaders: { request: true, response: true },
httpBodies: ['incomingRequest', 'outgoingRequest', 'incomingResponse', 'outgoingResponse'],
urlQueryParams: true,
graphQL: { document: true, variables: true },
genAI: { inputs: true, outputs: true },
databaseQueryData: true,
stackFrameVariables: true,
frameContextLines: 5,
};
/**
* Resolves the effective `DataCollection` configuration from client options.
*
* Precedence:
* 1. Fields explicitly set in `dataCollection`
* 2. If `sendDefaultPii` is set and `dataCollection` is absent, bridge via `defaultPiiToCollectionOptions`
* 3. Spec defaults
*
* TODO(v11): Remove `sendDefaultPii` support and always fall through to DEFAULTS so that `userInfo: true`
* NOTE: In v10, DEFAULTS only apply when `dataCollection` is explicitly provided.
* When `dataCollection` is absent, the legacy `sendDefaultPii` bridge is used, which defaults to
* `userInfo: false` to preserve backward compatibility.
*/
export function resolveDataCollectionOptions(options: {
dataCollection?: DataCollection;
sendDefaultPii?: boolean;
}): ResolvedDataCollection {
// TODO(v11): Remove the sendDefaultPii bridge and always use DEFAULTS.
const base = options.dataCollection != null ? DEFAULTS : defaultPiiToCollectionOptions(options.sendDefaultPii);
const dc = options.dataCollection ?? {};
return {
userInfo: dc.userInfo ?? base.userInfo,
cookies: dc.cookies ?? base.cookies,
httpHeaders: {
request: dc.httpHeaders?.request ?? base.httpHeaders.request,
response: dc.httpHeaders?.response ?? base.httpHeaders.response,
},
httpBodies: dc.httpBodies ?? base.httpBodies,
// oxlint-disable-next-line typescript/no-deprecated
urlQueryParams: dc.urlQueryParams ?? dc.queryParams ?? base.urlQueryParams,
graphQL: {
document: dc.graphQL?.document ?? base.graphQL.document,
variables: dc.graphQL?.variables ?? base.graphQL.variables,
},
genAI: {
inputs: dc.genAI?.inputs ?? base.genAI.inputs,
outputs: dc.genAI?.outputs ?? base.genAI.outputs,
},
databaseQueryData: dc.databaseQueryData ?? base.databaseQueryData,
stackFrameVariables: dc.stackFrameVariables ?? base.stackFrameVariables,
frameContextLines: dc.frameContextLines ?? base.frameContextLines,
};
}