refactor(core/biblio-db): Move from indexedDB to idb

src/core/biblio-db.js

@@ -7,60 +7,22 @@
  * It's a standalone module that can be imported into other modules.
  *
  */
-/* globals IDBKeyRange, DOMException */
+/* globals IDBKeyRange */
+import { openDB } from "idb";
 import { pub } from "./pubsubhub";
 export const name = "core/biblio-db";
 
 const ALLOWED_TYPES = new Set(["alias", "reference"]);
 // Database initialization, tracked by "readyPromise"
-const readyPromise = new Promise((resolve, reject) => {
-  let request;
-  try {
-    request = window.indexedDB.open("respec-biblio2", 12);
-  } catch (err) {
-    return reject(err);
-  }
-  request.onerror = () => {
-    reject(new DOMException(request.error.message, request.error.name));
-  };
-  request.onsuccess = () => {
-    resolve(request.result);
-  };
-  request.onupgradeneeded = async () => {
-    const db = request.result;
+const readyPromise = openDB("respec-biblio2", 12, {
+  upgrade(db) {
     Array.from(db.objectStoreNames).map(storeName =>
       db.deleteObjectStore(storeName)
     );
-    const promisesToCreateSchema = [
-      new Promise((resolve, reject) => {
-        try {
-          const store = db.createObjectStore("alias", { keyPath: "id" });
-          store.createIndex("aliasOf", "aliasOf", { unique: false });
-          store.transaction.oncomplete = resolve;
-          store.transaction.onerror = reject;
-        } catch (err) {
-          reject(err);
-        }
-      }),
-      new Promise((resolve, reject) => {
-        try {
-          const transaction = db.createObjectStore("reference", {
-            keyPath: "id",
-          }).transaction;
-          transaction.oncomplete = resolve;
-          transaction.onerror = reject;
-        } catch (err) {
-          reject(err);
-        }
-      }),
-    ];
-    try {
-      await Promise.all(promisesToCreateSchema);
-      resolve();
-    } catch (err) {
-      reject(err);
-    }
-  };
+    const store = db.createObjectStore("alias", { keyPath: "id" });
+    store.createIndex("aliasOf", "aliasOf", { unique: false });
+    db.createObjectStore("reference", { keyPath: "id" });
+  },
 });
 
 export const biblioDB = {
@@ -78,7 +40,7 @@ export const biblioDB = {
     if (await this.isAlias(id)) {
       id = await this.resolveAlias(id);
     }
-    return this.get("reference", id);
+    return await this.get("reference", id);
   },
   /**
    * Checks if the database has an id for a given type.
@@ -95,17 +57,9 @@ export const biblioDB = {
       throw new TypeError("id is required");
     }
     const db = await this.ready;
-    return new Promise((resolve, reject) => {
-      const objectStore = db.transaction([type], "readonly").objectStore(type);
-      const range = IDBKeyRange.only(id);
-      const request = objectStore.openCursor(range);
-      request.onsuccess = () => {
-        resolve(!!request.result);
-      };
-      request.onerror = () => {
-        reject(new DOMException(request.error.message, request.error.name));
-      };
-    });
+    const objectStore = db.transaction([type], "readonly").objectStore(type);
+    const range = IDBKeyRange.only(id);
+    return !!(await objectStore.openCursor(range));
   },
   /**
    * Checks if a given id is an alias.
@@ -118,19 +72,11 @@ export const biblioDB = {
       throw new TypeError("id is required");
     }
     const db = await this.ready;
-    return new Promise((resolve, reject) => {
-      const objectStore = db
-        .transaction(["alias"], "readonly")
-        .objectStore("alias");
-      const range = IDBKeyRange.only(id);
-      const request = objectStore.openCursor(range);
-      request.onsuccess = () => {
-        resolve(!!request.result);
-      };
-      request.onerror = () => {
-        reject(new DOMException(request.error.message, request.error.name));
-      };
-    });
+    const objectStore = db
+      .transaction(["alias"], "readonly")
+      .objectStore("alias");
+    const range = IDBKeyRange.only(id);
+    return !!(await objectStore.openCursor(range));
   },
   /**
    * Resolves an alias to its corresponding reference id.
@@ -143,22 +89,13 @@ export const biblioDB = {
       throw new TypeError("id is required");
     }
     const db = await this.ready;
-    return new Promise((resolve, reject) => {
-      const objectStore = db
-        .transaction("alias", "readonly")
-        .objectStore("alias");
-      const range = IDBKeyRange.only(id);
-      const request = objectStore.openCursor(range);
-      request.onsuccess = () => {
-        if (request.result === null) {
-          return resolve(null);
-        }
-        resolve(request.result.value.aliasOf);
-      };
-      request.onerror = () => {
-        reject(new DOMException(request.error.message, request.error.name));
-      };
-    });
+
+    const objectStore = db
+      .transaction("alias", "readonly")
+      .objectStore("alias");
+    const range = IDBKeyRange.only(id);
+    const result = await objectStore.openCursor(range);
+    return result ? result.value.aliasOf : result;
   },
   /**
    * Get a reference or alias out of the database.
@@ -175,20 +112,10 @@ export const biblioDB = {
       throw new TypeError("id is required");
     }
     const db = await this.ready;
-    return new Promise((resolve, reject) => {
-      const objectStore = db.transaction([type], "readonly").objectStore(type);
-      const range = IDBKeyRange.only(id);
-      const request = objectStore.openCursor(range);
-      request.onsuccess = () => {
-        if (request.result === null) {
-          return resolve(null);
-        }
-        resolve(request.result.value);
-      };
-      request.onerror = () => {
-        reject(new DOMException(request.error.message, request.error.name));
-      };
-    });
+    const objectStore = db.transaction([type], "readonly").objectStore(type);
+    const range = IDBKeyRange.only(id);
+    const result = await objectStore.openCursor(range);
+    return result ? result.value : result;
   },
   /**
    * Adds references and aliases to database. This is usually the data from
@@ -226,8 +153,8 @@ export const biblioDB = {
       }, aliasesAndRefs);
     const promisesToAdd = Object.keys(aliasesAndRefs)
       .map(type => {
-        return Array.from(aliasesAndRefs[type]).map(details =>
-          this.add(type, details)
+        return Array.from(aliasesAndRefs[type]).map(
+          async details => await this.add(type, details)
         );
       })
       .reduce((collector, promises) => collector.concat(promises), []);
@@ -251,15 +178,10 @@ export const biblioDB = {
     }
     const db = await this.ready;
     const isInDB = await this.has(type, details.id);
-    return new Promise((resolve, reject) => {
-      const store = db.transaction([type], "readwrite").objectStore(type);
-      // update or add, depending of already having it in db
-      const request = isInDB ? store.put(details) : store.add(details);
-      request.onsuccess = resolve;
-      request.onerror = () => {
-        reject(new DOMException(request.error.message, request.error.name));
-      };
-    });
+    const store = db.transaction([type], "readwrite").objectStore(type);
+    // update or add, depending of already having it in db
+    const request = isInDB ? store.put(details) : store.add(details);
+    return await request;
   },
   /**
    * Closes the underlying database.
@@ -277,21 +199,10 @@ export const biblioDB = {
   async clear() {
     const db = await this.ready;
     const storeNames = [...ALLOWED_TYPES];
-    const stores = await new Promise((resolve, reject) => {
-      const transaction = db.transaction(storeNames, "readwrite");
-      transaction.onerror = () => {
-        reject(
-          new DOMException(transaction.error.message, transaction.error.name)
-        );
-      };
-      resolve(transaction);
-    });
-    const clearStorePromises = storeNames.map(name => {
-      return new Promise(resolve => {
-        const request = stores.objectStore(name).clear();
-        request.onsuccess = resolve;
-      });
+    const stores = await db.transaction(storeNames, "readwrite");
+    const clearStorePromises = storeNames.map(async name => {
+      return await stores.objectStore(name).clear();
     });
-    Promise.all(clearStorePromises);
+    await Promise.all(clearStorePromises);
   },
 };

tests/SpecRunner.html

@@ -28,6 +28,12 @@
         paths: {
           "jquery": "deps/jquery",
           "marked": "deps/marked",
+          "idb": "deps/idb",
+        },
+        shim: {
+          idb:  {
+            exports: "idb",
+          },
         },
         deps: testFiles,
         callback: runner,

tests/spec/core/xref-spec.js

@@ -4,8 +4,7 @@ describe("Core — xref", () => {
 
   let cache;
   beforeAll(async () => {
-    await new Promise(resolve => require(["deps/idb"], resolve));
-    const { openDB } = window.idb;
+    const { openDB } = await new Promise(resolve => require(["idb"], resolve));
     const { IDBKeyVal } = await new Promise(resolve =>
       require(["core/utils"], resolve)
     );

tests/test-main.js

@@ -21,11 +21,16 @@ require.config({
     w3c: "/base/js/w3c",
     clipboard: "deps/clipboard",
     hyperhtml: "deps/hyperhtml",
-    "idb-keyval": "deps/idb",
+    idb: "deps/idb",
     jquery: "deps/jquery",
     marked: "deps/marked",
     pluralize: "deps/pluralize",
     text: "deps/text",
     webidl2: "deps/webidl2",
   },
+  shim: {
+    idb: {
+      exports: "idb",
+    },
+  },
 });