feat: add IndexedDB unit test

Author: jin-sir

jest.config.js

@@ -9,4 +9,5 @@ module.exports = {
     testPathIgnorePatterns: ['/node_modules/'],
     testMatch: ['**/__test__/**/(*.)+test.[jt]s?(x)'],
     moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+    setupFilesAfterEnv: ['./jest.setup.ts'],
 };

jest.setup.ts

@@ -0,0 +1,6 @@
+import structuredClone from '@ungap/structured-clone';
+import 'fake-indexeddb/auto';
+
+if (typeof globalThis.structuredClone !== 'function') {
+    globalThis.structuredClone = structuredClone as unknown as typeof globalThis.structuredClone;
+}

package.json

@@ -46,10 +46,12 @@
         "@types/js-cookie": "^3.0.6",
         "@types/lodash-es": "^4.17.12",
         "@types/ua-parser-js": "^0.7.39",
+        "@ungap/structured-clone": "^1.3.0",
         "commitizen": "^4.3.1",
         "commitlint": "^19.5.0",
         "conventional-changelog-cli": "^2.0.31",
         "cz-conventional-changelog": "^3.3.0",
+        "fake-indexeddb": "^6.2.5",
         "gh-pages": "^6.3.0",
         "husky": "^9.1.6",
         "jest": "^29.7.0",

pnpm-lock.yaml

@@ -0,0 +1,98 @@
+import IndexedDB from '../index';
+
+describe('IndexedDB', () => {
+    const DB_NAME = 'testDB';
+    const STORE_NAME = 'testStore';
+    const VERSION = 1;
+
+    let db: IndexedDB;
+
+    beforeEach(async () => {
+        db = new IndexedDB(DB_NAME, VERSION, STORE_NAME);
+        await db.open();
+    });
+
+    afterEach(async () => {
+        const req = indexedDB.deleteDatabase(DB_NAME);
+        await new Promise((resolve) => {
+            req.onsuccess = req.onerror = req.onblocked = () => resolve(null);
+        });
+    });
+
+    // open
+    test('opens database successfully', async () => {
+        const instance = await db.open();
+        expect(instance).toBeDefined();
+        expect(instance.name).toBe(DB_NAME);
+    });
+
+    test('returns existing connection if already opened', async () => {
+        const first = await db.open();
+        const second = await db.open();
+        expect(first).toBe(second);
+    });
+
+    // 'add & get'
+    test('adds and retrieves data', async () => {
+        await db.add('user1', { name: 'John', age: 30 });
+
+        const result = await db.get<{ name: string; age: number }>('user1');
+
+        expect(result).toEqual({ name: 'John', age: 30 });
+    });
+
+    // set（update）
+    test('updates existing data', async () => {
+        await db.add('user1', { name: 'John', age: 30 });
+        await db.set('user1', { name: 'John', age: 31 });
+
+        const result = await db.get<{ age: number }>('user1');
+        expect(result.age).toBe(31);
+    });
+
+    // delete
+    test('deletes data by key', async () => {
+        await db.add('user1', { name: 'John' });
+        await db.delete('user1');
+
+        const result = await db.get('user1');
+        expect(result).toBeUndefined();
+    });
+
+    // clear
+    test('clears all data in store', async () => {
+        await db.add('user1', { name: 'John' });
+        await db.add('user2', { name: 'Jane' });
+
+        await db.clear();
+
+        const result1 = await db.get('user1');
+        const result2 = await db.get('user2');
+
+        expect(result1).toBeUndefined();
+        expect(result2).toBeUndefined();
+    });
+
+    //   ensureConnection / error handling
+    test('throws error when operating before open', async () => {
+        const newDB = new IndexedDB('newDB', 1, 'store');
+
+        await expect(newDB.get('key')).resolves.toBeUndefined();
+    });
+
+    test('handles non-existing key gracefully', async () => {
+        const result = await db.get('not-exist');
+        expect(result).toBeUndefined();
+    });
+
+    // version upgrade
+    test('creates object store on upgrade', async () => {
+        const oldDb = new IndexedDB('upgradeDB', 1, 'store1');
+        await oldDb.open();
+
+        const newDb = new IndexedDB('upgradeDB', 2, 'store2');
+        const instance = await newDb.open();
+
+        expect(instance.objectStoreNames.contains('store2')).toBe(true);
+    });
+});