ueberdb2 4.1.1 → 4.1.3

package/databases/rethink_db.ts

@@ -1,114 +0,0 @@
-/**
- * 2016 Remi Arnaud
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS-IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import AbstractDatabase, {Settings} from '../lib/AbstractDatabase';
-import r from 'rethinkdb';
-import async from 'async';
-import {BulkObject} from './cassandra_db';
-
-export const Database = class extends AbstractDatabase {
-  private host: string;
-  private db: string;
-  private port: number | string;
-  private table: string;
-  private connection: r.Connection | null;
-  constructor(settings:Settings) {
-    super();
-    if (!settings) settings = {};
-    if (!settings.host) { settings.host = 'localhost'; }
-    if (!settings.port) { settings.port = 28015; }
-    if (!settings.db) { settings.db = 'test'; }
-    if (!settings.table) { settings.table = 'test'; }
-
-    this.host = settings.host;
-    this.db = settings.db;
-    this.port = settings.port;
-    this.table = settings.table;
-    this.connection = null;
-  }
-
-  init(callback: (p: any, cursor: any)=>{}) {
-    // @ts-ignore
-    r.connect(this, (err, conn) => {
-      if (err) throw err;
-      this.connection = conn;
-
-      r.table(this.table).run(this.connection, (err, cursor) => {
-        if (err) {
-          // assuming table does not exists
-          // @ts-ignore
-          r.tableCreate(this.table).run(this.connection, callback);
-        } else if (callback) { callback(null, cursor); }
-      });
-    });
-  }
-
-  get(key:string, callback: (err: Error, p: any)=>{}) {
-    // @ts-ignore
-    r.table(this.table).get(key).run(this.connection, (err, item) => {
-      // @ts-ignore
-      callback(err, (item ? item.content : item));
-    });
-  }
-
-  findKeys(key:string, notKey:string, callback:()=>{}) {
-    const keys = [];
-    const regex = this.createFindRegex(key, notKey);
-    // @ts-ignore
-    r.filter((item) => {
-      if (item.id.search(regex) !== -1) {
-        keys.push(item.id);
-      }
-    }).run(this.connection, callback);
-  }
-
-  set(key:string, value:string, callback:()=>{}) {
-    r.table(this.table)
-        .insert({id: key, content: value}, {conflict: 'replace'})
-        .run(this.connection as r.Connection, callback);
-  }
-
-  doBulk(bulk: BulkObject[], callback: ()=>{}) {
-    const _in: any[] = [];
-    const _out: string | string[] | r.Expression<any> = [];
-
-    for (const i in bulk) {
-      if (bulk[i].type === 'set') {
-        _in.push({id: bulk[i].key, content: bulk[i].value});
-      } else if (bulk[i].type === 'remove') {
-        _out.push(bulk[i].key);
-      }
-    }
-
-    async.parallel([
-      (cb) => { // @ts-ignore
-        r.table(this.table).insert(_in, {conflict: 'replace'}).run(this.connection, cb);
-      },
-      (cb) => { // @ts-ignore
-        r.table(this.table).getAll(_out).delete().run(this.connection, cb);
-      },
-    ], callback);
-  }
-
-  remove(key:string, callback:()=>{}) {
-    // @ts-ignore
-    r.table(this.table).get(key).delete().run(this.connection, callback);
-  }
-
-  close(callback:()=>{}) {
-    if (this.connection) { this.connection.close(callback); }
-  }
-};

package/databases/sqlite_db.ts

@@ -1,159 +0,0 @@
-'use strict';
-import {BulkObject} from "./cassandra_db";
-import {Settings} from "../lib/AbstractDatabase";
-
-/**
- * 2011 Peter 'Pita' Martischka
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS-IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-let SQDB: any;
-try {
-  SQDB = require('sqlite3').Database;
-} catch (err) {
-  throw new Error(
-      'sqlite3 not found. It was removed from ueberdb\'s dependencies because it requires ' +
-      'compilation which fails on several systems. If you still want to use sqlite, run ' +
-      '"npm install sqlite3" in your etherpad-lite ./src directory.');
-}
-
-import AbstractDatabase from '../lib/AbstractDatabase';
-import util from 'util';
-
-const escape = (val:string) => `'${val.replace(/'/g, "''")}'`;
-
-export const Database = class SQLiteDB extends AbstractDatabase {
-  private db: typeof SQDB|null;
-  constructor(settings:Settings) {
-    super();
-    this.db = null;
-
-    if (!settings || !settings.filename) {
-      settings = {filename: ':memory:'};
-    }
-
-    this.settings = settings;
-
-    // set settings for the dbWrapper
-    if (settings.filename === ':memory:') {
-      this.settings.cache = 0;
-      this.settings.writeInterval = 0;
-      this.settings.json = true;
-    } else {
-      this.settings.cache = 1000;
-      this.settings.writeInterval = 100;
-      this.settings.json = true;
-    }
-  }
-
-  init(callback:Function) {
-    util.callbackify(async () => {
-      this.db = new SQDB(this.settings.filename as string)
-      await this._query('CREATE TABLE IF NOT EXISTS store (key TEXT PRIMARY KEY, value TEXT)');
-      // @ts-ignore
-    })(callback);
-  }
-
-  async _query(sql:string, params = []) {
-    // It is unclear how util.promisify() deals with variadic functions, so it is not used here.
-    return await new Promise((resolve, reject) => {
-      // According to sqlite3's documentation, .run() method (and maybe .all() and .get(); the
-      // documentation is unclear) might call the callback multiple times. That's OK -- ECMAScript
-      // guarantees that it is safe to call a Promise executor's resolve and reject functions
-      // multiple times. The subsequent calls are ignored, except Node.js's 'process' object emits a
-      // 'multipleResolves' event to aid in debugging.
-      this.db&&this.db.all(sql, params, (err:Error, rows:any) => {
-        if (err != null) return reject(err);
-        resolve(rows);
-      });
-    });
-  }
-
-  // Temporary callbackified version of _query. This will be removed once all database objects are
-  // asyncified.
-  _queryCb(sql: string, params: string[], callback: Function) {
-    // It is unclear how util.callbackify() handles optional parameters, so it is not used here.
-    const p = this._query(sql, params as []);
-    if (callback) p.then((rows) => callback(null, rows), (err) => callback(err || new Error(err)));
-  }
-
-
-
-  get(key:string, callback:Function) {
-    this._queryCb(
-        'SELECT value FROM store WHERE key = ?', [key],
-        (err:Error, rows:any) => callback(err, err == null && rows && rows.length ? rows[0].value : null));
-  }
-
-  findKeys(key:string, notKey:string, callback:Function) {
-    let query = 'SELECT key FROM store WHERE key LIKE ?';
-    const params = [];
-    // desired keys are %key:%, e.g. pad:%
-    key = key.replace(/\*/g, '%');
-    params.push(key);
-
-    if (notKey != null) {
-      // not desired keys are notKey:%, e.g. %:%:%
-      notKey = notKey.replace(/\*/g, '%');
-      query += ' AND key NOT LIKE ?';
-      params.push(notKey);
-    }
-
-    this._queryCb(query, params, (err: Error, results: { val: string, key: string }[]) => {
-      const value: string[] = [];
-
-      if (!err && Object.keys(results).length > 0) {
-        results.forEach((val) => {
-          value.push(val.key);
-        });
-      }
-
-      callback(err, value);
-    });
-  }
-
-  set(key:string, value:string, callback:Function) {
-    this._queryCb('REPLACE INTO store VALUES (?,?)', [key, value], callback);
-  }
-
-  remove(key:string, callback:Function) {
-    this._queryCb('DELETE FROM store WHERE key = ?', [key], callback);
-  }
-
-  doBulk(bulk:BulkObject[], callback:Function) {
-    let sql = 'BEGIN TRANSACTION;\n';
-    for (const i in bulk) {
-      if (bulk[i].type === 'set') {
-        sql += `REPLACE INTO store VALUES (${escape(bulk[i].key)}, ${escape(bulk[i].value as string)});\n`;
-      } else if (bulk[i].type === 'remove') {
-        sql += `DELETE FROM store WHERE key = ${escape(bulk[i].key)};\n`;
-      }
-    }
-    sql += 'END TRANSACTION;';
-
-    this.db&&this.db.exec(sql, (err:any) => {
-      if (err) {
-        console.error('ERROR WITH SQL: ');
-        console.error(sql);
-      }
-
-      callback(err);
-    });
-  }
-
-  close(callback: Function) {
-    callback()
-    this.db&&this.db.close((err:any) => callback(err));
-  }
-};

package/docker-compose.yml

@@ -1,44 +0,0 @@
-# Docker compose setup for testing with multiple databases
-version: '3.8'
-services:
-    couchdb:
-        image: couchdb
-        ports:
-        - "5984:5984"
-        environment:
-          COUCHDB_USER: ueberdb
-          COUCHDB_PASSWORD: ueberdb
-    elasticsearch:
-        image: elasticsearch:7.17.3
-        ports:
-        - 9200:9200
-        environment:
-          discovery.type: single-node
-    mongo:
-        image: mongo
-        ports:
-        - 27017:27017
-        environment:
-          MONGO_INITDB_DATABASE: mydb_test
-    mysql:
-      image: mariadb
-      ports:
-        - 3306:3306
-      environment:
-        MYSQL_ROOT_PASSWORD: password
-        MYSQL_USER: ueberdb
-        MYSQL_PASSWORD: ueberdb
-        MYSQL_DATABASE: ueberdb
-    postgres:
-      image: postgres:14-alpine
-      ports:
-        - 5432:5432
-      environment:
-        POSTGRES_USER: ueberdb
-        POSTGRES_PASSWORD: ueberdb
-        POSTGRES_DB: ueberdb
-        POSTGRES_HOST_AUTH_METHOD: "trust"
-    redis:
-      image: redis
-      ports:
-        - "6379:6379"

package/index.ts

@@ -1,224 +0,0 @@
-'use strict';
-
-/**
- * 2011 Peter 'Pita' Martischka
- * 2020 John McLear
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS-IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// @ts-ignore
-import cacheAndBufferLayer from './lib/CacheAndBufferLayer';
-import {normalizeLogger} from './lib/logging';
-import {callbackify} from 'util';
-import {Settings} from './lib/AbstractDatabase';
-
-const cbDb = {
-  init: () => {},
-  flush: () => {},
-  get: () => {},
-  remove: () => {},
-  findKeys: () => {},
-  close: () => {},
-  getSub: () => {},
-  setSub: () => {},
-};
-const fns = ['close', 'findKeys', 'flush', 'get', 'getSub', 'init', 'remove', 'set', 'setSub'];
-for (const fn of fns) { // @ts-ignore
-  cbDb[fn] = callbackify(cacheAndBufferLayer.Database.prototype[fn]);
-}
-const makeDoneCallback = (callback: (err?:any)=>{}, deprecated:(err:any)=>{}) => (err: null) => {
-  if (callback) callback(err);
-  if (deprecated) deprecated(err);
-  if (err != null && callback == null && deprecated == null) throw err;
-};
-
-export const Database = class {
-  private type: any;
-  private dbModule: any;
-  private readonly dbSettings: any;
-  private readonly wrapperSettings: any | {};
-  private readonly logger: Function | null;
-  private readonly db: any;
-  private metrics: any;
-  /**
-   * @param type The type of the database
-   * @param dbSettings The settings for that specific database type
-   * @param wrapperSettings
-   * @param logger Optional logger object. If no logger object is provided no logging will occur.
-   *     The logger object is expected to be a log4js logger object or `console`. A logger object
-   *     from another logging library should also work, but performance may be reduced if the logger
-   *     object does not have is${Level}Enabled() methods (isDebugEnabled(), etc.).
-   */
-  constructor(type: undefined | string, dbSettings: Settings | null | string, wrapperSettings?: null | {}, logger:any = null) {
-    if (!type) {
-      type = 'sqlite';
-      dbSettings = null;
-      wrapperSettings = null;
-    }
-
-    // saves all settings and require the db module
-    this.type = type;
-    this.dbModule = require(`./databases/${type}_db`);
-    this.dbSettings = dbSettings;
-    this.wrapperSettings = wrapperSettings;
-    this.logger = normalizeLogger(logger);
-    const db = new this.dbModule.Database(this.dbSettings);
-    db.logger = this.logger;
-    this.db = new cacheAndBufferLayer.Database(db, this.wrapperSettings, this.logger);
-
-    // Expose the cache wrapper's metrics to the user. See lib/CacheAndBufferLayer.js for details.
-    //
-    // WARNING: This feature is EXPERIMENTAL -- do not assume it will continue to exist in its
-    // current form in a future version.
-    this.metrics = this.db.metrics;
-  }
-
-  /**
-   * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-   */
-  init(callback = null) {
-    if (callback != null) {
-      return cbDb.init.call(this.db);
-    }
-    return this.db.init();
-  }
-
-  /**
-   * Wrapper functions
-   */
-
-  /**
-   * Deprecated synonym of flush().
-   *
-   * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-   */
-  doShutdown(callback = null) {
-    return this.flush(callback);
-  }
-
-  /**
-   * Writes any unsaved changes to the underlying database.
-   *
-   * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-   */
-  flush(callback = null) {
-    if (!cbDb || !cbDb.flush === undefined) return null;
-    if (callback != null) { // @ts-ignore
-      return cbDb.flush.call(this.db, callback);
-    }
-    return this.db.flush();
-  }
-
-  /**
-   * @param key
-   * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-   */
-  get(key:string, callback = null) {
-    if (callback != null) { // @ts-ignore
-      return cbDb.get.call(this.db, key, callback);
-    }
-    return this.db.get(key);
-  }
-
-  /**
-   * @param key
-   * @param notKey
-   * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-   */
-  findKeys(key:string, notKey:string, callback = null) {
-    if (callback != null) { // @ts-ignore
-      return cbDb.findKeys.call(this.db, key, notKey, callback);
-    }
-    return this.db.findKeys(key, notKey);
-  }
-
-  /**
-   * Removes an entry from the database if present.
-   *
-   * @param key
-   * @param cb Deprecated. Node-style callback. Called when the write has been committed to the
-   *     underlying database driver. If null, a Promise is returned.
-   * @param deprecated Deprecated callback that is called just after cb. Ignored if cb is null.
-   */
-  remove(key:string, cb = null, deprecated = null) {
-    if (cb != null) { // @ts-ignore
-      return cbDb.remove.call(this.db, key, makeDoneCallback(cb, deprecated));
-    }
-    return this.db.remove(key);
-  }
-
-  /**
-   * Adds or changes the value of an entry.
-   *
-   * @param key
-   * @param value
-   * @param cb Deprecated. Node-style callback. Called when the write has been committed to the
-   *     underlying database driver. If null, a Promise is returned.
-   * @param deprecated Deprecated callback that is called just after cb. Ignored if cb is null.
-   */
-  set(key:string, value:string, cb = null, deprecated = null) {
-    if (cb != null) { // @ts-ignore
-      return cbDb.get.call(this.db, key, value, makeDoneCallback(cb, deprecated));
-    }
-    return this.db.set(key, value);
-  }
-
-  /**
-   * @param key
-   * @param sub
-   * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-   */
-  getSub(key:string, sub:string, callback = null) {
-    if (callback != null) { // @ts-ignore
-      return cbDb.getSub.call(this.db, key, sub, callback);
-    }
-    return this.db.getSub(key, sub);
-  }
-
-  /**
-   * Adds or changes a subvalue of an entry.
-   *
-   * @param key
-   * @param sub
-   * @param value
-   * @param cb Deprecated. Node-style callback. Called when the write has been committed to the
-   *     underlying database driver. If null, a Promise is returned.
-   * @param deprecated Deprecated callback that is called just after cb. Ignored if cb is null.
-   */
-  setSub(key:string, sub:string, value:string, cb = null, deprecated = null) {
-    if (cb != null) {
-      // @ts-ignore
-      return cbDb.setSub.call(this.db, key, sub, value, makeDoneCallback(cb, deprecated));
-    }
-    return this.db.setSub(key, sub, value);
-  }
-
-  /**
-   * Flushes unwritten changes then closes the connection to the underlying database. After this
-   * returns, any future call to a method on this object may result in an error.
-   *
-   * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-   */
-  close(callback = null) {
-    if (callback != null) { // @ts-ignore
-      return cbDb.close.call(this.db, callback);
-    }
-    return this.db.close();
-  }
-};
-
-/**
- * Deprecated synonym of Database.
- */
-exports.database = exports.Database;

package/lib/AbstractDatabase.ts

@@ -1,79 +0,0 @@
-import {normalizeLogger} from './logging';
-
-const nullLogger = normalizeLogger(null);
-
-// Format: All characters match themselves except * matches any zero or more characters. No
-// backslash escaping is supported, so it is impossible to create a pattern that matches only the
-// '*' character.
-const simpleGlobToRegExp = (s:string) => s.replace(/[.+?^${}()|[\]\\]/g, '\\$&').replace(/\*/g, '.*');
-
-export type Settings = {
-  data?: any;
-  table?: string;
-  db?: string;
-  idleTimeoutMillis?: any;
-  min?: any;
-  max?: any;
-  engine?: string;
-  charset?: string;
-  server?: string | undefined;
-  requestTimeout?: number;
-  bulkLimit?: number;
-  queryTimeout?: number;
-  connectionString?: string;
-  parseJSON?: boolean;
-  dbName?: string;
-  collection?: string;
-  url?: string;
-  mock?: any;
-  base_index?: string;
-  migrate_to_newer_schema?: boolean;
-  api?: string
-  filename?: string;
-  database?: string;
-  password?: string;
-  user?: string;
-  port?: number | string;
-  host?: string;
-  maxListeners?: number | undefined;
-  json?: boolean;
-  cache?: number;
-  writeInterval?: number;
-  logger?: any;
-  columnFamily?: any;
-  clientOptions?: any;
-};
-
-
-class AbstractDatabase {
-  logger: any;
-  // @ts-ignore
-  settings: Settings;
-  constructor() {
-    if (new.target === module.exports) {
-      throw new TypeError('cannot instantiate Abstract Database directly');
-    }
-    for (const fn of ['init', 'close', 'get', 'findKeys', 'remove', 'set']) {
-      // @ts-ignore
-      if (typeof this[fn] !== 'function') throw new TypeError(`method ${fn} not defined`);
-    }
-    this.logger = nullLogger;
-  }
-
-  /**
-   * For findKey regex. Used by document dbs like mongodb or dirty.
-   */
-  createFindRegex(key:string, notKey?:string) {
-    let regex = `^(?=${simpleGlobToRegExp(key)}$)`;
-    if (notKey != null) regex += `(?!${simpleGlobToRegExp(notKey)}$)`;
-    return new RegExp(regex);
-  }
-
-  doBulk(operations:any, cb: ()=>{}) {
-    throw new Error('the doBulk method must be implemented if write caching is enabled');
-  }
-
-  get isAsync() { return false; }
-}
-
-export default AbstractDatabase;