Don't freeze signal when freezing Options (#2100)

svvac · web-flow · commit 43b14674ab12 · 2022-08-05T15:32:45.000+02:00
diff --git a/source/core/options.ts b/source/core/options.ts
@@ -2521,6 +2521,5 @@ export default class Options {
 		Object.freeze(options.retry.methods);
 		Object.freeze(options.retry.statusCodes);
 		Object.freeze(options.context);
-		Object.freeze(options.signal);
 	}
 }
diff --git a/test/abort.ts b/test/abort.ts
@@ -271,4 +271,17 @@ if (globalThis.AbortController !== undefined) {
 			message: 'This operation was aborted.',
 		});
 	});
+
+	test('support setting the signal as a default option', async t => {
+		const controller = new AbortController();
+
+		const got2 = got.extend({signal: controller.signal});
+		const p = got2('http://example.com', {signal: controller.signal});
+		controller.abort();
+
+		await t.throwsAsync(p, {
+			code: 'ERR_ABORTED',
+			message: 'This operation was aborted.',
+		});
+	});
 }
diff --git a/test/normalize-arguments.ts b/test/normalize-arguments.ts
@@ -167,3 +167,18 @@ test('searchParams - multiple values for one key', t => {
 		['100', '200', '300'],
 	);
 });
+
+if (globalThis.AbortSignal !== undefined) {
+	test('signal does not get frozen', t => {
+		const controller = new AbortController();
+		const {signal} = controller;
+
+		const options = new Options({
+			url: new URL('http://localhost'),
+			signal,
+		});
+		options.freeze();
+
+		t.is(Object.isFrozen(options.signal), false);
+	});
+}

Original file line number	Diff line number	Diff line change
`@@ -2521,6 +2521,5 @@ export default class Options {`
`2521`	`2521`	`Object.freeze(options.retry.methods);`
`2522`	`2522`	`Object.freeze(options.retry.statusCodes);`
`2523`	`2523`	`Object.freeze(options.context);`
`2524`		`- Object.freeze(options.signal);`
`2525`	`2524`	`}`
`2526`	`2525`	`}`