gloader/extensions/downthemall/lib/db.ts

"use strict";
// License: MIT

// eslint-disable-next-line no-unused-vars
import { BaseItem } from "./item";
// eslint-disable-next-line no-unused-vars
import { Download } from "./manager/download";
import { RUNNING, QUEUED, RETRYING } from "./manager/state";
import { storage } from "./browser";
import { sort } from "./sorting";

const VERSION = 1;
const STORE = "queue";

interface Database {
  init(): Promise<void>;
  saveItems(items: Download[]): Promise<unknown>;
  deleteItems(items: any[]): Promise<void>;
  getAll(): Promise<BaseItem[]>;
}

export class IDB implements Database {
  private db?: IDBDatabase;

  constructor() {
    this.db = undefined;
    this.getAllInternal = this.getAllInternal.bind(this);
  }

  async init() {
    if (this.db) {
      return;
    }
    await new Promise((resolve, reject) => {
      const req = indexedDB.open("downloads", VERSION);
      req.onupgradeneeded = evt => {
        const db = req.result;
        switch (evt.oldVersion) {
        case 0: {
          const queueStore = db.createObjectStore(STORE, {
            keyPath: "dbId",
            autoIncrement: true
          });
          queueStore.createIndex("by_position", "position", {unique: false});
          break;
        }
        }
      };
      req.onerror = ex => reject(ex);
      req.onsuccess = () => {
        this.db = req.result;
        resolve();
      };
    });
  }

  getAllInternal(resolve: (items: BaseItem[]) => void, reject: Function) {
    if (!this.db) {
      reject(new Error("db closed"));
      return;
    }
    const items: BaseItem[] = [];
    const transaction = this.db.transaction(STORE, "readonly");
    transaction.onerror = ex => reject(ex);
    const store = transaction.objectStore(STORE);
    const index = store.index("by_position");
    index.openCursor().onsuccess = event => {
      const cursor = (event.target as IDBRequest<IDBCursorWithValue>).result;
      if (!cursor) {
        resolve(items);
        return;
      }
      items.push(cursor.value);
      cursor.continue();
    };
  }

  async getAll() {
    await this.init();
    return await new Promise(this.getAllInternal);
  }

  saveItemsInternal(items: Download[], resolve: Function, reject: Function) {
    if (!items || !items.length || !this.db) {
      resolve();
      return;
    }
    try {
      const transaction = this.db.transaction(STORE, "readwrite");
      transaction.onerror = ex => reject(ex);
      transaction.oncomplete = () => resolve();
      const store = transaction.objectStore(STORE);
      for (const item of items) {
        if (item.private) {
          continue;
        }
        const json = item.toJSON();
        if (item.state === RUNNING || item.state === RETRYING) {
          json.state = QUEUED;
        }
        const req = store.put(json);
        if (!("dbId" in item) || item.dbId < 0) {
          req.onsuccess = () => item.dbId = req.result as number;
        }
      }
    }
    catch (ex) {
      reject(ex);
    }
  }

  async saveItems(items: Download[]) {
    await this.init();
    return await new Promise(this.saveItemsInternal.bind(this, items));
  }

  deleteItemsInternal(items: any[], resolve: () => void, reject: Function) {
    if (!items || !items.length || !this.db) {
      resolve();
      return;
    }
    try {
      const transaction = this.db.transaction(STORE, "readwrite");
      transaction.onerror = ex => reject(ex);
      transaction.oncomplete = () => resolve();
      const store = transaction.objectStore(STORE);
      for (const item of items) {
        if (item.private) {
          continue;
        }
        if (!("dbId" in item)) {
          continue;
        }
        store.delete(item.dbId);
      }
    }
    catch (ex) {
      console.error(ex.message, ex);
      reject(ex);
    }
  }

  async deleteItems(items: any[]) {
    if (!items.length) {
      return;
    }
    await this.init();
    await new Promise(this.deleteItemsInternal.bind(this, items));
  }
}

class StorageDB implements Database {
  private counter = 1;

  async init(): Promise<void> {
    const {db = null} = await storage.local.get("db");
    if (!db || !db.counter) {
      return;
    }
    this.counter = db.counter;
  }

  async saveItems(items: Download[]) {
    const db: any = {items: []};
    for (const item of items) {
      if (!item.dbId) {
        item.dbId = ++this.counter;
      }
      db.items.push(item.toJSON());
    }
    db.counter = this.counter;
    await storage.local.set({db});
  }

  async deleteItems(items: any[]): Promise<void> {
    const gone = new Set(items.map(i => i.dbId));
    const {db = null} = await storage.local.get("db");
    if (!db) {
      return;
    }
    db.items = db.items.filter((i: any) => !gone.has(i.dbId));
    await storage.local.set({db});
  }

  async getAll() {
    const {db = null} = await storage.local.get("db");
    if (!db || !Array.isArray(db.items)) {
      return [];
    }
    return sort(db.items, (i: any) => i.position) as BaseItem[];
  }
}

class MemoryDB implements Database {
  private counter = 1;

  private items = new Map();

  init(): Promise<void> {
    return Promise.resolve();
  }

  saveItems(items: Download[]) {
    for (const item of items) {
      if (item.private) {
        continue;
      }
      if (!item.dbId) {
        item.dbId = ++this.counter;
      }
      this.items.set(item.dbId, item.toJSON());
    }
    return Promise.resolve();
  }

  deleteItems(items: any[]) {
    for (const item of items) {
      if (!("dbId" in item)) {
        continue;
      }
      this.items.delete(item.dbId);
    }
    return Promise.resolve();
  }

  getAll(): Promise<BaseItem[]> {
    return Promise.resolve(Array.from(this.items.values()));
  }
}

export const DB = new class DBWrapper implements Database {
  saveItems(items: Download[]): Promise<unknown> {
    return this.db.saveItems(items);
  }

  deleteItems(items: any[]): Promise<void> {
    return this.db.deleteItems(items);
  }

  getAll(): Promise<BaseItem[]> {
    return this.db.getAll();
  }

  private db: Database;

  async init() {
    try {
      this.db = new IDB();
      await this.db.init();
    }
    catch (ex) {
      console.warn(
        "Failed to initialize idb backend, using storage db fallback", ex);
      try {
        this.db = new StorageDB();
        await this.db.init();
      }
      catch (ex) {
        console.warn(
          "Failed to initialize storage backend, using memory db fallback", ex);
        this.db = new MemoryDB();
        await this.db.init();
      }
    }
  }
}();