@hotmeshio/hotmesh 0.0.37 → 0.0.39

package/services/worker/index.ts

@@ -14,6 +14,7 @@ import { RedisClientType as IORedisClientType } from '../../types/ioredisclient'
 import { HotMeshConfig, HotMeshWorker } from "../../types/hotmesh";
 import {
   QuorumMessage,
+  QuorumProfile,
   SubscriptionCallback } from "../../types/quorum";
 import { RedisClient, RedisMulti } from "../../types/redis";
 import { RedisClientType } from '../../types/redisclient';
@@ -153,10 +154,39 @@ class WorkerService {
       self.logger.debug('worker-event-received', { topic, type: message.type });
       if (message.type === 'throttle') {
         self.throttle(message.throttle);
+      } else if(message.type === 'ping') {
+        self.sayPong(self.appId, self.guid, message.originator, message.details);
       }
     };
   }
 
+  async sayPong(appId: string, guid: string, originator: string, details = false) {
+    let profile: QuorumProfile;
+    if (details) {
+      const params = {
+        appId: this.appId,
+        topic: this.topic,
+      };
+
+      profile = {
+        engine_id: this.guid,
+        namespace: this.namespace,
+        app_id: this.appId,
+        worker_topic: this.topic,
+        stream: this.stream.mintKey(KeyType.STREAMS, params),
+      };
+    }
+    this.store.publish(
+      KeyType.QUORUM, 
+      {
+        type: 'pong',
+        guid, originator,
+        profile,
+      },
+      appId,
+    );
+  }
+
   async throttle(delayInMillis: number) {
     this.router.setThrottle(delayInMillis);
   }

package/types/durable.ts

@@ -1,3 +1,4 @@
+import { LogLevel } from './logger';
 import { RedisClass, RedisOptions } from './redis';
 
 type WorkflowConfig = {
@@ -173,16 +174,16 @@ type MeshOSActivityOptions = {
 }
 
 type MeshOSWorkerOptions = {
-  taskQueue?: string; //change the default task queue
+  taskQueue?: string;          //change the default task queue
   allowList?: Array<MeshOSOptions | string>; //limit which `hook` and `workflow` workers start
-  logLevel?: string; //debug, info, warn, error
-  maxSystemRetries?: number; //1-3 (10ms, 100ms, 1_000ms)
+  logLevel?: LogLevel;         //debug, info, warn, error
+  maxSystemRetries?: number;   //1-3 (10ms, 100ms, 1_000ms)
   backoffCoefficient?: number; //2-10ish
 }
 
 type WorkerOptions = {
-  logLevel?: string; //debug, info, warn, error
-  maxSystemRetries?: number; //1-3 (10ms, 100ms, 1_000ms)
+  logLevel?: LogLevel;         //debug, info, warn, error
+  maxSystemRetries?: number;   //1-3 (10ms, 100ms, 1_000ms)
   backoffCoefficient?: number; //2-10ish
 }
 

package/types/hotmesh.ts

@@ -3,6 +3,49 @@ import { HotMeshService } from '../services/hotmesh';
 import { HookRules } from './hook';
 import { RedisClass, RedisClient, RedisOptions } from './redis';
 import { StreamData, StreamDataResponse } from './stream';
+import { LogLevel } from './logger';
+
+/**
+ * the full set of entity types that are stored in the key/value store
+ */
+enum KeyType {
+  APP = 'APP',
+  ENGINE_ID = 'ENGINE',
+  HOOKS = 'HOOKS',
+  JOB_DEPENDENTS = 'JOB_DEPENDENTS',
+  JOB_STATE = 'JOB_STATE',
+  JOB_STATS_GENERAL = 'JOB_STATS_GENERAL',
+  JOB_STATS_MEDIAN = 'JOB_STATS_MEDIAN',
+  JOB_STATS_INDEX = 'JOB_STATS_INDEX',
+  HOTMESH = 'HOTMESH',
+  QUORUM = 'QUORUM',
+  SCHEMAS = 'SCHEMAS',
+  SIGNALS = 'SIGNALS',
+  STREAMS = 'STREAMS',
+  SUBSCRIPTIONS = 'SUBSCRIPTIONS',
+  SUBSCRIPTION_PATTERNS = 'SUBSCRIPTION_PATTERNS',
+  SYMKEYS = 'SYMKEYS',
+  SYMVALS = 'SYMVALS',
+  TIME_RANGE = 'TIME_RANGE',
+  WORK_ITEMS = 'WORK_ITEMS',
+};
+
+/**
+ * minting keys, requires one or more of the following parameters
+ */
+type KeyStoreParams = {
+  appId?: string;       //app id is a uuid for a hotmesh app
+  engineId?: string;    //unique auto-generated guid for an ephemeral engine instance
+  appVersion?: string;  //(e.g. "1.0.0", "1", "1.0")
+  jobId?: string;       //a customer-defined id for job; must be unique for the entire app
+  activityId?: string;  //activity id is a uuid for a given hotmesh app
+  jobKey?: string;      //a customer-defined label for a job that serves to categorize events 
+  dateTime?: string;    //UTC date time: YYYY-MM-DDTHH:MM (20203-04-12T00:00); serves as a time-series bucket for the job_key
+  facet?: string;       //data path starting at root with values separated by colons (e.g. "object/type:bar")
+  topic?: string;       //topic name (e.g., "foo" or "" for top-level)
+  timeValue?: number;   //time value (rounded to minute) (for delete range)
+  scoutType?: 'signal' | 'time'; //a single member of the quorum serves as the 'scout' for the group, triaging tasks for the collective
+};
 
 type HotMesh = typeof HotMeshService;
 
@@ -39,7 +82,7 @@ type HotMeshConfig = {
   namespace?: string;
   name?: string;
   logger?: ILogger;
-  logLevel?: 'silly' | 'debug' | 'info' | 'warn' | 'error' | 'silent';
+  logLevel?: LogLevel;
   engine?: HotMeshEngine;
   workers?: HotMeshWorker[];
 }
@@ -98,5 +141,7 @@ export {
   HotMeshApps,   //object array of all apps in the db
   HotMeshConfig, //customer config
   HotMeshManifest,
-  HotMeshGraph
+  HotMeshGraph,
+  KeyType,
+  KeyStoreParams,
 };

package/types/index.ts

@@ -90,7 +90,9 @@ export {
   HotMeshGraph,
   HotMeshManifest,
   HotMeshSettings,
-  HotMeshWorker } from './hotmesh';
+  HotMeshWorker,
+  KeyStoreParams,
+  KeyType } from './hotmesh';
 export {
   ActivateMessage,
   JobMessage,
@@ -98,6 +100,8 @@ export {
   PingMessage,
   PongMessage,
   QuorumMessage,
+  QuorumMessageCallback,
+  QuorumProfile,
   SubscriptionCallback,
   ThrottleMessage,
   WorkMessage } from './quorum';
@@ -161,7 +165,10 @@ export {
   trace,
   Tracer,
   ValueType } from './telemetry';
+export {
+  WorkListTaskType } from './task'
 export {
   TransitionMatch,
   TransitionRule,
   Transitions } from './transition';
+      

package/types/logger.ts

@@ -3,4 +3,6 @@ export interface ILogger {
   error(message: string, ...meta: any[]): void;
   warn(message: string, ...meta: any[]): void;
   debug(message: string, ...meta: any[]): void;
-}
+};
+
+export type LogLevel = 'silly' | 'debug' | 'info' | 'warn' | 'error' | 'silent';

package/types/quorum.ts

@@ -1,9 +1,20 @@
 import { JobOutput } from "./job";
 
-//used for coordination like version activation
+//used for coordination (like version activation)
+
+export interface QuorumProfile {
+  namespace: string;
+  app_id: string;
+  engine_id: string;
+  worker_topic?: string;
+  stream?: string;
+  stream_depth?: number;
+}
+
 export interface PingMessage {
   type: 'ping';
   originator: string; //guid
+  details?: boolean;  //if true, all endpoints will include their profile
 }
 
 export interface WorkMessage {
@@ -16,11 +27,11 @@ export interface CronMessage {
   originator: string; //guid
 }
 
-//used for coordination like version activation
 export interface PongMessage {
   type: 'pong';
-  originator: string; //clone of originator guid passed in ping
-  guid: string;
+  guid: string;            //call initiator
+  originator: string;      //clone of originator guid passed in ping
+  profile?: QuorumProfile; //contains details about the engine/worker
 }
 
 export interface ActivateMessage {

package/types/redisclient.ts

@@ -6,6 +6,7 @@ interface RedisMultiType {
   XADD(key: string, id: string, fields: any): this;
   XACK(key: string, group: string, id: string): this;
   XDEL(key: string, id: string): this;
+  XLEN(key: string): this;
   HDEL(key: string, itemId: string): this;
   HGET(key: string, itemId: string): this;
   HGETALL(key: string): this;

package/types/task.ts

@@ -0,0 +1 @@
+export type WorkListTaskType = 'sleep' | 'expire' | 'interrupt' | 'delist';