@metamask/snaps-controllers 0.38.3-flask.1 → 0.39.0-flask.1

package/CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.39.0-flask.1]
+### Added
+- Add `onNameLookup` export ([#1394](https://github.com/MetaMask/snaps/pull/1394))
+
+### Changed
+- Remove `pump` ([#1730](https://github.com/MetaMask/snaps/pull/1730))
+- Bump `metamask/utils` and `metamask/snaps-registry` ([#1738](https://github.com/MetaMask/snaps/pull/1738))
+
+### Fixed
+- Fix cronjob running on disabled snaps ([#1743](https://github.com/MetaMask/snaps/pull/1743))
+
 ## [0.38.3-flask.1]
 ### Changed
 - Bump `@metamask/post-message-stream` from 6.1.2 to 7.0.0 ([#1707](https://github.com/MetaMask/snaps/pull/1707), [#1724](https://github.com/MetaMask/snaps/pull/1724))
@@ -36,7 +47,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@0.38.3-flask.1...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@0.39.0-flask.1...HEAD
+[0.39.0-flask.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@0.38.3-flask.1...@metamask/snaps-controllers@0.39.0-flask.1
 [0.38.3-flask.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@0.38.2-flask.1...@metamask/snaps-controllers@0.38.3-flask.1
 [0.38.2-flask.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@0.38.1-flask.1...@metamask/snaps-controllers@0.38.2-flask.1
 [0.38.1-flask.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@0.38.0-flask.1...@metamask/snaps-controllers@0.38.1-flask.1

package/dist/cjs/cronjob/CronjobController.js

@@ -211,25 +211,27 @@ class CronjobController extends _basecontroller.BaseControllerV2 {
    * Run controller teardown process and unsubscribe from Snap events.
    */ destroy() {
         super.destroy();
-        /* eslint-disable @typescript-eslint/unbound-method */ this.messagingSystem.unsubscribe('SnapController:snapInstalled', this._handleEventSnapInstalled);
-        this.messagingSystem.unsubscribe('SnapController:snapRemoved', this._handleEventSnapRemoved);
+        /* eslint-disable @typescript-eslint/unbound-method */ this.messagingSystem.unsubscribe('SnapController:snapInstalled', this._handleSnapRegisterEvent);
+        this.messagingSystem.unsubscribe('SnapController:snapRemoved', this._handleSnapUnregisterEvent);
+        this.messagingSystem.unsubscribe('SnapController:snapEnabled', this._handleSnapRegisterEvent);
+        this.messagingSystem.unsubscribe('SnapController:snapDisabled', this._handleSnapUnregisterEvent);
         this.messagingSystem.unsubscribe('SnapController:snapUpdated', this._handleEventSnapUpdated);
         /* eslint-enable @typescript-eslint/unbound-method */ _class_private_field_get(this, _snapIds).forEach((snapId)=>{
             this.unregister(snapId);
         });
     }
     /**
-   * Handle cron jobs on 'snapInstalled' event.
+   * Handle events that should cause cronjobs to be registered.
    *
    * @param snap - Basic Snap information.
-   */ _handleEventSnapInstalled(snap) {
+   */ _handleSnapRegisterEvent(snap) {
         this.register(snap.id);
     }
     /**
-   * Handle cron jobs on 'snapRemoved' event.
+   * Handle events that should cause cronjobs to be unregistered.
    *
    * @param snap - Basic Snap information.
-   */ _handleEventSnapRemoved(snap) {
+   */ _handleSnapUnregisterEvent(snap) {
         this.unregister(snap.id);
     }
     /**
@@ -274,12 +276,14 @@ class CronjobController extends _basecontroller.BaseControllerV2 {
         _class_private_field_set(this, _timers, new Map());
         _class_private_field_set(this, _snapIds, new Map());
         _class_private_field_set(this, _messenger, messenger);
-        this._handleEventSnapInstalled = this._handleEventSnapInstalled.bind(this);
-        this._handleEventSnapRemoved = this._handleEventSnapRemoved.bind(this);
+        this._handleSnapRegisterEvent = this._handleSnapRegisterEvent.bind(this);
+        this._handleSnapUnregisterEvent = this._handleSnapUnregisterEvent.bind(this);
         this._handleEventSnapUpdated = this._handleEventSnapUpdated.bind(this);
         // Subscribe to Snap events
-        /* eslint-disable @typescript-eslint/unbound-method */ this.messagingSystem.subscribe('SnapController:snapInstalled', this._handleEventSnapInstalled);
-        this.messagingSystem.subscribe('SnapController:snapRemoved', this._handleEventSnapRemoved);
+        /* eslint-disable @typescript-eslint/unbound-method */ this.messagingSystem.subscribe('SnapController:snapInstalled', this._handleSnapRegisterEvent);
+        this.messagingSystem.subscribe('SnapController:snapRemoved', this._handleSnapUnregisterEvent);
+        this.messagingSystem.subscribe('SnapController:snapEnabled', this._handleSnapRegisterEvent);
+        this.messagingSystem.subscribe('SnapController:snapDisabled', this._handleSnapUnregisterEvent);
         this.messagingSystem.subscribe('SnapController:snapUpdated', this._handleEventSnapUpdated);
         /* eslint-enable @typescript-eslint/unbound-method */ this.dailyCheckIn().catch((error)=>{
             (0, _snapsutils.logError)(error);

package/dist/cjs/cronjob/CronjobController.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/cronjob/CronjobController.ts"],"sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseControllerV2 as BaseController } from '@metamask/base-controller';\nimport type { GetPermissions } from '@metamask/permission-controller';\nimport type {\n  SnapId,\n  ValidatedSnapId,\n  TruncatedSnap,\n  CronjobSpecification,\n} from '@metamask/snaps-utils';\nimport {\n  HandlerType,\n  parseCronExpression,\n  logError,\n} from '@metamask/snaps-utils';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport type {\n  GetAllSnaps,\n  HandleSnapRequest,\n  SnapInstalled,\n  SnapRemoved,\n  SnapUpdated,\n} from '..';\nimport { getRunnableSnaps, SnapEndowments } from '..';\nimport { getCronjobCaveatJobs } from '../snaps/endowments/cronjob';\nimport { Timer } from '../snaps/Timer';\n\nexport type CronjobControllerActions =\n  | GetAllSnaps\n  | HandleSnapRequest\n  | GetPermissions;\n\nexport type CronjobControllerEvents = SnapInstalled | SnapRemoved | SnapUpdated;\n\nexport type CronjobControllerMessenger = RestrictedControllerMessenger<\n  'CronjobController',\n  CronjobControllerActions,\n  CronjobControllerEvents,\n  CronjobControllerActions['type'],\n  CronjobControllerEvents['type']\n>;\n\nexport const DAILY_TIMEOUT = inMilliseconds(24, Duration.Hour);\n\nexport type CronjobControllerArgs = {\n  messenger: CronjobControllerMessenger;\n  /**\n   * Persisted state that will be used for rehydration.\n   */\n  state?: CronjobControllerState;\n};\n\nexport type Cronjob = {\n  timer?: Timer;\n  id: string;\n  snapId: ValidatedSnapId;\n} & CronjobSpecification;\n\nexport type StoredJobInformation = {\n  lastRun: number;\n};\n\nexport type CronjobControllerState = {\n  jobs: Record<string, StoredJobInformation>;\n};\n\nconst controllerName = 'CronjobController';\n\n/**\n * Use this controller to register and schedule periodically executed jobs\n * using RPC method hooks.\n */\nexport class CronjobController extends BaseController<\n  typeof controllerName,\n  CronjobControllerState,\n  CronjobControllerMessenger\n> {\n  #messenger: CronjobControllerMessenger;\n\n  #dailyTimer!: Timer;\n\n  #timers: Map<string, Timer>;\n\n  // Mapping from jobId to snapId\n  #snapIds: Map<string, string>;\n\n  constructor({ messenger, state }: CronjobControllerArgs) {\n    super({\n      messenger,\n      metadata: {\n        jobs: { persist: true, anonymous: false },\n      },\n      name: controllerName,\n      state: {\n        jobs: {},\n        ...state,\n      },\n    });\n    this.#timers = new Map();\n    this.#snapIds = new Map();\n    this.#messenger = messenger;\n\n    this._handleEventSnapInstalled = this._handleEventSnapInstalled.bind(this);\n    this._handleEventSnapRemoved = this._handleEventSnapRemoved.bind(this);\n    this._handleEventSnapUpdated = this._handleEventSnapUpdated.bind(this);\n\n    // Subscribe to Snap events\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.subscribe(\n      'SnapController:snapInstalled',\n      this._handleEventSnapInstalled,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapRemoved',\n      this._handleEventSnapRemoved,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.dailyCheckIn().catch((error) => {\n      logError(error);\n    });\n  }\n\n  /**\n   * Retrieve all cronjob specifications for all runnable snaps.\n   *\n   * @returns Array of Cronjob specifications.\n   */\n  private getAllJobs(): Cronjob[] {\n    const snaps = this.messagingSystem.call('SnapController:getAll');\n    const filteredSnaps = getRunnableSnaps(snaps);\n\n    const jobs = filteredSnaps.map((snap) => this.getSnapJobs(snap.id));\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n    return jobs.flat().filter((job) => job !== undefined) as Cronjob[];\n  }\n\n  /**\n   * Retrieve all Cronjob specifications for a Snap.\n   *\n   * @param snapId - ID of a Snap.\n   * @returns Array of Cronjob specifications.\n   */\n  private getSnapJobs(snapId: ValidatedSnapId): Cronjob[] | undefined {\n    const permissions = this.#messenger.call(\n      'PermissionController:getPermissions',\n      snapId,\n    );\n\n    const permission = permissions?.[SnapEndowments.Cronjob];\n    const definitions = getCronjobCaveatJobs(permission);\n\n    return definitions?.map((definition, idx) => {\n      return { ...definition, id: `${snapId}-${idx}`, snapId };\n    });\n  }\n\n  /**\n   * Register cron jobs for a given snap by getting specification from a permission caveats.\n   * Once registered, each job will be scheduled.\n   *\n   * @param snapId - ID of a snap.\n   */\n  register(snapId: ValidatedSnapId) {\n    const jobs = this.getSnapJobs(snapId);\n    jobs?.forEach((job) => this.schedule(job));\n  }\n\n  /**\n   * Schedule a new job.\n   * This will interpret the cron expression and tell the timer to execute the job\n   * at the next suitable point in time.\n   * Job last run state will be initialized afterwards.\n   *\n   * Note: Schedule will be skipped if the job's execution time is too far in the future and\n   * will be revisited on a daily check.\n   *\n   * @param job - Cronjob specification.\n   */\n  private schedule(job: Cronjob) {\n    if (this.#timers.has(job.id)) {\n      return;\n    }\n\n    const parsed = parseCronExpression(job.expression);\n    const next = parsed.next();\n    const now = new Date();\n    const ms = next.getTime() - now.getTime();\n\n    // Don't schedule this job yet as it is too far in the future\n    if (ms > DAILY_TIMEOUT) {\n      return;\n    }\n\n    const timer = new Timer(ms);\n    timer.start(() => {\n      this.executeCronjob(job).catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n\n      this.#timers.delete(job.id);\n      this.schedule(job);\n    });\n\n    this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually\n    this.#timers.set(job.id, timer);\n    this.#snapIds.set(job.id, job.snapId);\n  }\n\n  /**\n   * Execute job.\n   *\n   * @param job - Cronjob specification.\n   */\n  private async executeCronjob(job: Cronjob) {\n    this.updateJobLastRunState(job.id, Date.now());\n    await this.#messenger.call('SnapController:handleRequest', {\n      snapId: job.snapId,\n      origin: '',\n      handler: HandlerType.OnCronjob,\n      request: job.request,\n    });\n  }\n\n  /**\n   * Unregister all jobs related to the given snapId.\n   *\n   * @param snapId - ID of a snap.\n   */\n  unregister(snapId: SnapId) {\n    const jobs = [...this.#snapIds.entries()].filter(\n      ([_, jobSnapId]) => jobSnapId === snapId,\n    );\n\n    if (jobs.length) {\n      jobs.forEach(([id]) => {\n        const timer = this.#timers.get(id);\n        if (timer) {\n          timer.cancel();\n          this.#timers.delete(id);\n          this.#snapIds.delete(id);\n        }\n      });\n    }\n  }\n\n  /**\n   * Update time of a last run for the Cronjob specified by ID.\n   *\n   * @param jobId - ID of a cron job.\n   * @param lastRun - Unix timestamp when the job was last ran.\n   */\n  private updateJobLastRunState(jobId: string, lastRun: number) {\n    this.update((state) => {\n      state.jobs[jobId] = {\n        lastRun,\n      };\n    });\n  }\n\n  /**\n   * Runs every 24 hours to check if new jobs need to be scheduled.\n   *\n   * This is necesary for longer running jobs that execute with more than 24 hours between them.\n   */\n  async dailyCheckIn() {\n    const jobs = this.getAllJobs();\n\n    for (const job of jobs) {\n      const parsed = parseCronExpression(job.expression);\n      const lastRun = this.state.jobs[job.id]?.lastRun;\n      // If a job was supposed to run while we were shut down but wasn't we run it now\n      if (\n        lastRun !== undefined &&\n        parsed.hasPrev() &&\n        parsed.prev().getTime() > lastRun\n      ) {\n        await this.executeCronjob(job);\n      }\n\n      // Try scheduling, will fail if an existing scheduled job is found\n      this.schedule(job);\n    }\n\n    this.#dailyTimer = new Timer(DAILY_TIMEOUT);\n    this.#dailyTimer.start(() => {\n      this.dailyCheckIn().catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n    });\n  }\n\n  /**\n   * Run controller teardown process and unsubscribe from Snap events.\n   */\n  destroy() {\n    super.destroy();\n\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapInstalled',\n      this._handleEventSnapInstalled,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapRemoved',\n      this._handleEventSnapRemoved,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.#snapIds.forEach((snapId) => {\n      this.unregister(snapId);\n    });\n  }\n\n  /**\n   * Handle cron jobs on 'snapInstalled' event.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleEventSnapInstalled(snap: TruncatedSnap) {\n    this.register(snap.id);\n  }\n\n  /**\n   * Handle cron jobs on 'snapRemoved' event.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleEventSnapRemoved(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n  }\n\n  /**\n   * Handle cron jobs on 'snapUpdated' event.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleEventSnapUpdated(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n    this.register(snap.id);\n  }\n}\n"],"names":["DAILY_TIMEOUT","CronjobController","inMilliseconds","Duration","Hour","controllerName","BaseController","getAllJobs","snaps","messagingSystem","call","filteredSnaps","getRunnableSnaps","jobs","map","snap","getSnapJobs","id","flat","filter","job","undefined","snapId","permissions","messenger","permission","SnapEndowments","Cronjob","definitions","getCronjobCaveatJobs","definition","idx","register","forEach","schedule","timers","has","parsed","parseCronExpression","expression","next","now","Date","ms","getTime","timer","Timer","start","executeCronjob","catch","error","logError","delete","updateJobLastRunState","set","snapIds","origin","handler","HandlerType","OnCronjob","request","unregister","entries","_","jobSnapId","length","get","cancel","jobId","lastRun","update","state","dailyCheckIn","hasPrev","prev","dailyTimer","destroy","unsubscribe","_handleEventSnapInstalled","_handleEventSnapRemoved","_handleEventSnapUpdated","constructor","metadata","persist","anonymous","name","Map","bind","subscribe"],"mappings":";;;;;;;;;;;IA0CaA,aAAa;eAAbA;;IA8BAC,iBAAiB;eAAjBA;;;gCAvEsC;4BAY5C;uBACkC;kBASQ;yBACZ;uBACf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiBf,MAAMD,gBAAgBE,IAAAA,qBAAc,EAAC,IAAIC,eAAQ,CAACC,IAAI;AAwB7D,MAAMC,iBAAiB;IAWrB,0CAEA,2CAEA,uCAEA,+BAA+B;AAC/B;AAZK,MAAMJ,0BAA0BK,gCAAc;IAyDnD;;;;GAIC,GACD,AAAQC,aAAwB;QAC9B,MAAMC,QAAQ,IAAI,CAACC,eAAe,CAACC,IAAI,CAAC;QACxC,MAAMC,gBAAgBC,IAAAA,kBAAgB,EAACJ;QAEvC,MAAMK,OAAOF,cAAcG,GAAG,CAAC,CAACC,OAAS,IAAI,CAACC,WAAW,CAACD,KAAKE,EAAE;QACjE,4EAA4E;QAC5E,OAAOJ,KAAKK,IAAI,GAAGC,MAAM,CAAC,CAACC,MAAQA,QAAQC;IAC7C;IAEA;;;;;GAKC,GACD,AAAQL,YAAYM,MAAuB,EAAyB;QAClE,MAAMC,cAAc,yBAAA,IAAI,EAAEC,YAAUd,IAAI,CACtC,uCACAY;QAGF,MAAMG,aAAaF,aAAa,CAACG,gBAAc,CAACC,OAAO,CAAC;QACxD,MAAMC,cAAcC,IAAAA,6BAAoB,EAACJ;QAEzC,OAAOG,aAAad,IAAI,CAACgB,YAAYC;YACnC,OAAO;gBAAE,GAAGD,UAAU;gBAAEb,IAAI,CAAC,EAAEK,OAAO,CAAC,EAAES,IAAI,CAAC;gBAAET;YAAO;QACzD;IACF;IAEA;;;;;GAKC,GACDU,SAASV,MAAuB,EAAE;QAChC,MAAMT,OAAO,IAAI,CAACG,WAAW,CAACM;QAC9BT,MAAMoB,QAAQ,CAACb,MAAQ,IAAI,CAACc,QAAQ,CAACd;IACvC;IAEA;;;;;;;;;;GAUC,GACD,AAAQc,SAASd,GAAY,EAAE;QAC7B,IAAI,yBAAA,IAAI,EAAEe,SAAOC,GAAG,CAAChB,IAAIH,EAAE,GAAG;YAC5B;QACF;QAEA,MAAMoB,SAASC,IAAAA,+BAAmB,EAAClB,IAAImB,UAAU;QACjD,MAAMC,OAAOH,OAAOG,IAAI;QACxB,MAAMC,MAAM,IAAIC;QAChB,MAAMC,KAAKH,KAAKI,OAAO,KAAKH,IAAIG,OAAO;QAEvC,6DAA6D;QAC7D,IAAID,KAAK3C,eAAe;YACtB;QACF;QAEA,MAAM6C,QAAQ,IAAIC,YAAK,CAACH;QACxBE,MAAME,KAAK,CAAC;YACV,IAAI,CAACC,cAAc,CAAC5B,KAAK6B,KAAK,CAAC,CAACC;gBAC9B,qCAAqC;gBACrCC,IAAAA,oBAAQ,EAACD;YACX;YAEA,yBAAA,IAAI,EAAEf,SAAOiB,MAAM,CAAChC,IAAIH,EAAE;YAC1B,IAAI,CAACiB,QAAQ,CAACd;QAChB;QAEA,IAAI,CAACiC,qBAAqB,CAACjC,IAAIH,EAAE,EAAE,IAAI,iCAAiC;QACxE,yBAAA,IAAI,EAAEkB,SAAOmB,GAAG,CAAClC,IAAIH,EAAE,EAAE4B;QACzB,yBAAA,IAAI,EAAEU,UAAQD,GAAG,CAAClC,IAAIH,EAAE,EAAEG,IAAIE,MAAM;IACtC;IAEA;;;;GAIC,GACD,MAAc0B,eAAe5B,GAAY,EAAE;QACzC,IAAI,CAACiC,qBAAqB,CAACjC,IAAIH,EAAE,EAAEyB,KAAKD,GAAG;QAC3C,MAAM,yBAAA,IAAI,EAAEjB,YAAUd,IAAI,CAAC,gCAAgC;YACzDY,QAAQF,IAAIE,MAAM;YAClBkC,QAAQ;YACRC,SAASC,uBAAW,CAACC,SAAS;YAC9BC,SAASxC,IAAIwC,OAAO;QACtB;IACF;IAEA;;;;GAIC,GACDC,WAAWvC,MAAc,EAAE;QACzB,MAAMT,OAAO;eAAI,yBAAA,IAAI,EAAE0C,UAAQO,OAAO;SAAG,CAAC3C,MAAM,CAC9C,CAAC,CAAC4C,GAAGC,UAAU,GAAKA,cAAc1C;QAGpC,IAAIT,KAAKoD,MAAM,EAAE;YACfpD,KAAKoB,OAAO,CAAC,CAAC,CAAChB,GAAG;gBAChB,MAAM4B,QAAQ,yBAAA,IAAI,EAAEV,SAAO+B,GAAG,CAACjD;gBAC/B,IAAI4B,OAAO;oBACTA,MAAMsB,MAAM;oBACZ,yBAAA,IAAI,EAAEhC,SAAOiB,MAAM,CAACnC;oBACpB,yBAAA,IAAI,EAAEsC,UAAQH,MAAM,CAACnC;gBACvB;YACF;QACF;IACF;IAEA;;;;;GAKC,GACD,AAAQoC,sBAAsBe,KAAa,EAAEC,OAAe,EAAE;QAC5D,IAAI,CAACC,MAAM,CAAC,CAACC;YACXA,MAAM1D,IAAI,CAACuD,MAAM,GAAG;gBAClBC;YACF;QACF;IACF;IAEA;;;;GAIC,GACD,MAAMG,eAAe;QACnB,MAAM3D,OAAO,IAAI,CAACN,UAAU;QAE5B,KAAK,MAAMa,OAAOP,KAAM;YACtB,MAAMwB,SAASC,IAAAA,+BAAmB,EAAClB,IAAImB,UAAU;YACjD,MAAM8B,UAAU,IAAI,CAACE,KAAK,CAAC1D,IAAI,CAACO,IAAIH,EAAE,CAAC,EAAEoD;YACzC,gFAAgF;YAChF,IACEA,YAAYhD,aACZgB,OAAOoC,OAAO,MACdpC,OAAOqC,IAAI,GAAG9B,OAAO,KAAKyB,SAC1B;gBACA,MAAM,IAAI,CAACrB,cAAc,CAAC5B;YAC5B;YAEA,kEAAkE;YAClE,IAAI,CAACc,QAAQ,CAACd;QAChB;uCAEMuD,aAAa,IAAI7B,YAAK,CAAC9C;QAC7B,yBAAA,IAAI,EAAE2E,aAAW5B,KAAK,CAAC;YACrB,IAAI,CAACyB,YAAY,GAAGvB,KAAK,CAAC,CAACC;gBACzB,qCAAqC;gBACrCC,IAAAA,oBAAQ,EAACD;YACX;QACF;IACF;IAEA;;GAEC,GACD0B,UAAU;QACR,KAAK,CAACA;QAEN,oDAAoD,GACpD,IAAI,CAACnE,eAAe,CAACoE,WAAW,CAC9B,gCACA,IAAI,CAACC,yBAAyB;QAGhC,IAAI,CAACrE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACE,uBAAuB;QAG9B,IAAI,CAACtE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACG,uBAAuB;QAE9B,mDAAmD,GAEnD,yBAAA,IAAI,EAAEzB,UAAQtB,OAAO,CAAC,CAACX;YACrB,IAAI,CAACuC,UAAU,CAACvC;QAClB;IACF;IAEA;;;;GAIC,GACD,AAAQwD,0BAA0B/D,IAAmB,EAAE;QACrD,IAAI,CAACiB,QAAQ,CAACjB,KAAKE,EAAE;IACvB;IAEA;;;;GAIC,GACD,AAAQ8D,wBAAwBhE,IAAmB,EAAE;QACnD,IAAI,CAAC8C,UAAU,CAAC9C,KAAKE,EAAE;IACzB;IAEA;;;;GAIC,GACD,AAAQ+D,wBAAwBjE,IAAmB,EAAE;QACnD,IAAI,CAAC8C,UAAU,CAAC9C,KAAKE,EAAE;QACvB,IAAI,CAACe,QAAQ,CAACjB,KAAKE,EAAE;IACvB;IA5QAgE,YAAY,EAAEzD,SAAS,EAAE+C,KAAK,EAAyB,CAAE;QACvD,KAAK,CAAC;YACJ/C;YACA0D,UAAU;gBACRrE,MAAM;oBAAEsE,SAAS;oBAAMC,WAAW;gBAAM;YAC1C;YACAC,MAAMhF;YACNkE,OAAO;gBACL1D,MAAM,CAAC;gBACP,GAAG0D,KAAK;YACV;QACF;QApBF,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAGA,gCAAA;;mBAAA,KAAA;;uCAcQpC,SAAS,IAAImD;uCACb/B,UAAU,IAAI+B;uCACd9D,YAAYA;QAElB,IAAI,CAACsD,yBAAyB,GAAG,IAAI,CAACA,yBAAyB,CAACS,IAAI,CAAC,IAAI;QACzE,IAAI,CAACR,uBAAuB,GAAG,IAAI,CAACA,uBAAuB,CAACQ,IAAI,CAAC,IAAI;QACrE,IAAI,CAACP,uBAAuB,GAAG,IAAI,CAACA,uBAAuB,CAACO,IAAI,CAAC,IAAI;QAErE,2BAA2B;QAC3B,oDAAoD,GACpD,IAAI,CAAC9E,eAAe,CAAC+E,SAAS,CAC5B,gCACA,IAAI,CAACV,yBAAyB;QAGhC,IAAI,CAACrE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACT,uBAAuB;QAG9B,IAAI,CAACtE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACR,uBAAuB;QAE9B,mDAAmD,GAEnD,IAAI,CAACR,YAAY,GAAGvB,KAAK,CAAC,CAACC;YACzBC,IAAAA,oBAAQ,EAACD;QACX;IACF;AAoOF"}
+{"version":3,"sources":["../../../src/cronjob/CronjobController.ts"],"sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseControllerV2 as BaseController } from '@metamask/base-controller';\nimport type { GetPermissions } from '@metamask/permission-controller';\nimport type {\n  SnapId,\n  ValidatedSnapId,\n  TruncatedSnap,\n  CronjobSpecification,\n} from '@metamask/snaps-utils';\nimport {\n  HandlerType,\n  parseCronExpression,\n  logError,\n} from '@metamask/snaps-utils';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport type {\n  GetAllSnaps,\n  HandleSnapRequest,\n  SnapDisabled,\n  SnapEnabled,\n  SnapInstalled,\n  SnapRemoved,\n  SnapUpdated,\n} from '..';\nimport { getRunnableSnaps, SnapEndowments } from '..';\nimport { getCronjobCaveatJobs } from '../snaps/endowments/cronjob';\nimport { Timer } from '../snaps/Timer';\n\nexport type CronjobControllerActions =\n  | GetAllSnaps\n  | HandleSnapRequest\n  | GetPermissions;\n\nexport type CronjobControllerEvents =\n  | SnapInstalled\n  | SnapRemoved\n  | SnapUpdated\n  | SnapEnabled\n  | SnapDisabled;\n\nexport type CronjobControllerMessenger = RestrictedControllerMessenger<\n  'CronjobController',\n  CronjobControllerActions,\n  CronjobControllerEvents,\n  CronjobControllerActions['type'],\n  CronjobControllerEvents['type']\n>;\n\nexport const DAILY_TIMEOUT = inMilliseconds(24, Duration.Hour);\n\nexport type CronjobControllerArgs = {\n  messenger: CronjobControllerMessenger;\n  /**\n   * Persisted state that will be used for rehydration.\n   */\n  state?: CronjobControllerState;\n};\n\nexport type Cronjob = {\n  timer?: Timer;\n  id: string;\n  snapId: ValidatedSnapId;\n} & CronjobSpecification;\n\nexport type StoredJobInformation = {\n  lastRun: number;\n};\n\nexport type CronjobControllerState = {\n  jobs: Record<string, StoredJobInformation>;\n};\n\nconst controllerName = 'CronjobController';\n\n/**\n * Use this controller to register and schedule periodically executed jobs\n * using RPC method hooks.\n */\nexport class CronjobController extends BaseController<\n  typeof controllerName,\n  CronjobControllerState,\n  CronjobControllerMessenger\n> {\n  #messenger: CronjobControllerMessenger;\n\n  #dailyTimer!: Timer;\n\n  #timers: Map<string, Timer>;\n\n  // Mapping from jobId to snapId\n  #snapIds: Map<string, string>;\n\n  constructor({ messenger, state }: CronjobControllerArgs) {\n    super({\n      messenger,\n      metadata: {\n        jobs: { persist: true, anonymous: false },\n      },\n      name: controllerName,\n      state: {\n        jobs: {},\n        ...state,\n      },\n    });\n    this.#timers = new Map();\n    this.#snapIds = new Map();\n    this.#messenger = messenger;\n\n    this._handleSnapRegisterEvent = this._handleSnapRegisterEvent.bind(this);\n    this._handleSnapUnregisterEvent =\n      this._handleSnapUnregisterEvent.bind(this);\n    this._handleEventSnapUpdated = this._handleEventSnapUpdated.bind(this);\n\n    // Subscribe to Snap events\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.subscribe(\n      'SnapController:snapInstalled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapRemoved',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapEnabled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapDisabled',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.dailyCheckIn().catch((error) => {\n      logError(error);\n    });\n  }\n\n  /**\n   * Retrieve all cronjob specifications for all runnable snaps.\n   *\n   * @returns Array of Cronjob specifications.\n   */\n  private getAllJobs(): Cronjob[] {\n    const snaps = this.messagingSystem.call('SnapController:getAll');\n    const filteredSnaps = getRunnableSnaps(snaps);\n\n    const jobs = filteredSnaps.map((snap) => this.getSnapJobs(snap.id));\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n    return jobs.flat().filter((job) => job !== undefined) as Cronjob[];\n  }\n\n  /**\n   * Retrieve all Cronjob specifications for a Snap.\n   *\n   * @param snapId - ID of a Snap.\n   * @returns Array of Cronjob specifications.\n   */\n  private getSnapJobs(snapId: ValidatedSnapId): Cronjob[] | undefined {\n    const permissions = this.#messenger.call(\n      'PermissionController:getPermissions',\n      snapId,\n    );\n\n    const permission = permissions?.[SnapEndowments.Cronjob];\n    const definitions = getCronjobCaveatJobs(permission);\n\n    return definitions?.map((definition, idx) => {\n      return { ...definition, id: `${snapId}-${idx}`, snapId };\n    });\n  }\n\n  /**\n   * Register cron jobs for a given snap by getting specification from a permission caveats.\n   * Once registered, each job will be scheduled.\n   *\n   * @param snapId - ID of a snap.\n   */\n  register(snapId: ValidatedSnapId) {\n    const jobs = this.getSnapJobs(snapId);\n    jobs?.forEach((job) => this.schedule(job));\n  }\n\n  /**\n   * Schedule a new job.\n   * This will interpret the cron expression and tell the timer to execute the job\n   * at the next suitable point in time.\n   * Job last run state will be initialized afterwards.\n   *\n   * Note: Schedule will be skipped if the job's execution time is too far in the future and\n   * will be revisited on a daily check.\n   *\n   * @param job - Cronjob specification.\n   */\n  private schedule(job: Cronjob) {\n    if (this.#timers.has(job.id)) {\n      return;\n    }\n\n    const parsed = parseCronExpression(job.expression);\n    const next = parsed.next();\n    const now = new Date();\n    const ms = next.getTime() - now.getTime();\n\n    // Don't schedule this job yet as it is too far in the future\n    if (ms > DAILY_TIMEOUT) {\n      return;\n    }\n\n    const timer = new Timer(ms);\n    timer.start(() => {\n      this.executeCronjob(job).catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n\n      this.#timers.delete(job.id);\n      this.schedule(job);\n    });\n\n    this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually\n    this.#timers.set(job.id, timer);\n    this.#snapIds.set(job.id, job.snapId);\n  }\n\n  /**\n   * Execute job.\n   *\n   * @param job - Cronjob specification.\n   */\n  private async executeCronjob(job: Cronjob) {\n    this.updateJobLastRunState(job.id, Date.now());\n    await this.#messenger.call('SnapController:handleRequest', {\n      snapId: job.snapId,\n      origin: '',\n      handler: HandlerType.OnCronjob,\n      request: job.request,\n    });\n  }\n\n  /**\n   * Unregister all jobs related to the given snapId.\n   *\n   * @param snapId - ID of a snap.\n   */\n  unregister(snapId: SnapId) {\n    const jobs = [...this.#snapIds.entries()].filter(\n      ([_, jobSnapId]) => jobSnapId === snapId,\n    );\n\n    if (jobs.length) {\n      jobs.forEach(([id]) => {\n        const timer = this.#timers.get(id);\n        if (timer) {\n          timer.cancel();\n          this.#timers.delete(id);\n          this.#snapIds.delete(id);\n        }\n      });\n    }\n  }\n\n  /**\n   * Update time of a last run for the Cronjob specified by ID.\n   *\n   * @param jobId - ID of a cron job.\n   * @param lastRun - Unix timestamp when the job was last ran.\n   */\n  private updateJobLastRunState(jobId: string, lastRun: number) {\n    this.update((state) => {\n      state.jobs[jobId] = {\n        lastRun,\n      };\n    });\n  }\n\n  /**\n   * Runs every 24 hours to check if new jobs need to be scheduled.\n   *\n   * This is necesary for longer running jobs that execute with more than 24 hours between them.\n   */\n  async dailyCheckIn() {\n    const jobs = this.getAllJobs();\n\n    for (const job of jobs) {\n      const parsed = parseCronExpression(job.expression);\n      const lastRun = this.state.jobs[job.id]?.lastRun;\n      // If a job was supposed to run while we were shut down but wasn't we run it now\n      if (\n        lastRun !== undefined &&\n        parsed.hasPrev() &&\n        parsed.prev().getTime() > lastRun\n      ) {\n        await this.executeCronjob(job);\n      }\n\n      // Try scheduling, will fail if an existing scheduled job is found\n      this.schedule(job);\n    }\n\n    this.#dailyTimer = new Timer(DAILY_TIMEOUT);\n    this.#dailyTimer.start(() => {\n      this.dailyCheckIn().catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n    });\n  }\n\n  /**\n   * Run controller teardown process and unsubscribe from Snap events.\n   */\n  destroy() {\n    super.destroy();\n\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapInstalled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapRemoved',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapEnabled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapDisabled',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.#snapIds.forEach((snapId) => {\n      this.unregister(snapId);\n    });\n  }\n\n  /**\n   * Handle events that should cause cronjobs to be registered.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleSnapRegisterEvent(snap: TruncatedSnap) {\n    this.register(snap.id);\n  }\n\n  /**\n   * Handle events that should cause cronjobs to be unregistered.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleSnapUnregisterEvent(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n  }\n\n  /**\n   * Handle cron jobs on 'snapUpdated' event.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleEventSnapUpdated(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n    this.register(snap.id);\n  }\n}\n"],"names":["DAILY_TIMEOUT","CronjobController","inMilliseconds","Duration","Hour","controllerName","BaseController","getAllJobs","snaps","messagingSystem","call","filteredSnaps","getRunnableSnaps","jobs","map","snap","getSnapJobs","id","flat","filter","job","undefined","snapId","permissions","messenger","permission","SnapEndowments","Cronjob","definitions","getCronjobCaveatJobs","definition","idx","register","forEach","schedule","timers","has","parsed","parseCronExpression","expression","next","now","Date","ms","getTime","timer","Timer","start","executeCronjob","catch","error","logError","delete","updateJobLastRunState","set","snapIds","origin","handler","HandlerType","OnCronjob","request","unregister","entries","_","jobSnapId","length","get","cancel","jobId","lastRun","update","state","dailyCheckIn","hasPrev","prev","dailyTimer","destroy","unsubscribe","_handleSnapRegisterEvent","_handleSnapUnregisterEvent","_handleEventSnapUpdated","constructor","metadata","persist","anonymous","name","Map","bind","subscribe"],"mappings":";;;;;;;;;;;IAiDaA,aAAa;eAAbA;;IA8BAC,iBAAiB;eAAjBA;;;gCA9EsC;4BAY5C;uBACkC;kBAWQ;yBACZ;uBACf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsBf,MAAMD,gBAAgBE,IAAAA,qBAAc,EAAC,IAAIC,eAAQ,CAACC,IAAI;AAwB7D,MAAMC,iBAAiB;IAWrB,0CAEA,2CAEA,uCAEA,+BAA+B;AAC/B;AAZK,MAAMJ,0BAA0BK,gCAAc;IAoEnD;;;;GAIC,GACD,AAAQC,aAAwB;QAC9B,MAAMC,QAAQ,IAAI,CAACC,eAAe,CAACC,IAAI,CAAC;QACxC,MAAMC,gBAAgBC,IAAAA,kBAAgB,EAACJ;QAEvC,MAAMK,OAAOF,cAAcG,GAAG,CAAC,CAACC,OAAS,IAAI,CAACC,WAAW,CAACD,KAAKE,EAAE;QACjE,4EAA4E;QAC5E,OAAOJ,KAAKK,IAAI,GAAGC,MAAM,CAAC,CAACC,MAAQA,QAAQC;IAC7C;IAEA;;;;;GAKC,GACD,AAAQL,YAAYM,MAAuB,EAAyB;QAClE,MAAMC,cAAc,yBAAA,IAAI,EAAEC,YAAUd,IAAI,CACtC,uCACAY;QAGF,MAAMG,aAAaF,aAAa,CAACG,gBAAc,CAACC,OAAO,CAAC;QACxD,MAAMC,cAAcC,IAAAA,6BAAoB,EAACJ;QAEzC,OAAOG,aAAad,IAAI,CAACgB,YAAYC;YACnC,OAAO;gBAAE,GAAGD,UAAU;gBAAEb,IAAI,CAAC,EAAEK,OAAO,CAAC,EAAES,IAAI,CAAC;gBAAET;YAAO;QACzD;IACF;IAEA;;;;;GAKC,GACDU,SAASV,MAAuB,EAAE;QAChC,MAAMT,OAAO,IAAI,CAACG,WAAW,CAACM;QAC9BT,MAAMoB,QAAQ,CAACb,MAAQ,IAAI,CAACc,QAAQ,CAACd;IACvC;IAEA;;;;;;;;;;GAUC,GACD,AAAQc,SAASd,GAAY,EAAE;QAC7B,IAAI,yBAAA,IAAI,EAAEe,SAAOC,GAAG,CAAChB,IAAIH,EAAE,GAAG;YAC5B;QACF;QAEA,MAAMoB,SAASC,IAAAA,+BAAmB,EAAClB,IAAImB,UAAU;QACjD,MAAMC,OAAOH,OAAOG,IAAI;QACxB,MAAMC,MAAM,IAAIC;QAChB,MAAMC,KAAKH,KAAKI,OAAO,KAAKH,IAAIG,OAAO;QAEvC,6DAA6D;QAC7D,IAAID,KAAK3C,eAAe;YACtB;QACF;QAEA,MAAM6C,QAAQ,IAAIC,YAAK,CAACH;QACxBE,MAAME,KAAK,CAAC;YACV,IAAI,CAACC,cAAc,CAAC5B,KAAK6B,KAAK,CAAC,CAACC;gBAC9B,qCAAqC;gBACrCC,IAAAA,oBAAQ,EAACD;YACX;YAEA,yBAAA,IAAI,EAAEf,SAAOiB,MAAM,CAAChC,IAAIH,EAAE;YAC1B,IAAI,CAACiB,QAAQ,CAACd;QAChB;QAEA,IAAI,CAACiC,qBAAqB,CAACjC,IAAIH,EAAE,EAAE,IAAI,iCAAiC;QACxE,yBAAA,IAAI,EAAEkB,SAAOmB,GAAG,CAAClC,IAAIH,EAAE,EAAE4B;QACzB,yBAAA,IAAI,EAAEU,UAAQD,GAAG,CAAClC,IAAIH,EAAE,EAAEG,IAAIE,MAAM;IACtC;IAEA;;;;GAIC,GACD,MAAc0B,eAAe5B,GAAY,EAAE;QACzC,IAAI,CAACiC,qBAAqB,CAACjC,IAAIH,EAAE,EAAEyB,KAAKD,GAAG;QAC3C,MAAM,yBAAA,IAAI,EAAEjB,YAAUd,IAAI,CAAC,gCAAgC;YACzDY,QAAQF,IAAIE,MAAM;YAClBkC,QAAQ;YACRC,SAASC,uBAAW,CAACC,SAAS;YAC9BC,SAASxC,IAAIwC,OAAO;QACtB;IACF;IAEA;;;;GAIC,GACDC,WAAWvC,MAAc,EAAE;QACzB,MAAMT,OAAO;eAAI,yBAAA,IAAI,EAAE0C,UAAQO,OAAO;SAAG,CAAC3C,MAAM,CAC9C,CAAC,CAAC4C,GAAGC,UAAU,GAAKA,cAAc1C;QAGpC,IAAIT,KAAKoD,MAAM,EAAE;YACfpD,KAAKoB,OAAO,CAAC,CAAC,CAAChB,GAAG;gBAChB,MAAM4B,QAAQ,yBAAA,IAAI,EAAEV,SAAO+B,GAAG,CAACjD;gBAC/B,IAAI4B,OAAO;oBACTA,MAAMsB,MAAM;oBACZ,yBAAA,IAAI,EAAEhC,SAAOiB,MAAM,CAACnC;oBACpB,yBAAA,IAAI,EAAEsC,UAAQH,MAAM,CAACnC;gBACvB;YACF;QACF;IACF;IAEA;;;;;GAKC,GACD,AAAQoC,sBAAsBe,KAAa,EAAEC,OAAe,EAAE;QAC5D,IAAI,CAACC,MAAM,CAAC,CAACC;YACXA,MAAM1D,IAAI,CAACuD,MAAM,GAAG;gBAClBC;YACF;QACF;IACF;IAEA;;;;GAIC,GACD,MAAMG,eAAe;QACnB,MAAM3D,OAAO,IAAI,CAACN,UAAU;QAE5B,KAAK,MAAMa,OAAOP,KAAM;YACtB,MAAMwB,SAASC,IAAAA,+BAAmB,EAAClB,IAAImB,UAAU;YACjD,MAAM8B,UAAU,IAAI,CAACE,KAAK,CAAC1D,IAAI,CAACO,IAAIH,EAAE,CAAC,EAAEoD;YACzC,gFAAgF;YAChF,IACEA,YAAYhD,aACZgB,OAAOoC,OAAO,MACdpC,OAAOqC,IAAI,GAAG9B,OAAO,KAAKyB,SAC1B;gBACA,MAAM,IAAI,CAACrB,cAAc,CAAC5B;YAC5B;YAEA,kEAAkE;YAClE,IAAI,CAACc,QAAQ,CAACd;QAChB;uCAEMuD,aAAa,IAAI7B,YAAK,CAAC9C;QAC7B,yBAAA,IAAI,EAAE2E,aAAW5B,KAAK,CAAC;YACrB,IAAI,CAACyB,YAAY,GAAGvB,KAAK,CAAC,CAACC;gBACzB,qCAAqC;gBACrCC,IAAAA,oBAAQ,EAACD;YACX;QACF;IACF;IAEA;;GAEC,GACD0B,UAAU;QACR,KAAK,CAACA;QAEN,oDAAoD,GACpD,IAAI,CAACnE,eAAe,CAACoE,WAAW,CAC9B,gCACA,IAAI,CAACC,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACE,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACC,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAACoE,WAAW,CAC9B,+BACA,IAAI,CAACE,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACG,uBAAuB;QAE9B,mDAAmD,GAEnD,yBAAA,IAAI,EAAEzB,UAAQtB,OAAO,CAAC,CAACX;YACrB,IAAI,CAACuC,UAAU,CAACvC;QAClB;IACF;IAEA;;;;GAIC,GACD,AAAQwD,yBAAyB/D,IAAmB,EAAE;QACpD,IAAI,CAACiB,QAAQ,CAACjB,KAAKE,EAAE;IACvB;IAEA;;;;GAIC,GACD,AAAQ8D,2BAA2BhE,IAAmB,EAAE;QACtD,IAAI,CAAC8C,UAAU,CAAC9C,KAAKE,EAAE;IACzB;IAEA;;;;GAIC,GACD,AAAQ+D,wBAAwBjE,IAAmB,EAAE;QACnD,IAAI,CAAC8C,UAAU,CAAC9C,KAAKE,EAAE;QACvB,IAAI,CAACe,QAAQ,CAACjB,KAAKE,EAAE;IACvB;IAjSAgE,YAAY,EAAEzD,SAAS,EAAE+C,KAAK,EAAyB,CAAE;QACvD,KAAK,CAAC;YACJ/C;YACA0D,UAAU;gBACRrE,MAAM;oBAAEsE,SAAS;oBAAMC,WAAW;gBAAM;YAC1C;YACAC,MAAMhF;YACNkE,OAAO;gBACL1D,MAAM,CAAC;gBACP,GAAG0D,KAAK;YACV;QACF;QApBF,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAGA,gCAAA;;mBAAA,KAAA;;uCAcQpC,SAAS,IAAImD;uCACb/B,UAAU,IAAI+B;uCACd9D,YAAYA;QAElB,IAAI,CAACsD,wBAAwB,GAAG,IAAI,CAACA,wBAAwB,CAACS,IAAI,CAAC,IAAI;QACvE,IAAI,CAACR,0BAA0B,GAC7B,IAAI,CAACA,0BAA0B,CAACQ,IAAI,CAAC,IAAI;QAC3C,IAAI,CAACP,uBAAuB,GAAG,IAAI,CAACA,uBAAuB,CAACO,IAAI,CAAC,IAAI;QAErE,2BAA2B;QAC3B,oDAAoD,GACpD,IAAI,CAAC9E,eAAe,CAAC+E,SAAS,CAC5B,gCACA,IAAI,CAACV,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACT,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACV,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAAC+E,SAAS,CAC5B,+BACA,IAAI,CAACT,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACR,uBAAuB;QAE9B,mDAAmD,GAEnD,IAAI,CAACR,YAAY,GAAGvB,KAAK,CAAC,CAACC;YACzBC,IAAAA,oBAAQ,EAACD;QACX;IACF;AA8OF"}

package/dist/cjs/services/AbstractExecutionService.js

@@ -22,7 +22,7 @@ const _utils = require("@metamask/utils");
 const _jsonrpcengine = require("json-rpc-engine");
 const _jsonrpcmiddlewarestream = require("json-rpc-middleware-stream");
 const _nanoid = require("nanoid");
-const _pump = /*#__PURE__*/ _interop_require_default(require("pump"));
+const _stream = require("stream");
 const _logging = require("../logging");
 const _utils1 = require("../utils");
 function _check_private_redeclaration(obj, privateCollection) {
@@ -156,7 +156,11 @@ class AbstractExecutionService {
         const { streams, worker } = await this.initStreams(jobId);
         const rpcEngine = new _jsonrpcengine.JsonRpcEngine();
         const jsonRpcConnection = (0, _jsonrpcmiddlewarestream.createStreamMiddleware)();
-        (0, _pump.default)(jsonRpcConnection.stream, streams.command, jsonRpcConnection.stream);
+        (0, _stream.pipeline)(jsonRpcConnection.stream, streams.command, jsonRpcConnection.stream, (error)=>{
+            if (error) {
+                (0, _snapsutils.logError)(`Command stream failure.`, error);
+            }
+        });
         rpcEngine.push(jsonRpcConnection.middleware);
         const envMetadata = {
             id: jobId,
@@ -374,7 +378,7 @@ function removeSnapAndJobMapping(jobId) {
 }
 function setupMultiplex(connectionStream, streamName) {
     const mux = new _objectmultiplex.default();
-    (0, _pump.default)(connectionStream, // Typecast: stream type mismatch
+    (0, _stream.pipeline)(connectionStream, // Typecast: stream type mismatch
     mux, connectionStream, (error)=>{
         if (error) {
             streamName ? (0, _snapsutils.logError)(`"${streamName}" stream failure.`, error) : (0, _snapsutils.logError)(error);

package/dist/cjs/services/AbstractExecutionService.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/AbstractExecutionService.ts"],"sourcesContent":["import ObjectMultiplex from '@metamask/object-multiplex';\nimport type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport type { SnapRpcHook, SnapRpcHookArgs } from '@metamask/snaps-utils';\nimport { SNAP_STREAM_NAMES, logError } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcNotification } from '@metamask/utils';\nimport { Duration, isJsonRpcNotification, isObject } from '@metamask/utils';\nimport type {\n  // TODO: Replace with @metamask/utils version after bumping json-rpc-engine\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from 'json-rpc-engine';\nimport { JsonRpcEngine } from 'json-rpc-engine';\nimport { createStreamMiddleware } from 'json-rpc-middleware-stream';\nimport { nanoid } from 'nanoid';\nimport pump from 'pump';\nimport type { Duplex } from 'stream';\n\nimport { log } from '../logging';\nimport { hasTimedOut, withTimeout } from '../utils';\nimport type {\n  ExecutionService,\n  ExecutionServiceMessenger,\n  SnapErrorJson,\n  SnapExecutionData,\n} from './ExecutionService';\n\nconst controllerName = 'ExecutionService';\n\nexport type SetupSnapProvider = (snapId: string, stream: Duplex) => void;\n\nexport type ExecutionServiceArgs = {\n  setupSnapProvider: SetupSnapProvider;\n  messenger: ExecutionServiceMessenger;\n  terminationTimeout?: number;\n};\n\nexport type JobStreams = {\n  command: Duplex;\n  rpc: Duplex;\n  _connection: BasePostMessageStream;\n};\n\nexport type Job<WorkerType> = {\n  id: string;\n  streams: JobStreams;\n  rpcEngine: JsonRpcEngine;\n  worker: WorkerType;\n};\n\nexport abstract class AbstractExecutionService<WorkerType>\n  implements ExecutionService\n{\n  #snapRpcHooks: Map<string, SnapRpcHook>;\n\n  // Cannot be hash private yet because of tests.\n  protected jobs: Map<string, Job<WorkerType>>;\n\n  // Cannot be hash private yet because of tests.\n  private readonly setupSnapProvider: SetupSnapProvider;\n\n  #snapToJobMap: Map<string, string>;\n\n  #jobToSnapMap: Map<string, string>;\n\n  #messenger: ExecutionServiceMessenger;\n\n  #terminationTimeout: number;\n\n  constructor({\n    setupSnapProvider,\n    messenger,\n    terminationTimeout = Duration.Second,\n  }: ExecutionServiceArgs) {\n    this.#snapRpcHooks = new Map();\n    this.jobs = new Map();\n    this.setupSnapProvider = setupSnapProvider;\n    this.#snapToJobMap = new Map();\n    this.#jobToSnapMap = new Map();\n    this.#messenger = messenger;\n    this.#terminationTimeout = terminationTimeout;\n\n    this.registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering the controller's messaging system\n   * actions.\n   */\n  private registerMessageHandlers(): void {\n    this.#messenger.registerActionHandler(\n      `${controllerName}:handleRpcRequest`,\n      async (snapId: string, options: SnapRpcHookArgs) =>\n        this.handleRpcRequest(snapId, options),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:executeSnap`,\n      async (snapData: SnapExecutionData) => this.executeSnap(snapData),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateSnap`,\n      async (snapId: string) => this.terminateSnap(snapId),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateAllSnaps`,\n      async () => this.terminateAllSnaps(),\n    );\n  }\n\n  /**\n   * Performs additional necessary work during job termination. **MUST** be\n   * implemented by concrete implementations. See\n   * {@link AbstractExecutionService.terminate} for details.\n   *\n   * @param job - The object corresponding to the job to be terminated.\n   */\n  protected abstract terminateJob(job: Job<WorkerType>): void;\n\n  /**\n   * Terminates the job with the specified ID and deletes all its associated\n   * data. Any subsequent messages targeting the job will fail with an error.\n   * Throws an error if the specified job does not exist, or if termination\n   * fails unexpectedly.\n   *\n   * @param jobId - The id of the job to be terminated.\n   */\n  public async terminate(jobId: string): Promise<void> {\n    const jobWrapper = this.jobs.get(jobId);\n    if (!jobWrapper) {\n      throw new Error(`Job with id \"${jobId}\" not found.`);\n    }\n\n    // Ping worker and tell it to run teardown, continue with termination if it takes too long\n    const result = await withTimeout(\n      this.command(jobId, {\n        jsonrpc: '2.0',\n        method: 'terminate',\n        params: [],\n        id: nanoid(),\n      }),\n      this.#terminationTimeout,\n    );\n\n    if (result === hasTimedOut || result !== 'OK') {\n      // We tried to shutdown gracefully but failed. This probably means the Snap is in infinite loop and\n      // hogging down the whole JS process.\n      // TODO(ritave): It might be doing weird things such as posting a lot of setTimeouts. Add a test to ensure that this behaviour\n      //               doesn't leak into other workers. Especially important in IframeExecutionEnvironment since they all share the same\n      //               JS process.\n      logError(`Job \"${jobId}\" failed to terminate gracefully.`, result);\n    }\n\n    Object.values(jobWrapper.streams).forEach((stream) => {\n      try {\n        !stream.destroyed && stream.destroy();\n        stream.removeAllListeners();\n      } catch (error) {\n        logError('Error while destroying stream', error);\n      }\n    });\n\n    this.terminateJob(jobWrapper);\n\n    this.#removeSnapAndJobMapping(jobId);\n    this.jobs.delete(jobId);\n    log(`Job \"${jobId}\" terminated.`);\n  }\n\n  /**\n   * Initiates a job for a snap.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @returns Information regarding the created job.\n   */\n  protected async initJob(): Promise<Job<WorkerType>> {\n    const jobId = nanoid();\n    const { streams, worker } = await this.initStreams(jobId);\n    const rpcEngine = new JsonRpcEngine();\n\n    const jsonRpcConnection = createStreamMiddleware();\n\n    pump(jsonRpcConnection.stream, streams.command, jsonRpcConnection.stream);\n\n    rpcEngine.push(jsonRpcConnection.middleware);\n\n    const envMetadata = {\n      id: jobId,\n      streams,\n      rpcEngine,\n      worker,\n    };\n    this.jobs.set(jobId, envMetadata);\n\n    return envMetadata;\n  }\n\n  /**\n   * Sets up the streams for an initiated job.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @param jobId - The id of the job.\n   * @returns The streams to communicate with the worker and the worker itself.\n   */\n  protected async initStreams(\n    jobId: string,\n  ): Promise<{ streams: JobStreams; worker: WorkerType }> {\n    const { worker, stream: envStream } = await this.initEnvStream(jobId);\n    // Typecast justification: stream type mismatch\n    const mux = setupMultiplex(\n      envStream as unknown as Duplex,\n      `Job: \"${jobId}\"`,\n    );\n\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n\n    // Handle out-of-band errors, i.e. errors thrown from the snap outside of the req/res cycle.\n    // Also keep track of outbound request/responses\n    const notificationHandler = (\n      message:\n        | JsonRpcRequest<unknown>\n        | JsonRpcNotification<Json[] | Record<string, Json>>,\n    ) => {\n      if (!isJsonRpcNotification(message)) {\n        return;\n      }\n\n      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n      const snapId = this.#jobToSnapMap.get(jobId)!;\n      if (message.method === 'OutboundRequest') {\n        this.#messenger.publish('ExecutionService:outboundRequest', snapId);\n      } else if (message.method === 'OutboundResponse') {\n        this.#messenger.publish('ExecutionService:outboundResponse', snapId);\n      } else if (message.method === 'UnhandledError') {\n        if (isObject(message.params) && message.params.error) {\n          this.#messenger.publish(\n            'ExecutionService:unhandledError',\n            snapId,\n            message.params.error as SnapErrorJson,\n          );\n          commandStream.removeListener('data', notificationHandler);\n        } else {\n          logError(\n            new Error(\n              `Received malformed \"${message.method}\" command stream notification.`,\n            ),\n          );\n        }\n      } else {\n        logError(\n          new Error(\n            `Received unexpected command stream notification \"${message.method}\".`,\n          ),\n        );\n      }\n    };\n\n    commandStream.on('data', notificationHandler);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC);\n\n    // Typecast: stream type mismatch\n    return {\n      streams: {\n        command: commandStream as unknown as Duplex,\n        rpc: rpcStream,\n        // eslint-disable-next-line @typescript-eslint/naming-convention\n        _connection: envStream,\n      },\n      worker,\n    };\n  }\n\n  /**\n   * Abstract function implemented by implementing class that spins up a new worker for a job.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   */\n  protected abstract initEnvStream(jobId: string): Promise<{\n    worker: WorkerType;\n    stream: BasePostMessageStream;\n  }>;\n\n  /**\n   * Terminates the Snap with the specified ID. May throw an error if\n   * termination unexpectedly fails, but will not fail if no job for the snap\n   * with the specified ID is found.\n   *\n   * @param snapId - The ID of the snap to terminate.\n   */\n  async terminateSnap(snapId: string) {\n    const jobId = this.#snapToJobMap.get(snapId);\n    if (jobId) {\n      await this.terminate(jobId);\n    }\n  }\n\n  async terminateAllSnaps() {\n    await Promise.all(\n      [...this.jobs.keys()].map(async (jobId) => this.terminate(jobId)),\n    );\n    this.#snapRpcHooks.clear();\n  }\n\n  /**\n   * Gets the RPC request handler for the given snap.\n   *\n   * @param snapId - The id of the Snap whose message handler to get.\n   * @returns The RPC request handler for the snap.\n   */\n  private getRpcRequestHandler(snapId: string) {\n    return this.#snapRpcHooks.get(snapId);\n  }\n\n  /**\n   * Initializes and executes a snap, setting up the communication channels to the snap etc.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @param snapData - Data needed for Snap execution.\n   * @returns A string `OK` if execution succeeded.\n   * @throws If the execution service returns an error.\n   */\n  async executeSnap(snapData: SnapExecutionData): Promise<string> {\n    if (this.#snapToJobMap.has(snapData.snapId)) {\n      throw new Error(`Snap \"${snapData.snapId}\" is already being executed.`);\n    }\n\n    const job = await this.initJob();\n    this.#mapSnapAndJob(snapData.snapId, job.id);\n\n    // Ping the worker to ensure that it started up\n    await this.command(job.id, {\n      jsonrpc: '2.0',\n      method: 'ping',\n      id: nanoid(),\n    });\n\n    const rpcStream = job.streams.rpc as unknown as Duplex;\n\n    this.setupSnapProvider(snapData.snapId, rpcStream);\n\n    const result = await this.command(job.id, {\n      jsonrpc: '2.0',\n      method: 'executeSnap',\n      params: snapData,\n      id: nanoid(),\n    });\n    this.#createSnapHooks(snapData.snapId, job.id);\n    return result as string;\n  }\n\n  // Cannot be hash private yet because of tests.\n  private async command(\n    jobId: string,\n    message: JsonRpcRequest<unknown>,\n  ): Promise<unknown> {\n    if (typeof message !== 'object') {\n      throw new Error('Must send object.');\n    }\n\n    const job = this.jobs.get(jobId);\n    if (!job) {\n      throw new Error(`Job with id \"${jobId}\" not found.`);\n    }\n\n    log('Parent: Sending Command', message);\n    const response: PendingJsonRpcResponse<unknown> =\n      await job.rpcEngine.handle(message);\n    if (response.error) {\n      throw new Error(response.error.message);\n    }\n    return response.result;\n  }\n\n  #removeSnapHooks(snapId: string) {\n    this.#snapRpcHooks.delete(snapId);\n  }\n\n  #createSnapHooks(snapId: string, workerId: string) {\n    const rpcHook = async ({ origin, handler, request }: SnapRpcHookArgs) => {\n      return await this.command(workerId, {\n        id: nanoid(),\n        jsonrpc: '2.0',\n        method: 'snapRpc',\n        params: {\n          origin,\n          handler,\n          request,\n          target: snapId,\n        },\n      });\n    };\n\n    this.#snapRpcHooks.set(snapId, rpcHook);\n  }\n\n  #mapSnapAndJob(snapId: string, jobId: string): void {\n    this.#snapToJobMap.set(snapId, jobId);\n    this.#jobToSnapMap.set(jobId, snapId);\n  }\n\n  #removeSnapAndJobMapping(jobId: string): void {\n    const snapId = this.#jobToSnapMap.get(jobId);\n    if (!snapId) {\n      throw new Error(`job: \"${jobId}\" has no mapped snap.`);\n    }\n\n    this.#jobToSnapMap.delete(jobId);\n    this.#snapToJobMap.delete(snapId);\n    this.#removeSnapHooks(snapId);\n  }\n\n  /**\n   * Handle RPC request.\n   *\n   * @param snapId - The ID of the recipient snap.\n   * @param options - Bag of options to pass to the RPC handler.\n   * @returns Promise that can handle the request.\n   */\n  public async handleRpcRequest(\n    snapId: string,\n    options: SnapRpcHookArgs,\n  ): Promise<unknown> {\n    const rpcRequestHandler = await this.getRpcRequestHandler(snapId);\n\n    if (!rpcRequestHandler) {\n      throw new Error(\n        `Snap execution service returned no RPC handler for running snap \"${snapId}\".`,\n      );\n    }\n\n    return rpcRequestHandler(options);\n  }\n}\n\n/**\n * Sets up stream multiplexing for the given stream.\n *\n * @param connectionStream - The stream to mux.\n * @param streamName - The name of the stream, for identification in errors.\n * @returns The multiplexed stream.\n */\nexport function setupMultiplex(\n  connectionStream: Duplex,\n  streamName: string,\n): ObjectMultiplex {\n  const mux = new ObjectMultiplex();\n  pump(\n    connectionStream,\n    // Typecast: stream type mismatch\n    mux as unknown as Duplex,\n    connectionStream,\n    (error) => {\n      if (error) {\n        streamName\n          ? logError(`\"${streamName}\" stream failure.`, error)\n          : logError(error);\n      }\n    },\n  );\n  return mux;\n}\n"],"names":["AbstractExecutionService","setupMultiplex","controllerName","registerMessageHandlers","messenger","registerActionHandler","snapId","options","handleRpcRequest","snapData","executeSnap","terminateSnap","terminateAllSnaps","terminate","jobId","jobWrapper","jobs","get","Error","result","withTimeout","command","jsonrpc","method","params","id","nanoid","terminationTimeout","hasTimedOut","logError","Object","values","streams","forEach","stream","destroyed","destroy","removeAllListeners","error","terminateJob","removeSnapAndJobMapping","delete","log","initJob","worker","initStreams","rpcEngine","JsonRpcEngine","jsonRpcConnection","createStreamMiddleware","pump","push","middleware","envMetadata","set","envStream","initEnvStream","mux","commandStream","createStream","SNAP_STREAM_NAMES","COMMAND","notificationHandler","message","isJsonRpcNotification","jobToSnapMap","publish","isObject","removeListener","on","rpcStream","JSON_RPC","rpc","_connection","snapToJobMap","Promise","all","keys","map","snapRpcHooks","clear","getRpcRequestHandler","has","job","mapSnapAndJob","setupSnapProvider","createSnapHooks","response","handle","rpcRequestHandler","constructor","Duration","Second","Map","workerId","rpcHook","origin","handler","request","target","removeSnapHooks","connectionStream","streamName","ObjectMultiplex"],"mappings":";;;;;;;;;;;IAiDsBA,wBAAwB;eAAxBA;;IA4YNC,cAAc;eAAdA;;;wEA7bY;4BAGgB;uBAEc;+BAM5B;yCACS;wBAChB;6DACN;yBAGG;wBACqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQzC,MAAMC,iBAAiB;IA0BrB,6CAQA,6CAEA,6CAEA,0CAEA,mDAuTA,gDAIA,gDAkBA,8CAKA;AAnWK,MAAeF;IAmCpB;;;GAGC,GACD,AAAQG,0BAAgC;QACtC,yBAAA,IAAI,EAAEC,YAAUC,qBAAqB,CACnC,CAAC,EAAEH,eAAe,iBAAiB,CAAC,EACpC,OAAOI,QAAgBC,UACrB,IAAI,CAACC,gBAAgB,CAACF,QAAQC;QAGlC,yBAAA,IAAI,EAAEH,YAAUC,qBAAqB,CACnC,CAAC,EAAEH,eAAe,YAAY,CAAC,EAC/B,OAAOO,WAAgC,IAAI,CAACC,WAAW,CAACD;QAG1D,yBAAA,IAAI,EAAEL,YAAUC,qBAAqB,CACnC,CAAC,EAAEH,eAAe,cAAc,CAAC,EACjC,OAAOI,SAAmB,IAAI,CAACK,aAAa,CAACL;QAG/C,yBAAA,IAAI,EAAEF,YAAUC,qBAAqB,CACnC,CAAC,EAAEH,eAAe,kBAAkB,CAAC,EACrC,UAAY,IAAI,CAACU,iBAAiB;IAEtC;IAWA;;;;;;;GAOC,GACD,MAAaC,UAAUC,KAAa,EAAiB;QACnD,MAAMC,aAAa,IAAI,CAACC,IAAI,CAACC,GAAG,CAACH;QACjC,IAAI,CAACC,YAAY;YACf,MAAM,IAAIG,MAAM,CAAC,aAAa,EAAEJ,MAAM,YAAY,CAAC;QACrD;QAEA,0FAA0F;QAC1F,MAAMK,SAAS,MAAMC,IAAAA,mBAAW,EAC9B,IAAI,CAACC,OAAO,CAACP,OAAO;YAClBQ,SAAS;YACTC,QAAQ;YACRC,QAAQ,EAAE;YACVC,IAAIC,IAAAA,cAAM;QACZ,6BACA,IAAI,EAAEC;QAGR,IAAIR,WAAWS,mBAAW,IAAIT,WAAW,MAAM;YAC7C,mGAAmG;YACnG,qCAAqC;YACrC,8HAA8H;YAC9H,kIAAkI;YAClI,4BAA4B;YAC5BU,IAAAA,oBAAQ,EAAC,CAAC,KAAK,EAAEf,MAAM,iCAAiC,CAAC,EAAEK;QAC7D;QAEAW,OAAOC,MAAM,CAAChB,WAAWiB,OAAO,EAAEC,OAAO,CAAC,CAACC;YACzC,IAAI;gBACF,CAACA,OAAOC,SAAS,IAAID,OAAOE,OAAO;gBACnCF,OAAOG,kBAAkB;YAC3B,EAAE,OAAOC,OAAO;gBACdT,IAAAA,oBAAQ,EAAC,iCAAiCS;YAC5C;QACF;QAEA,IAAI,CAACC,YAAY,CAACxB;QAElB,0BAAA,IAAI,EAAEyB,0BAAAA,8BAAN,IAAI,EAA0B1B;QAC9B,IAAI,CAACE,IAAI,CAACyB,MAAM,CAAC3B;QACjB4B,IAAAA,YAAG,EAAC,CAAC,KAAK,EAAE5B,MAAM,aAAa,CAAC;IAClC;IAEA;;;;;;GAMC,GACD,MAAgB6B,UAAoC;QAClD,MAAM7B,QAAQY,IAAAA,cAAM;QACpB,MAAM,EAAEM,OAAO,EAAEY,MAAM,EAAE,GAAG,MAAM,IAAI,CAACC,WAAW,CAAC/B;QACnD,MAAMgC,YAAY,IAAIC,4BAAa;QAEnC,MAAMC,oBAAoBC,IAAAA,+CAAsB;QAEhDC,IAAAA,aAAI,EAACF,kBAAkBd,MAAM,EAAEF,QAAQX,OAAO,EAAE2B,kBAAkBd,MAAM;QAExEY,UAAUK,IAAI,CAACH,kBAAkBI,UAAU;QAE3C,MAAMC,cAAc;YAClB5B,IAAIX;YACJkB;YACAc;YACAF;QACF;QACA,IAAI,CAAC5B,IAAI,CAACsC,GAAG,CAACxC,OAAOuC;QAErB,OAAOA;IACT;IAEA;;;;;;;GAOC,GACD,MAAgBR,YACd/B,KAAa,EACyC;QACtD,MAAM,EAAE8B,MAAM,EAAEV,QAAQqB,SAAS,EAAE,GAAG,MAAM,IAAI,CAACC,aAAa,CAAC1C;QAC/D,+CAA+C;QAC/C,MAAM2C,MAAMxD,eACVsD,WACA,CAAC,MAAM,EAAEzC,MAAM,CAAC,CAAC;QAGnB,MAAM4C,gBAAgBD,IAAIE,YAAY,CAACC,6BAAiB,CAACC,OAAO;QAEhE,4FAA4F;QAC5F,gDAAgD;QAChD,MAAMC,sBAAsB,CAC1BC;YAIA,IAAI,CAACC,IAAAA,4BAAqB,EAACD,UAAU;gBACnC;YACF;YAEA,oEAAoE;YACpE,MAAMzD,SAAS,yBAAA,IAAI,EAAE2D,eAAahD,GAAG,CAACH;YACtC,IAAIiD,QAAQxC,MAAM,KAAK,mBAAmB;gBACxC,yBAAA,IAAI,EAAEnB,YAAU8D,OAAO,CAAC,oCAAoC5D;YAC9D,OAAO,IAAIyD,QAAQxC,MAAM,KAAK,oBAAoB;gBAChD,yBAAA,IAAI,EAAEnB,YAAU8D,OAAO,CAAC,qCAAqC5D;YAC/D,OAAO,IAAIyD,QAAQxC,MAAM,KAAK,kBAAkB;gBAC9C,IAAI4C,IAAAA,eAAQ,EAACJ,QAAQvC,MAAM,KAAKuC,QAAQvC,MAAM,CAACc,KAAK,EAAE;oBACpD,yBAAA,IAAI,EAAElC,YAAU8D,OAAO,CACrB,mCACA5D,QACAyD,QAAQvC,MAAM,CAACc,KAAK;oBAEtBoB,cAAcU,cAAc,CAAC,QAAQN;gBACvC,OAAO;oBACLjC,IAAAA,oBAAQ,EACN,IAAIX,MACF,CAAC,oBAAoB,EAAE6C,QAAQxC,MAAM,CAAC,8BAA8B,CAAC;gBAG3E;YACF,OAAO;gBACLM,IAAAA,oBAAQ,EACN,IAAIX,MACF,CAAC,iDAAiD,EAAE6C,QAAQxC,MAAM,CAAC,EAAE,CAAC;YAG5E;QACF;QAEAmC,cAAcW,EAAE,CAAC,QAAQP;QACzB,MAAMQ,YAAYb,IAAIE,YAAY,CAACC,6BAAiB,CAACW,QAAQ;QAE7D,iCAAiC;QACjC,OAAO;YACLvC,SAAS;gBACPX,SAASqC;gBACTc,KAAKF;gBACL,gEAAgE;gBAChEG,aAAalB;YACf;YACAX;QACF;IACF;IAYA;;;;;;GAMC,GACD,MAAMjC,cAAcL,MAAc,EAAE;QAClC,MAAMQ,QAAQ,yBAAA,IAAI,EAAE4D,eAAazD,GAAG,CAACX;QACrC,IAAIQ,OAAO;YACT,MAAM,IAAI,CAACD,SAAS,CAACC;QACvB;IACF;IAEA,MAAMF,oBAAoB;QACxB,MAAM+D,QAAQC,GAAG,CACf;eAAI,IAAI,CAAC5D,IAAI,CAAC6D,IAAI;SAAG,CAACC,GAAG,CAAC,OAAOhE,QAAU,IAAI,CAACD,SAAS,CAACC;QAE5D,yBAAA,IAAI,EAAEiE,eAAaC,KAAK;IAC1B;IAEA;;;;;GAKC,GACD,AAAQC,qBAAqB3E,MAAc,EAAE;QAC3C,OAAO,yBAAA,IAAI,EAAEyE,eAAa9D,GAAG,CAACX;IAChC;IAEA;;;;;;;;GAQC,GACD,MAAMI,YAAYD,QAA2B,EAAmB;QAC9D,IAAI,yBAAA,IAAI,EAAEiE,eAAaQ,GAAG,CAACzE,SAASH,MAAM,GAAG;YAC3C,MAAM,IAAIY,MAAM,CAAC,MAAM,EAAET,SAASH,MAAM,CAAC,4BAA4B,CAAC;QACxE;QAEA,MAAM6E,MAAM,MAAM,IAAI,CAACxC,OAAO;QAC9B,0BAAA,IAAI,EAAEyC,gBAAAA,oBAAN,IAAI,EAAgB3E,SAASH,MAAM,EAAE6E,IAAI1D,EAAE;QAE3C,+CAA+C;QAC/C,MAAM,IAAI,CAACJ,OAAO,CAAC8D,IAAI1D,EAAE,EAAE;YACzBH,SAAS;YACTC,QAAQ;YACRE,IAAIC,IAAAA,cAAM;QACZ;QAEA,MAAM4C,YAAYa,IAAInD,OAAO,CAACwC,GAAG;QAEjC,IAAI,CAACa,iBAAiB,CAAC5E,SAASH,MAAM,EAAEgE;QAExC,MAAMnD,SAAS,MAAM,IAAI,CAACE,OAAO,CAAC8D,IAAI1D,EAAE,EAAE;YACxCH,SAAS;YACTC,QAAQ;YACRC,QAAQf;YACRgB,IAAIC,IAAAA,cAAM;QACZ;QACA,0BAAA,IAAI,EAAE4D,kBAAAA,sBAAN,IAAI,EAAkB7E,SAASH,MAAM,EAAE6E,IAAI1D,EAAE;QAC7C,OAAON;IACT;IAEA,+CAA+C;IAC/C,MAAcE,QACZP,KAAa,EACbiD,OAAgC,EACd;QAClB,IAAI,OAAOA,YAAY,UAAU;YAC/B,MAAM,IAAI7C,MAAM;QAClB;QAEA,MAAMiE,MAAM,IAAI,CAACnE,IAAI,CAACC,GAAG,CAACH;QAC1B,IAAI,CAACqE,KAAK;YACR,MAAM,IAAIjE,MAAM,CAAC,aAAa,EAAEJ,MAAM,YAAY,CAAC;QACrD;QAEA4B,IAAAA,YAAG,EAAC,2BAA2BqB;QAC/B,MAAMwB,WACJ,MAAMJ,IAAIrC,SAAS,CAAC0C,MAAM,CAACzB;QAC7B,IAAIwB,SAASjD,KAAK,EAAE;YAClB,MAAM,IAAIpB,MAAMqE,SAASjD,KAAK,CAACyB,OAAO;QACxC;QACA,OAAOwB,SAASpE,MAAM;IACxB;IAwCA;;;;;;GAMC,GACD,MAAaX,iBACXF,MAAc,EACdC,OAAwB,EACN;QAClB,MAAMkF,oBAAoB,MAAM,IAAI,CAACR,oBAAoB,CAAC3E;QAE1D,IAAI,CAACmF,mBAAmB;YACtB,MAAM,IAAIvE,MACR,CAAC,iEAAiE,EAAEZ,OAAO,EAAE,CAAC;QAElF;QAEA,OAAOmF,kBAAkBlF;IAC3B;IA/WAmF,YAAY,EACVL,iBAAiB,EACjBjF,SAAS,EACTuB,qBAAqBgE,eAAQ,CAACC,MAAM,EACf,CAAE;QAiTzB,iCAAA;QAIA,iCAAA;QAkBA,iCAAA;QAKA,iCAAA;QAhWA,gCAAA;;mBAAA,KAAA;;QAEA,+CAA+C;QAC/C,uBAAU5E,QAAV,KAAA;QAEA,+CAA+C;QAC/C,uBAAiBqE,qBAAjB,KAAA;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;uCAOQN,eAAe,IAAIc;QACzB,IAAI,CAAC7E,IAAI,GAAG,IAAI6E;QAChB,IAAI,CAACR,iBAAiB,GAAGA;uCACnBX,eAAe,IAAImB;uCACnB5B,eAAe,IAAI4B;uCACnBzF,YAAYA;uCACZuB,qBAAqBA;QAE3B,IAAI,CAACxB,uBAAuB;IAC9B;AAkWF;AA3DE,SAAA,gBAAiBG,MAAc;IAC7B,yBAAA,IAAI,EAAEyE,eAAatC,MAAM,CAACnC;AAC5B;AAEA,SAAA,gBAAiBA,MAAc,EAAEwF,QAAgB;IAC/C,MAAMC,UAAU,OAAO,EAAEC,MAAM,EAAEC,OAAO,EAAEC,OAAO,EAAmB;QAClE,OAAO,MAAM,IAAI,CAAC7E,OAAO,CAACyE,UAAU;YAClCrE,IAAIC,IAAAA,cAAM;YACVJ,SAAS;YACTC,QAAQ;YACRC,QAAQ;gBACNwE;gBACAC;gBACAC;gBACAC,QAAQ7F;YACV;QACF;IACF;IAEA,yBAAA,IAAI,EAAEyE,eAAazB,GAAG,CAAChD,QAAQyF;AACjC;AAEA,SAAA,cAAezF,MAAc,EAAEQ,KAAa;IAC1C,yBAAA,IAAI,EAAE4D,eAAapB,GAAG,CAAChD,QAAQQ;IAC/B,yBAAA,IAAI,EAAEmD,eAAaX,GAAG,CAACxC,OAAOR;AAChC;AAEA,SAAA,wBAAyBQ,KAAa;IACpC,MAAMR,SAAS,yBAAA,IAAI,EAAE2D,eAAahD,GAAG,CAACH;IACtC,IAAI,CAACR,QAAQ;QACX,MAAM,IAAIY,MAAM,CAAC,MAAM,EAAEJ,MAAM,qBAAqB,CAAC;IACvD;IAEA,yBAAA,IAAI,EAAEmD,eAAaxB,MAAM,CAAC3B;IAC1B,yBAAA,IAAI,EAAE4D,eAAajC,MAAM,CAACnC;IAC1B,0BAAA,IAAI,EAAE8F,kBAAAA,sBAAN,IAAI,EAAkB9F;AACxB;AAgCK,SAASL,eACdoG,gBAAwB,EACxBC,UAAkB;IAElB,MAAM7C,MAAM,IAAI8C,wBAAe;IAC/BrD,IAAAA,aAAI,EACFmD,kBACA,iCAAiC;IACjC5C,KACA4C,kBACA,CAAC/D;QACC,IAAIA,OAAO;YACTgE,aACIzE,IAAAA,oBAAQ,EAAC,CAAC,CAAC,EAAEyE,WAAW,iBAAiB,CAAC,EAAEhE,SAC5CT,IAAAA,oBAAQ,EAACS;QACf;IACF;IAEF,OAAOmB;AACT"}
+{"version":3,"sources":["../../../src/services/AbstractExecutionService.ts"],"sourcesContent":["import ObjectMultiplex from '@metamask/object-multiplex';\nimport type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport type { SnapRpcHook, SnapRpcHookArgs } from '@metamask/snaps-utils';\nimport { SNAP_STREAM_NAMES, logError } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcNotification } from '@metamask/utils';\nimport { Duration, isJsonRpcNotification, isObject } from '@metamask/utils';\nimport type {\n  // TODO: Replace with @metamask/utils version after bumping json-rpc-engine\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from 'json-rpc-engine';\nimport { JsonRpcEngine } from 'json-rpc-engine';\nimport { createStreamMiddleware } from 'json-rpc-middleware-stream';\nimport { nanoid } from 'nanoid';\nimport { pipeline } from 'stream';\nimport type { Duplex } from 'stream';\n\nimport { log } from '../logging';\nimport { hasTimedOut, withTimeout } from '../utils';\nimport type {\n  ExecutionService,\n  ExecutionServiceMessenger,\n  SnapErrorJson,\n  SnapExecutionData,\n} from './ExecutionService';\n\nconst controllerName = 'ExecutionService';\n\nexport type SetupSnapProvider = (snapId: string, stream: Duplex) => void;\n\nexport type ExecutionServiceArgs = {\n  setupSnapProvider: SetupSnapProvider;\n  messenger: ExecutionServiceMessenger;\n  terminationTimeout?: number;\n};\n\nexport type JobStreams = {\n  command: Duplex;\n  rpc: Duplex;\n  _connection: BasePostMessageStream;\n};\n\nexport type Job<WorkerType> = {\n  id: string;\n  streams: JobStreams;\n  rpcEngine: JsonRpcEngine;\n  worker: WorkerType;\n};\n\nexport abstract class AbstractExecutionService<WorkerType>\n  implements ExecutionService\n{\n  #snapRpcHooks: Map<string, SnapRpcHook>;\n\n  // Cannot be hash private yet because of tests.\n  protected jobs: Map<string, Job<WorkerType>>;\n\n  // Cannot be hash private yet because of tests.\n  private readonly setupSnapProvider: SetupSnapProvider;\n\n  #snapToJobMap: Map<string, string>;\n\n  #jobToSnapMap: Map<string, string>;\n\n  #messenger: ExecutionServiceMessenger;\n\n  #terminationTimeout: number;\n\n  constructor({\n    setupSnapProvider,\n    messenger,\n    terminationTimeout = Duration.Second,\n  }: ExecutionServiceArgs) {\n    this.#snapRpcHooks = new Map();\n    this.jobs = new Map();\n    this.setupSnapProvider = setupSnapProvider;\n    this.#snapToJobMap = new Map();\n    this.#jobToSnapMap = new Map();\n    this.#messenger = messenger;\n    this.#terminationTimeout = terminationTimeout;\n\n    this.registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering the controller's messaging system\n   * actions.\n   */\n  private registerMessageHandlers(): void {\n    this.#messenger.registerActionHandler(\n      `${controllerName}:handleRpcRequest`,\n      async (snapId: string, options: SnapRpcHookArgs) =>\n        this.handleRpcRequest(snapId, options),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:executeSnap`,\n      async (snapData: SnapExecutionData) => this.executeSnap(snapData),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateSnap`,\n      async (snapId: string) => this.terminateSnap(snapId),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateAllSnaps`,\n      async () => this.terminateAllSnaps(),\n    );\n  }\n\n  /**\n   * Performs additional necessary work during job termination. **MUST** be\n   * implemented by concrete implementations. See\n   * {@link AbstractExecutionService.terminate} for details.\n   *\n   * @param job - The object corresponding to the job to be terminated.\n   */\n  protected abstract terminateJob(job: Job<WorkerType>): void;\n\n  /**\n   * Terminates the job with the specified ID and deletes all its associated\n   * data. Any subsequent messages targeting the job will fail with an error.\n   * Throws an error if the specified job does not exist, or if termination\n   * fails unexpectedly.\n   *\n   * @param jobId - The id of the job to be terminated.\n   */\n  public async terminate(jobId: string): Promise<void> {\n    const jobWrapper = this.jobs.get(jobId);\n    if (!jobWrapper) {\n      throw new Error(`Job with id \"${jobId}\" not found.`);\n    }\n\n    // Ping worker and tell it to run teardown, continue with termination if it takes too long\n    const result = await withTimeout(\n      this.command(jobId, {\n        jsonrpc: '2.0',\n        method: 'terminate',\n        params: [],\n        id: nanoid(),\n      }),\n      this.#terminationTimeout,\n    );\n\n    if (result === hasTimedOut || result !== 'OK') {\n      // We tried to shutdown gracefully but failed. This probably means the Snap is in infinite loop and\n      // hogging down the whole JS process.\n      // TODO(ritave): It might be doing weird things such as posting a lot of setTimeouts. Add a test to ensure that this behaviour\n      //               doesn't leak into other workers. Especially important in IframeExecutionEnvironment since they all share the same\n      //               JS process.\n      logError(`Job \"${jobId}\" failed to terminate gracefully.`, result);\n    }\n\n    Object.values(jobWrapper.streams).forEach((stream) => {\n      try {\n        !stream.destroyed && stream.destroy();\n        stream.removeAllListeners();\n      } catch (error) {\n        logError('Error while destroying stream', error);\n      }\n    });\n\n    this.terminateJob(jobWrapper);\n\n    this.#removeSnapAndJobMapping(jobId);\n    this.jobs.delete(jobId);\n    log(`Job \"${jobId}\" terminated.`);\n  }\n\n  /**\n   * Initiates a job for a snap.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @returns Information regarding the created job.\n   */\n  protected async initJob(): Promise<Job<WorkerType>> {\n    const jobId = nanoid();\n    const { streams, worker } = await this.initStreams(jobId);\n    const rpcEngine = new JsonRpcEngine();\n\n    const jsonRpcConnection = createStreamMiddleware();\n\n    pipeline(\n      jsonRpcConnection.stream,\n      streams.command,\n      jsonRpcConnection.stream,\n      (error) => {\n        if (error) {\n          logError(`Command stream failure.`, error);\n        }\n      },\n    );\n\n    rpcEngine.push(jsonRpcConnection.middleware);\n\n    const envMetadata = {\n      id: jobId,\n      streams,\n      rpcEngine,\n      worker,\n    };\n    this.jobs.set(jobId, envMetadata);\n\n    return envMetadata;\n  }\n\n  /**\n   * Sets up the streams for an initiated job.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @param jobId - The id of the job.\n   * @returns The streams to communicate with the worker and the worker itself.\n   */\n  protected async initStreams(\n    jobId: string,\n  ): Promise<{ streams: JobStreams; worker: WorkerType }> {\n    const { worker, stream: envStream } = await this.initEnvStream(jobId);\n    // Typecast justification: stream type mismatch\n    const mux = setupMultiplex(\n      envStream as unknown as Duplex,\n      `Job: \"${jobId}\"`,\n    );\n\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n\n    // Handle out-of-band errors, i.e. errors thrown from the snap outside of the req/res cycle.\n    // Also keep track of outbound request/responses\n    const notificationHandler = (\n      message:\n        | JsonRpcRequest<unknown>\n        | JsonRpcNotification<Json[] | Record<string, Json>>,\n    ) => {\n      if (!isJsonRpcNotification(message)) {\n        return;\n      }\n\n      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n      const snapId = this.#jobToSnapMap.get(jobId)!;\n      if (message.method === 'OutboundRequest') {\n        this.#messenger.publish('ExecutionService:outboundRequest', snapId);\n      } else if (message.method === 'OutboundResponse') {\n        this.#messenger.publish('ExecutionService:outboundResponse', snapId);\n      } else if (message.method === 'UnhandledError') {\n        if (isObject(message.params) && message.params.error) {\n          this.#messenger.publish(\n            'ExecutionService:unhandledError',\n            snapId,\n            message.params.error as SnapErrorJson,\n          );\n          commandStream.removeListener('data', notificationHandler);\n        } else {\n          logError(\n            new Error(\n              `Received malformed \"${message.method}\" command stream notification.`,\n            ),\n          );\n        }\n      } else {\n        logError(\n          new Error(\n            `Received unexpected command stream notification \"${message.method}\".`,\n          ),\n        );\n      }\n    };\n\n    commandStream.on('data', notificationHandler);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC);\n\n    // Typecast: stream type mismatch\n    return {\n      streams: {\n        command: commandStream as unknown as Duplex,\n        rpc: rpcStream,\n        // eslint-disable-next-line @typescript-eslint/naming-convention\n        _connection: envStream,\n      },\n      worker,\n    };\n  }\n\n  /**\n   * Abstract function implemented by implementing class that spins up a new worker for a job.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   */\n  protected abstract initEnvStream(jobId: string): Promise<{\n    worker: WorkerType;\n    stream: BasePostMessageStream;\n  }>;\n\n  /**\n   * Terminates the Snap with the specified ID. May throw an error if\n   * termination unexpectedly fails, but will not fail if no job for the snap\n   * with the specified ID is found.\n   *\n   * @param snapId - The ID of the snap to terminate.\n   */\n  async terminateSnap(snapId: string) {\n    const jobId = this.#snapToJobMap.get(snapId);\n    if (jobId) {\n      await this.terminate(jobId);\n    }\n  }\n\n  async terminateAllSnaps() {\n    await Promise.all(\n      [...this.jobs.keys()].map(async (jobId) => this.terminate(jobId)),\n    );\n    this.#snapRpcHooks.clear();\n  }\n\n  /**\n   * Gets the RPC request handler for the given snap.\n   *\n   * @param snapId - The id of the Snap whose message handler to get.\n   * @returns The RPC request handler for the snap.\n   */\n  private getRpcRequestHandler(snapId: string) {\n    return this.#snapRpcHooks.get(snapId);\n  }\n\n  /**\n   * Initializes and executes a snap, setting up the communication channels to the snap etc.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @param snapData - Data needed for Snap execution.\n   * @returns A string `OK` if execution succeeded.\n   * @throws If the execution service returns an error.\n   */\n  async executeSnap(snapData: SnapExecutionData): Promise<string> {\n    if (this.#snapToJobMap.has(snapData.snapId)) {\n      throw new Error(`Snap \"${snapData.snapId}\" is already being executed.`);\n    }\n\n    const job = await this.initJob();\n    this.#mapSnapAndJob(snapData.snapId, job.id);\n\n    // Ping the worker to ensure that it started up\n    await this.command(job.id, {\n      jsonrpc: '2.0',\n      method: 'ping',\n      id: nanoid(),\n    });\n\n    const rpcStream = job.streams.rpc as unknown as Duplex;\n\n    this.setupSnapProvider(snapData.snapId, rpcStream);\n\n    const result = await this.command(job.id, {\n      jsonrpc: '2.0',\n      method: 'executeSnap',\n      params: snapData,\n      id: nanoid(),\n    });\n    this.#createSnapHooks(snapData.snapId, job.id);\n    return result as string;\n  }\n\n  // Cannot be hash private yet because of tests.\n  private async command(\n    jobId: string,\n    message: JsonRpcRequest<unknown>,\n  ): Promise<unknown> {\n    if (typeof message !== 'object') {\n      throw new Error('Must send object.');\n    }\n\n    const job = this.jobs.get(jobId);\n    if (!job) {\n      throw new Error(`Job with id \"${jobId}\" not found.`);\n    }\n\n    log('Parent: Sending Command', message);\n    const response: PendingJsonRpcResponse<unknown> =\n      await job.rpcEngine.handle(message);\n    if (response.error) {\n      throw new Error(response.error.message);\n    }\n    return response.result;\n  }\n\n  #removeSnapHooks(snapId: string) {\n    this.#snapRpcHooks.delete(snapId);\n  }\n\n  #createSnapHooks(snapId: string, workerId: string) {\n    const rpcHook = async ({ origin, handler, request }: SnapRpcHookArgs) => {\n      return await this.command(workerId, {\n        id: nanoid(),\n        jsonrpc: '2.0',\n        method: 'snapRpc',\n        params: {\n          origin,\n          handler,\n          request,\n          target: snapId,\n        },\n      });\n    };\n\n    this.#snapRpcHooks.set(snapId, rpcHook);\n  }\n\n  #mapSnapAndJob(snapId: string, jobId: string): void {\n    this.#snapToJobMap.set(snapId, jobId);\n    this.#jobToSnapMap.set(jobId, snapId);\n  }\n\n  #removeSnapAndJobMapping(jobId: string): void {\n    const snapId = this.#jobToSnapMap.get(jobId);\n    if (!snapId) {\n      throw new Error(`job: \"${jobId}\" has no mapped snap.`);\n    }\n\n    this.#jobToSnapMap.delete(jobId);\n    this.#snapToJobMap.delete(snapId);\n    this.#removeSnapHooks(snapId);\n  }\n\n  /**\n   * Handle RPC request.\n   *\n   * @param snapId - The ID of the recipient snap.\n   * @param options - Bag of options to pass to the RPC handler.\n   * @returns Promise that can handle the request.\n   */\n  public async handleRpcRequest(\n    snapId: string,\n    options: SnapRpcHookArgs,\n  ): Promise<unknown> {\n    const rpcRequestHandler = await this.getRpcRequestHandler(snapId);\n\n    if (!rpcRequestHandler) {\n      throw new Error(\n        `Snap execution service returned no RPC handler for running snap \"${snapId}\".`,\n      );\n    }\n\n    return rpcRequestHandler(options);\n  }\n}\n\n/**\n * Sets up stream multiplexing for the given stream.\n *\n * @param connectionStream - The stream to mux.\n * @param streamName - The name of the stream, for identification in errors.\n * @returns The multiplexed stream.\n */\nexport function setupMultiplex(\n  connectionStream: Duplex,\n  streamName: string,\n): ObjectMultiplex {\n  const mux = new ObjectMultiplex();\n  pipeline(\n    connectionStream,\n    // Typecast: stream type mismatch\n    mux as unknown as Duplex,\n    connectionStream,\n    (error) => {\n      if (error) {\n        streamName\n          ? logError(`\"${streamName}\" stream failure.`, error)\n          : logError(error);\n      }\n    },\n  );\n  return mux;\n}\n"],"names":["AbstractExecutionService","setupMultiplex","controllerName","registerMessageHandlers","messenger","registerActionHandler","snapId","options","handleRpcRequest","snapData","executeSnap","terminateSnap","terminateAllSnaps","terminate","jobId","jobWrapper","jobs","get","Error","result","withTimeout","command","jsonrpc","method","params","id","nanoid","terminationTimeout","hasTimedOut","logError","Object","values","streams","forEach","stream","destroyed","destroy","removeAllListeners","error","terminateJob","removeSnapAndJobMapping","delete","log","initJob","worker","initStreams","rpcEngine","JsonRpcEngine","jsonRpcConnection","createStreamMiddleware","pipeline","push","middleware","envMetadata","set","envStream","initEnvStream","mux","commandStream","createStream","SNAP_STREAM_NAMES","COMMAND","notificationHandler","message","isJsonRpcNotification","jobToSnapMap","publish","isObject","removeListener","on","rpcStream","JSON_RPC","rpc","_connection","snapToJobMap","Promise","all","keys","map","snapRpcHooks","clear","getRpcRequestHandler","has","job","mapSnapAndJob","setupSnapProvider","createSnapHooks","response","handle","rpcRequestHandler","constructor","Duration","Second","Map","workerId","rpcHook","origin","handler","request","target","removeSnapHooks","connectionStream","streamName","ObjectMultiplex"],"mappings":";;;;;;;;;;;IAiDsBA,wBAAwB;eAAxBA;;IAqZNC,cAAc;eAAdA;;;wEAtcY;4BAGgB;uBAEc;+BAM5B;yCACS;wBAChB;wBACE;yBAGL;wBACqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQzC,MAAMC,iBAAiB;IA0BrB,6CAQA,6CAEA,6CAEA,0CAEA,mDAgUA,gDAIA,gDAkBA,8CAKA;AA5WK,MAAeF;IAmCpB;;;GAGC,GACD,AAAQG,0BAAgC;QACtC,yBAAA,IAAI,EAAEC,YAAUC,qBAAqB,CACnC,CAAC,EAAEH,eAAe,iBAAiB,CAAC,EACpC,OAAOI,QAAgBC,UACrB,IAAI,CAACC,gBAAgB,CAACF,QAAQC;QAGlC,yBAAA,IAAI,EAAEH,YAAUC,qBAAqB,CACnC,CAAC,EAAEH,eAAe,YAAY,CAAC,EAC/B,OAAOO,WAAgC,IAAI,CAACC,WAAW,CAACD;QAG1D,yBAAA,IAAI,EAAEL,YAAUC,qBAAqB,CACnC,CAAC,EAAEH,eAAe,cAAc,CAAC,EACjC,OAAOI,SAAmB,IAAI,CAACK,aAAa,CAACL;QAG/C,yBAAA,IAAI,EAAEF,YAAUC,qBAAqB,CACnC,CAAC,EAAEH,eAAe,kBAAkB,CAAC,EACrC,UAAY,IAAI,CAACU,iBAAiB;IAEtC;IAWA;;;;;;;GAOC,GACD,MAAaC,UAAUC,KAAa,EAAiB;QACnD,MAAMC,aAAa,IAAI,CAACC,IAAI,CAACC,GAAG,CAACH;QACjC,IAAI,CAACC,YAAY;YACf,MAAM,IAAIG,MAAM,CAAC,aAAa,EAAEJ,MAAM,YAAY,CAAC;QACrD;QAEA,0FAA0F;QAC1F,MAAMK,SAAS,MAAMC,IAAAA,mBAAW,EAC9B,IAAI,CAACC,OAAO,CAACP,OAAO;YAClBQ,SAAS;YACTC,QAAQ;YACRC,QAAQ,EAAE;YACVC,IAAIC,IAAAA,cAAM;QACZ,6BACA,IAAI,EAAEC;QAGR,IAAIR,WAAWS,mBAAW,IAAIT,WAAW,MAAM;YAC7C,mGAAmG;YACnG,qCAAqC;YACrC,8HAA8H;YAC9H,kIAAkI;YAClI,4BAA4B;YAC5BU,IAAAA,oBAAQ,EAAC,CAAC,KAAK,EAAEf,MAAM,iCAAiC,CAAC,EAAEK;QAC7D;QAEAW,OAAOC,MAAM,CAAChB,WAAWiB,OAAO,EAAEC,OAAO,CAAC,CAACC;YACzC,IAAI;gBACF,CAACA,OAAOC,SAAS,IAAID,OAAOE,OAAO;gBACnCF,OAAOG,kBAAkB;YAC3B,EAAE,OAAOC,OAAO;gBACdT,IAAAA,oBAAQ,EAAC,iCAAiCS;YAC5C;QACF;QAEA,IAAI,CAACC,YAAY,CAACxB;QAElB,0BAAA,IAAI,EAAEyB,0BAAAA,8BAAN,IAAI,EAA0B1B;QAC9B,IAAI,CAACE,IAAI,CAACyB,MAAM,CAAC3B;QACjB4B,IAAAA,YAAG,EAAC,CAAC,KAAK,EAAE5B,MAAM,aAAa,CAAC;IAClC;IAEA;;;;;;GAMC,GACD,MAAgB6B,UAAoC;QAClD,MAAM7B,QAAQY,IAAAA,cAAM;QACpB,MAAM,EAAEM,OAAO,EAAEY,MAAM,EAAE,GAAG,MAAM,IAAI,CAACC,WAAW,CAAC/B;QACnD,MAAMgC,YAAY,IAAIC,4BAAa;QAEnC,MAAMC,oBAAoBC,IAAAA,+CAAsB;QAEhDC,IAAAA,gBAAQ,EACNF,kBAAkBd,MAAM,EACxBF,QAAQX,OAAO,EACf2B,kBAAkBd,MAAM,EACxB,CAACI;YACC,IAAIA,OAAO;gBACTT,IAAAA,oBAAQ,EAAC,CAAC,uBAAuB,CAAC,EAAES;YACtC;QACF;QAGFQ,UAAUK,IAAI,CAACH,kBAAkBI,UAAU;QAE3C,MAAMC,cAAc;YAClB5B,IAAIX;YACJkB;YACAc;YACAF;QACF;QACA,IAAI,CAAC5B,IAAI,CAACsC,GAAG,CAACxC,OAAOuC;QAErB,OAAOA;IACT;IAEA;;;;;;;GAOC,GACD,MAAgBR,YACd/B,KAAa,EACyC;QACtD,MAAM,EAAE8B,MAAM,EAAEV,QAAQqB,SAAS,EAAE,GAAG,MAAM,IAAI,CAACC,aAAa,CAAC1C;QAC/D,+CAA+C;QAC/C,MAAM2C,MAAMxD,eACVsD,WACA,CAAC,MAAM,EAAEzC,MAAM,CAAC,CAAC;QAGnB,MAAM4C,gBAAgBD,IAAIE,YAAY,CAACC,6BAAiB,CAACC,OAAO;QAEhE,4FAA4F;QAC5F,gDAAgD;QAChD,MAAMC,sBAAsB,CAC1BC;YAIA,IAAI,CAACC,IAAAA,4BAAqB,EAACD,UAAU;gBACnC;YACF;YAEA,oEAAoE;YACpE,MAAMzD,SAAS,yBAAA,IAAI,EAAE2D,eAAahD,GAAG,CAACH;YACtC,IAAIiD,QAAQxC,MAAM,KAAK,mBAAmB;gBACxC,yBAAA,IAAI,EAAEnB,YAAU8D,OAAO,CAAC,oCAAoC5D;YAC9D,OAAO,IAAIyD,QAAQxC,MAAM,KAAK,oBAAoB;gBAChD,yBAAA,IAAI,EAAEnB,YAAU8D,OAAO,CAAC,qCAAqC5D;YAC/D,OAAO,IAAIyD,QAAQxC,MAAM,KAAK,kBAAkB;gBAC9C,IAAI4C,IAAAA,eAAQ,EAACJ,QAAQvC,MAAM,KAAKuC,QAAQvC,MAAM,CAACc,KAAK,EAAE;oBACpD,yBAAA,IAAI,EAAElC,YAAU8D,OAAO,CACrB,mCACA5D,QACAyD,QAAQvC,MAAM,CAACc,KAAK;oBAEtBoB,cAAcU,cAAc,CAAC,QAAQN;gBACvC,OAAO;oBACLjC,IAAAA,oBAAQ,EACN,IAAIX,MACF,CAAC,oBAAoB,EAAE6C,QAAQxC,MAAM,CAAC,8BAA8B,CAAC;gBAG3E;YACF,OAAO;gBACLM,IAAAA,oBAAQ,EACN,IAAIX,MACF,CAAC,iDAAiD,EAAE6C,QAAQxC,MAAM,CAAC,EAAE,CAAC;YAG5E;QACF;QAEAmC,cAAcW,EAAE,CAAC,QAAQP;QACzB,MAAMQ,YAAYb,IAAIE,YAAY,CAACC,6BAAiB,CAACW,QAAQ;QAE7D,iCAAiC;QACjC,OAAO;YACLvC,SAAS;gBACPX,SAASqC;gBACTc,KAAKF;gBACL,gEAAgE;gBAChEG,aAAalB;YACf;YACAX;QACF;IACF;IAYA;;;;;;GAMC,GACD,MAAMjC,cAAcL,MAAc,EAAE;QAClC,MAAMQ,QAAQ,yBAAA,IAAI,EAAE4D,eAAazD,GAAG,CAACX;QACrC,IAAIQ,OAAO;YACT,MAAM,IAAI,CAACD,SAAS,CAACC;QACvB;IACF;IAEA,MAAMF,oBAAoB;QACxB,MAAM+D,QAAQC,GAAG,CACf;eAAI,IAAI,CAAC5D,IAAI,CAAC6D,IAAI;SAAG,CAACC,GAAG,CAAC,OAAOhE,QAAU,IAAI,CAACD,SAAS,CAACC;QAE5D,yBAAA,IAAI,EAAEiE,eAAaC,KAAK;IAC1B;IAEA;;;;;GAKC,GACD,AAAQC,qBAAqB3E,MAAc,EAAE;QAC3C,OAAO,yBAAA,IAAI,EAAEyE,eAAa9D,GAAG,CAACX;IAChC;IAEA;;;;;;;;GAQC,GACD,MAAMI,YAAYD,QAA2B,EAAmB;QAC9D,IAAI,yBAAA,IAAI,EAAEiE,eAAaQ,GAAG,CAACzE,SAASH,MAAM,GAAG;YAC3C,MAAM,IAAIY,MAAM,CAAC,MAAM,EAAET,SAASH,MAAM,CAAC,4BAA4B,CAAC;QACxE;QAEA,MAAM6E,MAAM,MAAM,IAAI,CAACxC,OAAO;QAC9B,0BAAA,IAAI,EAAEyC,gBAAAA,oBAAN,IAAI,EAAgB3E,SAASH,MAAM,EAAE6E,IAAI1D,EAAE;QAE3C,+CAA+C;QAC/C,MAAM,IAAI,CAACJ,OAAO,CAAC8D,IAAI1D,EAAE,EAAE;YACzBH,SAAS;YACTC,QAAQ;YACRE,IAAIC,IAAAA,cAAM;QACZ;QAEA,MAAM4C,YAAYa,IAAInD,OAAO,CAACwC,GAAG;QAEjC,IAAI,CAACa,iBAAiB,CAAC5E,SAASH,MAAM,EAAEgE;QAExC,MAAMnD,SAAS,MAAM,IAAI,CAACE,OAAO,CAAC8D,IAAI1D,EAAE,EAAE;YACxCH,SAAS;YACTC,QAAQ;YACRC,QAAQf;YACRgB,IAAIC,IAAAA,cAAM;QACZ;QACA,0BAAA,IAAI,EAAE4D,kBAAAA,sBAAN,IAAI,EAAkB7E,SAASH,MAAM,EAAE6E,IAAI1D,EAAE;QAC7C,OAAON;IACT;IAEA,+CAA+C;IAC/C,MAAcE,QACZP,KAAa,EACbiD,OAAgC,EACd;QAClB,IAAI,OAAOA,YAAY,UAAU;YAC/B,MAAM,IAAI7C,MAAM;QAClB;QAEA,MAAMiE,MAAM,IAAI,CAACnE,IAAI,CAACC,GAAG,CAACH;QAC1B,IAAI,CAACqE,KAAK;YACR,MAAM,IAAIjE,MAAM,CAAC,aAAa,EAAEJ,MAAM,YAAY,CAAC;QACrD;QAEA4B,IAAAA,YAAG,EAAC,2BAA2BqB;QAC/B,MAAMwB,WACJ,MAAMJ,IAAIrC,SAAS,CAAC0C,MAAM,CAACzB;QAC7B,IAAIwB,SAASjD,KAAK,EAAE;YAClB,MAAM,IAAIpB,MAAMqE,SAASjD,KAAK,CAACyB,OAAO;QACxC;QACA,OAAOwB,SAASpE,MAAM;IACxB;IAwCA;;;;;;GAMC,GACD,MAAaX,iBACXF,MAAc,EACdC,OAAwB,EACN;QAClB,MAAMkF,oBAAoB,MAAM,IAAI,CAACR,oBAAoB,CAAC3E;QAE1D,IAAI,CAACmF,mBAAmB;YACtB,MAAM,IAAIvE,MACR,CAAC,iEAAiE,EAAEZ,OAAO,EAAE,CAAC;QAElF;QAEA,OAAOmF,kBAAkBlF;IAC3B;IAxXAmF,YAAY,EACVL,iBAAiB,EACjBjF,SAAS,EACTuB,qBAAqBgE,eAAQ,CAACC,MAAM,EACf,CAAE;QA0TzB,iCAAA;QAIA,iCAAA;QAkBA,iCAAA;QAKA,iCAAA;QAzWA,gCAAA;;mBAAA,KAAA;;QAEA,+CAA+C;QAC/C,uBAAU5E,QAAV,KAAA;QAEA,+CAA+C;QAC/C,uBAAiBqE,qBAAjB,KAAA;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;uCAOQN,eAAe,IAAIc;QACzB,IAAI,CAAC7E,IAAI,GAAG,IAAI6E;QAChB,IAAI,CAACR,iBAAiB,GAAGA;uCACnBX,eAAe,IAAImB;uCACnB5B,eAAe,IAAI4B;uCACnBzF,YAAYA;uCACZuB,qBAAqBA;QAE3B,IAAI,CAACxB,uBAAuB;IAC9B;AA2WF;AA3DE,SAAA,gBAAiBG,MAAc;IAC7B,yBAAA,IAAI,EAAEyE,eAAatC,MAAM,CAACnC;AAC5B;AAEA,SAAA,gBAAiBA,MAAc,EAAEwF,QAAgB;IAC/C,MAAMC,UAAU,OAAO,EAAEC,MAAM,EAAEC,OAAO,EAAEC,OAAO,EAAmB;QAClE,OAAO,MAAM,IAAI,CAAC7E,OAAO,CAACyE,UAAU;YAClCrE,IAAIC,IAAAA,cAAM;YACVJ,SAAS;YACTC,QAAQ;YACRC,QAAQ;gBACNwE;gBACAC;gBACAC;gBACAC,QAAQ7F;YACV;QACF;IACF;IAEA,yBAAA,IAAI,EAAEyE,eAAazB,GAAG,CAAChD,QAAQyF;AACjC;AAEA,SAAA,cAAezF,MAAc,EAAEQ,KAAa;IAC1C,yBAAA,IAAI,EAAE4D,eAAapB,GAAG,CAAChD,QAAQQ;IAC/B,yBAAA,IAAI,EAAEmD,eAAaX,GAAG,CAACxC,OAAOR;AAChC;AAEA,SAAA,wBAAyBQ,KAAa;IACpC,MAAMR,SAAS,yBAAA,IAAI,EAAE2D,eAAahD,GAAG,CAACH;IACtC,IAAI,CAACR,QAAQ;QACX,MAAM,IAAIY,MAAM,CAAC,MAAM,EAAEJ,MAAM,qBAAqB,CAAC;IACvD;IAEA,yBAAA,IAAI,EAAEmD,eAAaxB,MAAM,CAAC3B;IAC1B,yBAAA,IAAI,EAAE4D,eAAajC,MAAM,CAACnC;IAC1B,0BAAA,IAAI,EAAE8F,kBAAAA,sBAAN,IAAI,EAAkB9F;AACxB;AAgCK,SAASL,eACdoG,gBAAwB,EACxBC,UAAkB;IAElB,MAAM7C,MAAM,IAAI8C,wBAAe;IAC/BrD,IAAAA,gBAAQ,EACNmD,kBACA,iCAAiC;IACjC5C,KACA4C,kBACA,CAAC/D;QACC,IAAIA,OAAO;YACTgE,aACIzE,IAAAA,oBAAQ,EAAC,CAAC,CAAC,EAAEyE,WAAW,iBAAiB,CAAC,EAAEhE,SAC5CT,IAAAA,oBAAQ,EAACS;QACf;IACF;IAEF,OAAOmB;AACT"}

package/dist/cjs/snaps/SnapController.js

@@ -288,6 +288,7 @@ class SnapController extends _basecontroller.BaseControllerV2 {
         this.update((state)=>{
             state.snaps[snapId].enabled = true;
         });
+        this.messagingSystem.publish('SnapController:snapEnabled', this.getTruncatedExpect(snapId));
     }
     /**
    * Disables the given snap. A snap can only be started if it is enabled.
@@ -302,9 +303,9 @@ class SnapController extends _basecontroller.BaseControllerV2 {
             state.snaps[snapId].enabled = false;
         });
         if (this.isRunning(snapId)) {
-            return this.stopSnap(snapId, _snapsutils.SnapStatusEvents.Stop);
+            await this.stopSnap(snapId, _snapsutils.SnapStatusEvents.Stop);
         }
-        return Promise.resolve();
+        this.messagingSystem.publish('SnapController:snapDisabled', this.getTruncatedExpect(snapId));
     }
     /**
    * Stops the given snap, removes all hooks, closes all connections, and