@nymphjs/nymph 1.0.0-beta.1 → 1.0.0-beta.10

package/src/Nymph.ts

@@ -1,7 +1,7 @@
 import { Config, ConfigDefaults as defaults } from './conf';
 import { NymphDriver } from './driver';
 import Entity from './Entity';
-import { EntityConstructor, EntityData, EntityInterface } from './Entity.types';
+import { EntityConstructor, EntityInterface } from './Entity.types';
 import { ClassNotAvailableError } from './errors';
 import type {
   Selector,
@@ -63,7 +63,7 @@ export default class Nymph {
   /**
    * The entity class for this instance of Nymph.
    */
-  public Entity: typeof Entity = Entity;
+  public Entity: typeof Entity;
 
   private connectCallbacks: NymphConnectCallback[] = [];
   private disconnectCallbacks: NymphDisconnectCallback[] = [];
@@ -87,20 +87,6 @@ export default class Nymph {
   private beforeDeleteUIDCallbacks: NymphBeforeDeleteUIDCallback[] = [];
   private afterDeleteUIDCallbacks: NymphAfterDeleteUIDCallback[] = [];
 
-  public addEntityClass(entityClass: EntityConstructor) {
-    this.entityClasses[entityClass.class] = entityClass;
-    entityClass.nymph = this;
-  }
-
-  public getEntityClass(className: string): EntityConstructor {
-    if (className in this.entityClasses) {
-      const EntityClass = this.entityClasses[className];
-      EntityClass.nymph = this;
-      return EntityClass;
-    }
-    throw new ClassNotAvailableError('Tried to use class: ' + className);
-  }
-
   /**
    * Initialize Nymph.
    *
@@ -115,28 +101,63 @@ export default class Nymph {
   ) {
     this.config = { ...defaults, ...config };
     this.driver = driver;
+
+    this.Entity = this.addEntityClass(Entity);
+
     if (typeof tilmeld !== 'undefined') {
       this.tilmeld = tilmeld;
     }
 
-    class NymphEntity<T extends EntityData = EntityData> extends Entity<T> {}
-    NymphEntity.nymph = this;
-    this.Entity = NymphEntity;
-    this.addEntityClass(NymphEntity);
-
     this.driver.init(this);
     if (this.tilmeld) {
       this.tilmeld.init(this);
     }
   }
 
+  /**
+   * Add your class to this instance.
+   *
+   * This will create a class that extends your class within this instance of
+   * Nymph and return it. You can then use this class's constructor and methods,
+   * which will use this instance of Nymph.
+   *
+   * Because this creates a subclass, don't use the class
+   * returned from `getEntityClass` to check with `instanceof`.
+   */
+  public addEntityClass<T extends EntityConstructor>(entityClass: T): T {
+    const nymph = this;
+    class NymphEntity extends entityClass {
+      static nymph: Nymph = nymph;
+
+      constructor(...args: any[]) {
+        super(...args);
+      }
+    }
+    this.entityClasses[entityClass.class] = NymphEntity;
+    return NymphEntity;
+  }
+
+  /**
+   * Get the class that uses the specified class name.
+   */
+  public getEntityClass(className: string): EntityConstructor {
+    if (className in this.entityClasses) {
+      return this.entityClasses[className];
+    }
+    throw new ClassNotAvailableError('Tried to use class: ' + className);
+  }
+
   /**
    * Get a clone of this instance with duplicate classes and event listeners.
    *
    * @returns A clone of this instance.
    */
   public clone() {
-    const nymph = new Nymph(this.config, this.driver, this.tilmeld?.clone());
+    const nymph = new Nymph(
+      this.config,
+      this.driver.clone(),
+      this.tilmeld?.clone()
+    );
     for (const name in this.entityClasses) {
       if (name === 'Entity' || (this.entityClasses[name] as any).skipOnClone) {
         continue;
@@ -190,7 +211,7 @@ export default class Nymph {
     const result = this.driver.connect();
     for (let callback of this.connectCallbacks) {
       if (callback) {
-        callback(this, result);
+        await callback(this, result);
       }
     }
     return await result;
@@ -205,7 +226,7 @@ export default class Nymph {
     const result = this.driver.disconnect();
     for (let callback of this.disconnectCallbacks) {
       if (callback) {
-        callback(this, result);
+        await callback(this, result);
       }
     }
     return await result;
@@ -214,10 +235,7 @@ export default class Nymph {
   /**
    * Run all the query callbacks on a query.
    */
-  public async runQueryCallbacks(
-    options: Options,
-    selectors: FormattedSelector[]
-  ) {
+  public runQueryCallbacks(options: Options, selectors: FormattedSelector[]) {
     for (let callback of this.queryCallbacks) {
       if (callback) {
         callback(this, options, selectors);
@@ -235,7 +253,7 @@ export default class Nymph {
    * Transactions will nest as long as every name is unique. Internally, Nymph
    * uses names prefixed with "nymph-".
    *
-   * @returns True on success, false on failure.
+   * @returns A new instance of Nymph that should be used for the transaction.
    */
   public async startTransaction(name: string): Promise<Nymph> {
     return await this.driver.startTransaction(name);
@@ -244,6 +262,8 @@ export default class Nymph {
   /**
    * Commit the named transaction.
    *
+   * After this is called, the transaction instance should be discarded.
+   *
    * @returns True on success, false on failure.
    */
   public async commit(name: string): Promise<boolean> {
@@ -253,6 +273,8 @@ export default class Nymph {
   /**
    * Rollback the named transaction.
    *
+   * After this is called, the transaction instance should be discarded.
+   *
    * @returns True on success, false on failure.
    */
   public async rollback(name: string): Promise<boolean> {
@@ -292,13 +314,13 @@ export default class Nymph {
   public async newUID(name: string): Promise<number | null> {
     for (let callback of this.beforeNewUIDCallbacks) {
       if (callback) {
-        callback(this, name);
+        await callback(this, name);
       }
     }
     const result = this.driver.newUID(name);
     for (let callback of this.afterNewUIDCallbacks) {
       if (callback) {
-        callback(this, result);
+        await callback(this, result);
       }
     }
     return await result;
@@ -323,13 +345,13 @@ export default class Nymph {
   public async setUID(name: string, value: number): Promise<boolean> {
     for (let callback of this.beforeSetUIDCallbacks) {
       if (callback) {
-        callback(this, name, value);
+        await callback(this, name, value);
       }
     }
     const result = this.driver.setUID(name, value);
     for (let callback of this.afterSetUIDCallbacks) {
       if (callback) {
-        callback(this, result);
+        await callback(this, result);
       }
     }
     return await result;
@@ -344,13 +366,13 @@ export default class Nymph {
   public async deleteUID(name: string): Promise<boolean> {
     for (let callback of this.beforeDeleteUIDCallbacks) {
       if (callback) {
-        callback(this, name);
+        await callback(this, name);
       }
     }
     const result = this.driver.deleteUID(name);
     for (let callback of this.afterDeleteUIDCallbacks) {
       if (callback) {
-        callback(this, result);
+        await callback(this, result);
       }
     }
     return await result;
@@ -366,13 +388,13 @@ export default class Nymph {
   public async renameUID(oldName: string, newName: string): Promise<boolean> {
     for (let callback of this.beforeRenameUIDCallbacks) {
       if (callback) {
-        callback(this, oldName, newName);
+        await callback(this, oldName, newName);
       }
     }
     const result = this.driver.renameUID(oldName, newName);
     for (let callback of this.afterRenameUIDCallbacks) {
       if (callback) {
-        callback(this, result);
+        await callback(this, result);
       }
     }
     return await result;
@@ -392,13 +414,13 @@ export default class Nymph {
   public async saveEntity(entity: EntityInterface): Promise<boolean> {
     for (let callback of this.beforeSaveEntityCallbacks) {
       if (callback) {
-        callback(this, entity);
+        await callback(this, entity);
       }
     }
     const result = this.driver.saveEntity(entity);
     for (let callback of this.afterSaveEntityCallbacks) {
       if (callback) {
-        callback(this, result);
+        await callback(this, result);
       }
     }
     return await result;
@@ -581,7 +603,7 @@ export default class Nymph {
   ): Promise<ReturnType<T['factorySync']>[] | string[] | number> {
     for (let callback of this.beforeGetEntitiesCallbacks) {
       if (callback) {
-        callback(this, options, selectors);
+        await callback(this, options, selectors);
       }
     }
     return await this.driver.getEntities(options, ...selectors);
@@ -631,7 +653,7 @@ export default class Nymph {
     options.limit = 1;
     for (let callback of this.beforeGetEntityCallbacks) {
       if (callback) {
-        callback(this, options, selectors as Selector[]);
+        await callback(this, options, selectors as Selector[]);
       }
     }
     const entities = await this.driver.getEntities(
@@ -656,13 +678,13 @@ export default class Nymph {
   public async deleteEntity(entity: EntityInterface): Promise<boolean> {
     for (let callback of this.beforeDeleteEntityCallbacks) {
       if (callback) {
-        callback(this, entity);
+        await callback(this, entity);
       }
     }
     const result = this.driver.deleteEntity(entity);
     for (let callback of this.afterDeleteEntityCallbacks) {
       if (callback) {
-        callback(this, result);
+        await callback(this, result);
       }
     }
     return await result;
@@ -681,13 +703,13 @@ export default class Nymph {
   ): Promise<boolean> {
     for (let callback of this.beforeDeleteEntityByIDCallbacks) {
       if (callback) {
-        callback(this, guid, className);
+        await callback(this, guid, className);
       }
     }
     const result = this.driver.deleteEntityByID(guid, className);
     for (let callback of this.afterDeleteEntityByIDCallbacks) {
       if (callback) {
-        callback(this, result);
+        await callback(this, result);
       }
     }
     return await result;

package/src/Nymph.types.ts

@@ -24,12 +24,22 @@ export type NymphEventType =
 export type NymphConnectCallback = (
   nymph: Nymph,
   result: Promise<boolean>
-) => void;
+) => Promise<void>;
 export type NymphDisconnectCallback = (
   nymph: Nymph,
   result: Promise<boolean>
-) => void;
-/** The NymphQueryCallback will be called on both top level and qref queries. */
+) => Promise<void>;
+/**
+ * The NymphQueryCallback will be called on both top level and qref queries.
+ *
+ * This is the only callback that is not asynchronous.
+ *
+ * This also isn't necessarily run on every "query". It is run before a database
+ * query for an entity, but it is not run during PubSub entity change
+ * propagation. Therefore, it shouldn't do anything _entity_ specific, instead
+ * it should be _query_ specific. For example, throw an error if the user is not
+ * permitted to run the query at all.
+ */
 export type NymphQueryCallback = (
   nymph: Nymph,
   options: Options,
@@ -39,65 +49,71 @@ export type NymphBeforeGetEntityCallback = (
   nymph: Nymph,
   options: Options,
   selectors: Selector[]
-) => void;
+) => Promise<void>;
 export type NymphBeforeGetEntitiesCallback = (
   nymph: Nymph,
   options: Options,
   selectors: Selector[]
-) => void;
+) => Promise<void>;
 export type NymphBeforeSaveEntityCallback = (
   nymph: Nymph,
   entity: EntityInterface
-) => void;
+) => Promise<void>;
 export type NymphAfterSaveEntityCallback = (
   nymph: Nymph,
   result: Promise<boolean>
-) => void;
+) => Promise<void>;
 export type NymphBeforeDeleteEntityCallback = (
   nymph: Nymph,
   entity: EntityInterface
-) => void;
+) => Promise<void>;
 export type NymphAfterDeleteEntityCallback = (
   nymph: Nymph,
   result: Promise<boolean>
-) => void;
+) => Promise<void>;
 export type NymphBeforeDeleteEntityByIDCallback = (
   nymph: Nymph,
   guid: string,
   className?: string
-) => void;
+) => Promise<void>;
 export type NymphAfterDeleteEntityByIDCallback = (
   nymph: Nymph,
   result: Promise<boolean>
-) => void;
-export type NymphBeforeNewUIDCallback = (nymph: Nymph, name: string) => void;
+) => Promise<void>;
+export type NymphBeforeNewUIDCallback = (
+  nymph: Nymph,
+  name: string
+) => Promise<void>;
 export type NymphAfterNewUIDCallback = (
   nymph: Nymph,
   result: Promise<number | null>
-) => void;
+) => Promise<void>;
 export type NymphBeforeSetUIDCallback = (
   nymph: Nymph,
   name: string,
   value: number
-) => void;
+) => Promise<void>;
 export type NymphAfterSetUIDCallback = (
   nymph: Nymph,
   result: Promise<boolean>
-) => void;
+) => Promise<void>;
 export type NymphBeforeRenameUIDCallback = (
   nymph: Nymph,
   oldName: string,
   newName: string
-) => void;
+) => Promise<void>;
 export type NymphAfterRenameUIDCallback = (
   nymph: Nymph,
   result: Promise<boolean>
-) => void;
-export type NymphBeforeDeleteUIDCallback = (nymph: Nymph, name: string) => void;
+) => Promise<void>;
+export type NymphBeforeDeleteUIDCallback = (
+  nymph: Nymph,
+  name: string
+) => Promise<void>;
 export type NymphAfterDeleteUIDCallback = (
   nymph: Nymph,
   result: Promise<boolean>
-) => void;
+) => Promise<void>;
 
 export type Options<T extends EntityConstructor = EntityConstructor> = {
   class?: T;

package/src/driver/NymphDriver.ts

@@ -54,7 +54,18 @@ export default abstract class NymphDriver {
    */
   private putDataCounter = 0;
 
+  /**
+   * This is used internally by Nymph. Don't call it yourself.
+   *
+   * @returns A clone of this instance.
+   */
+  abstract clone(): NymphDriver;
+
+  /**
+   * Connect to the data store.
+   */
   abstract connect(): Promise<boolean>;
+
   abstract isConnected(): boolean;
   abstract startTransaction(name: string): Promise<Nymph>;
   abstract commit(name: string): Promise<boolean>;
@@ -66,7 +77,12 @@ export default abstract class NymphDriver {
   ): Promise<boolean>;
   abstract deleteEntityByID(guid: string, className?: string): Promise<boolean>;
   abstract deleteUID(name: string): Promise<boolean>;
+
+  /**
+   * Disconnect from the data store.
+   */
   abstract disconnect(): Promise<boolean>;
+
   protected abstract exportEntities(
     writeLine: (line: string) => void
   ): Promise<void>;
@@ -283,7 +299,7 @@ export default abstract class NymphDriver {
     guid: string | null = null,
     tags: string[] | null = null
   ) {
-    const formattedSelectors = this.formatSelectors(selectors);
+    const formattedSelectors = this.formatSelectors(selectors).selectors;
 
     for (const curSelector of formattedSelectors) {
       const type = curSelector.type;
@@ -575,8 +591,12 @@ export default abstract class NymphDriver {
   public formatSelectors(
     selectors: Selector[],
     options: Options = {}
-  ): FormattedSelector[] {
+  ): {
+    selectors: FormattedSelector[];
+    qrefs: [Options, ...FormattedSelector[]][];
+  } {
     const newSelectors: FormattedSelector[] = [];
+    const qrefs: [Options, ...FormattedSelector[]][] = [];
 
     for (const curSelector of selectors) {
       const newSelector: FormattedSelector = {
@@ -615,13 +635,18 @@ export default abstract class NymphDriver {
               source: options.source,
             };
             const newSelectors = this.formatSelectors(qrefSelectors, options);
-            this.nymph.runQueryCallbacks(newOptions, newSelectors);
-            formatArr[i] = [name, [newOptions, ...newSelectors]];
+            qrefs.push(
+              [newOptions, ...newSelectors.selectors],
+              ...newSelectors.qrefs
+            );
+            formatArr[i] = [name, [newOptions, ...newSelectors.selectors]];
           }
           newSelector[key] = formatArr;
         } else if (key === 'selector' || key === '!selector') {
           const tmpArr = (Array.isArray(value) ? value : [value]) as Selector[];
-          newSelector[key] = this.formatSelectors(tmpArr, options);
+          const newSelectors = this.formatSelectors(tmpArr, options);
+          newSelector[key] = newSelectors.selectors;
+          qrefs.push(...newSelectors.qrefs);
         } else if (!Array.isArray(value)) {
           // @ts-ignore: ts doesn't know what value is here.
           newSelector[key] = [[value]];
@@ -655,7 +680,7 @@ export default abstract class NymphDriver {
       newSelectors.push(newSelector);
     }
 
-    return newSelectors;
+    return { selectors: newSelectors, qrefs };
   }
 
   protected iterateSelectorsForQuery(
@@ -774,7 +799,7 @@ export default abstract class NymphDriver {
       name: string;
       svalue: string;
     }
-  ): { result: any; process: () => number };
+  ): { result: any; process: () => number | Error };
   protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
     selectors: Selector[],
@@ -798,7 +823,7 @@ export default abstract class NymphDriver {
       name: string;
       svalue: string;
     }
-  ): { result: any; process: () => string[] };
+  ): { result: any; process: () => string[] | Error };
   protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T>,
     selectors: Selector[],
@@ -822,7 +847,7 @@ export default abstract class NymphDriver {
       name: string;
       svalue: string;
     }
-  ): { result: any; process: () => ReturnType<T['factorySync']>[] };
+  ): { result: any; process: () => ReturnType<T['factorySync']>[] | Error };
   protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T>,
     selectors: Selector[],
@@ -848,7 +873,7 @@ export default abstract class NymphDriver {
     }
   ): {
     result: any;
-    process: () => ReturnType<T['factorySync']>[] | string[] | number;
+    process: () => ReturnType<T['factorySync']>[] | string[] | number | Error;
   } {
     if (!this.isConnected()) {
       throw new UnableToConnectError('not connected to DB');
@@ -918,78 +943,95 @@ export default abstract class NymphDriver {
       }
     }
 
-    const formattedSelectors = this.formatSelectors(selectors, options);
-    this.nymph.runQueryCallbacks(options, formattedSelectors);
-    const { result } = performQueryCallback(options, formattedSelectors, etype);
+    try {
+      const formattedSelectors = this.formatSelectors(selectors, options);
+      this.nymph.runQueryCallbacks(options, formattedSelectors.selectors);
+      for (let qref of formattedSelectors.qrefs) {
+        const [options, ...selectors] = qref;
+        this.nymph.runQueryCallbacks(options, selectors);
+      }
+      const { result } = performQueryCallback(
+        options,
+        formattedSelectors.selectors,
+        etype
+      );
 
-    return {
-      result,
-      process: () => {
-        let row = rowFetchCallback();
-        if (options.return === 'count') {
-          while (row != null) {
-            count += getCountCallback(row);
-            row = rowFetchCallback();
-          }
-        } else if (options.return === 'guid') {
-          while (row != null) {
-            (entities as string[]).push(getGUIDCallback(row));
-            row = rowFetchCallback();
-          }
-        } else {
-          while (row != null) {
-            const guid = getGUIDCallback(row);
-            const tagsAndDates = getTagsAndDatesCallback(row);
-            const tags = tagsAndDates.tags;
-            const cdate = tagsAndDates.cdate;
-            const mdate = tagsAndDates.mdate;
-            let dataNameAndSValue = getDataNameAndSValueCallback(row);
-            // Data.
-            const data: EntityData = {};
-            // Serialized data.
-            const sdata: SerializedEntityData = {};
-            if (dataNameAndSValue.name !== '') {
-              // This do will keep going and adding the data until the
-              // next entity is reached. $row will end on the next entity.
-              do {
-                dataNameAndSValue = getDataNameAndSValueCallback(row);
-                sdata[dataNameAndSValue.name] = dataNameAndSValue.svalue;
-                row = rowFetchCallback();
-              } while (row != null && getGUIDCallback(row) === guid);
-            } else {
-              // Make sure that $row is incremented :)
+      return {
+        result,
+        process: () => {
+          let row = rowFetchCallback();
+          if (options.return === 'count') {
+            while (row != null) {
+              count += getCountCallback(row);
               row = rowFetchCallback();
             }
-            const entity = EntityClass.factorySync() as ReturnType<
-              T['factorySync']
-            >;
-            entity.$nymph = this.nymph;
-            if (options.skipAc != null) {
-              entity.$useSkipAc(!!options.skipAc);
-            }
-            entity.guid = guid;
-            entity.cdate = cdate;
-            entity.mdate = mdate;
-            entity.tags = tags;
-            this.putDataCounter++;
-            if (this.putDataCounter == 100) {
-              throw new Error('Infinite loop detected in Entity loading.');
+          } else if (options.return === 'guid') {
+            while (row != null) {
+              (entities as string[]).push(getGUIDCallback(row));
+              row = rowFetchCallback();
             }
-            entity.$putData(data, sdata);
-            this.putDataCounter--;
-            if (this.nymph.config.cache) {
-              this.pushCache(guid, cdate, mdate, tags, data, sdata);
+          } else {
+            while (row != null) {
+              const guid = getGUIDCallback(row);
+              const tagsAndDates = getTagsAndDatesCallback(row);
+              const tags = tagsAndDates.tags;
+              const cdate = tagsAndDates.cdate;
+              const mdate = tagsAndDates.mdate;
+              let dataNameAndSValue = getDataNameAndSValueCallback(row);
+              // Data.
+              const data: EntityData = {};
+              // Serialized data.
+              const sdata: SerializedEntityData = {};
+              if (dataNameAndSValue.name !== '') {
+                // This do will keep going and adding the data until the
+                // next entity is reached. $row will end on the next entity.
+                do {
+                  dataNameAndSValue = getDataNameAndSValueCallback(row);
+                  sdata[dataNameAndSValue.name] = dataNameAndSValue.svalue;
+                  row = rowFetchCallback();
+                } while (row != null && getGUIDCallback(row) === guid);
+              } else {
+                // Make sure that $row is incremented :)
+                row = rowFetchCallback();
+              }
+              const entity = EntityClass.factorySync() as ReturnType<
+                T['factorySync']
+              >;
+              entity.$nymph = this.nymph;
+              if (options.skipAc != null) {
+                entity.$useSkipAc(!!options.skipAc);
+              }
+              entity.guid = guid;
+              entity.cdate = cdate;
+              entity.mdate = mdate;
+              entity.tags = tags;
+              this.putDataCounter++;
+              if (this.putDataCounter == 100) {
+                throw new Error('Infinite loop detected in Entity loading.');
+              }
+              entity.$putData(data, sdata);
+              this.putDataCounter--;
+              if (this.nymph.config.cache) {
+                this.pushCache(guid, cdate, mdate, tags, data, sdata);
+              }
+              // @ts-ignore: ts doesn't know the return type here.
+              entities.push(entity);
             }
-            // @ts-ignore: ts doesn't know the return type here.
-            entities.push(entity);
           }
-        }
 
-        freeResultCallback();
+          freeResultCallback();
 
-        return options.return === 'count' ? count : entities;
-      },
-    };
+          return options.return === 'count' ? count : entities;
+        },
+      };
+    } catch (e: any) {
+      return {
+        result: Promise.resolve(e),
+        process: () => {
+          return e;
+        },
+      };
+    }
   }
 
   protected async saveEntityRowLike(