Skip to content

A local-first personal finance app

Validates minimum node version to 18.12.0 for @actual-app/api npm package (#1980)

Stefan Hall29f323e72110
diff --git a/packages/api/index.js b/packages/api/index.js
index 3c6043f77b..aebc7c061d 100644
--- a/packages/api/index.js
+++ b/packages/api/index.js
@@ -3,6 +3,7 @@
// eslint-disable-next-line import/extensions
import * as bundle from './app/bundle.api.js';
import * as injected from './injected';
+import { validateNodeVersion } from './validateNodeVersion';
let actualApp;
export const internal = bundle.lib;
@@ -18,6 +19,8 @@ export async function init(config = {}) {
return;
}
+ validateNodeVersion();
+
global.fetch = (...args) =>
import('node-fetch').then(({ default: fetch }) => fetch(...args));
diff --git a/packages/api/package.json b/packages/api/package.json
index a2f07411c5..6f876dc338 100644
--- a/packages/api/package.json
+++ b/packages/api/package.json
@@ -20,6 +20,7 @@
},
"dependencies": {
"better-sqlite3": "^9.1.1",
+ "compare-versions": "^6.1.0",
"node-fetch": "^3.3.2",
"uuid": "^9.0.0"
},
diff --git a/packages/api/validateNodeVersion.js b/packages/api/validateNodeVersion.js
new file mode 100644
index 0000000000..d2bfb828a4
--- /dev/null
+++ b/packages/api/validateNodeVersion.js
@@ -0,0 +1,16 @@
+import { satisfies } from 'compare-versions';
+
+import * as packageJson from './package.json';
+
+export function validateNodeVersion() {
+ if (process?.versions?.node) {
+ const nodeVersion = process?.versions?.node;
+ const minimumNodeVersion = packageJson.engines.node;
+
+ if (!satisfies(nodeVersion, minimumNodeVersion)) {
+ throw new Error(
+ `@actual-app/api requires a node version ${minimumNodeVersion}. Found that you are using: ${nodeVersion}. Please upgrade to a higher version`,
+ );
+ }
+ }
+}
diff --git a/upcoming-release-notes/1980.md b/upcoming-release-notes/1980.md
new file mode 100644
index 0000000000..799c980f7b
--- /dev/null
+++ b/upcoming-release-notes/1980.md
@@ -0,0 +1,6 @@
+---
+category: Enhancements
+authors: [Marethyu1]
+---
+
+Validates minimum node version to 18.12.0 for @actual-app/api npm package
diff --git a/yarn.lock b/yarn.lock
index 5752137fd6..1dd1f7c591 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -25,6 +25,7 @@ __metadata:
dependencies:
"@types/uuid": "npm:^9.0.2"
better-sqlite3: "npm:^9.1.1"
+ compare-versions: "npm:^6.1.0"
node-fetch: "npm:^3.3.2"
typescript: "npm:^5.0.2"
uuid: "npm:^9.0.0"
@@ -7169,6 +7170,13 @@ __metadata:
languageName: node
linkType: hard
+"compare-versions@npm:^6.1.0":
+ version: 6.1.0
+ resolution: "compare-versions@npm:6.1.0"
+ checksum: 20f349e7f8ad784704c68265f4e660e2abbe2c3d5c75793184fccb85f0c5c0263260e01fdd4488376f6b74b0f069e16c9684463f7316b075716fb1581eb36b77
+ languageName: node
+ linkType: hard
+
"compressible@npm:~2.0.16":
version: 2.0.18
resolution: "compressible@npm:2.0.18"