@dxos/random-access-storage 0.4.0 → 0.4.1-main.2495eb8

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

@@ -2,15 +2,11 @@
 // Copyright 2021 DXOS.org
 //
 
-import chai, { expect } from 'chai';
-import chaiAsPromised from 'chai-as-promised';
+import { expect, describe, test } from 'vitest';
 
 import { asyncTimeout } from '@dxos/async';
-import { describe, test } from '@dxos/test';
 
-import { type File, type Storage, StorageType } from '../common';
-
-chai.use(chaiAsPromised);
+import { StorageType, type File, type Storage } from '../common';
 
 export const randomText = () => Math.random().toString(36).substring(2);
 
@@ -19,7 +15,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     await file.write(offset, data);
     const bufferRead = await file.read(offset, data.length);
     const result = data.equals(bufferRead);
-    expect(result).to.be.true;
+    expect(result).toBeTruthy();
   };
 
   describe(testGroupName, () => {
@@ -48,6 +44,8 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
     });
 
     test('list files', async () => {
+      // await waitForDebugger();
+
       const storage = createStorage();
       const directoryName = randomText();
       const directory = storage.createDirectory(directoryName);
@@ -63,7 +61,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
         }
 
         const entries = await directory.list();
-        expect(entries.length).to.equal(count);
+        expect(entries.length).toEqual(count);
       }
 
       {
@@ -75,7 +73,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
         }
 
         const entries = await directory.list();
-        expect(entries.length).to.equal(count - amountToDelete);
+        expect(entries.length).toEqual(count - amountToDelete);
       }
 
       // Cleanup.
@@ -92,7 +90,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       const file = directory.getOrCreateFile(fileName);
       const { size } = await file.stat();
       const data = await file.read(0, size);
-      expect(Buffer.from('').equals(data)).to.be.true;
+      expect(Buffer.from('')).toEqual(data);
     });
 
     test('reopen and check if data is the same', async () => {
@@ -110,7 +108,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       {
         const file = directory.getOrCreateFile(fileName);
         const data2 = await file.read(0, data1.length);
-        expect(data1.equals(data2)).to.be.true;
+        expect(data1).toEqual(data2);
         await file.close();
       }
     });
@@ -134,14 +132,14 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       {
         const file = directory.getOrCreateFile(fileName);
         const { size } = await file.stat();
-        expect(size).to.equal(0);
+        expect(size).toBe(0);
         await file.close();
       }
     });
 
-    test('double destroy file', async function () {
+    test('double destroy file', async (t) => {
       if (testGroupName !== StorageType.NODE) {
-        this.skip();
+        t.skip();
       }
       const fileName = randomText();
       let firstHandle: File;
@@ -166,7 +164,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       }
 
       await firstHandle.destroy();
-      await expect(secondHandle.destroy()).to.be.rejected;
+      await expect(secondHandle.destroy()).rejects.toThrow();
     });
 
     test('sub-directories', async () => {
@@ -188,8 +186,8 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       await file2.write(0, buffer2);
 
       // 4. Check that they have correct content.
-      expect(await file1.read(0, buffer1.length)).to.deep.equal(buffer1);
-      expect(await file2.read(0, buffer2.length)).to.deep.equal(buffer2);
+      expect(await file1.read(0, buffer1.length)).toEqual(buffer1);
+      expect(await file2.read(0, buffer2.length)).toEqual(buffer2);
     });
 
     test('write in directory/sub-directory/file', async () => {
@@ -202,7 +200,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       await file.write(0, buffer);
 
       const readBuffer = await file.read(0, buffer.length);
-      expect(readBuffer).to.deep.equal(buffer);
+      expect(readBuffer).toEqual(buffer);
       await file.close();
     });
 
@@ -215,10 +213,14 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       await writeAndCheck(file, buffer);
 
       await directory.delete();
-      await expect(file.read(0, buffer.length)).to.be.rejected;
+      await expect(file.read(0, buffer.length)).rejects.toThrow();
     });
 
-    test('del method', async () => {
+    test('del method', async (t) => {
+      // File.del() throws 'Not deletable' error for IDb.
+      if (testGroupName !== StorageType.NODE) {
+        t.skip();
+      }
       const storage = createStorage();
 
       const directory = storage.createDirectory();
@@ -234,14 +236,14 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       await file.del(buffer1.length, buffer2.length);
       expect((await file.stat()).size).to.equal(buffer1.length);
       expect(await file.read(0, buffer1.length)).to.deep.equal(buffer1);
-      await expect(file.read(buffer1.length, buffer2.length)).to.be.rejectedWith('Could not satisfy length');
-    }).onlyEnvironments('nodejs'); // File.del() throws 'Not deletable' error for IDb.
+      await expect(file.read(buffer1.length, buffer2.length)).rejects.toThrow('Could not satisfy length');
+    });
 
     test('stat of new file', async () => {
       const storage = createStorage();
       const directory = storage.createDirectory();
       const file = directory.getOrCreateFile(randomText());
-      expect((await file.stat()).size).to.equal(0);
+      expect((await file.stat()).size).toBe(0);
     });
 
     test('call del with edge arguments', async () => {
@@ -257,21 +259,21 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
         const file = directory.getOrCreateFile(randomText());
         await file.write(0, buffer);
         await file.del(0, buffer.length + 1);
-        expect((await file.stat()).size).to.equal(0);
+        expect((await file.stat()).size).toBe(0);
       }
 
       {
         const file = directory.getOrCreateFile(randomText());
         await file.write(0, buffer);
         await file.del(1, buffer.length);
-        expect((await file.stat()).size).to.equal(1);
+        expect((await file.stat()).size).toBe(1);
       }
 
       {
         const file = directory.getOrCreateFile(randomText());
         await file.write(0, buffer);
         await file.del(0, -1);
-        expect((await file.stat()).size).to.equal(buffer.length);
+        expect((await file.stat()).size).toBe(buffer.length);
       }
     });
 
@@ -297,7 +299,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
         const storage = createStorage();
         const directory = storage.createDirectory();
         const file = directory.getOrCreateFile(filename);
-        expect(await file.read(0, buffer.length)).to.deep.equal(buffer);
+        await expect(file.read(0, buffer.length)).resolves.toEqual(buffer);
         await file.close();
       }
 
@@ -310,13 +312,13 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
         const storage = createStorage();
         const directory = storage.createDirectory();
         const file = directory.getOrCreateFile(filename);
-        await expect(file.read(0, buffer.length)).to.be.rejected;
+        await expect(file.read(0, buffer.length)).rejects.toThrow();
       }
     });
 
-    test('list all files after reopen', async function () {
+    test('list all files after reopen', async (t) => {
       if (testGroupName !== StorageType.WEBFS && testGroupName !== StorageType.NODE) {
-        this.skip();
+        t.skip();
       }
 
       const dirname = randomText();
@@ -326,7 +328,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
 
       {
         const entries = await directory.list();
-        expect(entries.length).to.equal(0);
+        expect(entries.length).toBe(0);
       }
 
       const files = [...Array(10)].map(() => directory.getOrCreateFile(randomText()));
@@ -337,14 +339,14 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
 
       {
         const entries = await directory.list();
-        expect(entries.length).to.equal(files.length);
+        expect(entries.length).toBe(files.length);
       }
 
       {
         const storage = createStorage();
         const directory = storage.createDirectory(dirname);
         const entries = await directory.list();
-        expect(entries.length).to.equal(files.length);
+        expect(entries.length).toBe(files.length);
       }
     });
 
@@ -360,7 +362,7 @@ export const storageTests = (testGroupName: StorageType, createStorage: () => St
       }
       await directory.flush();
       const entries = await directory.list();
-      expect(entries).to.contain.members(FILES);
+      expect(entries).toEqual(expect.arrayContaining(FILES));
     });
   });
 };

package/src/testing/wait-for-debugger.ts

@@ -0,0 +1,22 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { sleep } from '@dxos/async';
+
+/**
+ * Will wait for the debugger to be attached and stop on the breakpoint.
+ * You can then press "step-out" to return to the caller.
+ */
+export const waitForDebugger = async () => {
+  while (true) {
+    const before = performance.now();
+    // eslint-disable-next-line no-debugger
+    debugger;
+    const after = performance.now();
+    if (after - before > 100) {
+      break;
+    }
+    await sleep(100);
+  }
+};

package/dist/types/src/browser/bench.test.d.ts

@@ -1,2 +0,0 @@
-import 'source-map-support/register';
-//# sourceMappingURL=bench.test.d.ts.map

package/dist/types/src/browser/bench.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bench.test.d.ts","sourceRoot":"","sources":["../../../../src/browser/bench.test.ts"],"names":[],"mappings":"AAMA,OAAO,6BAA6B,CAAC"}

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

@@ -1,2 +0,0 @@
-import 'source-map-support/register';
-//# sourceMappingURL=storage.test.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"storage.test.d.ts","sourceRoot":"","sources":["../../../../src/browser/storage.test.ts"],"names":[],"mappings":"AAOA,OAAO,6BAA6B,CAAC"}

package/dist/types/src/node/bench.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=bench.test.d.ts.map

package/dist/types/src/node/bench.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bench.test.d.ts","sourceRoot":"","sources":["../../../../src/node/bench.test.ts"],"names":[],"mappings":""}

package/dist/types/src/node/storage.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=storage.test.d.ts.map

package/dist/types/src/node/storage.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"storage.test.d.ts","sourceRoot":"","sources":["../../../../src/node/storage.test.ts"],"names":[],"mappings":""}