Skip to content

A fully open source & end-to-end encrypted note taking alternative to Evernote.

9.1 KB
Raw Blame
/*
This file is part of the Notesnook project (https://notesnook.com/)

Copyright (C) 2023 Streetwriters (Private) Limited

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

// Copyright 2022 Roy T. Hashimoto. All Rights Reserved.
import * as VFS from "./VFS.js";

const LOCK_TYPE_MASK =
  VFS.SQLITE_LOCK_NONE |
  VFS.SQLITE_LOCK_SHARED |
  VFS.SQLITE_LOCK_RESERVED |
  VFS.SQLITE_LOCK_PENDING |
  VFS.SQLITE_LOCK_EXCLUSIVE;

export class WebLocksBase {
  get state() {
    return this.#state;
  }
  #state = VFS.SQLITE_LOCK_NONE;

  timeoutMillis = 0;

  /** @type {Map<string, (value: any) => void>} */ #releasers = new Map();
  /** @type {Promise<0|5|3850>} */ #pending = Promise.resolve(0);

  /**
   * @param {number} flags
   * @returns {Promise<0|5|3850>} SQLITE_OK, SQLITE_BUSY, SQLITE_IOERR_LOCK
   */
  async lock(flags) {
    return this.#apply(this.#lock, flags);
  }

  /**
   * @param {number} flags
   * @returns {Promise<0|5|3850>} SQLITE_OK, SQLITE_IOERR_LOCK
   */
  async unlock(flags) {
    return this.#apply(this.#unlock, flags);
  }

  /**
   * @returns {Promise<boolean>}
   */
  async isSomewhereReserved() {
    throw new Error("unimplemented");
  }

  /**
   *
   * @param {(targetState: number) => void} method
   * @param {number} flags
   */
  async #apply(method, flags) {
    const targetState = flags & LOCK_TYPE_MASK;
    try {
      // Force locks and unlocks to run sequentially. This allows not
      // waiting for unlocks to complete.
      const call = () => method.call(this, targetState);
      await (this.#pending = this.#pending.then(call, call));
      this.#state = targetState;
      return VFS.SQLITE_OK;
    } catch (e) {
      if (e.name === "AbortError") {
        return VFS.SQLITE_BUSY;
      }
      console.error(e);
      return VFS.SQLITE_IOERR_LOCK;
    }
  }

  async #lock(targetState) {
    if (targetState === this.#state) return VFS.SQLITE_OK;
    switch (this.#state) {
      case VFS.SQLITE_LOCK_NONE:
        switch (targetState) {
          case VFS.SQLITE_LOCK_SHARED:
            return this._NONEtoSHARED();
          default:
            throw new Error(
              `unexpected transition ${this.#state} -> ${targetState}`
            );
        }

      case VFS.SQLITE_LOCK_SHARED:
        switch (targetState) {
          case VFS.SQLITE_LOCK_RESERVED:
            return this._SHAREDtoRESERVED();
          case VFS.SQLITE_LOCK_EXCLUSIVE:
            return this._SHAREDtoEXCLUSIVE();
          default:
            throw new Error(
              `unexpected transition ${this.#state} -> ${targetState}`
            );
        }

      case VFS.SQLITE_LOCK_RESERVED:
        switch (targetState) {
          case VFS.SQLITE_LOCK_EXCLUSIVE:
            return this._RESERVEDtoEXCLUSIVE();
          default:
            throw new Error(
              `unexpected transition ${this.#state} -> ${targetState}`
            );
        }

      default:
        throw new Error(
          `unexpected transition ${this.#state} -> ${targetState}`
        );
    }
  }

  async #unlock(targetState) {
    if (targetState === this.#state) return VFS.SQLITE_OK;
    switch (this.#state) {
      case VFS.SQLITE_LOCK_EXCLUSIVE:
        switch (targetState) {
          case VFS.SQLITE_LOCK_SHARED:
            return this._EXCLUSIVEtoSHARED();
          case VFS.SQLITE_LOCK_NONE:
            return this._EXCLUSIVEtoNONE();
          default:
            throw new Error(
              `unexpected transition ${this.#state} -> ${targetState}`
            );
        }

      case VFS.SQLITE_LOCK_RESERVED:
        switch (targetState) {
          case VFS.SQLITE_LOCK_SHARED:
            return this._RESERVEDtoSHARED();
          case VFS.SQLITE_LOCK_NONE:
            return this._RESERVEDtoNONE();
          default:
            throw new Error(
              `unexpected transition ${this.#state} -> ${targetState}`
            );
        }

      case VFS.SQLITE_LOCK_SHARED:
        switch (targetState) {
          case VFS.SQLITE_LOCK_NONE:
            return this._SHAREDtoNONE();
          default:
            throw new Error(
              `unexpected transition ${this.#state} -> ${targetState}`
            );
        }

      default:
        throw new Error(
          `unexpected transition ${this.#state} -> ${targetState}`
        );
    }
  }

  async _NONEtoSHARED() {}

  async _SHAREDtoEXCLUSIVE() {
    await this._SHAREDtoRESERVED();
    await this._RESERVEDtoEXCLUSIVE();
  }

  async _SHAREDtoRESERVED() {}

  async _RESERVEDtoEXCLUSIVE() {}

  async _EXCLUSIVEtoRESERVED() {}

  async _EXCLUSIVEtoSHARED() {
    await this._EXCLUSIVEtoRESERVED();
    await this._RESERVEDtoSHARED();
  }

  async _EXCLUSIVEtoNONE() {
    await this._EXCLUSIVEtoRESERVED();
    await this._RESERVEDtoSHARED();
    await this._SHAREDtoNONE();
  }

  async _RESERVEDtoSHARED() {}

  async _RESERVEDtoNONE() {
    await this._RESERVEDtoSHARED();
    await this._SHAREDtoNONE();
  }

  async _SHAREDtoNONE() {}

  /**
   * @param {string} lockName
   * @param {LockOptions} options
   * @returns {Promise<?Lock>}
   */
  _acquireWebLock(lockName, options) {
    return new Promise(async (resolve, reject) => {
      try {
        await navigator.locks.request(lockName, options, (lock) => {
          resolve(lock);
          if (lock) {
            return new Promise((release) =>
              this.#releasers.set(lockName, release)
            );
          }
        });
      } catch (e) {
        reject(e);
      }
    });
  }

  /**
   * @param {string} lockName
   */
  _releaseWebLock(lockName) {
    this.#releasers.get(lockName)?.();
    this.#releasers.delete(lockName);
  }

  /**
   * @param {string} lockName
   */
  async _pollWebLock(lockName) {
    const query = await navigator.locks.query();
    return query.held.find(({ name }) => name === lockName)?.mode;
  }

  /**
   * @returns {?AbortSignal}
   */
  _getTimeoutSignal() {
    if (this.timeoutMillis) {
      const abortController = new AbortController();
      setTimeout(() => abortController.abort(), this.timeoutMillis);
      return abortController.signal;
    }
    return undefined;
  }
}

export class WebLocksExclusive extends WebLocksBase {
  /**
   * @param {string} name
   */
  constructor(name) {
    super();
    this._lockName = name + "-outer";
    this._reservedName = name + "-reserved";
  }

  async isSomewhereReserved() {
    const mode = await this._pollWebLock(this._reservedName);
    return mode === "exclusive";
  }

  async _NONEtoSHARED() {
    await this._acquireWebLock(this._lockName, {
      mode: "exclusive",
      signal: this._getTimeoutSignal()
    });
  }

  async _SHAREDtoRESERVED() {
    await this._acquireWebLock(this._reservedName, {
      mode: "exclusive",
      signal: this._getTimeoutSignal()
    });
  }

  async _RESERVEDtoSHARED() {
    this._releaseWebLock(this._reservedName);
  }

  async _SHAREDtoNONE() {
    this._releaseWebLock(this._lockName);
  }
}

export class WebLocksShared extends WebLocksBase {
  maxRetryMillis = 1000;

  /**
   * @param {string} name
   */
  constructor(name) {
    super();
    this._outerName = name + "-outer";
    this._innerName = name + "-inner";
  }

  async isSomewhereReserved() {
    const mode = await this._pollWebLock(this._outerName);
    return mode === "exclusive";
  }

  async _NONEtoSHARED() {
    await this._acquireWebLock(this._outerName, {
      mode: "shared",
      signal: this._getTimeoutSignal()
    });
    await this._acquireWebLock(this._innerName, {
      mode: "shared",
      signal: this._getTimeoutSignal()
    });
    this._releaseWebLock(this._outerName);
  }

  async _SHAREDtoRESERVED() {
    let timeoutMillis = 1;
    while (true) {
      // Attempt to get the outer lock without blocking.
      const isLocked = await this._acquireWebLock(this._outerName, {
        mode: "exclusive",
        ifAvailable: true
      });
      if (isLocked) break;

      if (await this.isSomewhereReserved()) {
        // Someone else has a reserved lock so retry cannot succeed.
        throw new DOMException("", "AbortError");
      }

      await new Promise((resolve) => setTimeout(resolve, timeoutMillis));
      timeoutMillis = Math.min(2 * timeoutMillis, this.maxRetryMillis);
    }
    this._releaseWebLock(this._innerName);
  }

  async _RESERVEDtoEXCLUSIVE() {
    await this._acquireWebLock(this._innerName, {
      mode: "exclusive",
      signal: this._getTimeoutSignal()
    });
  }

  async _EXCLUSIVEtoRESERVED() {
    this._releaseWebLock(this._innerName);
  }

  async _RESERVEDtoSHARED() {
    await this._acquireWebLock(this._innerName, { mode: "shared" });
    this._releaseWebLock(this._outerName);
  }

  async _SHAREDtoNONE() {
    this._releaseWebLock(this._innerName);
  }
}