anbaric-state-machine 1.20.1 → 1.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "anbaric-state-machine",
-  "version": "1.20.1",
+  "version": "1.21.0",
   "description": "This is the state machine library that one can use to add state management to an application. It will, by default, be locally runnable but can deployed to the Anbaric Cloud via the CLI",
   "license": "MIT",
   "author": "chris@anbaric.ai",
@@ -15,8 +15,8 @@
     "typescript": "^7.0.2"
   },
   "dependencies": {
-    "anbaric-impl-cloud": "^1.20.1",
-    "anbaric-tsapi": "^1.20.1"
+    "anbaric-impl-cloud": "^1.21.0",
+    "anbaric-tsapi": "^1.21.0"
   },
   "files": [
     "src"

package/src/StateMachine.ts

@@ -1,9 +1,11 @@
 import {
     Action,
     Actor,
+    AppAware,
     Auditor,
     Await,
     Consumer,
+    currentAppId,
     Job,
     JobPersistence,
     PropertyDefinition,
@@ -19,7 +21,7 @@ import {ConsumerFactory} from "./scheduling/ConsumerFactory";
 import {AuditorFactory} from "./auditing/AuditorFactory";
 import {Code} from "./actors/Code";
 
-class StateMachine {
+class StateMachine implements AppAware {
 
     readonly workflowId: string;
     readonly states: Map<string, State>;
@@ -30,44 +32,51 @@ class StateMachine {
     private queue: Queue;
     private consumer: Consumer;
     private machineActor: Code;
-    private sameStateDelayMs: number;
     private auditor: Auditor;
 
-    constructor(workflowId : string, states : Array<State>, startState? : string, dataSchema : Array<PropertyDefinition> = [], persistence : JobPersistence = JobPersistenceFactory.instance(), queue : Queue = QueueFactory.instance(), sameStateDelayMs : number = 5 * 60_000, auditor : Auditor = AuditorFactory.instance()) {
+    private readonly NO_TRANSITION_REQUEUE_DELAY: number = 5 * 60_000;
 
-        const appId = process.env.ANBARIC_APP_ID;
-        this.workflowId = appId ? `${appId}/${workflowId}` : workflowId;
+    constructor(workflowId : string, states : Array<State>, startState? : string, dataSchema : Array<PropertyDefinition> = [], persistence : JobPersistence = JobPersistenceFactory.instance(), queue : Queue = QueueFactory.instance(), auditor : Auditor = AuditorFactory.instance()) {
+
+        // The workflow's identity is the composite (appId, workflowId): the app
+        // it is deployed in (from the environment, via getAppId()) and the
+        // machine's own id, kept as separate values rather than a concatenated
+        // string.
+        this.workflowId = workflowId;
         this.states = new Map(states.map(state => [state.id, state]));
         this.startState = startState ?? states[0].id;
         this.dataSchema = new Map(dataSchema.map(property => [property.id, property]));
         this.persistence = persistence;
         this.queue = queue;
         this.machineActor = new Code(this.workflowId, "state-machine");
-        this.sameStateDelayMs = sameStateDelayMs;
         this.auditor = auditor;
 
         this.consumer = ConsumerFactory.instance(queue)
-        this.consumer.subscribe(this.workflowId, jobId => this.progressJob(jobId));
+        this.consumer.subscribe(this.getAppId(), this.workflowId, jobId => this.progressJob(jobId));
 
-        void this.auditor.audit("state-machine", this.workflowId, SystemActor.actor, ["INITIALIZE"],
+        void this.auditor.audit(this.getAppId(), "state-machine", this.workflowId, SystemActor.actor, ["INITIALIZE"],
             "State machine initialised", this.describe()).catch(() => {});
     }
 
+    getAppId() : string {
+        return currentAppId();
+    }
+
     private describe() : WorkflowDefinition {
-        return WorkflowDefinition.describe(this.workflowId, this.startState,
+        return WorkflowDefinition.describe(this.getAppId(), this.workflowId, this.startState,
             [...this.states.values()], [...this.dataSchema.values()]);
     }
 
     async startJob(properties?: Map<string, any>, actor : Actor = this.machineActor): Promise<Job> {
 
         const job = new Job(crypto.randomUUID(), properties, this.startState, this.workflowId,
-            actor?.id ?? this.workflowId);
+            this.getAppId(), actor?.id ?? this.workflowId);
 
         if (! this.validateProperties(properties ?? new Map(), true)) throw new Error("Invalid properties");
         if (! this.authorizeActor(actor, job)) throw new Error("Unauthorized");
 
         await this.persistence.create(actor, job);
-        await this.queue.enqueue(job.id, this.workflowId);
+        await this.queue.enqueue(job.id, this.getAppId(), this.workflowId);
 
         return job;
     }
@@ -161,7 +170,7 @@ class StateMachine {
             job.waitingFor = undefined;
             await this.persistence.save(involvedActors[0] ?? this.machineActor, `Job ${job.id} progressed automatically`,
                 job, propertiesChanged ? job.properties : undefined, newState);
-            if (! this.states.get(newState)?.isTerminal) await this.queue.enqueue(job.id, this.workflowId);
+            if (! this.states.get(newState)?.isTerminal) await this.queue.enqueue(job.id, this.getAppId(), this.workflowId);
             return;
         }
 
@@ -171,7 +180,7 @@ class StateMachine {
 
         await this.persistence.save(involvedActors[0] ?? this.machineActor, `Job ${job.id} progressed automatically`,
             job, job.properties);
-        await this.queue.schedule(job.id, this.workflowId, new Date(Date.now() + this.sameStateDelayMs));
+        await this.queue.schedule(job.id, this.getAppId(), this.workflowId, new Date(Date.now() + this.NO_TRANSITION_REQUEUE_DELAY));
     }
 
     private async updateJobInternal(actor: Actor, message : string, job: Job, newProperties?: Map<string, any>, newState? : string) {
@@ -179,7 +188,7 @@ class StateMachine {
         if (newProperties && !this.validateProperties(newProperties, false)) throw new Error("Invalid properties");
 
         await this.persistence.save(actor, "Properties Updated", job, newProperties, newState)
-        await this.queue.enqueue(job.id, this.workflowId);
+        await this.queue.enqueue(job.id, this.getAppId(), this.workflowId);
     }
 
     private validateProperties(properties : Map<string, any>, isNew : boolean) : boolean {

package/src/auditing/ConsoleAuditor.ts

@@ -2,9 +2,10 @@ import {Actor, Auditor} from "anbaric-tsapi";
 
 class ConsoleAuditor implements Auditor {
 
-    async audit(resourceType : string, resourceId : string, actor : Actor, interaction : Array<string>,
-                description : string, details : any) : Promise<void> {
-        console.log(`[${resourceType} ${resourceId}] ${actor.id} ${interaction.join(",")} ${description} ${JSON.stringify(details ?? null)}`);
+    async audit(appId : string | undefined, resourceType : string, resourceId : string, actor : Actor,
+                interaction : Array<string>, description : string, details : any) : Promise<void> {
+        const scope = appId ? `${appId}/` : "";
+        console.log(`[${scope}${resourceType} ${resourceId}] ${actor.id} ${interaction.join(",")} ${description} ${JSON.stringify(details ?? null)}`);
     }
 
 }

package/src/scheduling/InMemoryQueue.ts

@@ -5,12 +5,12 @@ class InMemoryQueue implements Dequeue {
     private ready : Array<QueueMessage> = [];
     private scheduled : Array<{ message : QueueMessage, due : Date }> = [];
 
-    async enqueue(jobId : string, workflowId : string) : Promise<void> {
-        this.ready.push({ jobId, workflowId });
+    async enqueue(jobId : string, appId : string | undefined, workflowId : string) : Promise<void> {
+        this.ready.push({ jobId, appId, workflowId });
     }
 
-    async schedule(jobId : string, workflowId : string, due : Date) : Promise<void> {
-        this.scheduled.push({ message: { jobId, workflowId }, due });
+    async schedule(jobId : string, appId : string | undefined, workflowId : string, due : Date) : Promise<void> {
+        this.scheduled.push({ message: { jobId, appId, workflowId }, due });
     }
 
     async dequeueSome() : Promise<Array<QueueMessage>> {

package/src/scheduling/PullConsumer.ts

@@ -10,8 +10,14 @@ class PullConsumer implements Consumer {
 
     constructor(private queue : Dequeue, private pollIntervalMs : number = 1000) {}
 
-    subscribe(workflowId : string, processJob : ProcessJob) : void {
-        this.subscribers.set(workflowId, processJob);
+    // Subscribers are keyed by the (appId, workflowId) composite, encoded as a
+    // tuple so an app and a machine id can never collide.
+    private key(appId : string | undefined, workflowId : string) : string {
+        return JSON.stringify([appId || null, workflowId]);
+    }
+
+    subscribe(appId : string | undefined, workflowId : string, processJob : ProcessJob) : void {
+        this.subscribers.set(this.key(appId, workflowId), processJob);
         if (!this.ticker) {
             this.ticker = setInterval(() => void this.drain(), this.pollIntervalMs);
             this.ticker.unref();
@@ -37,15 +43,15 @@ class PullConsumer implements Consumer {
     }
 
     private async forward(message : QueueMessage) : Promise<void> {
-        const processJob = this.subscribers.get(message.workflowId);
+        const processJob = this.subscribers.get(this.key(message.appId, message.workflowId));
         if (!processJob) {
-            await this.queue.enqueue(message.jobId, message.workflowId);
+            await this.queue.enqueue(message.jobId, message.appId, message.workflowId);
             return;
         }
         try {
             await processJob(message.jobId);
         } catch {
-            await this.queue.enqueue(message.jobId, message.workflowId);
+            await this.queue.enqueue(message.jobId, message.appId, message.workflowId);
         }
     }