Update nock to 15.0.0-beta.5 to work with native fetch

Nock 15 adds support for native fetch.

Change-type: patch
See: https://github.com/nock/nock/blob/beta/migration_guides/migrating_to_15.md

Author: thgreasi

npm-shrinkwrap.json

@@ -161,7 +161,7 @@
     "mocha": "^10.6.0",
     "mock-fs": "^5.2.0",
     "mock-require": "^3.0.3",
-    "nock": "^14.0.4",
+    "nock": "^15.0.0-beta.5",
     "oclif": "^4.22.0",
     "rewire": "^7.0.0",
     "simple-git": "^3.14.1",

package.json

@@ -108,7 +108,7 @@ describe('Utils:', async function () {
 			});
 		});
 
-		return describe('given the token does authenticate with the server', function () {
+		describe('given the token does authenticate with the server', function () {
 			beforeEach(function () {
 				this.balenaAuthIsLoggedInStub = sinon.stub(balena.auth, 'isLoggedIn');
 				return this.balenaAuthIsLoggedInStub.resolves(true);
@@ -118,7 +118,7 @@ describe('Utils:', async function () {
 				return this.balenaAuthIsLoggedInStub.restore();
 			});
 
-			return it('should eventually be true', function () {
+			it('should eventually be true', function () {
 				const promise = utils.loginIfTokenValid(tokens.johndoe.token);
 				return expect(promise).to.eventually.be.true;
 			});

tests/auth/utils.spec.ts

@@ -20,7 +20,6 @@ import type { Request as ReleaseRequest } from '@balena/compose/dist/release';
 import { expect } from 'chai';
 import { promises as fs } from 'fs';
 import * as _ from 'lodash';
-import type * as nock from 'nock';
 import * as path from 'path';
 import * as sinon from 'sinon';
 
@@ -181,8 +180,8 @@ describe('balena deploy', function () {
 		];
 
 		api.expectPostRelease({
-			inspectRequest: (_uri: string, requestBody: nock.Body) => {
-				const body = requestBody.valueOf() as Partial<ReleaseRequest>;
+			inspectRequest: async (request: Request) => {
+				const body = (await request.json()) as Partial<ReleaseRequest>;
 				expect(body.contract).to.deep.equal({
 					name: 'testContract',
 					type: 'sw.application',
@@ -232,8 +231,8 @@ describe('balena deploy', function () {
 		];
 
 		api.expectPostRelease({
-			inspectRequest: (_uri: string, requestBody: nock.Body) => {
-				const body = requestBody.valueOf() as Partial<ReleaseRequest>;
+			inspectRequest: async (request: Request) => {
+				const body = (await request.json()) as Partial<ReleaseRequest>;
 				expect(body.contract).to.deep.equal({
 					name: 'testContract',
 					type: 'sw.application',
@@ -298,21 +297,21 @@ describe('balena deploy', function () {
 			statusCode: 500,
 			// b/c failed requests are retried
 			times: maxRequestRetries,
-			inspectRequest: (_uri, requestBody) => {
-				const imageBody = requestBody as Partial<
+			inspectRequest: async (request: Request) => {
+				const body = (await request.json()) as Partial<
 					import('@balena/compose/dist/release/models').ImageModel
 				>;
-				expect(imageBody.status).to.equal('success');
+				expect(body.status).to.equal('success');
 				failedImagePatchRequests++;
 			},
 		});
 		// Check that the CLI patches the release with status="failed"
 		api.expectPatchRelease({
-			inspectRequest: (_uri, requestBody) => {
-				const releaseBody = requestBody as Partial<
+			inspectRequest: async (request: Request) => {
+				const body = (await request.json()) as Partial<
 					import('@balena/compose/dist/release/models').ReleaseModel
 				>;
-				expect(releaseBody.status).to.equal('failed');
+				expect(body.status).to.equal('failed');
 			},
 		});
 		api.expectPostImageLabel();
@@ -386,8 +385,8 @@ describe('balena deploy', function () {
 		let succesfullImagePatchRequests = 0;
 		api
 			.optPatch(/^\/v7\/image($|[(?])/, { times: maxRequestRetries })
-			.reply((_uri, requestBody) => {
-				const imageBody = requestBody as Partial<
+			.reply(async (request) => {
+				const imageBody = (await request.json()) as Partial<
 					import('@balena/compose/dist/release/models').ImageModel
 				>;
 				expect(imageBody.status).to.equal('success');

tests/commands/deploy.spec.ts

@@ -61,12 +61,15 @@ export class BalenaAPIMock extends NockMock {
 	}
 
 	public expectDownloadConfig(opts: ScopeOpts = {}) {
-		this.optPost('/download-config', opts).reply(200, (_uri, body) => {
-			let deviceType = 'raspberrypi3';
-			if (typeof body === 'object' && 'deviceType' in body) {
-				deviceType = body.deviceType;
-			}
-			return JSON.parse(`{
+		this.optPost('/download-config', opts).reply(
+			200,
+			async (request: Request) => {
+				const body = await request.json();
+				let deviceType = 'raspberrypi3';
+				if (typeof body === 'object' && 'deviceType' in body) {
+					deviceType = body.deviceType;
+				}
+				return JSON.parse(`{
 					"applicationId":1301645,
 					"deviceType":"${deviceType}",
 					"userId":43699,
@@ -79,7 +82,8 @@ export class BalenaAPIMock extends NockMock {
 					"deltaEndpoint":"https://delta.balena-cloud.com",
 					"apiKey":"nothingtoseehere"
 				}`);
-		});
+			},
+		);
 	}
 
 	public expectApplicationProvisioning(opts: ScopeOpts = {}) {
@@ -284,8 +288,8 @@ export class BalenaAPIMock extends NockMock {
 
 	public expectGetAppServiceVars(opts: ScopeOpts = {}) {
 		this.optGet(/^\/v\d+\/service_environment_variable($|\?)/, opts).reply(
-			function (uri, _requestBody) {
-				const match = uri.match(/service_name%20eq%20%27(.+?)%27/);
+			function (request) {
+				const match = request.url.match(/service_name%20eq%20%27(.+?)%27/);
 				const serviceName = match?.[1] || undefined;
 				let varArray: any[];
 				if (serviceName) {
@@ -332,8 +336,8 @@ export class BalenaAPIMock extends NockMock {
 		this.optGet(
 			/^\/v\d+\/device_service_environment_variable($|\?)/,
 			opts,
-		).reply(function (uri, _requestBody) {
-			const match = uri.match(/service_name%20eq%20%27(.+?)%27/);
+		).reply(function (request) {
+			const match = request.url.match(/service_name%20eq%20%27(.+?)%27/);
 			const serviceName = match?.[1] || undefined;
 			let varArray: any[];
 			if (serviceName) {

tests/nock/balena-api-mock.ts

@@ -16,12 +16,7 @@
  */
 
 import * as path from 'path';
-import * as zlib from 'zlib';
-
 import { NockMock } from './nock-mock';
-import { promisify } from 'util';
-
-const gunzipAsync = promisify(zlib.gunzip);
 
 export const builderResponsePath = path.normalize(
 	path.join(__dirname, '..', 'test-data', 'builder-response'),
@@ -40,20 +35,16 @@ export class BuilderMock extends NockMock {
 		checkURI: (uri: string) => Promise<void> | void;
 		checkBuildRequestBody: (requestBody: string | Buffer) => Promise<void>;
 	}) {
-		this.optPost(/^\/v3\/build($|[(?])/, opts).reply(
-			async function (uri, requestBody) {
-				await opts.checkURI(uri);
-				if (typeof requestBody === 'string') {
-					const gzipped = Buffer.from(requestBody, 'hex');
-					const gunzipped = await gunzipAsync(gzipped);
-					await opts.checkBuildRequestBody(gunzipped);
-					return [opts.responseCode, opts.responseBody];
-				} else {
-					throw new Error(
-						`unexpected requestBody type "${typeof requestBody}"`,
-					);
-				}
-			},
-		);
+		this.optPost(/^\/v3\/build($|[(?])/, opts).reply(async function (
+			request: Request,
+		) {
+			await opts.checkURI(request.url);
+			const requestBody = await request.text();
+			if (typeof requestBody !== 'string') {
+				throw new Error(`unexpected requestBody type "${typeof requestBody}"`);
+			}
+			await opts.checkBuildRequestBody(requestBody);
+			return [opts.responseCode, opts.responseBody];
+		});
 	}
 }

tests/nock/builder-mock.ts

@@ -81,14 +81,14 @@ export class DockerMock extends NockMock {
 		this.optPost(
 			new RegExp(`^/build\\?(|.+&)${qs.stringify({ t: opts.tag })}&`),
 			opts,
-		).reply(async function (uri, requestBody) {
-			await opts.checkURI(uri);
-			if (typeof requestBody === 'string') {
-				await opts.checkBuildRequestBody(requestBody);
-				return [opts.responseCode, opts.responseBody];
-			} else {
+		).reply(async function (request) {
+			await opts.checkURI(request.url);
+			const requestBody = await request.text();
+			if (typeof requestBody !== 'string') {
 				throw new Error(`unexpected requestBody type "${typeof requestBody}"`);
 			}
+			await opts.checkBuildRequestBody(requestBody);
+			return [opts.responseCode, opts.responseBody];
 		});
 	}
 

tests/nock/docker-mock.ts

@@ -100,47 +100,28 @@ export class NockMock {
 		return this.optMethod('post', uri, opts);
 	}
 
-	protected inspectNoOp(_uri: string, _requestBody: nock.Body): void {
-		return undefined;
+	protected inspectNoOp(_request: Request): void | Promise<void> {
+		return;
 	}
 
 	protected getInspectedReplyBodyFunction(
-		inspectRequest: (uri: string, requestBody: nock.Body) => void,
+		inspectRequest: (request: Request) => void | Promise<void>,
 		replyBody: nock.ReplyBody,
 	) {
-		return function (
-			this: nock.ReplyFnContext,
-			uri: string,
-			requestBody: nock.Body,
-			cb: (err: NodeJS.ErrnoException | null, result: nock.ReplyBody) => void,
-		) {
-			try {
-				inspectRequest(uri, requestBody);
-			} catch (err) {
-				cb(err, '');
-			}
-			cb(null, replyBody);
+		return async function (request: Request): Promise<nock.ReplyBody> {
+			await inspectRequest(request);
+			return replyBody;
 		};
 	}
 
 	protected getInspectedReplyFileFunction(
-		inspectRequest: (uri: string, requestBody: nock.Body) => void,
+		inspectRequest: (request: Request) => void | Promise<void>,
 		replyBodyFile: string,
 	) {
-		return function (
-			this: nock.ReplyFnContext,
-			uri: string,
-			requestBody: nock.Body,
-			cb: (err: NodeJS.ErrnoException | null, result: nock.ReplyBody) => void,
-		) {
-			try {
-				inspectRequest(uri, requestBody);
-			} catch (err) {
-				cb(err, '');
-			}
-
+		return async function (request: Request): Promise<nock.ReplyBody> {
+			await inspectRequest(request);
 			const replyBody = fs.readFileSync(replyBodyFile);
-			cb(null, replyBody);
+			return replyBody;
 		};
 	}
 

tests/nock/nock-mock.ts

@@ -48,8 +48,8 @@ export class SupervisorMock extends NockMock {
 				}, 10);
 			},
 		});
-		this.optGet('/v2/local/logs', opts).reply((_uri, _reqBody, cb) => {
-			cb(null, [200, chunkedStream]);
+		this.optGet('/v2/local/logs', opts).reply(() => {
+			return [200, chunkedStream];
 		});
 	}
 }