feat: implementing Startable and propogating stop()

Signed-off-by: Curtish <ch@curtish.me>
hyperledger · Oct 22, 2024 · aaa05f7 · aaa05f7
1 parent e6d0008
commit aaa05f7
Show file tree

Hide file tree

Showing 14 changed files with 426 additions and 156 deletions.
diff --git a/src/domain/buildingBlocks/Pluto.ts b/src/domain/buildingBlocks/Pluto.ts
@@ -33,11 +33,18 @@ export namespace Pluto {
  * preferred underlying storage technology, most appropriate for your use case.
  */
 export interface Pluto {
+  // TODO extend Startable.Controller (changes the interface)
+
   /**
-   * Pluto initialise function
+   * Handle startup.
    */
   start(): Promise<void>;
 
+  /**
+   * Handle teardown.
+   */
+  stop?(): Promise<void>;
+
   /**
    * create a Backup object from the stored data
    */

diff --git a/src/domain/buildingBlocks/Pollux.ts b/src/domain/buildingBlocks/Pollux.ts
@@ -17,8 +17,8 @@ export type CredentialOfferJWTBasePayload = {
   options: {
     challenge: string;
     domain: string;
-  }
-}
+  };
+};
 
 export type CredentialOfferPayloads = {
   [CredentialType.AnonCreds]: Anoncreds.CredentialOfferType;
@@ -48,9 +48,8 @@ export type ProcessedCredentialOfferPayloads = {
  * handle Credential related tasks
  */
 export interface Pollux {
-
   revealCredentialFields: (credential: Credential, fields: string[], linkSecret: string) => Promise<{
-    [name: string]: any
+    [name: string]: any;
   }>;
 
   isCredentialRevoked: (credential: Credential) => Promise<boolean>;
@@ -71,12 +70,12 @@ export interface Pollux {
     presentationDefinition: PresentationDefinitionRequest<CredentialType.JWT>,
     credential: Credential,
     privateKey: PrivateKey
-  ): Promise<PresentationSubmission<CredentialType.JWT>>
+  ): Promise<PresentationSubmission<CredentialType.JWT>>;
   createPresentationSubmission(
     presentationDefinition: PresentationDefinitionRequest<CredentialType.AnonCreds>,
     credential: Credential,
     privateKey: LinkSecret
-  ): Promise<PresentationSubmission<CredentialType.AnonCreds>>
+  ): Promise<PresentationSubmission<CredentialType.AnonCreds>>;
 
   /**
    * Process a PresentationSubmission, resolve the issuer did and verify the credential and the holder signature
@@ -88,15 +87,15 @@ export interface Pollux {
   verifyPresentationSubmission(
     presentationSubmission: PresentationSubmission<CredentialType.JWT>,
     options?: Pollux.verifyPresentationSubmission.options.JWT
-  ): Promise<boolean>
+  ): Promise<boolean>;
   verifyPresentationSubmission(
     presentationSubmission: PresentationSubmission<CredentialType.AnonCreds>,
     options?: Pollux.verifyPresentationSubmission.options.Anoncreds
-  ): Promise<boolean>
+  ): Promise<boolean>;
   verifyPresentationSubmission(
     presentationSubmission: PresentationSubmission,
     options?: Pollux.verifyPresentationSubmission.options.JWT | Pollux.verifyPresentationSubmission.options.Anoncreds
-  ): Promise<boolean>
+  ): Promise<boolean>;
 
   /**
    * Creates a PresentationDefinitionRequest object for oob Verifications
@@ -108,7 +107,7 @@ export interface Pollux {
     type: T,
     claims: PresentationClaims<T>,
     options: PresentationOptions
-  ): Promise<PresentationDefinitionRequest<T>>
+  ): Promise<PresentationDefinitionRequest<T>>;
 
 
 

diff --git a/src/edge-agent/Agent.ts b/src/edge-agent/Agent.ts
@@ -7,13 +7,8 @@ import { SignWithDID } from "./didFunctions/Sign";
 import { CreatePrismDID } from "./didFunctions/CreatePrismDID";
 import { FetchApi } from "./helpers/FetchApi";
 import { Task } from "../utils/tasks";
-
-enum AgentState {
-  STOPPED = "stopped",
-  STARTING = "starting",
-  RUNNING = "running",
-  STOPPING = "stopping",
-}
+import { Startable } from "../utils/startable";
+import { notNil } from "../utils";
 
 /**
  * Edge agent implementation
@@ -22,14 +17,14 @@ enum AgentState {
  * @class Agent
  * @typedef {Agent}
  */
-export default class Agent {
+export default class Agent implements Startable.Controller {
   /**
    * Agent state
    *
    * @public
-   * @type {AgentState}
+   * @type {Startable.State}
    */
-  public state: AgentState = AgentState.STOPPED;
+  public state = Startable.State.STOPPED;
   public backup: AgentBackup;
   public readonly pollux: Pollux;
 
@@ -86,30 +81,28 @@ export default class Agent {
   /**
    * Asyncronously start the agent
    *
-   * @async
    * @returns {Promise<AgentState>}
    */
-  async start(): Promise<AgentState> {
-    if (this.state === AgentState.STOPPED) {
-      this.state = AgentState.STARTING;
+  start(): Promise<Startable.State> {
+    return Startable.start(this, async () => {
       await this.pluto.start();
       await this.pollux.start();
-    }
-
-    return this.state;
+    });
   }
 
   /**
    * Asyncronously stop the agent and any side task that is running
    *
-   * @async
-   * @returns {Promise<void>}
+   * @returns {Promise<Startable.State>}
    */
-  async stop(): Promise<void> {
-    if (this.state !== AgentState.RUNNING) {
-      return;
-    }
-    this.state = AgentState.STOPPED;
+  stop(): Promise<Startable.State> {
+    return Startable.stop(this, async () => {
+      await this.pollux.stop();
+
+      if (notNil(this.pluto.stop)) {
+        await this.pluto.stop();
+      }
+    });
   }
 
   /**

diff --git a/src/edge-agent/didcomm/Agent.ts b/src/edge-agent/didcomm/Agent.ts
@@ -37,13 +37,8 @@ import { FetchApi } from "../helpers/FetchApi";
 import { ParsePrismInvitation } from "./ParsePrismInvitation";
 import { ParseInvitation } from "./ParseInvitation";
 import { HandleOOBInvitation } from "./HandleOOBInvitation";
-
-enum AgentState {
-  STOPPED = "stopped",
-  STARTING = "starting",
-  RUNNING = "running",
-  STOPPING = "stopping",
-}
+import { Startable } from "../../utils/startable";
+import { notNil } from "../../utils";
 
 /**
  * Edge agent implementation
@@ -52,14 +47,8 @@ enum AgentState {
  * @class Agent
  * @typedef {Agent}
  */
-export default class DIDCommAgent {
-  /**
-   * Agent state
-   *
-   * @public
-   * @type {AgentState}
-   */
-  public state: AgentState = AgentState.STOPPED;
+export default class DIDCommAgent implements Startable.Controller {
+  public state = Startable.State.STOPPED;
   public backup: AgentBackup;
   public readonly pollux: Pollux;
 
@@ -148,64 +137,55 @@ export default class DIDCommAgent {
     return agent;
   }
 
+  start(): Promise<Startable.State> {
+    return Startable.start(this, async () => {
+      try {
+        this.state = Startable.State.STARTING;
+        await this.pluto.start();
+        await this.pollux.start();
+        await this.connectionManager.startMediator();
+      }
+      catch (e) {
+        if (e instanceof Domain.AgentError.NoMediatorAvailableError) {
+          const hostDID = await this.createNewPeerDID([], false);
+          await this.connectionManager.registerMediator(hostDID);
+        }
+        else {
+          throw e;
+        }
+      }
 
-  /**
-   * Asyncronously start the agent
-   *
-   * @async
-   * @returns {Promise<AgentState>}
-   */
-  async start(): Promise<AgentState> {
-    if (this.state !== AgentState.STOPPED) {
-      return this.state;
-    }
-
-    try {
-      this.state = AgentState.STARTING;
-      await this.pluto.start();
-      await this.pollux.start();
-      await this.connectionManager.startMediator();
-    } catch (e) {
-      if (e instanceof Domain.AgentError.NoMediatorAvailableError) {
-        const hostDID = await this.createNewPeerDID([], false);
-
-        await this.connectionManager.registerMediator(hostDID);
-
-      } else throw e;
-    }
-
-    if (this.connectionManager.mediationHandler.mediator !== undefined) {
-      await this.connectionManager.startFetchingMessages(5);
-      this.state = AgentState.RUNNING;
-    } else {
-      throw new Domain.AgentError.MediationRequestFailedError("Mediation failed");
-    }
-
-    const storedLinkSecret = await this.pluto.getLinkSecret();
-    if (storedLinkSecret == null) {
-      const secret = this.pollux.anoncreds.createLinksecret();
-      const linkSecret = new Domain.LinkSecret(secret);
-      await this.pluto.storeLinkSecret(linkSecret);
-    }
+      if (this.connectionManager.mediationHandler.mediator !== undefined) {
+        await this.connectionManager.startFetchingMessages(5);
+      }
+      else {
+        throw new Domain.AgentError.MediationRequestFailedError("Mediation failed");
+      }
 
-    return this.state;
+      const storedLinkSecret = await this.pluto.getLinkSecret();
+      if (storedLinkSecret == null) {
+        const secret = this.pollux.anoncreds.createLinksecret();
+        const linkSecret = new Domain.LinkSecret(secret);
+        await this.pluto.storeLinkSecret(linkSecret);
+      }
+    });
   }
 
   /**
-   * Asyncronously stop the agent and any side task that is running
+   * Asyncronously stop the agent and dependencies
    *
-   * @async
    * @returns {Promise<void>}
    */
-  async stop(): Promise<void> {
-    if (this.state !== AgentState.RUNNING) {
-      return;
-    }
-    this.state = AgentState.STOPPING;
-    await this.connectionManager.stopAllEvents();
-    await this.connectionManager.stopFetchingMessages();
-    // await this.agent.stop();
-    this.state = AgentState.STOPPED;
+  stop(): Promise<Startable.State> {
+    return Startable.stop(this, async () => {
+      await this.connectionManager.stopAllEvents();
+      await this.connectionManager.stopFetchingMessages();
+      await this.pollux.stop();
+
+      if (notNil(this.pluto.stop)) {
+        await this.pluto.stop();
+      }
+    });
   }
 
   /**

diff --git a/src/edge-agent/oidc/Agent.ts b/src/edge-agent/oidc/Agent.ts
@@ -12,7 +12,8 @@ import { Task } from "../../utils/tasks";
 import * as DIDfns from "../didFunctions";
 import * as Tasks from "./tasks";
 import * as Errors from "./errors";
-import { JsonObj, expect } from "../../utils";
+import { JsonObj, expect, notNil } from "../../utils";
+import { Startable } from "../../utils/startable";
 
 /**
  * https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html
@@ -24,20 +25,12 @@ class Connection {
     public readonly issuerMeta: OIDC.IssuerMetadata,
     public readonly scopes: string[],
     public readonly tokenResponse: TokenResponse,
-  ) { }
+  ) {}
 }
 
-// TODO make startable interface
-enum AgentState {
-  STOPPED = "stopped",
-  STARTING = "starting",
-  RUNNING = "running",
-  STOPPING = "stopping",
-}
-
-export class OIDCAgent {
+export class OIDCAgent implements Startable.Controller {
   private connections: Connection[] = [];
-  public state = AgentState.STOPPED;
+  public state = Startable.State.STOPPED;
   public readonly pollux: Pollux;
 
   constructor(
@@ -81,18 +74,21 @@ export class OIDCAgent {
     return agent;
   }
 
-  async start() {
-    if (this.state === AgentState.STOPPED) {
-      this.state = AgentState.STARTING;
+  start(): Promise<Startable.State> {
+    return Startable.start(this, async () => {
       await this.pluto.start();
       await this.pollux.start();
-      this.state = AgentState.RUNNING;
-    }
-    return this.state;
+    });
   }
 
-  async stop(): Promise<void> {
-    this.state = AgentState.STOPPED
+  async stop(): Promise<Startable.State> {
+    return Startable.stop(this, async () => {
+      await this.pollux.stop();
+
+      if (notNil(this.pluto.stop)) {
+        await this.pluto.stop();
+      }
+    });
   }
 
   private runTask<T>(task: Task<T>): Promise<T> {