@nymphjs/nymph 1.0.0-beta.131 → 1.0.0-beta.133

package/src/driver/NymphDriver.ts

@@ -5,7 +5,11 @@ import { strtotime } from 'locutus/php/datetime/index';
 import { Tokenizer } from '@sciactive/tokenizer';
 
 import type Nymph from '../Nymph.js';
-import type { Selector, Options, FormattedSelector } from '../Nymph.types.js';
+import {
+  type Selector,
+  type Options,
+  type FormattedSelector,
+} from '../Nymph.types.js';
 import Entity from '../Entity.js';
 import type { EntityInstanceType, EntityObjectType } from '../Entity.js';
 import type {
@@ -47,22 +51,6 @@ export default abstract class NymphDriver {
 
   protected tokenizer = new Tokenizer();
 
-  /**
-   * A cache to make entity retrieval faster.
-   */
-  protected entityCache: {
-    [k: string]: {
-      cdate: number;
-      mdate: number;
-      tags: string[];
-      data: EntityData;
-      sdata: SerializedEntityData;
-    };
-  } = {};
-  /**
-   * A counter for the entity cache to determine the most accessed entities.
-   */
-  protected entityCount: { [k: string]: number } = {};
   /**
    * Protect against infinite loops.
    */
@@ -359,8 +347,6 @@ export default abstract class NymphDriver {
             sdata[propMatch[1]] = propMatch[2];
           }
         }
-        // Clear the entity cache.
-        this.entityCache = {};
       }
       // Save the last entity.
       if (guid) {
@@ -681,15 +667,6 @@ export default abstract class NymphDriver {
     }
   }
 
-  /**
-   * Remove all copies of an entity from the cache.
-   *
-   * @param guid The GUID of the entity to remove.
-   */
-  protected cleanCache(guid: string) {
-    delete this.entityCache[guid];
-  }
-
   public async deleteEntity(entity: EntityInterface) {
     const className = (entity.constructor as any).class as string;
     if (entity.guid == null) {
@@ -1026,7 +1003,9 @@ export default abstract class NymphDriver {
               ...qrefOptions,
               class: QrefEntityClass,
               source: options.source,
+              skipAc: options.skipAc,
             };
+            delete newOptions.return;
             const newSelectors = this.formatSelectors(qrefSelectors, options);
             qrefs.push(
               [newOptions, ...newSelectors.selectors],
@@ -1280,108 +1259,6 @@ export default abstract class NymphDriver {
       );
     }
 
-    // Check if the requested entity is cached.
-    if (
-      this.nymph.config.cache &&
-      !options.skipCache &&
-      selectors.length &&
-      'guid' in selectors[0] &&
-      typeof selectors[0].guid === 'number'
-    ) {
-      // Only safe to use the cache option with no other selectors than a GUID
-      // and tags.
-      if (
-        selectors.length === 1 &&
-        selectors[0].type === '&' &&
-        (Object.keys(selectors[0]).length === 2 ||
-          (Object.keys(selectors[0]).length === 3 && 'tag' in selectors[0]))
-      ) {
-        const cacheEntity = this.pullCache(selectors[0]['guid']);
-
-        if (
-          cacheEntity != null &&
-          cacheEntity.guid != null &&
-          (!('tag' in selectors[0]) ||
-            !(
-              Array.isArray(selectors[0].tag)
-                ? selectors[0].tag
-                : [selectors[0].tag]
-            ).find((tag) => tag == null || !cacheEntity.tags.includes(tag)))
-        ) {
-          // Return the value from the cache.
-          const { guid, cdate, mdate, tags, data, sdata } = cacheEntity;
-
-          if (options.return === 'count') {
-            return {
-              result: Promise.resolve(null),
-              process: () => 1,
-            };
-          } else if (options.return === 'guid') {
-            return {
-              result: Promise.resolve(null),
-              process: () => [guid],
-            };
-          } else if (options.return === 'object') {
-            return {
-              result: Promise.resolve(null),
-              process: () => [
-                {
-                  guid,
-                  cdate,
-                  mdate,
-                  tags,
-                  ...data,
-                  ...Object.fromEntries(
-                    Object.entries(sdata).map(([name, value]) => [
-                      name,
-                      JSON.parse(value),
-                    ]),
-                  ),
-                } as EntityObjectType<T>,
-              ],
-            };
-          } else {
-            const entity = this.nymph
-              .getEntityClass(EntityClass.class)
-              .factorySync() as EntityInstanceType<T>;
-            if (entity) {
-              entity.$nymph = this.nymph;
-              if (options.skipAc != null) {
-                entity.$useSkipAc(!!options.skipAc);
-              }
-              entity.guid = guid;
-              entity.cdate = cdate;
-              entity.mdate = mdate;
-              entity.tags = tags;
-              entity.$putData(
-                classNamesToEntityConstructors(
-                  this.nymph,
-                  referencesToEntities(
-                    data,
-                    this.nymph,
-                    !!options.skipAc,
-                    false,
-                  ),
-                  false,
-                ),
-                sdata,
-                'server',
-              );
-              return {
-                result: Promise.resolve(null),
-                process: () => [entity],
-              };
-            }
-
-            return {
-              result: Promise.resolve(null),
-              process: () => [],
-            };
-          }
-        }
-      }
-    }
-
     try {
       const formattedSelectors = this.formatSelectors(selectors, options);
       this.nymph.runQueryCallbacks(options, formattedSelectors.selectors);
@@ -1542,9 +1419,6 @@ export default abstract class NymphDriver {
                 this.putDataCounter--;
                 entities.push(entity);
               }
-              if (this.nymph.config.cache) {
-                this.pushCache(guid, cdate, mdate, tags, data, sdata);
-              }
             }
           }
 
@@ -1639,10 +1513,6 @@ export default abstract class NymphDriver {
           entity.mdate = mdate;
         }
       } else {
-        // Removed any cached versions of this entity.
-        if (this.nymph.config.cache) {
-          this.cleanCache(entity.guid);
-        }
         success = await saveExistingEntityCallback({
           entity,
           guid: entity.guid,
@@ -1660,17 +1530,6 @@ export default abstract class NymphDriver {
       if (commitTransactionCallback) {
         success = await commitTransactionCallback(success);
       }
-      // Cache the entity.
-      if (success && this.nymph.config.cache) {
-        this.pushCache(
-          entity.guid as string,
-          entity.cdate as number,
-          entity.mdate as number,
-          entity.tags,
-          data,
-          sdata,
-        );
-      }
 
       if (!success) {
         entity.guid = originalGuid;
@@ -1697,95 +1556,6 @@ export default abstract class NymphDriver {
     }
   }
 
-  /**
-   * Pull an entity from the cache.
-   *
-   * @param guid The entity's GUID.
-   * @returns The entity's data or null if it's not cached.
-   */
-  protected pullCache(guid: string): {
-    guid: string;
-    cdate: number;
-    mdate: number;
-    tags: string[];
-    data: EntityData;
-    sdata: SerializedEntityData;
-  } | null {
-    // Increment the entity access count.
-    if (!(guid in this.entityCount)) {
-      this.entityCount[guid] = 0;
-    }
-    this.entityCount[guid]++;
-    if (guid in this.entityCache) {
-      return {
-        guid,
-        cdate: this.entityCache[guid]['cdate'],
-        mdate: this.entityCache[guid]['mdate'],
-        tags: this.entityCache[guid]['tags'],
-        data: this.entityCache[guid]['data'],
-        sdata: this.entityCache[guid]['sdata'],
-      };
-    }
-    return null;
-  }
-
-  /**
-   * Push an entity onto the cache.
-   *
-   * @param guid The entity's GUID.
-   * @param cdate The entity's cdate.
-   * @param mdate The entity's mdate.
-   * @param tags The entity's tags.
-   * @param data The entity's data.
-   * @param sdata The entity's sdata.
-   */
-  protected pushCache(
-    guid: string,
-    cdate: number,
-    mdate: number,
-    tags: string[],
-    data: EntityData,
-    sdata: SerializedEntityData,
-  ) {
-    if (guid == null) {
-      return;
-    }
-    // Increment the entity access count.
-    if (!(guid in this.entityCount)) {
-      this.entityCount[guid] = 0;
-    }
-    this.entityCount[guid]++;
-    // Check the threshold.
-    if (this.entityCount[guid] < this.nymph.config.cacheThreshold) {
-      return;
-    }
-    // Cache the entity.
-    this.entityCache[guid] = {
-      cdate,
-      mdate,
-      tags,
-      data,
-      sdata,
-    };
-    while (
-      this.nymph.config.cacheLimit &&
-      Object.keys(this.entityCache).length >= this.nymph.config.cacheLimit
-    ) {
-      // Find which entity has been accessed the least.
-      const least =
-        Object.entries(this.entityCount)
-          .sort(([_guidA, countA], [_guidB, countB]) => countA - countB)
-          .pop()?.[0] ?? null;
-      if (least == null) {
-        // This should never happen.
-        return;
-      }
-      // Remove it.
-      delete this.entityCache[least];
-      delete this.entityCount[least];
-    }
-  }
-
   protected findReferences(svalue: string): string[] {
     const re = /\["nymph_entity_reference","([0-9a-fA-F]+)",/g;
     const matches = svalue.match(re);

package/src/testArtifacts.ts

@@ -2,7 +2,7 @@ import Entity from './Entity.js';
 import { transactional } from './decorators/index.js';
 import { transaction } from './helpers/index.js';
 
-export type TestModelData = {
+export interface TestModelData {
   name?: string;
   null?: null;
   string?: string;
@@ -24,7 +24,9 @@ export type TestModelData = {
   index?: string;
   // For uniqueness tests.
   uniques?: string[];
-};
+}
+
+export interface TestModel extends TestModelData {}
 
 /**
  * This class is a test class that extends the Entity class.
@@ -43,12 +45,12 @@ export class TestModel extends Entity<TestModelData> {
     super();
 
     this.$addTag('test');
-    this.$data.boolean = true;
-    this.$data.uniques = [];
+    this.boolean = true;
+    this.uniques = [];
   }
 
   public async $getUniques() {
-    return this.$data.uniques ?? [];
+    return this.uniques ?? [];
   }
 
   public $useProtectedData() {
@@ -72,12 +74,12 @@ export class TestModel extends Entity<TestModelData> {
 
   @transactional
   public async $testTransactionalDecorator(throwError: boolean) {
-    this.$data.string = 'this has been changed';
+    this.string = 'this has been changed';
 
-    if (this.$data.reference) {
-      await this.$data.reference.$wake();
-      this.$data.reference.string = 'this has been changed too';
-      await this.$data.reference.$save();
+    if (this.reference) {
+      await this.reference.$wake();
+      this.reference.string = 'this has been changed too';
+      await this.reference.$save();
     }
 
     await this.$save();
@@ -95,12 +97,12 @@ export class TestModel extends Entity<TestModelData> {
       'test-transaction',
       async (nymph) => {
         this.$setNymph(nymph);
-        this.$data.string = 'this has been changed';
+        this.string = 'this has been changed';
 
-        if (this.$data.reference) {
-          await this.$data.reference.$wake();
-          this.$data.reference.string = 'this has been changed too';
-          await this.$data.reference.$save();
+        if (this.reference) {
+          await this.reference.$wake();
+          this.reference.string = 'this has been changed too';
+          await this.reference.$save();
         }
 
         await this.$save();
@@ -128,6 +130,8 @@ export class TestBModel extends TestModel {
 
 export type TestEmptyModelData = {};
 
+export interface TestEmptyModel extends TestEmptyModelData {}
+
 /**
  * This class is a test class that extends the Entity class.
  */