perf(FileAdapter): Remove need for atomically. With RWLock we have al…

…l we need. One less dependency for the library.
Belphemur · Jan 24, 2023 · 4b52670 · 4b52670
1 parent d70bd56
commit 4b52670
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 45 deletions.
diff --git a/package.json b/package.json
@@ -56,7 +56,6 @@
     ]
   },
   "dependencies": {
-    "atomically": "^1.7.0",
     "rwlock": "^5.0.0"
   },
   "devDependencies": {

diff --git a/src/adapter/file/AtomicFileAdapter.ts b/src/adapter/file/AtomicFileAdapter.ts
diff --git a/src/adapter/file/FileAdapter.ts b/src/adapter/file/FileAdapter.ts
@@ -0,0 +1,50 @@
+import {IFileAdapter} from "../IAdapter";
+import {readFile, open, FileHandle, mkdir} from "fs/promises";
+import * as path from "path";
+
+export class FileAdapter implements IFileAdapter<string> {
+    public readonly filename: string;
+    private readonly fsync: boolean;
+
+    constructor(filename: string, fsync: boolean) {
+        this.filename = filename;
+        this.fsync = fsync;
+    }
+
+    async readAsync(): Promise<string | null> {
+        try {
+            return await readFile(this.filename, {
+                encoding: 'utf-8'
+            })
+        } catch (e) {
+            if ((e as NodeJS.ErrnoException).code === 'ENOENT') {
+                return null;
+            }
+            throw e
+        }
+    }
+
+    async writeAsync(data: string): Promise<void> {
+        let fd: FileHandle | null = null;
+        try {
+            fd = await open(this.filename, 'w')
+        } catch (e) {
+            if ((e as NodeJS.ErrnoException).code !== 'ENOENT') {
+                throw e;
+            }
+            const basepath = path.dirname(this.filename);
+            await mkdir(basepath, {recursive: true});
+            fd = await open(this.filename, 'w');
+        }
+        try {
+            await fd.writeFile(data, {
+                encoding: 'utf-8'
+            })
+            if (this.fsync) {
+                await fd.sync()
+            }
+        } finally {
+            await fd.close();
+        }
+    }
+}
diff --git a/src/lib/JsonDBConfig.ts b/src/lib/JsonDBConfig.ts
@@ -1,7 +1,7 @@
 import * as path from "path";
 import {IAdapter} from "../adapter/IAdapter";
 import {JsonAdapter} from "../adapter/data/JsonAdapter";
-import {AtomicFileAdapter} from "../adapter/file/AtomicFileAdapter";
+import {FileAdapter} from "../adapter/file/FileAdapter";
 
 export interface JsonDBConfig {
     readonly adapter: IAdapter<any>,
@@ -25,7 +25,7 @@ export class Config implements JsonDBConfig {
 
         this.saveOnPush = saveOnPush
         this.separator = separator
-        this.adapter = new JsonAdapter(new AtomicFileAdapter(this.filename, syncOnSave), humanReadable);
+        this.adapter = new JsonAdapter(new FileAdapter(this.filename, syncOnSave), humanReadable);
     }
 }
 

diff --git a/test/adapter/adapters.test.ts b/test/adapter/adapters.test.ts
@@ -1,4 +1,4 @@
-import {AtomicFileAdapter} from "../../src/adapter/file/AtomicFileAdapter";
+import {FileAdapter} from "../../src/adapter/file/FileAdapter";
 import * as fs from "fs";
 import {JsonAdapter} from "../../src/adapter/data/JsonAdapter";
 import {IAdapter} from "../../src/adapter/IAdapter";
@@ -25,12 +25,12 @@ class MemoryAdapter implements IAdapter<any> {
 }
 
 describe('Adapter', () => {
-    describe('Atomic', () => {
+    describe('File', () => {
         test('should be able to write then read to a file', async () => {
             const filename = "data/test.file";
             const data = "Hello World";
 
-            const adapter = new AtomicFileAdapter(filename, false);
+            const adapter = new FileAdapter(filename, false);
             await adapter.writeAsync(data);
             const exists = await checkFileExists(filename);
             expect(exists).toBeTruthy();
@@ -40,7 +40,7 @@ describe('Adapter', () => {
         test('should return null data when file doesn\'t exists', async () => {
             const filename = "data/test2.file";
 
-            const adapter = new AtomicFileAdapter(filename, false);
+            const adapter = new FileAdapter(filename, false);
             const data = await adapter.readAsync();
             expect(data).toBeNull();
 
@@ -50,7 +50,7 @@ describe('Adapter', () => {
                 const filename = "data/test.json";
                 const data = {Hello: "World", Foo: "Bar"};
 
-                const adapter = new JsonAdapter(new AtomicFileAdapter(filename, false), false);
+                const adapter = new JsonAdapter(new FileAdapter(filename, false), false);
                 await adapter.writeAsync(data);
                 const exists = await checkFileExists(filename);
                 expect(exists).toBeTruthy();
@@ -60,7 +60,7 @@ describe('Adapter', () => {
             })
             test('should create file when loading if it doesn\'t exists', async () => {
                 const filename = "data/test.json";
-                const adapter = new JsonAdapter(new AtomicFileAdapter(filename, false), false);
+                const adapter = new JsonAdapter(new FileAdapter(filename, false), false);
                 await adapter.readAsync();
 
                 const fileExists = await checkFileExists(filename);

diff --git a/yarn.lock b/yarn.lock
@@ -2064,10 +2064,6 @@ asap@^2.0.0:
   version "2.0.6"
   resolved "https://registry.npmjs.org/asap/-/asap-2.0.6.tgz"
 
-atomically@^1.7.0:
-  version "1.7.0"
-  resolved "https://registry.npmjs.org/atomically/-/atomically-1.7.0.tgz"
-
 babel-jest@^28.1.3:
   version "28.1.3"
   resolved "https://registry.npmjs.org/babel-jest/-/babel-jest-28.1.3.tgz"