Use the promises namespace of balena-image-fs

Update balena-image-fs from 7.0.6 to 7.3.0 Change-type: patch
balena-io-modules · Jan 7, 2025 · de0af08 · de0af08
1 parent f0f26e0
commit de0af08
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 38 deletions.
diff --git a/package.json b/package.json
@@ -58,7 +58,7 @@
   },
   "dependencies": {
     "balena-config-json": "^4.2.0",
-    "balena-image-fs": "^7.0.6",
+    "balena-image-fs": "^7.3.0",
     "balena-semver": "^2.2.0",
     "lodash": "^4.17.15",
     "reconfix": "1.0.0-v0-1-0-fork-46760acff4d165f5238bfac5e464256ef1944476",

diff --git a/repo.yml b/repo.yml
@@ -1 +1,4 @@
 type: 'node'
+upstream:
+  - repo: 'balena-image-fs'
+    url: 'https://github.com/balena-io-modules/balena-image-fs'
diff --git a/src/network.ts b/src/network.ts
@@ -20,7 +20,6 @@ limitations under the License.
 
 import _ from 'lodash';
 import path from 'path';
-import * as util from 'node:util';
 import * as imagefs from 'balena-image-fs';
 import reconfix from 'reconfix';
 import * as utils from './utils';
@@ -121,11 +120,10 @@ const prepareImageOS1NetworkConfig = function (
 		configFilePath.image,
 		configFilePath.partition,
 		function (_fs) {
-			const readFileAsync = util.promisify(_fs.readFile);
-			const writeFileAsync = util.promisify(_fs.writeFile);
-			return readFileAsync(configFilePath.path, {
-				encoding: 'utf8',
-			})
+			return _fs.promises
+				.readFile(configFilePath.path, {
+					encoding: 'utf8',
+				})
 				.catch((e) => {
 					if (fileNotFoundError(e)) {
 						return '{}';
@@ -140,7 +138,10 @@ const prepareImageOS1NetworkConfig = function (
 					if (contents.files['network/network.config'] == null) {
 						contents.files['network/network.config'] = '';
 					}
-					return writeFileAsync(configFilePath.path, JSON.stringify(contents));
+					return _fs.promises.writeFile(
+						configFilePath.path,
+						JSON.stringify(contents),
+					);
 				});
 		},
 	);
@@ -180,8 +181,7 @@ const prepareImageOS2WifiConfig = async function (
 		inputDefinition.image,
 		inputDefinition.partition,
 		function (_fs) {
-			const readdirAsync = util.promisify(_fs.readdir);
-			return readdirAsync(CONNECTIONS_FOLDER);
+			return _fs.promises.readdir(CONNECTIONS_FOLDER);
 		},
 	);
 
@@ -196,15 +196,16 @@ const prepareImageOS2WifiConfig = async function (
 			inputDefinition.image,
 			inputDefinition.partition,
 			async function (_fs) {
-				const readFileAsync = util.promisify(_fs.readFile);
-				const writeFileAsync = util.promisify(_fs.writeFile);
-				const contents = await readFileAsync(
+				const contents = await _fs.promises.readFile(
 					`${CONNECTIONS_FOLDER}/resin-sample.ignore`,
 					{
 						encoding: 'utf8',
 					},
 				);
-				await writeFileAsync(`${CONNECTIONS_FOLDER}/resin-wifi`, contents);
+				await _fs.promises.writeFile(
+					`${CONNECTIONS_FOLDER}/resin-wifi`,
+					contents,
+				);
 			},
 		);
 		return;
@@ -216,15 +217,16 @@ const prepareImageOS2WifiConfig = async function (
 			inputDefinition.image,
 			inputDefinition.partition,
 			async function (_fs) {
-				const readFileAsync = util.promisify(_fs.readFile);
-				const writeFileAsync = util.promisify(_fs.writeFile);
-				const contents = await readFileAsync(
+				const contents = await _fs.promises.readFile(
 					`${CONNECTIONS_FOLDER}/resin-sample`,
 					{
 						encoding: 'utf8',
 					},
 				);
-				await writeFileAsync(`${CONNECTIONS_FOLDER}/resin-wifi`, contents);
+				await _fs.promises.writeFile(
+					`${CONNECTIONS_FOLDER}/resin-wifi`,
+					contents,
+				);
 			},
 		);
 		return;
@@ -235,8 +237,7 @@ const prepareImageOS2WifiConfig = async function (
 		inputDefinition.image,
 		inputDefinition.partition,
 		async function (_fs) {
-			const writeFileAsync = util.promisify(_fs.writeFile);
-			await writeFileAsync(
+			await _fs.promises.writeFile(
 				`${CONNECTIONS_FOLDER}/resin-wifi`,
 				DEFAULT_CONNECTION_FILE,
 			);

diff --git a/src/utils.ts b/src/utils.ts
@@ -16,7 +16,6 @@ limitations under the License.
 
 import _ from 'lodash';
 import path from 'path';
-import * as util from 'node:util';
 import * as imagefs from 'balena-image-fs';
 import { getBootPartition } from 'balena-config-json';
 
@@ -48,8 +47,7 @@ export async function getImageManifest(
 			image,
 			bootPartitionNumber,
 			function (_fs) {
-				const readFileAsync = util.promisify(_fs.readFile);
-				return readFileAsync('/device-type.json', {
+				return _fs.promises.readFile('/device-type.json', {
 					encoding: 'utf8',
 				});
 			},
@@ -167,8 +165,7 @@ export async function getImageOsVersion(
 			definition.image,
 			definition.partition,
 			function (_fs) {
-				const readFileAsync = util.promisify(_fs.readFile);
-				return readFileAsync('/os-release', { encoding: 'utf8' });
+				return _fs.promises.readFile('/os-release', { encoding: 'utf8' });
 			},
 		);
 
@@ -235,8 +232,7 @@ export const writeConfigJSON = function (
 		definitionWithImage.image,
 		definitionWithImage.partition,
 		function (_fs) {
-			const writeFileAsync = util.promisify(_fs.writeFile);
-			return writeFileAsync(definitionWithImage.path, serializedConfig);
+			return _fs.promises.writeFile(definitionWithImage.path, serializedConfig);
 		},
 	);
 };
diff --git a/tests/e2e.ts b/tests/e2e.ts
@@ -3,7 +3,6 @@ import * as sinon from 'sinon';
 import * as fsPromise from 'fs/promises';
 import * as fs from 'fs';
 import path from 'path';
-import * as util from 'node:util';
 import wary from 'wary';
 
 import * as settings from 'balena-settings-client';
@@ -73,8 +72,7 @@ wary.it(
 			.then(waitStream)
 			.then(() =>
 				imagefs.interact(images.raspberrypi, 1, function (_fs) {
-					const readFileAsync = util.promisify(_fs.readFile);
-					return readFileAsync('/config.json', { encoding: 'utf8' });
+					return _fs.promises.readFile('/config.json', { encoding: 'utf8' });
 				}),
 			)
 			.then(JSON.parse)
@@ -101,8 +99,7 @@ wary.it(
 			.then(waitStream)
 			.then(() =>
 				imagefs.interact(images.raspberrypi, 5, function (_fs) {
-					const readFileAsync = util.promisify(_fs.readFile);
-					return readFileAsync('/config.json', { encoding: 'utf8' });
+					return _fs.promises.readFile('/config.json', { encoding: 'utf8' });
 				}),
 			)
 			.then(JSON.parse)
@@ -130,8 +127,7 @@ wary.it(
 			.then(waitStream)
 			.then(() =>
 				imagefs.interact(images.raspberrypi, 1, function (_fs) {
-					const readFileAsync = util.promisify(_fs.readFile);
-					return readFileAsync('/config.json', { encoding: 'utf8' });
+					return _fs.promises.readFile('/config.json', { encoding: 'utf8' });
 				}),
 			)
 			.then(JSON.parse)
@@ -169,8 +165,7 @@ wary.it(
 			.then(waitStream)
 			.then(() =>
 				imagefs.interact(images.raspberrypi, 1, function (_fs) {
-					const readFileAsync = util.promisify(_fs.readFile);
-					return readFileAsync('/system-connections/resin-wifi', {
+					return _fs.promises.readFile('/system-connections/resin-wifi', {
 						encoding: 'utf8',
 					});
 				}),
@@ -408,8 +403,7 @@ wary.it(
 					path.join(images.edison, 'resin-image-edison.hddimg'),
 					undefined,
 					function (_fs) {
-						const readFileAsync = util.promisify(_fs.readFile);
-						return readFileAsync('/config.json', { encoding: 'utf8' });
+						return _fs.promises.readFile('/config.json', { encoding: 'utf8' });
 					},
 				),
 			)