/
recording.ts
179 lines (158 loc) · 5.35 KB
/
recording.ts
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
import defaultsDeep from 'lodash/defaultsDeep';
import { gunzipSync } from 'zlib';
import NodeHttpAdapter from '@pollyjs/adapter-node-http';
import { Polly, PollyConfig } from '@pollyjs/core';
import FSPersister from '@pollyjs/persister-fs';
import { HarEntry, Har } from '@pollyjs/persister';
Polly.register(NodeHttpAdapter);
Polly.register(FSPersister);
export type Recording = Polly;
export type RecordingEntry = HarEntry;
export interface SetupRecordingInput {
directory: string;
name: string;
redactedRequestHeaders?: string[];
redactedResponseHeaders?: string[];
mutateEntry?: (entry: any) => void;
mutateRequest?: (request: any) => void;
options?: PollyConfig;
}
const SENSITIVE_HEADER_NAMES = ['authorization'].map((i) => i.toLowerCase());
/**
* Sets up a recording of all http requests and writes the data to disk when it
* is stopped. This leverages Polly.js to do all the heavy lifting.
*
* @param input.mutateEntry allows mutating each `RecordingEntry` before being
* persisted.
*
* @param input.mutateRequest allows [mutating the
* `PollyRequest`](https://github.com/Netflix/pollyjs/blob/master/packages/%40pollyjs/core/src/-private/request.js#L30)
* object pre flight, affecting how the request is sent out and how it is
* stored. This is currently the only known way to get compressed (gzip, broli,
* etc.) requests to persist their body to the har file.
*
* @example
* ```typescript
* let recording;
* beforeEach(() => {
* recording = setupRecording({
* directory: __dirname,
* name: 'my recording',
* mutateEntry: (entry: RecordingEntry) => entry.response.content.text = '',
* mutateRequest: (request) => request.body = '';
* });
* });
* test('does some stuff', async () => {
* // make some requests
* });
* afterEach(async () => await recording.stop());
* ```
*/
export function setupRecording({
directory,
name,
redactedRequestHeaders = [],
redactedResponseHeaders = [],
mutateEntry,
mutateRequest,
options,
}: SetupRecordingInput): Polly {
const redactedRequestHeadersSet = new Set<string>([
...redactedRequestHeaders.map((h) => h.toLowerCase()),
...SENSITIVE_HEADER_NAMES,
]);
const redactedResponseHeadersSet = new Set<string>([
...redactedResponseHeaders.map((h) => h.toLowerCase()),
'set-cookie',
]);
class JupiterOneIntegationFSPersister extends FSPersister {
static get id(): string {
return 'JupiterOneIntegationFSPersister';
}
async onSaveRecording(recordingId: string, data: Har): Promise<void> {
data.log.entries.forEach((entry) => {
// Redact tokens, even though they expire
entry.request.headers = entry.request.headers.map((header) => ({
...header,
value: redactedRequestHeadersSet.has(header.name.toLowerCase())
? '[REDACTED]'
: header.value,
}));
// Redact all cookie values
entry.response.headers = entry.response.headers.map((header) => ({
...header,
value: redactedResponseHeadersSet.has(header.name.toLowerCase())
? '[REDACTED]'
: header.value,
}));
entry.response.cookies = entry.response.cookies.map((e) => ({
...e,
value: '[REDACTED]',
}));
mutateEntry?.(entry);
});
return super.onSaveRecording(recordingId, data);
}
}
class JupiterOneIntegrationAdapter extends NodeHttpAdapter {
static get id() {
return 'JupiterOneIntegrationAdapter';
}
onRequest(pollyRequest: any) {
mutateRequest?.(pollyRequest);
// types are not great on polly node http adapter
// eslint-disable-next-line
// @ts-ignore
return super.onRequest(pollyRequest);
}
}
Polly.register(JupiterOneIntegrationAdapter);
const defaultOptions = {
adapters: [JupiterOneIntegrationAdapter.id],
persister: JupiterOneIntegationFSPersister,
persisterOptions: {
JupiterOneIntegationFSPersister: {
recordingsDir: `${directory}/__recordings__`,
},
},
matchRequestsBy: {
headers: false,
body: false,
},
};
return new Polly(name, defaultsDeep(options, defaultOptions));
}
function unzipGzippedRecordingEntry(entry: RecordingEntry): void {
function unzipGzippedResponseText(responseText: string) {
const chunkBuffers: Buffer[] = [];
const hexChunks = JSON.parse(responseText) as string[];
hexChunks.forEach((chunk) => {
const chunkBuffer = Buffer.from(chunk, 'hex');
chunkBuffers.push(chunkBuffer);
});
return gunzipSync(Buffer.concat(chunkBuffers)).toString('utf-8');
}
let responseText = entry.response.content.text;
if (!responseText) {
return;
}
const contentEncoding = entry.response.headers.find(
(e) => e.name === 'content-encoding',
);
const transferEncoding = entry.response.headers.find(
(e) => e.name === 'transfer-encoding',
);
if (contentEncoding && contentEncoding.value === 'gzip') {
responseText = unzipGzippedResponseText(responseText);
// Remove encoding/chunking since content is now unzipped
entry.response.headers = entry.response.headers.filter(
(e) => e && e !== contentEncoding && e !== transferEncoding,
);
// Remove recording binary marker
delete (entry.response.content as any)._isBinary;
entry.response.content.text = responseText;
}
}
export const mutations = {
unzipGzippedRecordingEntry,
};