@activeledger/activestorage 4.5.12 → 4.5.14

package/src/cache.ts

@@ -1,72 +0,0 @@
-// filterOldTxList on index.ts may be better to use this testing between the 2 will tell.
-
-export class Cache<T = any> {
-  private data: Map<string, T>;
-  private timers: Map<string, NodeJS.Timeout>;
-  constructor(private ttl = 1200000) {
-    this.data = new Map();
-    this.timers = new Map();
-  }
-
-  public set(key: string, value: T, ttl?: number): void {
-    if (this.timers.has(key)) {
-      clearTimeout(this.timers.get(key));
-    }
-    this.timers.set(
-      key,
-      setTimeout(() => this.delete(key), ttl ?? this.ttl)
-    );
-    this.data.set(key, value);
-  }
-
-  public delete(key: string): void {
-    if (this.timers.has(key)) {
-      clearTimeout(this.timers.get(key));
-      this.timers.delete(key);
-    }
-    this.data.delete(key);
-  }
-
-  public get(key: string, extend?: number): T | undefined {
-    const value = this.data.get(key);
-    if (value && extend) {
-      // Refresh the TTL
-      this.set(key, value, extend);
-    }
-    return value;
-  }
-
-  public has(key: string): boolean {
-    return this.data.has(key);
-  }
-
-  public clear(): void {
-    this.data.clear();
-    for (const timer of this.timers.values()) {
-      clearTimeout(timer);
-    }
-    this.timers.clear();
-  }
-
-  public size(): number {
-    return this.data.size;
-  }
-}
-
-  export class CacheManager {
-    private static caches: {
-      [index: string]: Cache;
-    } = {};
-  
-    public static fetch<T = any>(name: string, ttl?: number): Cache<T> {
-      if (!this.caches[name]) {
-        this.caches[name] = new Cache(ttl);
-      }
-      return this.caches[name];
-    }
-  
-    public static all(): Cache<any>[] {
-      return Object.values(this.caches);
-    }
-  }
-  

package/src/datastore.ts

@@ -1,187 +0,0 @@
-/*
- * MIT License (MIT)
- * Copyright (c) 2018 Activeledger
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import * as fs from "fs";
-import { promises as fsPromises } from "fs";
-import * as child from "child_process";
-import { ActiveOptions } from "@activeledger/activeoptions";
-import { ActiveLogger } from "@activeledger/activelogger";
-
-// Maximum restarts allowed
-const MAX_RESTARTS = 5;
-
-// How long until the restart counter is allowed to be reset.
-const MAX_RESTART_RESET_HOURS = 24;
-
-/**
- * Manage the self hosted data storage engine
- *
- * @export
- * @class DataStore
- */
-export class ActiveDataStore {
-  // Flag to prevent restart loop
-  public isShuttingDown = false;
-
-  /**
-   * Folder location
-   *
-   * @private
-   * @type {string}
-   */
-  private dsLocation: string;
-
-  /**
-   * Running process
-   *
-   * @private
-   * @type {child.ChildProcess}
-   */
-  private process: child.ChildProcess;
-
-  /**
-   * Keeps track how many time database restart has occured
-   * This wont solve the restart problem just reduce the logs
-   *
-   * @private
-   */
-  private restartCounter = 0;
-
-  /**
-   * Keeps track the last time it has restarted. This is used
-   * as part of the counter and max retries so long running instances are not
-   * effected by this new restriction
-   *
-   * @private
-   * @type {Date}
-   */
-  private lastRestart: number = Date.now();
-
-  /**
-   * Creates an instance of DataStore.
-   */
-  constructor() {
-    // Set Folder Location
-    this.dsLocation = ActiveOptions.get<any>("db", {}).selfhost.dir || "./.ds";
-
-    // Check folder exists
-    if (!fs.existsSync(this.dsLocation)) {
-      fs.mkdirSync(this.dsLocation);
-    }
-
-    // Start Server, Can't block as server wont return
-    ActiveLogger.info(
-      "Self-hosted data engine @ http://127.0.0.1:" +
-        ActiveOptions.get<any>("db", {}).selfhost.port
-    );
-  }
-
-  /**
-   * Launch data store process
-   *
-   * @private
-   * @returns {string}
-   */
-  public launch(): string {
-    const dbInfo = ActiveOptions.get<any>("db", {});
-    // Launch Background Database Process
-    this.process = child.spawn(
-      "node",
-      [
-        __dirname + "/selfhost.js",
-        this.dsLocation,
-        `${dbInfo.selfhost.port}`,
-        `${dbInfo.selfhost.engine || "level"}`,
-      ],
-      {
-        stdio: "inherit",
-      }
-    );
-
-    ActiveLogger.info(
-      `Self-hosted data engine (${
-        dbInfo.selfhost.engine || "level"
-      })  : Starting Up (${this.process.pid})`
-    );
-
-    // Store the PID for stop command
-    this.storePid(this.process.pid || 0);
-
-    // Listen for possible exits
-    this.process.on("exit", (code: number, signal: string) => {
-      // Just restart as we need the database up
-      ActiveLogger.error(
-        `Self-hosted data engine has shutdown (${code} : ${
-          signal || "No Signal"
-        })`
-      );
-      // As its an attached process killing activeledger will prevent this restart
-      // If killed via activeledger --stop check for SIGTERM signal and don't restart if it is
-      if (
-        !this.isShuttingDown &&
-        signal !== "SIGTERM" &&
-        MAX_RESTARTS >= this.restartCounter
-      ) {
-        this.restartCounter++;
-        this.launch();
-
-        // Can we reset the counter?
-        if (
-          Date.now() >
-          this.lastRestart + MAX_RESTART_RESET_HOURS * 60 * 60 * 1000
-        ) {
-          this.restartCounter = 0;
-        }
-      } else {
-        ActiveLogger.error(
-          "Not attempting to restart either due to signal or counters reached"
-        );
-      }
-    });
-
-    // Return running location
-    return "http://127.0.0.1:" + ActiveOptions.get<any>("db", {}).selfhost.port;
-  }
-
-  private async storePid(pid: number): Promise<void> {
-    const pidPath = ".PID";
-    let pidData: {
-      activeledger: number;
-      activestorage: number;
-      activecore: number;
-      activerestore: number;
-    };
-
-    try {
-      pidData = JSON.parse((await fsPromises.readFile(pidPath)).toString());
-      pidData.activestorage = pid;
-
-      await fsPromises.writeFile(pidPath, JSON.stringify(pidData));
-    } catch (error) {
-      ActiveLogger.warn(
-        "Error storing PID, activeledger --stop may not work correctly"
-      );
-      ActiveLogger.warn(error.message);
-    }
-  }
-}

package/src/driver.ts

@@ -1,18 +0,0 @@
-import { LevelUpChain } from "levelup";
-
-/**
- * Abstract interface for Activeledger storage backends.
- */
-export interface IStorageDriver {
-  get(key: string): Promise<Buffer>;
-  getMany(keys: string[]): Promise<Buffer[]>;
-  put(key: string, value: any): Promise<void>;
-  del(key: string): Promise<void>;
-  batch(): Promise<LevelUpChain<any, any>>;
-  createReadStream(options: any): any;
-  createValueStream(): any;
-  isOpen(): boolean;
-  open(): Promise<void>;
-  close(): Promise<void>;
-  compactRange?(start: string, end: string): Promise<void>;
-}

package/src/drivers/leveldb.ts

@@ -1,145 +0,0 @@
-import { IStorageDriver } from "../driver";
-import { LevelUpChain } from "levelup";
-import { mkdirSync } from "fs";
-import { ClassicLevel } from "classic-level";
-import { Readable } from "stream";
-
-export class LevelDBDriver implements IStorageDriver {
-  private db: any = null;
-  private opening: boolean = false;
-
-  constructor(private location: string, provider: string) {
-    mkdirSync(location, { recursive: true });
-  }
-
-  public async get(key: string): Promise<Buffer> {
-    const val = await this.db.get(key);
-    if (val === undefined) {
-      // classic-level resolves undefined for a missing key instead of
-      // throwing (unlike the older levelup/leveldown API) - callers
-      // (prepareForWrite() in particular) check error.notFound to detect
-      // a new document, so restore that convention here.
-      const err: any = new Error(`Key not found in database [${key}]`);
-      err.notFound = true;
-      err.code = "LEVEL_NOT_FOUND";
-      throw err;
-    }
-    return Buffer.isBuffer(val) ? val : Buffer.from(val);
-  }
-
-  public async getMany(keys: string[]): Promise<Buffer[]> {
-    const vals = await this.db.getMany(keys);
-    // classic-level resolves undefined per-key for anything missing from
-    // the batch (matching get()'s single-key behaviour) rather than
-    // throwing - callers (permissionsChecker's stream lookups in
-    // particular) request keys that legitimately don't always exist
-    // (e.g. an optional ":stream" companion document) and rely on
-    // getMany() simply omitting those, not on positional correspondence
-    // to the input keys, so filter rather than converting undefined and
-    // crashing the whole batch.
-    return vals
-      .filter((v: any) => v !== undefined)
-      .map((v: any) => Buffer.isBuffer(v) ? v : Buffer.from(v));
-  }
-
-  public async put(key: string, value: any): Promise<void> {
-    await this.db.put(key, value);
-  }
-
-  public async del(key: string): Promise<void> {
-    await this.db.del(key);
-  }
-
-  public async batch(): Promise<LevelUpChain<any, any>> {
-    if (!this.db || this.db.status !== 'open') {
-        await this.open();
-    }
-    return this.db.batch();
-  }
-
-  public createReadStream(options: any): any {
-    const iterator = this.db.iterator(options);
-
-    return new Readable({
-      objectMode: true,
-      async read() {
-        try {
-          const entry = await iterator.next();
-          if (entry) {
-            const val = entry[1];
-            this.push({ key: entry[0], value: Buffer.isBuffer(val) ? val : Buffer.from(val) });
-          } else {
-            this.push(null);
-            await iterator.close();
-          }
-        } catch (err) {
-          this.emit("error", err);
-          this.push(null);
-        }
-      },
-      async destroy(err: Error | null, callback: (error: Error | null) => void) {
-        await iterator.close();
-        callback(err);
-      }
-    });
-  }
-
-  // classic-level's values()/keys() return a modern async-iterable, not a
-  // classic Node Readable stream - levelme.ts's backup() needs .on("data"),
-  // so wrap it the same way createReadStream() wraps the kv iterator.
-  public createValueStream(): any {
-    const iterator = this.db.values();
-
-    return new Readable({
-      objectMode: true,
-      async read() {
-        try {
-          const val = await iterator.next();
-          if (val !== undefined) {
-            this.push(Buffer.isBuffer(val) ? val : Buffer.from(val));
-          } else {
-            this.push(null);
-            await iterator.close();
-          }
-        } catch (err) {
-          this.emit("error", err);
-          this.push(null);
-        }
-      },
-      async destroy(err: Error | null, callback: (error: Error | null) => void) {
-        await iterator.close();
-        callback(err);
-      }
-    });
-  }
-
-  public isOpen(): boolean {
-    return this.db?.status === 'open';
-  }
-
-  public async open(): Promise<void> {
-    if (this.db?.status !== 'open' && !this.opening) {
-      this.opening = true;
-      try {
-        this.db = new ClassicLevel(this.location, { valueEncoding: 'binary' });
-        await this.db.open();
-      } catch (e) {
-        // If opening fails, ensure the DB instance is cleared so it doesn't hold resources/locks
-        this.db = null;
-        throw e;
-      } finally {
-        this.opening = false;
-      }
-    }
-  }
-
-  public async close(): Promise<void> {
-    await this.db.close();
-  }
-
-  public async compactRange(start: string, end: string): Promise<void> {
-    if (typeof (this.db as any).compactRange === 'function') {
-        await (this.db as any).compactRange(start, end);
-    }
-  }
-}

package/src/drivers/rocksdb.ts

@@ -1,118 +0,0 @@
-import { IStorageDriver } from "../driver";
-import { LevelUpChain } from "levelup";
-import { mkdirSync } from "fs";
-const { RocksLevel } = require("@nxtedition/rocksdb");
-
-export class RocksDBDriver implements IStorageDriver {
-  private db: any = null;
-  private opening: boolean = false;
-
-  constructor(private location: string, provider: string) {
-    mkdirSync(location, { recursive: true });
-  }
-
-  public async get(key: string): Promise<Buffer> {
-    const val = await this.db.get(key);
-    if (val === undefined) {
-      // abstract-level-based drivers resolve undefined for a missing key
-      // instead of throwing (unlike the older levelup/leveldown API) -
-      // callers (prepareForWrite() in particular) check error.notFound to
-      // detect a new document, so restore that convention here.
-      const err: any = new Error(`Key not found in database [${key}]`);
-      err.notFound = true;
-      err.code = "LEVEL_NOT_FOUND";
-      throw err;
-    }
-    return Buffer.isBuffer(val) ? val : Buffer.from(val);
-  }
-
-  public async getMany(keys: string[]): Promise<Buffer[]> {
-    const vals = await this.db.getMany(keys);
-    // See leveldb.ts's getMany() - same fix, same reasoning: abstract-level
-    // -based drivers resolve undefined per-key for a missing entry rather
-    // than throwing, and callers rely on getMany() omitting those, not on
-    // positional correspondence to the input keys.
-    return vals
-      .filter((v: any) => v !== undefined)
-      .map((v: any) => Buffer.isBuffer(v) ? v : Buffer.from(v));
-  }
-
-  public async put(key: string, value: any): Promise<void> {
-    await this.db.put(key, value);
-  }
-
-  public async del(key: string): Promise<void> {
-    await this.db.del(key);
-  }
-
-  public async batch(): Promise<LevelUpChain<any, any>> {
-    if (!this.db || this.db.status !== 'open') {
-        await this.open();
-    }
-    return this.db.batch();
-  }
-
-  public createReadStream(options: any): any {
-    const iterator = this.db.iterator(options);
-    const { Readable } = require("stream");
-
-    return new Readable({
-      objectMode: true,
-      async read() {
-        try {
-          const entry = await iterator.next();
-          if (entry) {
-            const val = entry[1];
-            this.push({ key: entry[0], value: Buffer.isBuffer(val) ? val : Buffer.from(val) });
-          } else {
-            this.push(null);
-            await iterator.close();
-          }
-        } catch (err) {
-          this.emit("error", err);
-          this.push(null);
-        }
-      },
-      async destroy(err: Error | null, callback: (error: Error | null) => void) {
-        await iterator.close();
-        callback(err);
-      }
-    });
-  }
-
-  public createValueStream(): any {
-    return this.db.values();
-  }
-
-  public isOpen(): boolean {
-    return this.db?.status === 'open';
-  }
-
-  public async open(): Promise<void> {
-    if (this.db?.status !== 'open' && !this.opening) {
-      this.opening = true;
-      try {
-        this.db = new RocksLevel(this.location, { valueEncoding: 'binary' });
-        await this.db.open();
-      } catch (e) {
-        // If opening fails, ensure the DB instance is cleared so it doesn't hold resources/locks
-        this.db = null;
-        throw e;
-      } finally {
-        this.opening = false;
-      }
-    }
-  }
-
-  public async close(): Promise<void> {
-    await this.db.close();
-  }
-
-  public async compactRange(start: string, end: string): Promise<void> {
-    // RocksLevel now handles compaction internally or via properties; 
-    // for this driver we keep the API consistent.
-    if (typeof (this.db as any).compactRange === 'function') {
-        await (this.db as any).compactRange(start, end);
-    }
-  }
-}

package/src/heartbeat.ts

@@ -1,60 +0,0 @@
-/*
- * MIT License (MIT)
- * Copyright (c) 2018 Activeledger
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-import { IActiveHttpResponse } from "@activeledger/httpd/lib/httpd";
-
-/**
- * Connection Heartbeat management
- *
- * @export
- * @class HeartBeat
- */
-export class HeartBeat {
-  /**
-   * Start & Maintain SSE Heartbeat
-   *
-   * @static
-   * @param {ServerResponse} response
-   * @returns {NodeJS.Timeout}
-   */
-  public static Start(response: IActiveHttpResponse): NodeJS.Timeout {
-    return setInterval(() => {
-      if (response.writable) {
-        response.cork(() => {
-          response.write(":\n\n");
-        });
-      }
-      // Increase timeout with TCP keepalive enabled.
-      // Some connections still may timeout after long periods of inactivity
-    }, 10 * 60 * 1000);
-  }
-
-  /**
-   * Stop SSE Heartbeat
-   *
-   * @static
-   * @param {NodeJS.Timeout} interval
-   */
-  public static Stop(interval: NodeJS.Timeout): void {
-    clearInterval(interval);
-  }
-}

package/src/index.ts

@@ -1,25 +0,0 @@
-/*
- * MIT License (MIT)
- * Copyright (c) 2018 Activeledger
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { ActiveDataStore } from "./datastore";
-export { ActiveDataStore };