balena-request 13.3.3 → 13.3.4

package/.versionbot/CHANGELOG.yml

@@ -1,3 +1,15 @@
+- commits:
+    - subject: "Tests: Convert to typescript"
+      hash: 2697961c510380f62735cf0a3e9a2c2224e70545
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+  version: 13.3.4
+  title: ""
+  date: 2024-12-04T16:02:06.212Z
 - commits:
     - subject: "Tests: add missing @types/temp dependency"
       hash: 2698e0be2a764268831bf2388c82fabeeac542a4
@@ -33,7 +45,7 @@
       nested: []
   version: 13.3.3
   title: ""
-  date: 2024-12-03T15:16:48.769Z
+  date: 2024-12-03T15:23:02.553Z
 - commits:
     - subject: Fix always following redirects when followRedirect = false
       hash: 34db7e138eabfcfcfd822133b391c738d01de323

package/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.4 - 2024-12-04
+
+* Tests: Convert to typescript [Pagan Gazzard]
+
 ## 13.3.3 - 2024-12-03
 
 * Tests: add missing @types/temp dependency [Pagan Gazzard]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "balena-request",
-  "version": "13.3.3",
+  "version": "13.3.4",
   "description": "Balena HTTP client",
   "main": "build/request.js",
   "types": "build/request.d.ts",
@@ -21,12 +21,12 @@
     "node": ">=18.0.0"
   },
   "scripts": {
-    "lint": "balena-lint -e js -e ts lib tests",
+    "lint": "balena-lint -e js -e ts lib tests && tsc --noEmit --project tsconfig.dev.json",
     "lint-fix": "balena-lint -e js -e ts --fix lib tests",
     "pretest": "npm run build",
     "test": "npm run test-node && npm run test-browser",
     "posttest": "npm run lint",
-    "test-node": "mocha -r ts-node/register/transpile-only --reporter spec tests/**/*.spec.js",
+    "test-node": "mocha -r ts-node/register/transpile-only --reporter spec tests/**/*.spec.ts",
     "test-browser": "mockttp -c karma start",
     "build": "npx tsc",
     "prepare": "npm run build",
@@ -82,6 +82,6 @@
     "balena-auth": "^6.0.1"
   },
   "versionist": {
-    "publishedAt": "2024-12-03T15:16:48.906Z"
+    "publishedAt": "2024-12-04T16:02:06.338Z"
   }
 }

package/tests/{api-key.spec.js → api-key.spec.ts}

@@ -4,6 +4,7 @@ import * as sinon from 'sinon';
 import * as mockhttp from 'mockttp';
 import * as tokens from './tokens.json';
 import * as utils from '../build/utils';
+import type { BalenaRequestPassThroughStream } from '../build/request';
 
 const johnDoeFixture = tokens.johndoe;
 const mockServer = mockhttp.getLocal();
@@ -89,9 +90,10 @@ describe('Request (api key):', function () {
 									apiKey: '123456789',
 								})
 								.then(function (stream) {
-									expect(stream.response.request.uri.query).to.equal(
-										'apikey=123456789',
-									);
+									expect(
+										(stream as BalenaRequestPassThroughStream).response.request
+											.uri.query,
+									).to.equal('apikey=123456789');
 									return utils.getStreamContents(stream);
 								})));
 				});
@@ -120,7 +122,7 @@ describe('Request (api key):', function () {
 									url: '/foo',
 									apiKey: '123456789',
 								})
-								.then((v) => v.request.headers.Authorization);
+								.then((v) => v.request.headers?.Authorization);
 							return expect(promise).to.eventually.equal(
 								`Bearer ${johnDoeFixture.token}`,
 							);
@@ -137,9 +139,10 @@ describe('Request (api key):', function () {
 									apiKey: '123456789',
 								})
 								.then(function (stream) {
-									expect(stream.response.request.uri.query).to.equal(
-										'apikey=123456789',
-									);
+									expect(
+										(stream as BalenaRequestPassThroughStream).response.request
+											.uri.query,
+									).to.equal('apikey=123456789');
 									return utils.getStreamContents(stream);
 								}));
 
@@ -152,8 +155,9 @@ describe('Request (api key):', function () {
 									apiKey: '123456789',
 								})
 								.then(function (stream) {
-									const { headers } = stream.response.request;
-									expect(headers.Authorization).to.equal(
+									const { headers } = (stream as BalenaRequestPassThroughStream)
+										.response.request;
+									expect(headers?.Authorization).to.equal(
 										`Bearer ${johnDoeFixture.token}`,
 									);
 									return utils.getStreamContents(stream);
@@ -189,7 +193,10 @@ describe('Request (api key):', function () {
 									apiKey: '',
 								})
 								.then(function (stream) {
-									expect(stream.response.request.uri.query).to.not.exist;
+									expect(
+										(stream as BalenaRequestPassThroughStream).response.request
+											.uri.query,
+									).to.not.exist;
 									return utils.getStreamContents(stream);
 								})));
 				}));

package/tests/browserify-zlib.ts

@@ -0,0 +1,3 @@
+declare module 'browserify-zlib' {
+	export * from 'zlib';
+}

package/tests/{hooks.spec.js → hooks.spec.ts}

@@ -111,15 +111,16 @@ describe('An interceptor', function () {
 
 	describe('with a requestError hook', function () {
 		it('should not call requestError if there are no errors', function () {
+			const requestErrors = [sinon.mock(), sinon.mock()];
 			request.interceptors[0] = {
 				request(req) {
 					return Object.assign({}, req, {
 						url: mockServer.urlFor('/changed'),
 					});
 				},
-				requestError: sinon.mock(),
+				requestError: requestErrors[0],
 			};
-			request.interceptors[1] = { requestError: sinon.mock() };
+			request.interceptors[1] = { requestError: requestErrors[1] };
 
 			return request
 				.send({
@@ -127,8 +128,8 @@ describe('An interceptor', function () {
 				})
 				.then(function ({ body }) {
 					expect(body).to.deep.equal({ requested: 'changed' });
-					request.interceptors.forEach((interceptor) =>
-						expect(interceptor.requestError.called).to.equal(
+					requestErrors.forEach((requestError) =>
+						expect(requestError.called).to.equal(
 							false,
 							'requestError should not have been called',
 						),
@@ -137,22 +138,23 @@ describe('An interceptor', function () {
 		});
 
 		it('should call requestError only in the subsequent hook, if a previous hook fails', function () {
+			const requestErrors = [sinon.mock(), sinon.mock()];
 			request.interceptors[0] = {
 				request: sinon.mock().throws(new Error('blocked')),
-				requestError: sinon.mock(),
+				requestError: requestErrors[0],
 			};
 			request.interceptors[1] = {
-				requestError: sinon.mock().throws(new Error('error overridden')),
+				requestError: requestErrors[1].throws(new Error('error overridden')),
 			};
 
 			return expect(request.send({ url: mockServer.url })).to.be.rejected.then(
 				function (err) {
 					expect(err.message).to.deep.equal('error overridden');
-					expect(request.interceptors[0].requestError.called).to.equal(
+					expect(requestErrors[0].called).to.equal(
 						false,
 						'Preceeding requestError hooks should not be called',
 					);
-					expect(request.interceptors[1].requestError.called).to.equal(
+					expect(requestErrors[1].called).to.equal(
 						true,
 						'Subsequent requestError hook should be called',
 					);
@@ -164,7 +166,7 @@ describe('An interceptor', function () {
 			beforeEach(function () {
 				return (this.utilsShouldUpdateToken = sinon
 					.stub(utils, 'shouldRefreshKey')
-					.returns(true));
+					.resolves(true));
 			});
 
 			afterEach(function () {
@@ -293,7 +295,7 @@ describe('An interceptor', function () {
 
 		it('should be able to change a stream response before it is returned', function () {
 			request.interceptors[0] = {
-				response() {
+				async response() {
 					return stringToStream('replacement stream');
 				},
 			};
@@ -309,7 +311,8 @@ describe('An interceptor', function () {
 
 	describe('with a responseError hook', function () {
 		it('should not call responseError if there are no errors', function () {
-			request.interceptors[0] = { responseError: sinon.mock() };
+			const responseError = sinon.mock();
+			request.interceptors[0] = { responseError };
 
 			return request
 				.send({
@@ -317,7 +320,7 @@ describe('An interceptor', function () {
 				})
 				.then(function ({ body }) {
 					expect(body).to.deep.equal({ requested: '/' });
-					return expect(request.interceptors[0].responseError.called).to.equal(
+					return expect(responseError.called).to.equal(
 						false,
 						'responseError should not have been called',
 					);
@@ -394,6 +397,7 @@ describe('An interceptor', function () {
 					return expect(
 						request.send({
 							url: targetUrl,
+							// @ts-expect-error We're intentionally testing invalid input
 							anotherExtraOption: true,
 						}),
 					).to.be.rejected.then(function (err) {
@@ -418,6 +422,7 @@ describe('An interceptor', function () {
 					return expect(
 						request.send({
 							url: targetUrl,
+							// @ts-expect-error We're intentionally testing invalid input
 							anotherExtraOption: true,
 						}),
 					).to.be.rejected.then(function (err) {

package/tests/{request.spec.js → request.spec.ts}

@@ -9,12 +9,23 @@ const mockServer = mockhttp.getLocal();
 const { auth, request, getCustomRequest, IS_BROWSER, delay } = setup();
 
 class TestFile extends Blob {
-	constructor(blobParts, name, type) {
+	constructor(
+		blobParts: BlobPart[],
+		public name: string,
+		type?: string,
+	) {
 		super(blobParts, { type });
-		this.name = name;
 	}
 }
 
+const writeMethods = [
+	['DELETE', 'Delete'],
+	['PATCH', 'Patch'],
+	['PUT', 'Put'],
+	['POST', 'Post'],
+] as const;
+const methods = [['GET', 'Get'], ...writeMethods] as const;
+
 describe('Request:', function () {
 	this.timeout(10000);
 
@@ -53,11 +64,9 @@ describe('Request:', function () {
 		describe('given multiple endpoints', function () {
 			beforeEach(() =>
 				Promise.all(
-					['get', 'post', 'put', 'patch', 'delete'].map((method) =>
-						mockServer[`for${method[0].toUpperCase() + method.slice(1)}`](
-							'/foo',
-						).thenJson(200, {
-							method: method.toUpperCase(),
+					methods.map(([upperMethod, camelMethod]) =>
+						mockServer[`for${camelMethod}`]('/foo').thenJson(200, {
+							method: upperMethod,
 						}),
 					),
 				),
@@ -276,7 +285,7 @@ describe('Request:', function () {
 					});
 
 					describe('when the http server specifies the Access-Control-Expose-Headers=Retry-After in the OPTIONS response headers', function () {
-						let mockServer2;
+						let mockServer2: mockhttp.Mockttp;
 
 						beforeEach(async () => {
 							await mockServer.stop();
@@ -356,10 +365,10 @@ describe('Request:', function () {
 		});
 
 		describe('given simple endpoints that handle a request body', () =>
-			['delete', 'patch', 'put', 'post'].forEach((method) =>
-				describe(`given a ${method.toUpperCase()} endpoint that matches the request body`, function () {
+			writeMethods.forEach(([upperMethod, camelMethod]) =>
+				describe(`given a ${upperMethod} endpoint that matches the request body`, function () {
 					beforeEach(() =>
-						mockServer[`for${method[0].toUpperCase() + method.slice(1)}`]('/')
+						mockServer[`for${camelMethod}`]('/')
 							.withBody(JSON.stringify({ foo: 'bar' }))
 							.thenJson(200, { matched: true }),
 					);
@@ -367,7 +376,7 @@ describe('Request:', function () {
 					it('should eventually return the body', function () {
 						const promise = request
 							.send({
-								method: method.toUpperCase(),
+								method: upperMethod,
 								baseUrl: mockServer.url,
 								url: '/',
 								body: {

package/tests/{response-format.spec.js → response-format.spec.ts}

@@ -80,7 +80,7 @@ describe('responseFormat:', function () {
 						return reader.readAsText(body);
 					});
 				});
-			return expect(promise).to.eventually.satisfy(function (body) {
+			return expect(promise).to.eventually.satisfy(function (body: any) {
 				const s = JSON.stringify(RESPONSE_BODY);
 				if (IS_BROWSER) {
 					return body === s;
@@ -97,6 +97,7 @@ describe('responseFormat:', function () {
 				method: 'GET',
 				baseUrl: mockServer.url,
 				url: '/',
+				// @ts-expect-error We're intentionally testing invalid input
 				responseFormat: 'uzabzabza',
 			});
 			return expect(promise).to.be.rejectedWith(

package/tests/{setup.js → setup.ts}

@@ -1,6 +1,6 @@
 const IS_BROWSER = typeof window !== 'undefined' && window !== null;
 
-let dataDirectoryPath = null;
+let dataDirectoryPath: string | undefined;
 if (!IS_BROWSER) {
 	// eslint-disable-next-line @typescript-eslint/no-var-requires
 	const temp = require('temp').track();
@@ -22,15 +22,15 @@ import * as chai from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
 chai.use(chaiAsPromised);
 
-const getCustomRequest = function (opts) {
-	opts = Object.assign({}, { auth, debug: false, isBrowser: IS_BROWSER }, opts);
+const getCustomRequest = function (opts = {}) {
+	opts = { auth, debug: false, isBrowser: IS_BROWSER, ...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) =>
+const delay = (delayMs: number) =>
 	new Promise((resolve) => unstubbedSetTimeout(resolve, delayMs));
 
 export default () => ({

package/tests/{stream.spec.js → stream.spec.ts}

@@ -1,3 +1,5 @@
+import './browserify-zlib';
+
 import { PassThrough } from 'stream';
 import { expect } from 'chai';
 import setup from './setup';
@@ -8,8 +10,8 @@ import * as utils from '../build/utils';
 const mockServer = mockhttp.getLocal();
 
 const { auth, request, delay } = setup();
-const gzip = (contents) =>
-	new Promise((resolve, reject) =>
+const gzip = (contents: string) =>
+	new Promise<Buffer>((resolve, reject) =>
 		zlib.gzip(contents, (err, res) => {
 			if (err) {
 				reject(err);
@@ -19,6 +21,14 @@ const gzip = (contents) =>
 		}),
 	);
 
+const writeMethods = [
+	['DELETE', 'Delete'],
+	['PATCH', 'Patch'],
+	['PUT', 'Put'],
+	['POST', 'Post'],
+] as const;
+const methods = [['GET', 'Get'], ...writeMethods] as const;
+
 describe('Request (stream):', function () {
 	beforeEach(() => Promise.all([auth.removeKey(), mockServer.start()]));
 
@@ -86,10 +96,8 @@ describe('Request (stream):', function () {
 
 	describe('given multiple endpoints', function () {
 		beforeEach(() =>
-			['get', 'post', 'put', 'patch', 'delete'].forEach((method) =>
-				mockServer[`for${method[0].toUpperCase() + method.slice(1)}`](
-					'/foo',
-				).thenReply(200, method.toUpperCase()),
+			methods.forEach(([upperMethod, camelMethod]) =>
+				mockServer[`for${camelMethod}`]('/foo').thenReply(200, upperMethod),
 			),
 		);
 
@@ -134,7 +142,10 @@ describe('Request (stream):', function () {
 					baseUrl: mockServer.url,
 					url: '/foo',
 				})
-				.then((stream) => expect(stream.length).to.be.undefined));
+				.then((stream) => {
+					// @ts-expect-error We're intentionally testing invalid property
+					expect(stream.length).to.be.undefined;
+				}));
 	});
 
 	describe('given an gzip endpoint with a content-length header', function () {

package/tests/{token.spec.js → token.spec.ts}

@@ -5,6 +5,7 @@ import * as errors from 'balena-errors';
 import * as mockhttp from 'mockttp';
 import * as tokens from './tokens.json';
 import * as utils from '../build/utils';
+import type { BalenaRequestPassThroughStream } from '../build/request';
 
 const johnDoeFixture = tokens.johndoe;
 const janeDoeFixture = tokens.janedoe;
@@ -44,7 +45,7 @@ describe('Request (token):', function () {
 								baseUrl: mockServer.url,
 								url: '/foo',
 							})
-							.then((v) => v.request.headers.Authorization);
+							.then((v) => v.request.headers?.Authorization);
 						return expect(promise).to.eventually.equal(
 							`Bearer ${johnDoeFixture.token}`,
 						);
@@ -58,7 +59,7 @@ describe('Request (token):', function () {
 								url: '/foo',
 								sendToken: false,
 							})
-							.then((v) => v.request.headers.Authorization);
+							.then((v) => v.request.headers?.Authorization);
 						return expect(promise).to.eventually.equal(undefined);
 					});
 				});
@@ -73,7 +74,7 @@ describe('Request (token):', function () {
 								baseUrl: mockServer.url,
 								url: '/foo',
 							})
-							.then((v) => v.request.headers.Authorization);
+							.then((v) => v.request.headers?.Authorization);
 						return expect(promise).to.eventually.not.exist;
 					});
 				});
@@ -156,7 +157,7 @@ describe('Request (token):', function () {
 							})
 							.then(function (response) {
 								const authorizationHeader =
-									response.request.headers.Authorization;
+									response.request.headers?.Authorization;
 								return expect(authorizationHeader).to.equal(
 									`Bearer ${janeDoeFixture.token}`,
 								);
@@ -302,8 +303,9 @@ describe('Request (token):', function () {
 								url: '/foo',
 							})
 							.then(function (stream) {
-								const { headers } = stream.response.request;
-								expect(headers.Authorization).to.equal(
+								const { headers } = (stream as BalenaRequestPassThroughStream)
+									.response.request;
+								expect(headers?.Authorization).to.equal(
 									`Bearer ${johnDoeFixture.token}`,
 								);
 								return utils.getStreamContents(stream);
@@ -321,8 +323,9 @@ describe('Request (token):', function () {
 								url: '/foo',
 							})
 							.then(function (stream) {
-								const { headers } = stream.response.request;
-								expect(headers.Authorization).to.not.exist;
+								const { headers } = (stream as BalenaRequestPassThroughStream)
+									.response.request;
+								expect(headers?.Authorization).to.not.exist;
 								return utils.getStreamContents(stream);
 							}));
 				});

package/tests/{utils.spec.js → utils.spec.ts}

@@ -5,6 +5,7 @@ import * as fetchPonyfill from 'fetch-ponyfill';
 import * as sinon from 'sinon';
 import * as tokens from './tokens.json';
 import * as utils from '../build/utils';
+import type { BalenaRequestResponse } from '../build/request';
 
 const { Headers } = fetchPonyfill({ Promise });
 const { auth } = setup();
@@ -237,13 +238,15 @@ describe('Utils:', function () {
 				headers: new Headers({
 					'content-encoding': 'gzip',
 				}),
-			};
+			} as BalenaRequestResponse<any>;
 
 			return expect(utils.isResponseCompressed(response)).to.be.true;
 		});
 
 		it('should return false if Content-Encoding is not set', function () {
-			const response = { headers: new Headers({}) };
+			const response = {
+				headers: new Headers({}),
+			} as BalenaRequestResponse<any>;
 
 			return expect(utils.isResponseCompressed(response)).to.be.false;
 		});

package/tsconfig.json

@@ -11,8 +11,6 @@
         "noUnusedParameters": true,
         "noUnusedLocals": true,
         "moduleResolution": "node",
-        "allowJs": true,
-        "checkJs": true,
         "skipLibCheck": true,
         "importHelpers": true
     },