@dxos/random-access-storage 0.4.9 → 0.4.10-main.05b9ab6

package/src/testing/storage.blueprint-test.ts

@@ -11,7 +11,7 @@ import { type File, type Storage, StorageType } from '../common';
 
 export const randomText = () => uuid.v4();
 
-export const storageTests = (testGroupName: StorageType, createStorage: () => Storage) => {
+export const storageTests = (testGroupName: StorageType, createStorage: (name: string) => Storage) => {
   const writeAndCheck = async (file: File, data: Buffer, offset = 0) => {
     await file.write(offset, data);
     const bufferRead = await file.read(offset, data.length);
@@ -21,7 +21,9 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
 
   describe(testGroupName, () => {
     test('open & close', async () => {
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
       const directory = storage.createDirectory();
       const fileName = randomText();
       const file = directory.getOrCreateFile(fileName);
@@ -29,7 +31,9 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('open file, read & write', async () => {
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
       const fileName = randomText();
       const directory = storage.createDirectory();
       const file = directory.getOrCreateFile(fileName);
@@ -45,9 +49,9 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('list files', async () => {
-      // await waitForDebugger();
+      const storageName = uuid.v4();
 
-      const storage = createStorage();
+      const storage = createStorage(storageName);
       const directoryName = randomText();
       const directory = storage.createDirectory(directoryName);
 
@@ -84,7 +88,9 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('read from empty file', async () => {
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
       const directory = storage.createDirectory();
 
       const fileName = randomText();
@@ -95,7 +101,9 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('reopen and check if data is the same', async () => {
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
       const directory = storage.createDirectory();
       const fileName = randomText();
       const data1 = Buffer.from(randomText());
@@ -115,7 +123,9 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('destroy clears all data', async () => {
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
       const directory = storage.createDirectory();
       const fileName = randomText();
 
@@ -139,12 +149,14 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       if (testGroupName !== StorageType.NODE) {
         t.skip();
       }
+      const storageName = uuid.v4();
+
       const fileName = randomText();
       let firstHandle: File;
       let secondHandle: File;
 
       {
-        const storage = createStorage();
+        const storage = createStorage(storageName);
         const directory = storage.createDirectory();
         const file = directory.getOrCreateFile(fileName);
         const buffer = Buffer.from(randomText());
@@ -153,7 +165,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       }
 
       {
-        const storage = createStorage();
+        const storage = createStorage(storageName);
         const directory = storage.createDirectory();
         const file = directory.getOrCreateFile(fileName);
         const buffer = Buffer.from(randomText());
@@ -166,8 +178,10 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('sub-directories', async () => {
+      const storageName = uuid.v4();
+
       // 1. Create storage and two subdirectories
-      const storage = createStorage();
+      const storage = createStorage(storageName);
       const dir1 = storage.createDirectory('dir1');
       const dir2 = storage.createDirectory('dir2');
 
@@ -189,7 +203,9 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('write in directory/sub-directory/file', async () => {
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
       const dir = storage.createDirectory('directory');
       const subDir = dir.createDirectory('subDirectory');
 
@@ -206,10 +222,11 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       if (testGroupName === StorageType.RAM) {
         t.skip();
       }
+      const storageName = uuid.v4();
 
       const fileName = randomText();
       {
-        const storage = createStorage();
+        const storage = createStorage(storageName);
         const directory = storage.createDirectory();
         const file = directory.getOrCreateFile(fileName);
         await file.write(0, Buffer.alloc(10, '0'));
@@ -220,7 +237,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       }
 
       {
-        const storage = createStorage();
+        const storage = createStorage(storageName);
         const directory = storage.createDirectory();
         const file = directory.getOrCreateFile(fileName);
         const allContent = await file.read(0, (await file.stat()).size);
@@ -232,10 +249,11 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       if (testGroupName === StorageType.RAM) {
         t.skip();
       }
+      const storageName = uuid.v4();
 
       const fileName = randomText();
       {
-        const storage = createStorage();
+        const storage = createStorage(storageName);
         const directory = storage.createDirectory();
         const file = directory.getOrCreateFile(fileName);
         await file.write(0, Buffer.alloc(3, '0'));
@@ -246,7 +264,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       }
 
       {
-        const storage = createStorage();
+        const storage = createStorage(storageName);
         const directory = storage.createDirectory();
         const file = directory.getOrCreateFile(fileName);
         const allContent = await file.read(0, (await file.stat()).size);
@@ -255,7 +273,9 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('operations on a destroyed file are rejected', async () => {
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
       const directory = storage.createDirectory();
       const file = directory.getOrCreateFile(randomText());
 
@@ -275,7 +295,9 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('delete directory', async () => {
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
       const directory = storage.createDirectory();
       const file = directory.getOrCreateFile(randomText());
 
@@ -291,7 +313,9 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       if (testGroupName !== StorageType.NODE) {
         t.skip();
       }
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
 
       const directory = storage.createDirectory();
       const file = directory.getOrCreateFile(randomText());
@@ -310,14 +334,18 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('stat of new file', async () => {
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
       const directory = storage.createDirectory();
       const file = directory.getOrCreateFile(randomText());
       expect((await file.stat()).size).toBe(0);
     });
 
     test('call del with edge arguments', async () => {
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
       if (storage.type === StorageType.IDB) {
         // Not deletable.
         return;
@@ -347,42 +375,44 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       }
     });
 
-    test('reset', async () => {
-      if (
-        testGroupName === StorageType.RAM || // RAM storage does not persist data.
-        testGroupName === StorageType.IDB // IDB storage is blocked by opened connection, and there is no handle to close it.
-      ) {
-        return;
+    test('reset', async (t) => {
+      if (testGroupName === StorageType.RAM) {
+        t.skip();
       }
+      const storageName = uuid.v4();
       const filename = randomText();
       const buffer = Buffer.from(randomText());
 
       {
-        const storage = createStorage();
+        const storage = createStorage(storageName);
         const directory = storage.createDirectory();
         const file = directory.getOrCreateFile(filename);
         await file.write(0, buffer);
         await file.close();
+        await storage.close();
       }
 
       {
-        const storage = createStorage();
+        const storage = createStorage(storageName);
         const directory = storage.createDirectory();
         const file = directory.getOrCreateFile(filename);
         await expect(file.read(0, buffer.length)).resolves.toEqual(buffer);
         await file.close();
+        await storage.close();
       }
 
       {
-        const storage = createStorage();
+        const storage = createStorage(storageName);
         await asyncTimeout(storage.reset(), 1_000);
       }
 
       {
-        const storage = createStorage();
+        const storage = createStorage(storageName);
         const directory = storage.createDirectory();
         const file = directory.getOrCreateFile(filename);
-        await expect(file.read(0, buffer.length)).rejects.toThrow();
+        const { size } = await file.stat();
+        await expect(size).to.eq(0);
+        await storage.close();
       }
     });
 
@@ -390,10 +420,10 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       if (testGroupName === StorageType.RAM) {
         t.skip();
       }
-
+      const storageName = uuid.v4();
       const dirname = randomText();
 
-      const storage = createStorage();
+      const storage = createStorage(storageName);
       const directory = storage.createDirectory(dirname);
 
       {
@@ -413,7 +443,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       }
 
       {
-        const storage = createStorage();
+        const storage = createStorage(storageName);
         const directory = storage.createDirectory(dirname);
         const entries = await directory.list();
         expect(entries.length).toBe(files.length);
@@ -421,10 +451,11 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('list returns correct filenames', async () => {
+      const storageName = uuid.v4();
       const FILES = ['one', 'two', 'three'];
 
       // Create storage and check.
-      const storage = createStorage();
+      const storage = createStorage(storageName);
       const directory = storage.createDirectory('dir');
 
       for (const file of FILES) {
@@ -436,7 +467,9 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('getDiskInfo returns correct size', async (t) => {
-      const storage = createStorage();
+      const storageName = uuid.v4();
+
+      const storage = createStorage(storageName);
       if (storage.type === StorageType.IDB) {
         t.skip();
       }

package/dist/types/src/browser/browser-storage.d.ts

@@ -1,13 +0,0 @@
-import type { RandomAccessStorage } from 'random-access-storage';
-import { AbstractStorage } from '../common';
-/**
- * Base class for random access files based on IDB.
- */
-export declare abstract class BrowserStorage extends AbstractStorage {
-    protected readonly _fileStorage: (filename: string, opts?: {}) => RandomAccessStorage;
-    constructor(path: string);
-    protected _createFile(path: string, filename: string): RandomAccessStorage;
-    protected abstract _createFileStorage(path: string): (filename: string, opts?: {}) => RandomAccessStorage;
-    protected _destroy(): Promise<void>;
-}
-//# sourceMappingURL=browser-storage.d.ts.map

package/dist/types/src/browser/browser-storage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"browser-storage.d.ts","sourceRoot":"","sources":["../../../../src/browser/browser-storage.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,OAAO,EAAE,eAAe,EAAe,MAAM,WAAW,CAAC;AAEzD;;GAEG;AACH,8BAAsB,cAAe,SAAQ,eAAe;IAC1D,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,mBAAmB,CAAC;gBAE1E,IAAI,EAAE,MAAM;IAKxB,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,mBAAmB;IAK1E,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,mBAAmB;cAEhF,QAAQ;CAkBlC"}

package/dist/types/src/browser/firefox-storage.d.ts

@@ -1,11 +0,0 @@
-import { BrowserStorage } from './browser-storage';
-import { StorageType } from '../common';
-/**
- * Storage interface implementation for Firefox browser.
- * https://github.com/random-access-storage/random-access-web
- */
-export declare class FirefoxStorage extends BrowserStorage {
-    type: StorageType;
-    protected _createFileStorage(path: string): any;
-}
-//# sourceMappingURL=firefox-storage.d.ts.map

package/dist/types/src/browser/firefox-storage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"firefox-storage.d.ts","sourceRoot":"","sources":["../../../../src/browser/firefox-storage.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC;;;GAGG;AACH,qBAAa,cAAe,SAAQ,cAAc;IAChC,IAAI,EAAE,WAAW,CAAuB;cAErC,kBAAkB,CAAC,IAAI,EAAE,MAAM;CAGnD"}

package/src/browser/browser-storage.ts

@@ -1,45 +0,0 @@
-//
-// Copyright 2021 DXOS.org
-//
-
-import type { RandomAccessStorage } from 'random-access-storage';
-
-import { AbstractStorage, getFullPath } from '../common';
-
-/**
- * Base class for random access files based on IDB.
- */
-export abstract class BrowserStorage extends AbstractStorage {
-  protected readonly _fileStorage: (filename: string, opts?: {}) => RandomAccessStorage;
-
-  constructor(path: string) {
-    super(path);
-    this._fileStorage = this._createFileStorage(path);
-  }
-
-  protected _createFile(path: string, filename: string): RandomAccessStorage {
-    const fullPath = getFullPath(path, filename);
-    return this._fileStorage(fullPath);
-  }
-
-  protected abstract _createFileStorage(path: string): (filename: string, opts?: {}) => RandomAccessStorage;
-
-  protected override async _destroy() {
-    // eslint-disable-next-line no-undef
-    return new Promise<void>((resolve, reject) => {
-      const request = indexedDB.deleteDatabase(this.path);
-      request.onsuccess = () => {
-        resolve();
-      };
-      request.onupgradeneeded = () => {
-        reject(new Error('Upgrade needed.'));
-      };
-      request.onblocked = () => {
-        reject(new Error('Blocked.'));
-      };
-      request.onerror = (err: any) => {
-        reject(err);
-      };
-    });
-  }
-}

package/src/browser/firefox-storage.ts

@@ -1,23 +0,0 @@
-//
-// Copyright 2021 DXOS.org
-//
-
-// NOTE: Removing the .js extension here breaks usage in create-react-app.
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import raw from 'random-access-web/mutable-file-wrapper.js';
-
-import { BrowserStorage } from './browser-storage';
-import { StorageType } from '../common';
-
-/**
- * Storage interface implementation for Firefox browser.
- * https://github.com/random-access-storage/random-access-web
- */
-export class FirefoxStorage extends BrowserStorage {
-  public override type: StorageType = StorageType.FIREFOX;
-
-  protected override _createFileStorage(path: string) {
-    return raw({ name: path });
-  }
-}