balena-request 13.3.2 → 13.3.3

package/.versionbot/CHANGELOG.yml

@@ -1,3 +1,39 @@
+- commits:
+    - subject: "Tests: add missing @types/temp dependency"
+      hash: 2698e0be2a764268831bf2388c82fabeeac542a4
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: "Tests: remove bluebird dependency"
+      hash: 461710c7c2e7b76e7141ae920e668bf93620e745
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: "Tests: remove rindle dependency"
+      hash: 27fca4510937b79cf796be5985ff251d0cd33ece
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: Update `author` in package.json
+      hash: b7d09e73d66a2253b672fabae3b4f1d5c111247d
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+  version: 13.3.3
+  title: ""
+  date: 2024-12-03T15:16:48.769Z
 - commits:
     - subject: Fix always following redirects when followRedirect = false
       hash: 34db7e138eabfcfcfd822133b391c738d01de323
@@ -9,7 +45,7 @@
       nested: []
   version: 13.3.2
   title: ""
-  date: 2024-07-12T08:40:03.970Z
+  date: 2024-07-12T09:16:13.529Z
 - commits:
     - subject: Update balena-auth to 6.0.1
       hash: 1d3cd469288f2dd0e1ed70a292778b70bd518528

package/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file
 automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 13.3.3 - 2024-12-03
+
+* Tests: add missing @types/temp dependency [Pagan Gazzard]
+* Tests: remove bluebird dependency [Pagan Gazzard]
+* Tests: remove rindle dependency [Pagan Gazzard]
+* Update `author` in package.json [Pagan Gazzard]
+
 ## 13.3.2 - 2024-07-12
 
 * Fix always following redirects when followRedirect = false [Thodoris Greasidis]

package/build/request.js

@@ -246,17 +246,8 @@ function getRequest({ auth, debug = false, retries = 0, isBrowser = false, inter
                 return download;
             }
             // If status code is an error code, interpret the body of the request as an error.
-            const chunks = [];
-            download.on('data', function (chunk) {
-                chunks.push(chunk);
-            });
-            yield new Promise((resolve, reject) => {
-                download.on('error', reject);
-                download.on('close', resolve);
-                download.on('end', resolve);
-                download.on('done', resolve);
-            });
-            const responseError = chunks.join() || 'The request was unsuccessful';
+            const data = yield utils.getStreamContents(download);
+            const responseError = data || 'The request was unsuccessful';
             debugRequest(options, download.response);
             // @ts-expect-error error without request options
             throw new errors.BalenaRequestError(responseError, download.response.statusCode);

package/build/utils.d.ts

@@ -1,5 +1,6 @@
 import type BalenaAuth from 'balena-auth';
 import type { BalenaRequestOptions, BalenaRequestResponse } from './request';
+import { Readable } from 'stream';
 /**
  * @module utils
  */
@@ -147,3 +148,11 @@ export declare function getBody(response: BalenaRequestResponse, responseFormat?
  * 	console.log(response)
  */
 export declare function getRequestAsync($fetch?: typeof fetch): (options: BalenaRequestOptions) => Promise<BalenaRequestResponse<any>>;
+/**
+ * @summary A function that returns the contents of a stream
+ * @function
+ * @protected
+ *
+ * @param {Readable} [stream] - the stream to get the contents of
+ */
+export declare function getStreamContents(stream: Readable): Promise<string>;

package/build/utils.js

@@ -25,6 +25,7 @@ exports.getResponseLength = getResponseLength;
 exports.debugRequest = debugRequest;
 exports.getBody = getBody;
 exports.getRequestAsync = getRequestAsync;
+exports.getStreamContents = getStreamContents;
 const tslib_1 = require("tslib");
 const { fetch: normalFetch, Headers: HeadersPonyfill } = 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
@@ -477,3 +478,25 @@ function handleAbortIfNotSupported(signal, response) {
 function getRequestAsync($fetch = normalFetch) {
     return (options) => requestAsync($fetch, options);
 }
+/**
+ * @summary A function that returns the contents of a stream
+ * @function
+ * @protected
+ *
+ * @param {Readable} [stream] - the stream to get the contents of
+ */
+function getStreamContents(stream) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const chunks = [];
+        stream.on('data', function (chunk) {
+            chunks.push(chunk);
+        });
+        yield new Promise((resolve, reject) => {
+            stream.on('error', reject);
+            stream.on('close', resolve);
+            stream.on('end', resolve);
+            stream.on('done', resolve);
+        });
+        return chunks.join();
+    });
+}

package/lib/request.ts

@@ -364,17 +364,8 @@ export function getRequest({
 				}
 
 				// If status code is an error code, interpret the body of the request as an error.
-				const chunks: unknown[] = [];
-				download.on('data', function (chunk: unknown) {
-					chunks.push(chunk);
-				});
-				await new Promise((resolve, reject) => {
-					download.on('error', reject);
-					download.on('close', resolve);
-					download.on('end', resolve);
-					download.on('done', resolve);
-				});
-				const responseError = chunks.join() || 'The request was unsuccessful';
+				const data = await utils.getStreamContents(download);
+				const responseError = data || 'The request was unsuccessful';
 
 				debugRequest(options, download.response);
 				// @ts-expect-error error without request options

package/lib/utils.ts

@@ -544,3 +544,24 @@ function handleAbortIfNotSupported(
 export function getRequestAsync($fetch: typeof fetch = normalFetch) {
 	return (options: BalenaRequestOptions) => requestAsync($fetch, options);
 }
+
+/**
+ * @summary A function that returns the contents of a stream
+ * @function
+ * @protected
+ *
+ * @param {Readable} [stream] - the stream to get the contents of
+ */
+export async function getStreamContents(stream: Readable) {
+	const chunks: unknown[] = [];
+	stream.on('data', function (chunk) {
+		chunks.push(chunk);
+	});
+	await new Promise((resolve, reject) => {
+		stream.on('error', reject);
+		stream.on('close', resolve);
+		stream.on('end', resolve);
+		stream.on('done', resolve);
+	});
+	return chunks.join();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "balena-request",
-  "version": "13.3.2",
+  "version": "13.3.3",
   "description": "Balena HTTP client",
   "main": "build/request.js",
   "types": "build/request.d.ts",
@@ -32,7 +32,7 @@
     "prepare": "npm run build",
     "readme": "jsdoc2md --template doc/README.hbs build/request.js build/progress.js build/utils.js > README.md"
   },
-  "author": "Juan Cruz Viotti <juanchiviotti@gmail.com>",
+  "author": "Balena Ltd. <hello@balena.io>",
   "license": "Apache-2.0",
   "devDependencies": {
     "@balena/lint": "^7.2.0",
@@ -43,10 +43,10 @@
     "@types/progress-stream": "^2.0.0",
     "@types/qs": "^6.9.3",
     "@types/sinon": "^10.0.11",
+    "@types/temp": "^0.9.4",
     "assert": "^2.0.0",
     "balena-auth": "^6.0.1",
     "balena-config-karma": "4.0.0",
-    "bluebird": "^3.7.2",
     "browserify-zlib": "^0.2.0",
     "buffer": "^5.7.1",
     "chai": "^4.3.4",
@@ -57,9 +57,9 @@
     "mockttp": "^3.8.0",
     "process": "^0.11.10",
     "querystring-es3": "^0.2.1",
-    "rindle": "^1.3.6",
     "sinon": "^15.0.1",
     "stream-browserify": "^3.0.0",
+    "string-to-stream": "^3.0.1",
     "temp": "^0.8.4",
     "timekeeper": "^1.0.0",
     "ts-node": "^10.9.1",
@@ -82,6 +82,6 @@
     "balena-auth": "^6.0.1"
   },
   "versionist": {
-    "publishedAt": "2024-07-12T08:40:04.114Z"
+    "publishedAt": "2024-12-03T15:16:48.906Z"
   }
 }

package/tests/api-key.spec.js

@@ -1,6 +1,5 @@
 import { expect } from 'chai';
 import setup from './setup';
-import * as rindle from 'rindle';
 import * as sinon from 'sinon';
 import * as mockhttp from 'mockttp';
 import * as tokens from './tokens.json';
@@ -93,7 +92,7 @@ describe('Request (api key):', function () {
 									expect(stream.response.request.uri.query).to.equal(
 										'apikey=123456789',
 									);
-									return rindle.extract(stream);
+									return utils.getStreamContents(stream);
 								})));
 				});
 
@@ -141,7 +140,7 @@ describe('Request (api key):', function () {
 									expect(stream.response.request.uri.query).to.equal(
 										'apikey=123456789',
 									);
-									return rindle.extract(stream);
+									return utils.getStreamContents(stream);
 								}));
 
 						it('should still send an Authorization header', () =>
@@ -157,7 +156,7 @@ describe('Request (api key):', function () {
 									expect(headers.Authorization).to.equal(
 										`Bearer ${johnDoeFixture.token}`,
 									);
-									return rindle.extract(stream);
+									return utils.getStreamContents(stream);
 								}));
 					});
 				});
@@ -191,7 +190,7 @@ describe('Request (api key):', function () {
 								})
 								.then(function (stream) {
 									expect(stream.response.request.uri.query).to.not.exist;
-									return rindle.extract(stream);
+									return utils.getStreamContents(stream);
 								})));
 				}));
 		});

package/tests/hooks.spec.js

@@ -1,14 +1,13 @@
 import { expect } from 'chai';
 import setup from './setup';
-import * as Bluebird from 'bluebird';
-import * as rindle from 'rindle';
+import * as stringToStream from 'string-to-stream';
 import * as sinon from 'sinon';
 import * as mockhttp from 'mockttp';
 import * as utils from '../build/utils';
 
 const mockServer = mockhttp.getLocal();
 
-const { auth, request } = setup();
+const { auth, request, delay } = setup();
 
 describe('An interceptor', function () {
 	this.timeout(10000);
@@ -58,7 +57,7 @@ describe('An interceptor', function () {
 		it('should be able to asynchronously change a request before it is sent', function () {
 			request.interceptors[0] = {
 				request(req) {
-					return Bluebird.delay(100).then(() =>
+					return delay(100).then(() =>
 						Object.assign({}, req, { url: mockServer.urlFor('/changed') }),
 					);
 				},
@@ -102,7 +101,7 @@ describe('An interceptor', function () {
 				.stream({
 					url: mockServer.urlFor('/original'),
 				})
-				.then(rindle.extract)
+				.then(utils.getStreamContents)
 				.then(function (data) {
 					const body = JSON.parse(data);
 					expect(body).to.deep.equal({ requested: 'changed' });
@@ -256,7 +255,7 @@ describe('An interceptor', function () {
 		it('should be able to asynchronously change a response before it is returned', function () {
 			request.interceptors[0] = {
 				response(response) {
-					return Bluebird.delay(100).then(() =>
+					return delay(100).then(() =>
 						Object.assign({}, response, { body: { replaced: true } }),
 					);
 				},
@@ -295,7 +294,7 @@ describe('An interceptor', function () {
 		it('should be able to change a stream response before it is returned', function () {
 			request.interceptors[0] = {
 				response() {
-					return rindle.getStreamFromString('replacement stream');
+					return stringToStream('replacement stream');
 				},
 			};
 
@@ -303,7 +302,7 @@ describe('An interceptor', function () {
 				.stream({
 					url: mockServer.urlFor('/original'),
 				})
-				.then(rindle.extract)
+				.then(utils.getStreamContents)
 				.then((data) => expect(data).to.equal('replacement stream'));
 		});
 	});

package/tests/request.spec.js

@@ -6,13 +6,7 @@ import * as mockhttp from 'mockttp';
 
 const mockServer = mockhttp.getLocal();
 
-const { auth, request, getCustomRequest, IS_BROWSER } = setup();
-
-// Grab setTimeout before we replace it with a fake later, so
-// we can still do real waiting in the tests themselves
-const unstubbedSetTimeout = setTimeout;
-const delay = (delayMs) =>
-	new Promise((resolve) => unstubbedSetTimeout(resolve, delayMs));
+const { auth, request, getCustomRequest, IS_BROWSER, delay } = setup();
 
 class TestFile extends Blob {
 	constructor(blobParts, name, type) {

package/tests/setup.js

@@ -27,9 +27,16 @@ const getCustomRequest = function (opts) {
 	return getRequest(opts);
 };
 
+// Grab setTimeout before we replace it with a fake later, so
+// we can still do real waiting in the tests themselves
+const unstubbedSetTimeout = setTimeout;
+const delay = (delayMs) =>
+	new Promise((resolve) => unstubbedSetTimeout(resolve, delayMs));
+
 export default () => ({
 	IS_BROWSER,
 	auth,
 	request: getCustomRequest(),
 	getCustomRequest,
+	delay,
 });

package/tests/stream.spec.js

@@ -1,15 +1,23 @@
 import { PassThrough } from 'stream';
 import { expect } from 'chai';
 import setup from './setup';
-import * as Bluebird from 'bluebird';
-import * as rindle from 'rindle';
 import * as zlib from 'browserify-zlib';
 import * as mockhttp from 'mockttp';
+import * as utils from '../build/utils';
 
 const mockServer = mockhttp.getLocal();
 
-const { auth, request } = setup();
-const gzip = Bluebird.promisify(zlib.gzip);
+const { auth, request, delay } = setup();
+const gzip = (contents) =>
+	new Promise((resolve, reject) =>
+		zlib.gzip(contents, (err, res) => {
+			if (err) {
+				reject(err);
+			} else {
+				resolve(res);
+			}
+		}),
+	);
 
 describe('Request (stream):', function () {
 	beforeEach(() => Promise.all([auth.removeKey(), mockServer.start()]));
@@ -53,7 +61,7 @@ describe('Request (stream):', function () {
 					baseUrl: mockServer.url,
 					url: '/foo',
 				})
-				.then(rindle.extract)
+				.then(utils.getStreamContents)
 				.then((data) => expect(data).to.equal('Lorem ipsum dolor sit amet')));
 
 		it('should be able to pipe the response after a delay', () =>
@@ -63,13 +71,13 @@ describe('Request (stream):', function () {
 					baseUrl: mockServer.url,
 					url: '/foo',
 				})
-				.then((stream) => Bluebird.delay(200).return(stream))
+				.then((stream) => delay(200).then(() => stream))
 				.then(function (stream) {
 					const pass = new PassThrough();
 					stream.pipe(pass);
 
-					return rindle
-						.extract(pass)
+					return utils
+						.getStreamContents(pass)
 						.then((data) =>
 							expect(data).to.equal('Lorem ipsum dolor sit amet'),
 						);
@@ -92,7 +100,7 @@ describe('Request (stream):', function () {
 						baseUrl: mockServer.url,
 						url: '/foo',
 					})
-					.then(rindle.extract)
+					.then(utils.getStreamContents)
 					.then((data) => expect(data).to.equal('GET'))));
 	});
 
@@ -114,7 +122,7 @@ describe('Request (stream):', function () {
 					baseUrl: mockServer.url,
 					url: '/foo',
 				})
-				.then((stream) => rindle.extract(stream))
+				.then((stream) => utils.getStreamContents(stream))
 				.then(function (data) {
 					expect(data).to.equal('Lorem ipsum dolor sit amet');
 					return expect(data.length).to.equal(26);
@@ -147,7 +155,7 @@ describe('Request (stream):', function () {
 					baseUrl: mockServer.url,
 					url: '/foo',
 				})
-				.then((stream) => rindle.extract(stream))
+				.then((stream) => utils.getStreamContents(stream))
 				.then(function (data) {
 					expect(data).to.equal('Lorem ipsum dolor sit amet');
 					return expect(data.length).to.equal(26);
@@ -173,7 +181,7 @@ describe('Request (stream):', function () {
 					baseUrl: mockServer.url,
 					url: '/foo',
 				})
-				.then((stream) => rindle.extract(stream))
+				.then((stream) => utils.getStreamContents(stream))
 				.then(function (data) {
 					expect(data).to.equal('Lorem ipsum dolor sit amet');
 					return expect(data.length).to.equal(26);

package/tests/token.spec.js

@@ -1,6 +1,5 @@
 import { expect } from 'chai';
 import setup from './setup';
-import * as rindle from 'rindle';
 import * as sinon from 'sinon';
 import * as errors from 'balena-errors';
 import * as mockhttp from 'mockttp';
@@ -307,7 +306,7 @@ describe('Request (token):', function () {
 								expect(headers.Authorization).to.equal(
 									`Bearer ${johnDoeFixture.token}`,
 								);
-								return rindle.extract(stream);
+								return utils.getStreamContents(stream);
 							}));
 				});
 
@@ -324,7 +323,7 @@ describe('Request (token):', function () {
 							.then(function (stream) {
 								const { headers } = stream.response.request;
 								expect(headers.Authorization).to.not.exist;
-								return rindle.extract(stream);
+								return utils.getStreamContents(stream);
 							}));
 				});
 			});