Maximum allowed response length

[jiripospisil]

It would be great if it was possible to set the maximum allowed response length. If the response was larger than that, it would report an error. It should not rely on the response's Content-Length.

Looking at the available API, it could be done manually by consuming the response as stream and counting but exposing it as an option would be more user friendly.

const response = await got(url, {
  maxResponseLength: 123, // bytes
});

[szmarczak]

https://github.com/sindresorhus/got/blob/master/advanced-creation.md#limiting-download--upload

[benjie]

The above has moved to:

https://github.com/sindresorhus/got/blob/master/documentation/advanced-creation.md#limiting-download--upload-size

Permalink:

https://github.com/sindresorhus/got/blob/49c16ee54fb19ea7aa77e24ac8c2b602f0aad265/documentation/advanced-creation.md#limiting-download--upload-size

[szmarczak]

@benjie Good spot. Also it's not compatible with streams, since they use stream.destroy. Although we can make stream.cancel an alias to stream.destroy.

[benjie]

That seems wise; or update the doc. Thanks for the heads up 🙏

[szmarczak]

Updated:

got/documentation/examples/advanced-creation.js

Lines 40 to 77 in 4880017

	// Limiting download & upload size
	// This can prevent crashing due to insufficient memory
	const limitDownloadUpload = got.extend({
	handlers: [
	(options, next) => {
	const {downloadLimit, uploadLimit} = options.context;
	let promiseOrStream = next(options);
	// A destroy function that supports both promises and streams
	const destroy = message => {
	if (options.isStream) {
	promiseOrStream.destroy(new Error(message));
	return;
	}
	promiseOrStream.cancel(message);
	};
	if (typeof downloadLimit === 'number') {
	promiseOrStream.on('downloadProgress', progress => {
	if (progress.transferred > downloadLimit && progress.percent !== 1) {
	destroy(`Exceeded the download limit of ${downloadLimit} bytes`);
	}
	});
	}
	if (typeof uploadLimit === 'number') {
	promiseOrStream.on('uploadProgress', progress => {
	if (progress.transferred > uploadLimit && progress.percent !== 1) {
	destroy(`Exceeded the upload limit of ${uploadLimit} bytes`);
	}
	});
	}
	return promiseOrStream;
	}
	]
	});