@hotmeshio/hotmesh 0.0.55 → 0.0.57

package/services/collator/index.ts

@@ -1,291 +0,0 @@
-import { CollationError, InactiveJobError } from '../../modules/errors';
-import { RedisMulti } from '../../types/redis';
-import { CollationFaultType, CollationStage } from '../../types/collator';
-import { ActivityDuplex } from '../../types/activity';
-import { HotMeshGraph } from '../../types/hotmesh';
-import { Activity } from '../activities/activity';
-import { Cycle } from '../activities/cycle';
-
-class CollatorService {
-
-  //max int digit count that supports `hincrby`
-  static targetLength = 15;
-
-  /**
-   * Upon re/entry, verify that the job status is active
-   */
-  static assertJobActive(status: number, jobId: string, activityId: string): void {
-    if (status <= 0) {
-      throw new InactiveJobError(jobId, status, activityId);
-    }
-  }
-
-  /**
-   * returns the dimensional address (dad) for the target; due
-   * to the nature of the notary system, the dad for leg 2 entry
-   * must target the `0` index while leg 2 exit must target the
-   * current index (0)
-   */
-  static getDimensionalAddress(activity: Activity, isEntry = false): Record<string, string> {
-    let dad = activity.context.metadata.dad || activity.metadata.dad;
-    if (isEntry && dad && activity.leg === 2) {
-      dad = `${dad.substring(0, dad.lastIndexOf(','))},0`;
-    }
-    return CollatorService.getDimensionsById([...activity.config.ancestors, activity.metadata.aid], dad);
-  }
-
-  /**
-   * resolves the dimensional address for the
-   * ancestor in the graph to go back to. this address
-   * is determined by trimming the last digits from
-   * the `dad` (including the target).
-   * the target activity index is then set to `0`, so that
-   * the origin node can be queried for approval/entry.
-   */
-  static resolveReentryDimension(activity: Cycle) {
-    const targetActivityId = activity.config.ancestor;
-    const ancestors = activity.config.ancestors;
-    const ancestorIndex = ancestors.indexOf(targetActivityId);
-    const dimensions = activity.metadata.dad.split(','); //e.g., `,0,0,1,0`
-    dimensions.length = ancestorIndex + 1;
-    dimensions.push('0');
-    return dimensions.join(',');
-  }
-
-  static async notarizeEntry(activity: Activity, multi?: RedisMulti): Promise<number> {
-    //decrement by -100_000_000_000_000
-    const amount = await activity.store.collate(activity.context.metadata.jid, activity.metadata.aid, -100_000_000_000_000, this.getDimensionalAddress(activity), multi);
-    this.verifyInteger(amount, 1, 'enter');
-    return amount;
-  };
-
-  static async authorizeReentry(activity: Activity, multi?: RedisMulti): Promise<number> {
-    //set second digit to 8, allowing for re-entry
-    //decrement by -10_000_000_000_000
-    const amount = await activity.store.collate(activity.context.metadata.jid, activity.metadata.aid, -10_000_000_000_000, this.getDimensionalAddress(activity), multi);
-    return amount;
-  }
-
-  static async notarizeEarlyExit(activity: Activity, multi?: RedisMulti): Promise<number> {
-    //decrement the 2nd and 3rd digits to fully deactivate (`cycle` activities use this command to fully exit after leg 1) (should result in `888000000000000`)
-    return await activity.store.collate(activity.context.metadata.jid, activity.metadata.aid, -11_000_000_000_000, this.getDimensionalAddress(activity), multi);
-  };
-
-  static async notarizeEarlyCompletion(activity: Activity, multi?: RedisMulti): Promise<number> {
-    //initialize both `possible` (1m) and `actualized` (1) zero dimension, while decrementing the 2nd
-    //3rd digit is optionally kept open if the activity might be used in a cycle
-    const decrement = activity.config.cycle ? 10_000_000_000_000 : 11_000_000_000_000;
-    return await activity.store.collate(activity.context.metadata.jid, activity.metadata.aid, 1_000_001 - decrement, this.getDimensionalAddress(activity), multi);
-  };
-
-  /**
-   * verifies both the concrete and synthetic keys for the activity; concrete keys
-   * exist in the original model and are effectively the 'real' keys. In reality,
-   * hook activities are atomized during compilation to create a synthetic DAG that
-   * is used to track the status of the graph in a distributed environment. The
-   * synthetic key represents different dimensional realities and is used to
-   * track re-entry overages (it distinguishes between the original and re-entry).
-   * The essential challenge is: is this a re-entry that is purposeful in
-   * order to induce cycles, or is the re-entry due to a failure in the system?
-   */
-  static async notarizeReentry(activity: Activity, guid: string, multi?: RedisMulti): Promise<number> {
-    const jid = activity.context.metadata.jid;
-    const localMulti = multi || activity.store.getMulti();
-    //increment by 1_000_000 (indicates re-entry and is used to drive the 'dimensional address' for adjacent activities (minus 1))
-    await activity.store.collate(jid, activity.metadata.aid, 1_000_000, this.getDimensionalAddress(activity, true), localMulti);
-    await activity.store.collateSynthetic(jid, guid, 1_000_000, localMulti);
-    const [_amountConcrete, _amountSynthetic] = await localMulti.exec();
-    const amountConcrete = Array.isArray(_amountConcrete) ? _amountConcrete[1] : _amountConcrete;
-    const amountSynthetic = Array.isArray(_amountSynthetic) ? _amountSynthetic[1] : _amountSynthetic;
-    this.verifyInteger(amountConcrete as number, 2, 'enter');
-    this.verifySyntheticInteger(amountSynthetic as number);
-    return amountConcrete as number;
-  };
-
-  static async notarizeContinuation(activity: Activity, multi?: RedisMulti): Promise<number> {
-    //keep open; actualize the leg2 dimension (+1)
-    return await activity.store.collate(activity.context.metadata.jid, activity.metadata.aid, 1, this.getDimensionalAddress(activity), multi);
-  };
-
-  static async notarizeCompletion(activity: Activity, multi?: RedisMulti): Promise<number> {
-    //1) ALWAYS actualize leg2 dimension (+1)
-    //2) IF the activity is used in a cycle, don't close leg 2!
-    const decrement = activity.config.cycle ? 0 : 1_000_000_000_000;
-    return await activity.store.collate(activity.context.metadata.jid, activity.metadata.aid, 1 - decrement, this.getDimensionalAddress(activity), multi);
-  };
-
-  static getDigitAtIndex(num: number, targetDigitIndex: number): number | null {
-    const numStr = num.toString();
-    if (targetDigitIndex < 0 || targetDigitIndex >= numStr.length) {
-      return null;
-    }
-    const digit = parseInt(numStr[targetDigitIndex], 10);
-    return digit;
-  }
-
-  static getDimensionalIndex(num: number): number | null {
-    const numStr = num.toString();
-    if (numStr.length < 9) {
-      return null;
-    }
-    const extractedStr = numStr.substring(3, 9);
-    const extractedInt = parseInt(extractedStr, 10);
-    return extractedInt - 1;
-  }
-
-  static isDuplicate(num: number, targetDigitIndex: number): boolean {
-    return this.getDigitAtIndex(num, targetDigitIndex) < 8;
-  }
-
-  static isInactive(num: number): boolean {
-    return this.getDigitAtIndex(num, 2) < 9;
-  }
-
-  static isPrimed(amount: number, leg: ActivityDuplex): boolean {
-    //activity entry is not allowed if paths not properly pre-set
-    if (leg == 1) {
-      return amount != -100_000_000_000_000;
-    } else {
-      return this.getDigitAtIndex(amount, 0) < 9 &&
-        this.getDigitAtIndex(amount, 1) < 9;
-    }
-  }
-
-  /**
-   * During compilation, the graphs are compiled into structures necessary
-   * for distributed processing; these are referred to as 'synthetic DAGs',
-   * because they are not part of the original graph, but are used to track
-   * the status of the graph in a distributed environment. This check ensures
-   * that the 'synthetic key' is not a duplicate. (which is different than
-   * saying the 'key' is not a duplicate)
-   */
-  static verifySyntheticInteger(amount: number): void {
-    const samount = amount.toString();
-    const isCompletedValue = parseInt(samount[samount.length - 1], 10);
-    if (isCompletedValue > 0) {
-      //already done error (ack/delete clearly failed; this is a duplicate)
-      throw new CollationError(amount, 2, 'enter', CollationFaultType.INACTIVE);
-    } else if (amount >= 2_000_000) {
-      //duplicate synthetic key (todo: need to resolve/fix this!!)
-      throw new CollationError(amount, 2, 'enter', CollationFaultType.DUPLICATE);
-    }
-  }
-
-  static verifyInteger(amount: number, leg: ActivityDuplex, stage: CollationStage): void {
-    let faultType: CollationFaultType | undefined;
-    if (leg === 1 && stage === 'enter') {
-      if (!this.isPrimed(amount, 1)) {
-        faultType = CollationFaultType.MISSING;
-      } else if (this.isDuplicate(amount, 0)) {
-        faultType = CollationFaultType.DUPLICATE;
-      } else if (amount != 899_000_000_000_000) {
-        faultType = CollationFaultType.INVALID;
-      }
-    } else if (leg === 1 && stage === 'exit') {
-      if (amount === -10_000_000_000_000) {
-        faultType = CollationFaultType.MISSING;
-      } else if (this.isDuplicate(amount, 1)) {
-        faultType = CollationFaultType.DUPLICATE;
-      }
-    } else if (leg === 2 && stage === 'enter') {
-      if (!this.isPrimed(amount, 2)) {
-        faultType = CollationFaultType.FORBIDDEN;
-      } else if (this.isInactive(amount)) {
-        faultType = CollationFaultType.INACTIVE;
-      }
-    }
-    if (faultType) {
-      throw new CollationError(amount, leg, stage, faultType);
-    }
-  }
-
-  static getDimensionsById(ancestors: string[], dad: string): Record<string, string> {
-    //ancestors is an ordered list of all ancestors, starting with the trigger (['t1', 'a1', 'a2'])
-    //dad is the dimensional address of the ancestors list (',0,5,3')
-    //loop through the ancestors list and create a map of the ancestor to the dimensional address.
-    //return { 't1': ',0', 'a1': ',0,5', 'a1': ',0,5,3', $ADJACENT: ',0,5,3,0' };
-    // `adjacent` is a special key that is used to track the dimensional address of adjacent activities
-    const map: Record<string, string> = { '$ADJACENT': `${dad},0` };
-    let dadStr = dad;
-    ancestors.reverse().forEach((ancestor) => {
-      map[ancestor] = dadStr;
-      dadStr = dadStr.substring(0, dadStr.lastIndexOf(','));
-    });
-    return map;
-  }
-
-  /**
-   * All non-trigger activities are assigned a status seed by their parent
-   */
-  static getSeed(): string {
-    return '999000000000000';
-  }
-
-  /**
-   * All trigger activities are assigned a status seed in a completed state
-   */
-  static getTriggerSeed(): string {
-    return '888000001000001';
-  }
-
-  /**
-   * entry point for compiler-type activities. This is called by the compiler
-   * to bind the sorted activity IDs to the trigger activity. These are then used
-   * at runtime by the activities to track job/activity status.
-   * @param graphs
-   */
-  static compile(graphs: HotMeshGraph[]) {
-    CollatorService.bindAncestorArray(graphs);
-  }
-
-  /**
-   * binds the ancestor array to each activity.
-   * Used in conjunction with the dimensional
-   *  address (dad). If dad is `,0,1,0,0` and the
-   * ancestor array is `['t1', 'a1', 'a2']` for
-   * activity 'a3', then the SAVED DAD
-   * will always have the trailing
-   * 0's removed. This ensures that the addressing
-   * remains consistent even if the graph changes.
-   *   id    DAD           SAVED DAD
-   * * t1 => ,0        =>  [empty]
-   * * a1 => ,0,1      =>  ,0,1
-   * * a2 => ,0,1,0    =>  ,0,1
-   * * a3 => ,0,1,0,0  =>  ,0,1
-   * 
-   */
-  static bindAncestorArray(graphs: HotMeshGraph[]) {
-    graphs.forEach((graph) => {
-      const ancestors: Record<string, string[]> = {};
-        const startingNode = Object.keys(graph.activities).find(
-        (activity) => graph.activities[activity].type === 'trigger'
-      );
-      if (!startingNode) {
-        throw new Error('collator-trigger-activity-not-found');
-      }
-      const dfs = (node: string, parentList: string[]) => {
-        ancestors[node] = parentList;
-        graph.activities[node]['ancestors'] = parentList;
-        const transitions = graph.transitions?.[node] || [];
-        transitions.forEach((transition) => {
-          dfs(transition.to, [...parentList, node]);
-        });
-      };
-      // Start the DFS traversal
-      dfs(startingNode, []);
-    });
-  }
-
-  /**
-   * All activities exist on a dimensional plane. Zero
-   * is the default. A value of 
-   * `AxY,0,0,0,0,1,0,0` would reflect that
-   * an ancestor activity was dimensionalized beyond
-   * the default.
-   */
-  static getDimensionalSeed(index = 0): string {
-    return `,${index}`;
-  }
-}
-
-export { CollatorService };