feat: ESM migration

Author: tegefaulkes

.github/workflows/tag.yml

@@ -1,4 +1,4 @@
-name: "CI / Tag"
+npname: "CI / Tag"
 
 on:
   push:

package-lock.json

@@ -61,7 +61,7 @@
   "dependencies": {
     "@matrixai/async-init": "^2.1.2",
     "@matrixai/async-locks": "^5.0.2",
-    "@matrixai/db": "^5.3.0",
+    "@matrixai/db": "^6.0.20",
     "@matrixai/errors": "^2.1.3",
     "@matrixai/logger": "^4.0.3",
     "@matrixai/resources": "^2.0.1",
@@ -75,30 +75,30 @@
   },
   "devDependencies": {
     "@fast-check/jest": "^2.1.0",
-    "@swc/core": "^1.3.62",
-    "@swc/jest": "^0.2.26",
-    "@types/jest": "^28.1.3",
-    "@types/node": "^18.15.0",
+    "@swc/core": "1.3.82",
+    "@swc/jest": "^0.2.29",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^20.5.7",
     "@types/node-forge": "^1.0.2",
     "@types/readable-stream": "^2.3.11",
-    "@typescript-eslint/eslint-plugin": "^5.45.1",
-    "@typescript-eslint/parser": "^5.45.1",
+    "@typescript-eslint/eslint-plugin": "^5.61.0",
+    "@typescript-eslint/parser": "^5.61.0",
     "benny": "^3.7.1",
     "common-tags": "^1.8.2",
-    "eslint": "^8.15.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-prettier": "^4.0.0",
+    "eslint": "^8.44.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^5.0.0-alpha.2",
     "fast-check": "^4.0.0",
-    "jest": "^28.1.1",
-    "jest-extended": "^3.0.1",
-    "jest-junit": "^14.0.0",
-    "prettier": "^2.6.2",
+    "jest": "^29.6.2",
+    "jest-extended": "^4.0.0",
+    "jest-junit": "^16.0.0",
+    "prettier": "^3.0.0",
     "shx": "^0.3.4",
     "systeminformation": "^5.18.5",
     "ts-node": "^10.9.1",
     "tsx": "^3.12.7",
-    "typedoc": "^0.23.21",
-    "typescript": "^4.9.3"
+    "typedoc": "^0.24.8",
+    "typescript": "^5.1.6"
   }
 }

package.json

@@ -1,4 +1,8 @@
-import type { Crypto, DBTransaction } from '@matrixai/db';
+import type {
+  Crypto,
+  DBTransaction,
+  DBWorkerManagerInterface,
+} from '@matrixai/db';
 import type {
   Navigated,
   ParsedPath,
@@ -7,7 +11,6 @@ import type {
   Options,
   Data,
   File,
-  EFSWorkerManagerInterface,
 } from './types.js';
 import type { INodeIndex, INodeType } from './inodes/types.js';
 import type { FdIndex, FileDescriptor } from './fd/index.js';
@@ -26,6 +29,7 @@ import * as constants from './constants.js';
 import * as permissions from './permissions.js';
 import * as utils from './utils.js';
 import * as errors from './errors.js';
+import efsWorker from './efsWorker.js';
 
 interface EncryptedFS extends createDestroyStartStop.CreateDestroyStartStop {}
 @createDestroyStartStop.CreateDestroyStartStop(
@@ -100,10 +104,7 @@ class EncryptedFS {
     if (db == null) {
       crypto = {
         key: dbKey!,
-        ops: {
-          encrypt: utils.encrypt,
-          decrypt: utils.decrypt,
-        },
+        ops: efsWorker,
       };
       try {
         db = await DB.createDB({
@@ -309,7 +310,7 @@ class EncryptedFS {
     this.logger.info(`Destroyed ${this.constructor.name}`);
   }
 
-  public setWorkerManager(workerManager: EFSWorkerManagerInterface) {
+  public setWorkerManager(workerManager: DBWorkerManagerInterface) {
     this.db.setWorkerManager(workerManager);
   }
 
@@ -2282,10 +2283,10 @@ class EncryptedFS {
       typeof offsetOrCallback === 'function'
         ? offsetOrCallback
         : typeof lengthOrCallback === 'function'
-        ? lengthOrCallback
-        : typeof positionOrCallback === 'function'
-        ? positionOrCallback
-        : callback;
+          ? lengthOrCallback
+          : typeof positionOrCallback === 'function'
+            ? positionOrCallback
+            : callback;
     return utils.maybeCallback(async () => {
       const fd = this.fdMgr.getFd(fdIndex);
       if (!fd) {
@@ -2413,8 +2414,12 @@ class EncryptedFS {
         .filter(([name]) => name !== '.' && name !== '..')
         .map(([name]) => {
           if (options.encoding === 'binary') {
+            if (typeof name === 'string') return Buffer.from(name);
             return Buffer.from(name);
           } else {
+            if (typeof name === 'string') {
+              return Buffer.from(name).toString(options.encoding);
+            }
             return Buffer.from(name).toString(options.encoding);
           }
         });
@@ -3304,10 +3309,10 @@ class EncryptedFS {
       typeof offsetOrPosOrCallback === 'function'
         ? offsetOrPosOrCallback
         : typeof lengthOrEncodingOrCallback === 'function'
-        ? lengthOrEncodingOrCallback
-        : typeof positionOrCallback === 'function'
-        ? positionOrCallback
-        : callback;
+          ? lengthOrEncodingOrCallback
+          : typeof positionOrCallback === 'function'
+            ? positionOrCallback
+            : callback;
     return utils.maybeCallback(async () => {
       const fd = this.fdMgr.getFd(fdIndex);
       if (!fd) {

src/EncryptedFS.ts

@@ -0,0 +1,42 @@
+import type { WorkerManifest } from '@matrixai/workers';
+import type { Crypto } from '@matrixai/db';
+import { expose } from '@matrixai/workers';
+import * as utils from './utils.js';
+
+const efsWorker: Crypto = {
+  async encrypt({
+    key,
+    plainText,
+  }: {
+    key: ArrayBuffer;
+    plainText: ArrayBuffer;
+  }): Promise<{ data: ArrayBuffer; transferList: [ArrayBuffer] }> {
+    const cipherText = await utils.encrypt(key, plainText);
+    return { data: cipherText, transferList: [cipherText] };
+  },
+  async decrypt({
+    key,
+    cipherText,
+  }: {
+    key: ArrayBuffer;
+    cipherText: ArrayBuffer;
+  }): Promise<
+    | { data: ArrayBuffer; transferList: [ArrayBuffer] }
+    | { data: undefined; transferList: [] }
+  > {
+    const plainText = await utils.decrypt(key, cipherText);
+    if (plainText != null) {
+      return { data: plainText, transferList: [plainText] };
+    } else {
+      return { data: undefined, transferList: [] };
+    }
+  },
+} satisfies WorkerManifest;
+
+expose(efsWorker);
+
+type EFSWorker = typeof efsWorker;
+
+export type { EFSWorker };
+
+export default efsWorker;

src/efsWorker.ts

@@ -18,7 +18,8 @@ class FileDescriptorManager {
    * Make sure not get real fd numbers confused with these fd numbers.
    */
   constructor(iNodeMgr: INodeManager) {
-    this._counter = new Counter(0);
+    // Using Counter.default since Counter isn't exported properly for ESM
+    this._counter = new Counter.default(0);
     this._fds = new Map();
     this._iNodeMgr = iNodeMgr;
   }

src/fd/FileDescriptorManager.ts

@@ -1,7 +1,7 @@
 export { default as EncryptedFS } from './EncryptedFS.js';
 export { default as Stat } from './Stat.js';
 export * as errors from './errors.js';
-export * as workers from './workers/index.js';
+export * from './efsWorker.js';
 export * as inodes from './inodes/index.js';
 export * as constants from './constants.js';
 export * as permissions from './permissions.js';

src/index.ts

@@ -61,7 +61,8 @@ class INodeManager {
 
   protected logger: Logger;
   protected db: DB;
-  protected iNodeCounter: Counter = new Counter(1);
+  // Using Counter.default since Counter isn't exported properly for ESM
+  protected iNodeCounter: Counter = new Counter.default(1);
   protected iNodeAllocations: Map<string, Ref<INodeIndex>> = new Map();
   protected refs: Map<INodeIndex, number> = new Map();
 
@@ -96,7 +97,8 @@ class INodeManager {
     // Clean up all dangling inodes that could not be removed due to references
     await this.gcAll();
     // Reset the inode counter, it will be repopulated on start
-    this.iNodeCounter = new Counter(1);
+    // Using Counter.default since Counter isn't exported properly for ESM
+    this.iNodeCounter = new Counter.default(1);
     // Reset the references
     this.refs.clear();
     this.logger.info(`Stopped ${this.constructor.name}`);

src/inodes/INodeManager.ts

@@ -1,7 +1,5 @@
-import type { WorkerManagerInterface } from '@matrixai/workers';
 import type { INodeIndex } from './inodes/types.js';
 import type { FdIndex } from './fd/types.js';
-import type { EFSWorkerModule } from './workers/efsWorkerModule';
 
 /**
  * Plain data dictionary
@@ -87,8 +85,6 @@ type Data = string | Buffer | Uint8Array;
 
 type File = FdIndex | Path;
 
-type EFSWorkerManagerInterface = WorkerManagerInterface<EFSWorkerModule>;
-
 export type {
   POJO,
   Opaque,
@@ -104,6 +100,4 @@ export type {
   Options,
   Data,
   File,
-  EFSWorkerManagerInterface,
-  EFSWorkerModule,
 };

src/types.ts

@@ -1,7 +1,7 @@
 import type { Callback } from './types.js';
 import type Stat from './Stat.js';
 import pathNode from 'path';
-import { md, random, pkcs5, cipher, util as forgeUtil } from 'node-forge';
+import nodeForge from 'node-forge';
 import callbackify from 'util-callbackify';
 import * as constants from './constants.js';
 
@@ -31,7 +31,7 @@ function fromArrayBuffer(
 
 async function getRandomBytes(size: number): Promise<Buffer> {
   const p = new Promise<string>((resolve, reject) => {
-    random.getBytes(size, (e, bytes) => {
+    nodeForge.random.getBytes(size, (e, bytes) => {
       if (e != null) {
         reject(e);
       } else {
@@ -43,7 +43,7 @@ async function getRandomBytes(size: number): Promise<Buffer> {
 }
 
 function getRandomBytesSync(size: number): Buffer {
-  return Buffer.from(random.getBytesSync(size), 'binary');
+  return Buffer.from(nodeForge.random.getBytesSync(size), 'binary');
 }
 
 async function generateKey(bits: 128 | 192 | 256 = 256): Promise<Buffer> {
@@ -76,12 +76,12 @@ async function generateKeyFromPass(
     salt = (await getRandomBytes(16)).toString('binary');
   }
   const keyLen = Math.floor(bits / 8);
-  const key = await promisify<string>(pkcs5.pbkdf2)(
+  const key = await promisify<string>(nodeForge.pkcs5.pbkdf2)(
     password,
     salt,
     2048,
     keyLen,
-    md.sha512.create(),
+    nodeForge.md.sha512.create(),
   );
   return [Buffer.from(key, 'binary'), Buffer.from(salt, 'binary')];
 }
@@ -98,7 +98,13 @@ function generateKeyFromPassSync(
     salt = getRandomBytesSync(16).toString('binary');
   }
   const keyLen = Math.floor(bits / 8);
-  const key = pkcs5.pbkdf2(password, salt, 2048, keyLen, md.sha512.create());
+  const key = nodeForge.pkcs5.pbkdf2(
+    password,
+    salt,
+    2048,
+    keyLen,
+    nodeForge.md.sha512.create(),
+  );
   return [Buffer.from(key, 'binary'), Buffer.from(salt, 'binary')];
 }
 
@@ -107,9 +113,12 @@ async function encrypt(
   plainText: ArrayBuffer,
 ): Promise<ArrayBuffer> {
   const iv = getRandomBytesSync(ivSize);
-  const c = cipher.createCipher('AES-GCM', Buffer.from(key).toString('binary'));
+  const c = nodeForge.cipher.createCipher(
+    'AES-GCM',
+    Buffer.from(key).toString('binary'),
+  );
   c.start({ iv: iv.toString('binary'), tagLength: authTagSize * 8 });
-  c.update(forgeUtil.createBuffer(plainText));
+  c.update(nodeForge.util.createBuffer(plainText));
   c.finish();
   const cipherText = Buffer.from(c.output.getBytes(), 'binary');
   const authTag = Buffer.from(c.mode.tag.getBytes(), 'binary');
@@ -128,16 +137,16 @@ async function decrypt(
   const iv = cipherTextBuf.subarray(0, ivSize);
   const authTag = cipherTextBuf.subarray(ivSize, ivSize + authTagSize);
   const cipherText_ = cipherTextBuf.subarray(ivSize + authTagSize);
-  const d = cipher.createDecipher(
+  const d = nodeForge.cipher.createDecipher(
     'AES-GCM',
     Buffer.from(key).toString('binary'),
   );
   d.start({
     iv: iv.toString('binary'),
     tagLength: authTagSize * 8,
-    tag: forgeUtil.createBuffer(authTag),
+    tag: nodeForge.util.createBuffer(authTag),
   });
-  d.update(forgeUtil.createBuffer(cipherText_));
+  d.update(nodeForge.util.createBuffer(cipherText_));
   if (!d.finish()) {
     return;
   }