Merge #1739 into Got 12

szmarczak · szmarczak · commit f27e8d331627 · 2021-07-01T23:21:24.000+02:00
diff --git a/source/as-promise/types.ts b/source/as-promise/types.ts
@@ -15,6 +15,7 @@ export class CancelError extends RequestError {
 	constructor(request: Request) {
 		super('Promise was canceled', {}, request);
 		this.name = 'CancelError';
+		this.code = 'ERR_CANCELED';
 	}
 
 	get isCanceled() {
diff --git a/source/core/calculate-retry-delay.ts b/source/core/calculate-retry-delay.ts
@@ -18,7 +18,7 @@ const calculateRetryDelay: Returns<RetryFunction, number> = ({
 	}
 
 	const hasMethod = retryOptions.methods.includes(error.options.method);
-	const hasErrorCode = retryOptions.errorCodes.includes(error.code!);
+	const hasErrorCode = retryOptions.errorCodes.includes(error.code);
 	const hasStatusCode = error.response && retryOptions.statusCodes.includes(error.response.statusCode);
 	if (!hasMethod || (!hasErrorCode && !hasStatusCode)) {
 		return 0;
diff --git a/source/core/errors.ts b/source/core/errors.ts
@@ -19,7 +19,7 @@ Contains a `code` property with error class code, like `ECONNREFUSED`.
 export class RequestError extends Error {
 	input?: string;
 
-	code?: string;
+	code: string;
 	stack!: string;
 	declare readonly options: Options;
 	readonly response?: Response;
@@ -31,7 +31,7 @@ export class RequestError extends Error {
 		Error.captureStackTrace(this, this.constructor);
 
 		this.name = 'RequestError';
-		this.code = error.code;
+		this.code = error.code ?? 'ERR_GOT_REQUEST_ERROR';
 		this.input = (error as any).input;
 
 		if (isRequest(self)) {
@@ -80,6 +80,7 @@ export class MaxRedirectsError extends RequestError {
 	constructor(request: Request) {
 		super(`Redirected ${request.options.maxRedirects} times. Aborting.`, {}, request);
 		this.name = 'MaxRedirectsError';
+		this.code = 'ERR_TOO_MANY_REDIRECTS';
 	}
 }
 
@@ -95,6 +96,7 @@ export class HTTPError extends RequestError {
 	constructor(response: PlainResponse) {
 		super(`Response code ${response.statusCode} (${response.statusMessage!})`, {}, response.request);
 		this.name = 'HTTPError';
+		this.code = 'ERR_NON_2XX_3XX_RESPONSE';
 	}
 }
 
@@ -108,6 +110,7 @@ export class CacheError extends RequestError {
 	constructor(error: Error, request: Request) {
 		super(error.message, error, request);
 		this.name = 'CacheError';
+		this.code = this.code === 'ERR_GOT_REQUEST_ERROR' ? 'ERR_CACHE_ACCESS' : this.code;
 	}
 }
 
@@ -120,6 +123,7 @@ export class UploadError extends RequestError {
 	constructor(error: Error, request: Request) {
 		super(error.message, error, request);
 		this.name = 'UploadError';
+		this.code = this.code === 'ERR_GOT_REQUEST_ERROR' ? 'ERR_UPLOAD' : this.code;
 	}
 }
 
@@ -151,6 +155,7 @@ export class ReadError extends RequestError {
 	constructor(error: Error, request: Request) {
 		super(error.message, error, request);
 		this.name = 'ReadError';
+		this.code = this.code === 'ERR_GOT_REQUEST_ERROR' ? 'ERR_READING_RESPONSE_STREAM' : this.code;
 	}
 }
 
diff --git a/source/core/options.ts b/source/core/options.ts
@@ -1166,7 +1166,10 @@ export default class Options {
 		}
 
 		if (url.protocol !== 'http:' && url.protocol !== 'https:') {
-			throw new Error(`Unsupported protocol: ${url.protocol}`);
+			const error: NodeJS.ErrnoException = new Error(`Unsupported protocol: ${url.protocol}`);
+			error.code = 'ERR_UNSUPPORTED_PROTOCOL';
+
+			throw error;
 		}
 
 		if (this._internals.username) {
diff --git a/source/core/response.ts b/source/core/response.ts
@@ -123,6 +123,7 @@ export class ParseError extends RequestError {
 
 		super(`${error.message} in "${options.url!.toString()}"`, error, response.request);
 		this.name = 'ParseError';
+		this.code = 'ERR_BODY_PARSE_FAILURE';
 	}
 }
 
diff --git a/test/cache.ts b/test/cache.ts
@@ -121,7 +121,10 @@ test('cache error throws `CacheError`', withServer, async (t, server, got) => {
 	const cache = {};
 
 	// @ts-expect-error Error tests
-	await t.throwsAsync(got({cache}), {instanceOf: CacheError});
+	await t.throwsAsync(got({cache}), {
+		instanceOf: CacheError,
+		code: 'ERR_CACHE_ACCESS'
+	});
 });
 
 test('doesn\'t cache response when received HTTP error', withServer, async (t, server, got) => {
diff --git a/test/cancel.ts b/test/cancel.ts
@@ -78,7 +78,10 @@ test.serial('does not retry after cancelation', withServerAndFakeTimers, async (
 		gotPromise.cancel();
 	});
 
-	await t.throwsAsync(gotPromise, {instanceOf: CancelError});
+	await t.throwsAsync(gotPromise, {
+		instanceOf: CancelError,
+		code: 'ERR_CANCELED'
+	});
 	await t.notThrowsAsync(promise, 'Request finished instead of aborting.');
 });
 
@@ -105,7 +108,10 @@ test.serial('cleans up request timeouts', withServer, async (t, server, got) =>
 		}
 	});
 
-	await t.throwsAsync(gotPromise, {instanceOf: CancelError});
+	await t.throwsAsync(gotPromise, {
+		instanceOf: CancelError,
+		code: 'ERR_CANCELED'
+	});
 
 	// Wait for unhandled errors
 	await delay(40);
@@ -127,7 +133,10 @@ test.serial('cancels in-progress request', withServerAndFakeTimers, async (t, se
 		body.push(null);
 	});
 
-	await t.throwsAsync(gotPromise, {instanceOf: CancelError});
+	await t.throwsAsync(gotPromise, {
+		instanceOf: CancelError,
+		code: 'ERR_CANCELED'
+	});
 	await t.notThrowsAsync(promise, 'Request finished instead of aborting.');
 });
 
@@ -147,7 +156,10 @@ test.serial('cancels in-progress request with timeout', withServerAndFakeTimers,
 		body.push(null);
 	});
 
-	await t.throwsAsync(gotPromise, {instanceOf: CancelError});
+	await t.throwsAsync(gotPromise, {
+		instanceOf: CancelError,
+		code: 'ERR_CANCELED'
+	});
 	await t.notThrowsAsync(promise, 'Request finished instead of aborting.');
 });
 
@@ -227,7 +239,10 @@ test.serial('throws on incomplete (canceled) response - promise #2', withServer,
 		promise.cancel();
 	}, 500);
 
-	await t.throwsAsync(promise, {instanceOf: CancelError});
+	await t.throwsAsync(promise, {
+		instanceOf: CancelError,
+		code: 'ERR_CANCELED'
+	});
 });
 
 test.serial('throws on incomplete (canceled) response - stream', withServerAndFakeTimers, async (t, server, got, clock) => {
@@ -255,5 +270,8 @@ test('throws when canceling cached request', withServer, async (t, server, got)
 	const promise = got({cache});
 	promise.cancel();
 
-	await t.throwsAsync(promise, {instanceOf: CancelError});
+	await t.throwsAsync(promise, {
+		instanceOf: CancelError,
+		code: 'ERR_CANCELED'
+	});
 });
diff --git a/test/error.ts b/test/error.ts
@@ -27,7 +27,7 @@ test('properties', withServer, async (t, server, got) => {
 	t.truthy(error.options);
 	t.true({}.propertyIsEnumerable.call(error, 'options'));
 	t.false({}.propertyIsEnumerable.call(error, 'response'));
-	t.is(error.code, undefined);
+	t.is(error.code, 'ERR_NON_2XX_3XX_RESPONSE');
 	t.is(error.message, 'Response code 404 (Not Found)');
 	t.deepEqual(error.options.url, url);
 	t.is(error.response.headers.connection, 'close');
@@ -40,6 +40,7 @@ test('catches dns errors', async t => {
 	t.regex(error.message, /ENOTFOUND|EAI_AGAIN/);
 	t.is((error.options.url as URL).host, 'doesntexist');
 	t.is(error.options.method, 'GET');
+	t.is(error.code, 'ENOTFOUND');
 });
 
 test('`options.body` form error message', async t => {
@@ -132,7 +133,8 @@ test('`http.request` error', async t => {
 		}
 	}), {
 		instanceOf: RequestError,
-		message: 'The header content contains invalid characters'
+		message: 'The header content contains invalid characters',
+		code: 'ERR_GOT_REQUEST_ERROR'
 	});
 });
 
@@ -236,7 +238,8 @@ test('promise does not hang on timeout on HTTP error', withServer, async (t, ser
 			request: 100
 		}
 	}), {
-		instanceOf: TimeoutError
+		instanceOf: TimeoutError,
+		code: 'ETIMEDOUT'
 	});
 });
 
diff --git a/test/http.ts b/test/http.ts
@@ -93,7 +93,8 @@ test('doesn\'t throw if `options.throwHttpErrors` is false', withServer, async (
 test('invalid protocol throws', async t => {
 	await t.throwsAsync(got('c:/nope.com').json(), {
 		instanceOf: RequestError,
-		message: 'Unsupported protocol: c:'
+		message: 'Unsupported protocol: c:',
+		code: 'ERR_UNSUPPORTED_PROTOCOL'
 	});
 });
 
@@ -226,7 +227,8 @@ test('throws an error if the server aborted the request', withServer, async (t,
 	});
 
 	const error = await t.throwsAsync<ReadError>(got(''), {
-		message: 'The server aborted pending request'
+		message: 'The server aborted pending request',
+		code: 'ECONNRESET'
 	});
 
 	t.truthy(error.response.retryCount);
diff --git a/test/post.ts b/test/post.ts
@@ -334,7 +334,8 @@ test('throws on upload error', withServer, async (t, server, got) => {
 		}
 	})), {
 		instanceOf: UploadError,
-		message
+		message,
+		code: 'ERR_UPLOAD'
 	});
 });
 
diff --git a/test/promise.ts b/test/promise.ts
@@ -71,8 +71,14 @@ test('promise.json() can be called before a file stream body is open', withServe
 
 	const promise = got({body});
 	const checks = [
-		t.throwsAsync(promise, {instanceOf: CancelError}),
-		t.throwsAsync(promise.json(), {instanceOf: CancelError})
+		t.throwsAsync(promise, {
+			instanceOf: CancelError,
+			code: 'ERR_CANCELED'
+		}),
+		t.throwsAsync(promise.json(), {
+			instanceOf: CancelError,
+			code: 'ERR_CANCELED'
+		})
 	];
 
 	promise.cancel();
diff --git a/test/redirects.ts b/test/redirects.ts
@@ -84,6 +84,7 @@ test('throws on endless redirects - default behavior', withServer, async (t, ser
 	const error = await t.throwsAsync<MaxRedirectsError>(got(''), {message: 'Redirected 10 times. Aborting.'});
 
 	t.deepEqual(error.response.redirectUrls.map(x => String(x)), Array.from({length: 10}).fill(`${server.url}/`));
+	t.is(error.code, 'ERR_TOO_MANY_REDIRECTS');
 });
 
 test('custom `maxRedirects` option', withServer, async (t, server, got) => {
@@ -97,6 +98,7 @@ test('custom `maxRedirects` option', withServer, async (t, server, got) => {
 	const error = await t.throwsAsync<MaxRedirectsError>(got('', {maxRedirects: 5}), {message: 'Redirected 5 times. Aborting.'});
 
 	t.deepEqual(error.response.redirectUrls.map(x => String(x)), Array.from({length: 5}).fill(`${server.url}/`));
+	t.is(error.code, 'ERR_TOO_MANY_REDIRECTS');
 });
 
 test('searchParams are not breaking redirects', withServer, async (t, server, got) => {
@@ -123,7 +125,8 @@ test('redirects GET and HEAD requests', withServer, async (t, server, got) => {
 	});
 
 	await t.throwsAsync(got.get(''), {
-		instanceOf: MaxRedirectsError
+		instanceOf: MaxRedirectsError,
+		code: 'ERR_TOO_MANY_REDIRECTS'
 	});
 });
 
@@ -136,7 +139,8 @@ test('redirects POST requests', withServer, async (t, server, got) => {
 	});
 
 	await t.throwsAsync(got.post({body: 'wow'}), {
-		instanceOf: MaxRedirectsError
+		instanceOf: MaxRedirectsError,
+		code: 'ERR_TOO_MANY_REDIRECTS'
 	});
 });
 
diff --git a/test/response-parse.ts b/test/response-parse.ts
@@ -98,6 +98,7 @@ test('wraps parsing errors', withServer, async (t, server, got) => {
 	const error = await t.throwsAsync<ParseError>(got({responseType: 'json'}), {instanceOf: ParseError});
 	t.true(error.message.includes((error.options.url as URL).hostname));
 	t.is((error.options.url as URL).pathname, '/');
+	t.is(error.code, 'ERR_BODY_PARSE_FAILURE');
 });
 
 test('parses non-200 responses', withServer, async (t, server, got) => {
@@ -134,6 +135,7 @@ test('parse errors have `response` property', withServer, async (t, server, got)
 
 	t.is(error.response.statusCode, 200);
 	t.is(error.response.body, '/');
+	t.is(error.code, 'ERR_BODY_PARSE_FAILURE');
 });
 
 test('sets correct headers', withServer, async (t, server, got) => {
@@ -184,7 +186,8 @@ test('shortcuts throw ParseErrors', withServer, async (t, server, got) => {
 
 	await t.throwsAsync(got('').json(), {
 		instanceOf: ParseError,
-		message: /^Unexpected token o in JSON at position 1 in/
+		message: /^Unexpected token o in JSON at position 1 in/,
+		code: 'ERR_BODY_PARSE_FAILURE'
 	});
 });
 
diff --git a/test/retry.ts b/test/retry.ts
@@ -188,7 +188,7 @@ test('custom error codes', async t => {
 		},
 		retry: {
 			calculateDelay: ({error}) => {
-				t.is(error.code! as typeof errorCode, errorCode);
+				t.is(error.code, errorCode);
 				return 0;
 			},
 			methods: [

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ export class CancelError extends RequestError {`
`15`	`15`	`constructor(request: Request) {`
`16`	`16`	`super('Promise was canceled', {}, request);`
`17`	`17`	`this.name = 'CancelError';`
	`18`	`+ this.code = 'ERR_CANCELED';`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`get isCanceled() {`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ const calculateRetryDelay: Returns<RetryFunction, number> = ({`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`const hasMethod = retryOptions.methods.includes(error.options.method);`
`21`		`- const hasErrorCode = retryOptions.errorCodes.includes(error.code!);`
	`21`	`+ const hasErrorCode = retryOptions.errorCodes.includes(error.code);`
`22`	`22`	`const hasStatusCode = error.response && retryOptions.statusCodes.includes(error.response.statusCode);`
`23`	`23`	`if (!hasMethod \|\| (!hasErrorCode && !hasStatusCode)) {`
`24`	`24`	`return 0;`
Original file line number	Diff line number	Diff line change
@@ -19,7 +19,7 @@ Contains a `code` property with error class code, like `ECONNREFUSED`.
`19`	`19`	`export class RequestError extends Error {`
`20`	`20`	`input?: string;`
`21`	`21`
`22`		`- code?: string;`
	`22`	`+ code: string;`
`23`	`23`	`stack!: string;`
`24`	`24`	`declare readonly options: Options;`
`25`	`25`	`readonly response?: Response;`
`@@ -31,7 +31,7 @@ export class RequestError extends Error {`
`31`	`31`	`Error.captureStackTrace(this, this.constructor);`
`32`	`32`
`33`	`33`	`this.name = 'RequestError';`
`34`		`- this.code = error.code;`
	`34`	`+ this.code = error.code ?? 'ERR_GOT_REQUEST_ERROR';`
`35`	`35`	`this.input = (error as any).input;`
`36`	`36`
`37`	`37`	`if (isRequest(self)) {`
`@@ -80,6 +80,7 @@ export class MaxRedirectsError extends RequestError {`
`80`	`80`	`constructor(request: Request) {`
`81`	`81`	super(`Redirected ${request.options.maxRedirects} times. Aborting.`, {}, request);
`82`	`82`	`this.name = 'MaxRedirectsError';`
	`83`	`+ this.code = 'ERR_TOO_MANY_REDIRECTS';`
`83`	`84`	`}`
`84`	`85`	`}`
`85`	`86`
`@@ -95,6 +96,7 @@ export class HTTPError extends RequestError {`
`95`	`96`	`constructor(response: PlainResponse) {`
`96`	`97`	super(`Response code ${response.statusCode} (${response.statusMessage!})`, {}, response.request);
`97`	`98`	`this.name = 'HTTPError';`
	`99`	`+ this.code = 'ERR_NON_2XX_3XX_RESPONSE';`
`98`	`100`	`}`
`99`	`101`	`}`
`100`	`102`
`@@ -108,6 +110,7 @@ export class CacheError extends RequestError {`
`108`	`110`	`constructor(error: Error, request: Request) {`
`109`	`111`	`super(error.message, error, request);`
`110`	`112`	`this.name = 'CacheError';`
	`113`	`+ this.code = this.code === 'ERR_GOT_REQUEST_ERROR' ? 'ERR_CACHE_ACCESS' : this.code;`
`111`	`114`	`}`
`112`	`115`	`}`
`113`	`116`
`@@ -120,6 +123,7 @@ export class UploadError extends RequestError {`
`120`	`123`	`constructor(error: Error, request: Request) {`
`121`	`124`	`super(error.message, error, request);`
`122`	`125`	`this.name = 'UploadError';`
	`126`	`+ this.code = this.code === 'ERR_GOT_REQUEST_ERROR' ? 'ERR_UPLOAD' : this.code;`
`123`	`127`	`}`
`124`	`128`	`}`
`125`	`129`
`@@ -151,6 +155,7 @@ export class ReadError extends RequestError {`
`151`	`155`	`constructor(error: Error, request: Request) {`
`152`	`156`	`super(error.message, error, request);`
`153`	`157`	`this.name = 'ReadError';`
	`158`	`+ this.code = this.code === 'ERR_GOT_REQUEST_ERROR' ? 'ERR_READING_RESPONSE_STREAM' : this.code;`
`154`	`159`	`}`
`155`	`160`	`}`
`156`	`161`
Original file line number	Diff line number	Diff line change
`@@ -1166,7 +1166,10 @@ export default class Options {`
`1166`	`1166`	`}`
`1167`	`1167`
`1168`	`1168`	`if (url.protocol !== 'http:' && url.protocol !== 'https:') {`
`1169`		- throw new Error(`Unsupported protocol: ${url.protocol}`);
	`1169`	+ const error: NodeJS.ErrnoException = new Error(`Unsupported protocol: ${url.protocol}`);
	`1170`	`+ error.code = 'ERR_UNSUPPORTED_PROTOCOL';`
	`1171`	`+`
	`1172`	`+ throw error;`
`1170`	`1173`	`}`
`1171`	`1174`
`1172`	`1175`	`if (this._internals.username) {`
Original file line number	Diff line number	Diff line change
`@@ -123,6 +123,7 @@ export class ParseError extends RequestError {`
`123`	`123`
`124`	`124`	super(`${error.message} in "${options.url!.toString()}"`, error, response.request);
`125`	`125`	`this.name = 'ParseError';`
	`126`	`+ this.code = 'ERR_BODY_PARSE_FAILURE';`
`126`	`127`	`}`
`127`	`128`	`}`
`128`	`129`
Original file line number	Diff line number	Diff line change
`@@ -334,7 +334,8 @@ test('throws on upload error', withServer, async (t, server, got) => {`
`334`	`334`	`}`
`335`	`335`	`})), {`
`336`	`336`	`instanceOf: UploadError,`
`337`		`- message`
	`337`	`+ message,`
	`338`	`+ code: 'ERR_UPLOAD'`
`338`	`339`	`});`
`339`	`340`	`});`
`340`	`341`