@hotmeshio/hotmesh 0.0.30 → 0.0.31

package/build/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hotmeshio/hotmesh",
-    "version": "0.0.30",
+    "version": "0.0.31",
     "description": "Unbreakable Workflows",
     "main": "build/index.js",
     "types": "build/index.d.ts",

package/build/services/durable/workflow.js

@@ -31,16 +31,16 @@ class WorkflowService {
         const workflowSpan = store.get('workflowSpan');
         const COUNTER = store.get('counter');
         const execIndex = COUNTER.counter = COUNTER.counter + 1;
-        const prefix = options.prefix ?? '';
-        //this is risky but MUST be allowed. Users MAY set the workflowId,
-        //but if there is a naming collision, the data from the target entity will be used
-        //as there is know way of knowing if the item was generated via a prior run of the workflow
-        const childJobId = options.workflowId ?? `${prefix}-${workflowId}-$${options.workflowName}${workflowDimension}-${execIndex}`;
+        //NOTE: this is the hash prefix; necessary for the search index to locate the entity
+        //if the hash is a helper, a dash begins it, so it isn't indexed
+        const entityOrEmptyString = options.entity ?? '';
+        //If the workflowId is not provided, it is generated from the entity and the workflow name
+        const childJobId = options.workflowId ?? `${entityOrEmptyString}-${workflowId}-$${options.entity ?? options.workflowName}${workflowDimension}-${execIndex}`;
         const parentWorkflowId = `${workflowId}-f`;
         const client = new client_1.ClientService({
             connection: await connection_1.ConnectionService.connect(worker_1.WorkerService.connection),
         });
-        let handle = await client.workflow.getHandle(options.taskQueue, options.workflowName, childJobId, namespace);
+        let handle = await client.workflow.getHandle(options.entity ?? options.taskQueue, options.entity ?? options.workflowName, childJobId, namespace);
         try {
             return await handle.result(true);
         }
@@ -73,10 +73,12 @@ class WorkflowService {
         const workflowSpan = store.get('workflowSpan');
         const COUNTER = store.get('counter');
         const execIndex = COUNTER.counter = COUNTER.counter + 1;
-        const prefix = options.prefix ?? '';
-        const childJobId = options.workflowId ?? `${prefix}-${workflowId}-$${options.workflowName}${workflowDimension}-${execIndex}`;
+        //NOTE: this is the hash prefix; necessary for the search index to locate the entity
+        const entityOrEmptyString = options.entity ?? '';
+        //If the workflowId is not provided, it is generated from the entity and the workflow name
+        const childJobId = options.workflowId ?? `${entityOrEmptyString}-${workflowId}-$${options.entity ?? options.workflowName}${workflowDimension}-${execIndex}`;
         const parentWorkflowId = `${workflowId}-f`;
-        const workflowTopic = `${options.taskQueue}-${options.workflowName}`;
+        const workflowTopic = `${options.entity ?? options.taskQueue}-${options.entity ?? options.workflowName}`;
         try {
             //get the status; if there is no error, return childJobId (what was spawned)
             const hotMeshClient = await worker_1.WorkerService.getHotMesh(workflowTopic, { namespace });
@@ -247,8 +249,8 @@ class WorkflowService {
             const store = asyncLocalStorage_1.asyncLocalStorage.getStore();
             const workflowId = options.workflowId ?? store.get('workflowId');
             let workflowTopic = store.get('workflowTopic');
-            if (options.taskQueue && options.workflowName) {
-                workflowTopic = `${options.taskQueue}-${options.workflowName}`;
+            if (options.entity || (options.taskQueue && options.workflowName)) {
+                workflowTopic = `${options.entity ?? options.taskQueue}-${options.entity ?? options.workflowName}`;
             } //else this is essentially recursion as the function calls itself
             const payload = {
                 arguments: [...options.args],

package/build/services/signaler/stream.js

@@ -220,7 +220,6 @@ class StreamSignaler {
         for (const instance of [...StreamSignaler.signalers]) {
             instance.stopConsuming();
         }
-        await (0, utils_1.sleepFor)(BLOCK_TIME_MS);
     }
     async stopConsuming() {
         this.shouldConsume = false;

package/build/types/durable.d.ts

@@ -49,7 +49,7 @@ type WorkflowOptions = {
     taskQueue: string;
     args: any[];
     workflowId?: string;
-    prefix?: string;
+    entity?: string;
     workflowName?: string;
     parentWorkflowId?: string;
     workflowTrace?: string;
@@ -61,6 +61,7 @@ type HookOptions = {
     namespace?: string;
     taskQueue?: string;
     args: any[];
+    entity?: string;
     workflowId?: string;
     workflowName?: string;
     search?: WorkflowSearchOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hotmeshio/hotmesh",
-  "version": "0.0.30",
+  "version": "0.0.31",
   "description": "Unbreakable Workflows",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/services/durable/workflow.ts

@@ -39,11 +39,11 @@ export class WorkflowService {
     const workflowSpan = store.get('workflowSpan');
     const COUNTER = store.get('counter');
     const execIndex = COUNTER.counter = COUNTER.counter + 1;
-    const prefix = options.prefix ?? '';
-    //this is risky but MUST be allowed. Users MAY set the workflowId,
-    //but if there is a naming collision, the data from the target entity will be used
-    //as there is know way of knowing if the item was generated via a prior run of the workflow
-    const childJobId = options.workflowId ?? `${prefix}-${workflowId}-$${options.workflowName}${workflowDimension}-${execIndex}`;
+    //NOTE: this is the hash prefix; necessary for the search index to locate the entity
+    //if the hash is a helper, a dash begins it, so it isn't indexed
+    const entityOrEmptyString = options.entity ?? '';
+    //If the workflowId is not provided, it is generated from the entity and the workflow name
+    const childJobId = options.workflowId ?? `${entityOrEmptyString}-${workflowId}-$${options.entity ?? options.workflowName}${workflowDimension}-${execIndex}`;
     const parentWorkflowId = `${workflowId}-f`;
 
     const client = new Client({
@@ -51,8 +51,8 @@ export class WorkflowService {
     });
 
     let handle = await client.workflow.getHandle(
-      options.taskQueue,
-      options.workflowName,
+      options.entity ?? options.taskQueue,
+      options.entity ?? options.workflowName,
       childJobId,
       namespace,
     );
@@ -89,10 +89,12 @@ export class WorkflowService {
     const workflowSpan = store.get('workflowSpan');
     const COUNTER = store.get('counter');
     const execIndex = COUNTER.counter = COUNTER.counter + 1;
-    const prefix = options.prefix ?? '';
-    const childJobId = options.workflowId ?? `${prefix}-${workflowId}-$${options.workflowName}${workflowDimension}-${execIndex}`;
+    //NOTE: this is the hash prefix; necessary for the search index to locate the entity
+    const entityOrEmptyString = options.entity ?? '';
+    //If the workflowId is not provided, it is generated from the entity and the workflow name
+    const childJobId = options.workflowId ?? `${entityOrEmptyString}-${workflowId}-$${options.entity ?? options.workflowName}${workflowDimension}-${execIndex}`;
     const parentWorkflowId = `${workflowId}-f`;
-    const workflowTopic = `${options.taskQueue}-${options.workflowName}`;
+    const workflowTopic = `${options.entity ?? options.taskQueue}-${options.entity ?? options.workflowName}`;
 
     try {
       //get the status; if there is no error, return childJobId (what was spawned)
@@ -273,8 +275,8 @@ export class WorkflowService {
       const store = asyncLocalStorage.getStore();
       const workflowId = options.workflowId ?? store.get('workflowId');
       let workflowTopic = store.get('workflowTopic');
-      if (options.taskQueue && options.workflowName) {
-        workflowTopic = `${options.taskQueue}-${options.workflowName}`;
+      if (options.entity || (options.taskQueue && options.workflowName)) {
+        workflowTopic = `${options.entity ?? options.taskQueue}-${options.entity ?? options.workflowName}`;
       } //else this is essentially recursion as the function calls itself
       const payload = {
         arguments: [...options.args],

package/services/signaler/stream.ts

@@ -254,7 +254,6 @@ class StreamSignaler {
     for (const instance of [...StreamSignaler.signalers]) {
       instance.stopConsuming();
     }
-    await sleepFor(BLOCK_TIME_MS);
   }
   
   async stopConsuming() {

package/types/durable.ts

@@ -57,7 +57,7 @@ type WorkflowOptions = {
   taskQueue: string;
   args: any[];                //input arguments to pass in
   workflowId?: string;        //execution id (the job id)
-  prefix?: string;            //If invoking a hook, the prefix ensures the FT.SEARCH index is properly scoped to those documents with this prefix
+  entity?: string;            //If invoking a workflow, passing 'entity' will apply the value as the workflowName, taskQueue, and prefix, ensuring the FT.SEARCH index is properly scoped. This is a convenience method but limits options.
   workflowName?: string;      //the name of the user's workflow function
   parentWorkflowId?: string;  //system reserved; the id of the parent; if present the flow will not self-clean until the parent that spawned it self-cleans
   workflowTrace?: string;
@@ -70,6 +70,7 @@ type HookOptions = {
   namespace?: string;   //'durable' is the default namespace if not provided; similar to setting `appid` in the YAML
   taskQueue?: string;
   args: any[];          //input arguments to pass into the hook
+  entity?: string;      //If invoking a hook, passing 'entity' will apply the value as the workflowName, taskQueue, and prefix, ensuring the FT.SEARCH index is properly scoped. This is a convenience method but limits options.
   workflowId?: string;   //execution id (the job id to hook into)
   workflowName?: string; //the name of the user's hook function
   search?: WorkflowSearchOptions //bind additional search terms immediately before hook reentry