@metamask/snaps-controllers 1.0.2 → 2.0.0

package/dist/types/snaps/location/npm.d.ts

@@ -0,0 +1,49 @@
+import type { SnapManifest } from '@metamask/snaps-utils';
+import { VirtualFile } from '@metamask/snaps-utils';
+import type { SemVerRange } from '@metamask/utils';
+import type { DetectSnapLocationOptions, SnapLocation } from './location';
+export declare const DEFAULT_NPM_REGISTRY = "https://registry.npmjs.org";
+export interface NpmOptions {
+    /**
+     * @default DEFAULT_REQUESTED_SNAP_VERSION
+     */
+    versionRange?: SemVerRange;
+    /**
+     * Whether to allow custom NPM registries outside of {@link DEFAULT_NPM_REGISTRY}.
+     *
+     * @default false
+     */
+    allowCustomRegistries?: boolean;
+}
+export declare class NpmLocation implements SnapLocation {
+    #private;
+    private readonly meta;
+    private validatedManifest?;
+    private files?;
+    constructor(url: URL, opts?: DetectSnapLocationOptions);
+    manifest(): Promise<VirtualFile<SnapManifest>>;
+    fetch(path: string): Promise<VirtualFile>;
+    get packageName(): string;
+    get version(): string;
+    get registry(): URL;
+    get versionRange(): SemVerRange;
+}
+export declare type PartialNpmMetadata = {
+    versions: Record<string, {
+        dist: {
+            tarball: string;
+        };
+    }>;
+};
+/**
+ * Fetches the NPM metadata of the specified package from
+ * the public npm registry.
+ *
+ * @param packageName - The name of the package whose metadata to fetch.
+ * @param registryUrl - The URL of the npm registry to fetch the metadata from.
+ * @param fetchFunction - The fetch function to use. Defaults to the global
+ * {@link fetch}. Useful for Node.js compatibility.
+ * @returns The NPM metadata object.
+ * @throws If fetching the metadata fails.
+ */
+export declare function fetchNpmMetadata(packageName: string, registryUrl: URL | string, fetchFunction: typeof fetch): Promise<PartialNpmMetadata>;

package/dist/types/snaps/permissions.d.ts

@@ -0,0 +1,16 @@
+import type { PermissionConstraint, PermissionSpecificationConstraint } from '@metamask/permission-controller';
+import type { SnapPermissions } from '@metamask/snaps-utils';
+/**
+ * Map initial permissions as defined in a Snap manifest to something that can
+ * be processed by the PermissionsController. Each caveat mapping function
+ * should return a valid permission caveat value.
+ *
+ * This function does not validate the caveat values, since that is done by
+ * the PermissionsController itself, upon requesting the permissions.
+ *
+ * @param initialPermissions - The initial permissions to process.
+ * @returns The processed permissions.
+ */
+export declare function processSnapPermissions(initialPermissions: SnapPermissions): Record<string, Pick<PermissionConstraint, 'caveats'>>;
+export declare const buildSnapEndowmentSpecifications: (excludedEndowments: string[]) => Record<string, PermissionSpecificationConstraint>;
+export declare const buildSnapRestrictedMethodSpecifications: (excludedPermissions: string[], hooks: Record<string, unknown>) => Record<string, PermissionSpecificationConstraint>;

package/dist/{snaps → types/snaps}/registry/json.d.ts

@@ -1,7 +1,8 @@
-import { BaseControllerV2 as BaseController, RestrictedControllerMessenger } from '@metamask/base-controller';
-import { SnapsRegistryDatabase } from '@metamask/snaps-registry';
-import { Hex } from '@metamask/utils';
-import { SnapsRegistry } from './registry';
+import type { RestrictedControllerMessenger } from '@metamask/base-controller';
+import { BaseControllerV2 as BaseController } from '@metamask/base-controller';
+import type { SnapsRegistryDatabase } from '@metamask/snaps-registry';
+import type { Hex } from '@metamask/utils';
+import type { SnapsRegistry } from './registry';
 declare type JsonSnapsRegistryUrl = {
     registry: string;
     signature: string;

package/dist/{snaps → types/snaps}/registry/registry.d.ts

@@ -1,12 +1,12 @@
-import { BlockReason, SnapsRegistryDatabase } from '@metamask/snaps-registry';
-import { SnapId } from '@metamask/snaps-utils';
-import { SemVerVersion } from '@metamask/utils';
+import type { BlockReason, SnapsRegistryDatabase } from '@metamask/snaps-registry';
+import type { SnapId, ValidatedSnapId } from '@metamask/snaps-utils';
+import type { SemVerVersion } from '@metamask/utils';
 export declare type SnapsRegistryInfo = {
     version: SemVerVersion;
     checksum: string;
 };
 export declare type SnapsRegistryRequest = Record<SnapId, SnapsRegistryInfo>;
-export declare type SnapsRegistryMetadata = SnapsRegistryDatabase['verifiedSnaps'][SnapId]['metadata'];
+export declare type SnapsRegistryMetadata = SnapsRegistryDatabase['verifiedSnaps'][ValidatedSnapId]['metadata'];
 export declare enum SnapsRegistryStatus {
     Unverified = 0,
     Blocked = 1,
@@ -17,7 +17,7 @@ export declare type SnapsRegistryResult = {
     reason?: BlockReason;
 };
 export declare type SnapsRegistry = {
-    get(snaps: SnapsRegistryRequest): Promise<Record<SnapId, SnapsRegistryResult>>;
+    get(snaps: SnapsRegistryRequest): Promise<Record<ValidatedSnapId, SnapsRegistryResult>>;
     update(): Promise<void>;
     /**
      * Get metadata for the given snap ID.

package/dist/types/snaps/selectors.d.ts

@@ -0,0 +1,2 @@
+import type { TruncatedSnap } from '@metamask/snaps-utils';
+export declare const getRunnableSnaps: <Snap extends TruncatedSnap>(snaps: Snap[]) => Snap[];

package/dist/{utils.d.ts → types/utils.d.ts}

@@ -15,7 +15,7 @@ import { Timer } from './snaps/Timer';
  */
 export declare function setDiff<ObjectA extends Record<any, unknown>, ObjectB extends Record<any, unknown>>(objectA: ObjectA, objectB: ObjectB): Diff<ObjectA, ObjectB>;
 /**
- * A Promise that delays it's return for a given amount of milliseconds.
+ * A Promise that delays its return for a given amount of milliseconds.
  *
  * @param ms - Milliseconds to delay the execution for.
  * @param result - The result to return from the Promise after delay.
@@ -46,7 +46,7 @@ export declare const hasTimedOut: unique symbol;
  * @param timerOrMs - The timer controlling the timeout or a ms value.
  * @returns The resolved `PromiseValue`, or the hasTimedOut symbol if
  * returning early.
- * @template PromiseValue- - The value of the Promise.
+ * @template PromiseValue - The value of the Promise.
  */
 export declare function withTimeout<PromiseValue = void>(promise: Promise<PromiseValue>, timerOrMs: Timer | number): Promise<PromiseValue | typeof hasTimedOut>;
 /**
@@ -72,7 +72,7 @@ export declare function withTimeout<PromiseValue = void>(promise: Promise<Promis
  * // t5 = false;
  * ```
  */
-declare type IsLiteral<T> = T extends string | number | boolean | symbol ? Extract<string | number | boolean | symbol, T> extends never ? true : false : false;
+declare type IsLiteral<Type> = Type extends string | number | boolean | symbol ? Extract<string | number | boolean | symbol, Type> extends never ? true : false : false;
 /**
  * Returns all keys of an object, that are literal, as an union
  *
@@ -83,9 +83,9 @@ declare type IsLiteral<T> = T extends string | number | boolean | symbol ? Extra
  * ```
  * @see [Literal types]{@link https://www.typescriptlang.org/docs/handbook/literal-types.html}
  */
-declare type LiteralKeys<T> = NonNullable<{
-    [Key in keyof T]: IsLiteral<Key> extends true ? Key : never;
-}[keyof T]>;
+declare type LiteralKeys<Type> = NonNullable<{
+    [Key in keyof Type]: IsLiteral<Key> extends true ? Key : never;
+}[keyof Type]>;
 /**
  * Returns all keys of an object, that are not literal, as an union
  *
@@ -96,9 +96,9 @@ declare type LiteralKeys<T> = NonNullable<{
  * ```
  * @see [Literal types]{@link https://www.typescriptlang.org/docs/handbook/literal-types.html}
  */
-declare type NonLiteralKeys<T> = NonNullable<{
-    [Key in keyof T]: IsLiteral<Key> extends false ? Key : never;
-}[keyof T]>;
+declare type NonLiteralKeys<Type> = NonNullable<{
+    [Key in keyof Type]: IsLiteral<Key> extends false ? Key : never;
+}[keyof Type]>;
 /**
  * A set difference of two objects based on their keys
  *
@@ -113,16 +113,16 @@ declare type NonLiteralKeys<T> = NonNullable<{
  * ```
  * @see {@link setDiff} for the main use-case
  */
-export declare type Diff<A, B> = Omit<A, LiteralKeys<B>> & Partial<Pick<A, Extract<keyof A, NonLiteralKeys<B>>>>;
+export declare type Diff<First, Second> = Omit<First, LiteralKeys<Second>> & Partial<Pick<First, Extract<keyof First, NonLiteralKeys<Second>>>>;
 /**
  * Makes every specified property of the specified object type mutable.
  *
- * @template T - The object whose readonly properties to make mutable.
+ * @template Type - The object whose readonly properties to make mutable.
  * @template TargetKey - The property key(s) to make mutable.
  */
-export declare type Mutable<T extends Record<string, unknown>, TargetKey extends string> = {
-    -readonly [Key in keyof Pick<T, TargetKey>]: T[Key];
+export declare type Mutable<Type extends Record<string, unknown>, TargetKey extends string> = {
+    -readonly [Key in keyof Pick<Type, TargetKey>]: Type[Key];
 } & {
-    [Key in keyof Omit<T, TargetKey>]: T[Key];
+    [Key in keyof Omit<Type, TargetKey>]: Type[Key];
 };
 export {};

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "@metamask/snaps-controllers",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "Controllers for MetaMask Snaps.",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
   },
-  "main": "dist/index.js",
+  "sideEffects": false,
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
   "browser": {
-    "./dist/services": "./dist/services/browser.js"
+    "./dist/cjs/services": "./dist/cjs/services/browser.js",
+    "./dist/esm/services": "./dist/esm/services/browser.js"
   },
-  "types": "dist/index.d.ts",
+  "types": "./dist/types/index.d.ts",
   "files": [
-    "dist/"
+    "dist/cjs/**",
+    "dist/esm/**",
+    "dist/types/**"
   ],
   "scripts": {
     "test:prepare": "yarn mkdirp test/fixtures && ./scripts/generate-fixtures.sh",
@@ -20,97 +25,102 @@
     "posttest": "ts-node scripts/coverage.ts && rimraf coverage/jest coverage/wdio",
     "test:browser": "wdio run wdio.config.ts",
     "test:ci": "yarn test",
-    "build:tsc": "tsc --project tsconfig.build.json",
-    "build": "yarn build:tsc",
+    "build": "yarn build:source && yarn build:types",
+    "build:source": "yarn build:esm && yarn build:cjs",
+    "build:types": "tsc --project tsconfig.build.json",
+    "build:esm": "swc src --out-dir dist/esm --config-file ../../.swcrc.build.json --config module.type=es6",
+    "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:clean": "yarn clean && yarn build",
-    "clean": "rimraf '*.tsbuildinfo' 'dist/*'",
-    "lint:eslint": "eslint . --cache --ext js,ts",
-    "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' --ignore-path ../../.gitignore",
-    "lint": "yarn lint:eslint && yarn lint:misc --check",
+    "clean": "rimraf '*.tsbuildinfo' 'dist'",
+    "lint:eslint": "eslint . --cache --ext js,ts,jsx,tsx",
+    "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" --ignore-path ../../.gitignore",
+    "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog && yarn lint:dependencies",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
-    "lint:changelog": "yarn auto-changelog validate",
+    "lint:changelog": "../../scripts/validate-changelog.sh @metamask/snaps-controllers",
     "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
-    "publish:package": "../../scripts/publish-package.sh"
+    "lint:ci": "yarn lint",
+    "lint:dependencies": "depcheck"
   },
   "dependencies": {
-    "@metamask/approval-controller": "^3.0.0",
-    "@metamask/base-controller": "^3.0.0",
+    "@metamask/approval-controller": "^3.5.0",
+    "@metamask/base-controller": "^3.2.0",
     "@metamask/object-multiplex": "^1.2.0",
-    "@metamask/permission-controller": "^4.0.0",
-    "@metamask/post-message-stream": "^6.1.2",
-    "@metamask/rpc-methods": "^1.0.2",
-    "@metamask/snaps-execution-environments": "^1.0.2",
-    "@metamask/snaps-registry": "^1.2.1",
-    "@metamask/snaps-utils": "^1.0.2",
-    "@metamask/utils": "^6.0.1",
+    "@metamask/permission-controller": "^4.1.0",
+    "@metamask/post-message-stream": "^7.0.0",
+    "@metamask/rpc-methods": "^2.0.0",
+    "@metamask/snaps-execution-environments": "^2.0.0",
+    "@metamask/snaps-registry": "^2.0.0",
+    "@metamask/snaps-utils": "^2.0.0",
+    "@metamask/utils": "^8.1.0",
     "@xstate/fsm": "^2.0.0",
     "concat-stream": "^2.0.0",
-    "cron-parser": "^4.5.0",
-    "eth-rpc-errors": "^4.0.2",
+    "eth-rpc-errors": "^4.0.3",
     "gunzip-maybe": "^1.4.2",
     "immer": "^9.0.6",
     "json-rpc-engine": "^6.1.0",
     "json-rpc-middleware-stream": "^4.2.0",
     "nanoid": "^3.1.31",
-    "pump": "^3.0.0",
     "readable-web-to-node-stream": "^3.0.2",
     "tar-stream": "^2.2.0"
   },
   "devDependencies": {
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
-    "@lavamoat/allow-scripts": "^2.0.3",
+    "@lavamoat/allow-scripts": "^2.3.1",
     "@metamask/auto-changelog": "^3.1.0",
-    "@metamask/eslint-config": "^11.0.0",
-    "@metamask/eslint-config-jest": "^11.0.0",
-    "@metamask/eslint-config-nodejs": "^11.0.1",
-    "@metamask/eslint-config-typescript": "^11.0.0",
+    "@metamask/eslint-config": "^12.1.0",
+    "@metamask/eslint-config-jest": "^12.1.0",
+    "@metamask/eslint-config-nodejs": "^12.1.0",
+    "@metamask/eslint-config-typescript": "^12.1.0",
     "@metamask/template-snap": "^0.7.0",
-    "@peculiar/webcrypto": "^1.3.3",
+    "@swc/cli": "^0.1.62",
+    "@swc/core": "1.3.78",
+    "@swc/jest": "^0.2.26",
+    "@types/chrome": "^0.0.237",
     "@types/concat-stream": "^2.0.0",
     "@types/gunzip-maybe": "^1.4.0",
     "@types/jest": "^27.5.1",
     "@types/mocha": "^10.0.1",
-    "@types/pump": "^1.1.1",
+    "@types/node": "18.14.2",
     "@types/readable-stream": "^2.3.15",
     "@types/tar-stream": "^2.2.2",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.1",
-    "@wdio/browser-runner": "^8.3.10",
-    "@wdio/cli": "^8.3.10",
-    "@wdio/globals": "^8.3.10",
-    "@wdio/mocha-framework": "^8.3.0",
-    "@wdio/spec-reporter": "^8.3.0",
-    "@wdio/static-server-service": "^8.3.0",
+    "@wdio/browser-runner": "^8.15.9",
+    "@wdio/cli": "^8.15.9",
+    "@wdio/globals": "^8.15.9",
+    "@wdio/mocha-framework": "^8.15.9",
+    "@wdio/spec-reporter": "^8.15.7",
+    "@wdio/static-server-service": "^8.15.7",
     "deepmerge": "^4.2.2",
+    "depcheck": "^1.4.5",
+    "esbuild": "^0.18.10",
     "eslint": "^8.27.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jest": "^27.1.5",
     "eslint-plugin-jsdoc": "^39.6.2",
-    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.1.1",
     "expect-webdriverio": "^4.1.2",
     "istanbul-lib-coverage": "^3.2.0",
     "istanbul-lib-report": "^3.0.0",
     "istanbul-reports": "^3.1.5",
     "jest": "^29.0.2",
     "jest-fetch-mock": "^3.0.3",
-    "jest-it-up": "^2.0.0",
     "mkdirp": "^1.0.4",
     "prettier": "^2.7.1",
     "prettier-plugin-packagejson": "^2.2.11",
-    "rimraf": "^3.0.2",
-    "serve-handler": "^6.1.5",
-    "ts-jest": "^29.0.0",
+    "rimraf": "^4.1.2",
     "ts-node": "^10.9.1",
     "typescript": "~4.8.4",
     "vite": "^4.3.9",
     "vite-tsconfig-paths": "^4.0.5",
     "wdio-chromedriver-service": "^8.1.1",
-    "wdio-geckodriver-service": "^4.1.0",
-    "webdriverio": "^8.3.10"
+    "wdio-geckodriver-service": "^5.0.2",
+    "webdriverio": "^8.15.9"
   },
   "engines": {
     "node": ">=16.0.0"

package/dist/cronjob/CronjobController.js

@@ -1,248 +0,0 @@
-"use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _CronjobController_messenger, _CronjobController_dailyTimer, _CronjobController_timers, _CronjobController_snapIds;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CronjobController = exports.DAILY_TIMEOUT = void 0;
-const base_controller_1 = require("@metamask/base-controller");
-const snaps_utils_1 = require("@metamask/snaps-utils");
-const utils_1 = require("@metamask/utils");
-const __1 = require("..");
-const cronjob_1 = require("../snaps/endowments/cronjob");
-const Timer_1 = require("../snaps/Timer");
-exports.DAILY_TIMEOUT = (0, utils_1.inMilliseconds)(24, utils_1.Duration.Hour);
-const controllerName = 'CronjobController';
-/**
- * Use this controller to register and schedule periodically executed jobs
- * using RPC method hooks.
- */
-class CronjobController extends base_controller_1.BaseControllerV2 {
-    constructor({ messenger, state }) {
-        super({
-            messenger,
-            metadata: {
-                jobs: { persist: true, anonymous: false },
-            },
-            name: controllerName,
-            state: {
-                jobs: {},
-                ...state,
-            },
-        });
-        _CronjobController_messenger.set(this, void 0);
-        _CronjobController_dailyTimer.set(this, void 0);
-        _CronjobController_timers.set(this, void 0);
-        // Mapping from jobId to snapId
-        _CronjobController_snapIds.set(this, void 0);
-        __classPrivateFieldSet(this, _CronjobController_timers, new Map(), "f");
-        __classPrivateFieldSet(this, _CronjobController_snapIds, new Map(), "f");
-        __classPrivateFieldSet(this, _CronjobController_messenger, messenger, "f");
-        this._handleEventSnapInstalled = this._handleEventSnapInstalled.bind(this);
-        this._handleEventSnapRemoved = this._handleEventSnapRemoved.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);
-        this.messagingSystem.subscribe('SnapController:snapUpdated', this._handleEventSnapUpdated);
-        /* eslint-enable @typescript-eslint/unbound-method */
-        this.dailyCheckIn().catch((error) => {
-            (0, snaps_utils_1.logError)(error);
-        });
-    }
-    /**
-     * Retrieve all cronjob specifications for all runnable snaps.
-     *
-     * @returns Array of Cronjob specifications.
-     */
-    getAllJobs() {
-        const snaps = this.messagingSystem.call('SnapController:getAll');
-        const filteredSnaps = (0, __1.getRunnableSnaps)(snaps);
-        const jobs = filteredSnaps.map((snap) => this.getSnapJobs(snap.id));
-        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-        return jobs.flat().filter((job) => job !== undefined);
-    }
-    /**
-     * Retrieve all Cronjob specifications for a Snap.
-     *
-     * @param snapId - ID of a Snap.
-     * @returns Array of Cronjob specifications.
-     */
-    getSnapJobs(snapId) {
-        const permissions = __classPrivateFieldGet(this, _CronjobController_messenger, "f").call('PermissionController:getPermissions', snapId);
-        const permission = permissions?.[__1.SnapEndowments.Cronjob];
-        const definitions = (0, cronjob_1.getCronjobCaveatJobs)(permission);
-        return definitions?.map((definition, idx) => {
-            return { ...definition, id: `${snapId}-${idx}`, snapId };
-        });
-    }
-    /**
-     * Register cron jobs for a given snap by getting specification from a permission caveats.
-     * Once registered, each job will be scheduled.
-     *
-     * @param snapId - ID of a snap.
-     */
-    register(snapId) {
-        const jobs = this.getSnapJobs(snapId);
-        jobs?.forEach((job) => this.schedule(job));
-    }
-    /**
-     * Schedule a new job.
-     * This will interpret the cron expression and tell the timer to execute the job
-     * at the next suitable point in time.
-     * Job last run state will be initialized afterwards.
-     *
-     * Note: Schedule will be skipped if the job's execution time is too far in the future and
-     * will be revisited on a daily check.
-     *
-     * @param job - Cronjob specification.
-     */
-    schedule(job) {
-        if (__classPrivateFieldGet(this, _CronjobController_timers, "f").has(job.id)) {
-            return;
-        }
-        const parsed = (0, snaps_utils_1.parseCronExpression)(job.expression);
-        const next = parsed.next();
-        const now = new Date();
-        const ms = next.getTime() - now.getTime();
-        // Don't schedule this job yet as it is too far in the future
-        if (ms > exports.DAILY_TIMEOUT) {
-            return;
-        }
-        const timer = new Timer_1.Timer(ms);
-        timer.start(() => {
-            this.executeCronjob(job).catch((error) => {
-                // TODO: Decide how to handle errors.
-                (0, snaps_utils_1.logError)(error);
-            });
-            __classPrivateFieldGet(this, _CronjobController_timers, "f").delete(job.id);
-            this.schedule(job);
-        });
-        this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually
-        __classPrivateFieldGet(this, _CronjobController_timers, "f").set(job.id, timer);
-        __classPrivateFieldGet(this, _CronjobController_snapIds, "f").set(job.id, job.snapId);
-    }
-    /**
-     * Execute job.
-     *
-     * @param job - Cronjob specification.
-     */
-    async executeCronjob(job) {
-        this.updateJobLastRunState(job.id, Date.now());
-        await __classPrivateFieldGet(this, _CronjobController_messenger, "f").call('SnapController:handleRequest', {
-            snapId: job.snapId,
-            origin: '',
-            handler: snaps_utils_1.HandlerType.OnCronjob,
-            request: job.request,
-        });
-    }
-    /**
-     * Unregister all jobs related to the given snapId.
-     *
-     * @param snapId - ID of a snap.
-     */
-    unregister(snapId) {
-        const jobs = [...__classPrivateFieldGet(this, _CronjobController_snapIds, "f").entries()].filter(([_, jobSnapId]) => jobSnapId === snapId);
-        if (jobs.length) {
-            jobs.forEach(([id]) => {
-                const timer = __classPrivateFieldGet(this, _CronjobController_timers, "f").get(id);
-                if (timer) {
-                    timer.cancel();
-                    __classPrivateFieldGet(this, _CronjobController_timers, "f").delete(id);
-                    __classPrivateFieldGet(this, _CronjobController_snapIds, "f").delete(id);
-                }
-            });
-        }
-    }
-    /**
-     * Update time of a last run for the Cronjob specified by ID.
-     *
-     * @param jobId - ID of a cron job.
-     * @param lastRun - Unix timestamp when the job was last ran.
-     */
-    updateJobLastRunState(jobId, lastRun) {
-        this.update((state) => {
-            state.jobs[jobId] = {
-                lastRun,
-            };
-        });
-    }
-    /**
-     * Runs every 24 hours to check if new jobs need to be scheduled.
-     *
-     * This is necesary for longer running jobs that execute with more than 24 hours between them.
-     */
-    async dailyCheckIn() {
-        const jobs = this.getAllJobs();
-        for (const job of jobs) {
-            const parsed = (0, snaps_utils_1.parseCronExpression)(job.expression);
-            const lastRun = this.state.jobs[job.id]?.lastRun;
-            // If a job was supposed to run while we were shut down but wasn't we run it now
-            if (lastRun !== undefined &&
-                parsed.hasPrev() &&
-                parsed.prev().getTime() > lastRun) {
-                await this.executeCronjob(job);
-            }
-            // Try scheduling, will fail if an existing scheduled job is found
-            this.schedule(job);
-        }
-        __classPrivateFieldSet(this, _CronjobController_dailyTimer, new Timer_1.Timer(exports.DAILY_TIMEOUT), "f");
-        __classPrivateFieldGet(this, _CronjobController_dailyTimer, "f").start(() => {
-            this.dailyCheckIn().catch((error) => {
-                // TODO: Decide how to handle errors.
-                (0, snaps_utils_1.logError)(error);
-            });
-        });
-    }
-    /**
-     * 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);
-        this.messagingSystem.unsubscribe('SnapController:snapUpdated', this._handleEventSnapUpdated);
-        /* eslint-enable @typescript-eslint/unbound-method */
-        __classPrivateFieldGet(this, _CronjobController_snapIds, "f").forEach((snapId) => {
-            this.unregister(snapId);
-        });
-    }
-    /**
-     * Handle cron jobs on 'snapInstalled' event.
-     *
-     * @param snap - Basic Snap information.
-     */
-    _handleEventSnapInstalled(snap) {
-        this.register(snap.id);
-    }
-    /**
-     * Handle cron jobs on 'snapRemoved' event.
-     *
-     * @param snap - Basic Snap information.
-     */
-    _handleEventSnapRemoved(snap) {
-        this.unregister(snap.id);
-    }
-    /**
-     * Handle cron jobs on 'snapUpdated' event.
-     *
-     * @param snap - Basic Snap information.
-     */
-    _handleEventSnapUpdated(snap) {
-        this.unregister(snap.id);
-        this.register(snap.id);
-    }
-}
-exports.CronjobController = CronjobController;
-_CronjobController_messenger = new WeakMap(), _CronjobController_dailyTimer = new WeakMap(), _CronjobController_timers = new WeakMap(), _CronjobController_snapIds = new WeakMap();
-//# sourceMappingURL=CronjobController.js.map

package/dist/cronjob/CronjobController.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CronjobController.js","sourceRoot":"","sources":["../../src/cronjob/CronjobController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAGmC;AAEnC,uDAO+B;AAC/B,2CAA2D;AAE3D,0BAQY;AACZ,yDAAmE;AACnE,0CAAuC;AAiB1B,QAAA,aAAa,GAAG,IAAA,sBAAc,EAAC,EAAE,EAAE,gBAAQ,CAAC,IAAI,CAAC,CAAC;AAwB/D,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAE3C;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,kCAItC;IAUC,YAAY,EAAE,SAAS,EAAE,KAAK,EAAyB;QACrD,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE;gBACR,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;aAC1C;YACD,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,IAAI,EAAE,EAAE;gBACR,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QApBL,+CAAuC;QAEvC,gDAAoB;QAEpB,4CAA4B;QAE5B,+BAA+B;QAC/B,6CAA8B;QAc5B,uBAAA,IAAI,6BAAW,IAAI,GAAG,EAAE,MAAA,CAAC;QACzB,uBAAA,IAAI,8BAAY,IAAI,GAAG,EAAE,MAAA,CAAC;QAC1B,uBAAA,IAAI,gCAAc,SAAS,MAAA,CAAC;QAE5B,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvE,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEvE,2BAA2B;QAC3B,sDAAsD;QACtD,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,8BAA8B,EAC9B,IAAI,CAAC,yBAAyB,CAC/B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,4BAA4B,EAC5B,IAAI,CAAC,uBAAuB,CAC7B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,4BAA4B,EAC5B,IAAI,CAAC,uBAAuB,CAC7B,CAAC;QACF,qDAAqD;QAErD,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAClC,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,UAAU;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QACjE,MAAM,aAAa,GAAG,IAAA,oBAAgB,EAAC,KAAK,CAAC,CAAC;QAE9C,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACpE,4EAA4E;QAC5E,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,CAAc,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACK,WAAW,CAAC,MAAc;QAChC,MAAM,WAAW,GAAG,uBAAA,IAAI,oCAAW,CAAC,IAAI,CACtC,qCAAqC,EACrC,MAAM,CACP,CAAC;QAEF,MAAM,UAAU,GAAG,WAAW,EAAE,CAAC,kBAAc,CAAC,OAAO,CAAC,CAAC;QACzD,MAAM,WAAW,GAAG,IAAA,8BAAoB,EAAC,UAAU,CAAC,CAAC;QAErD,OAAO,WAAW,EAAE,GAAG,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;YAC1C,OAAO,EAAE,GAAG,UAAU,EAAE,EAAE,EAAE,GAAG,MAAM,IAAI,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,MAAc;QACrB,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;OAUG;IACK,QAAQ,CAAC,GAAY;QAC3B,IAAI,uBAAA,IAAI,iCAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YAC5B,OAAO;SACR;QAED,MAAM,MAAM,GAAG,IAAA,iCAAmB,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;QAE1C,6DAA6D;QAC7D,IAAI,EAAE,GAAG,qBAAa,EAAE;YACtB,OAAO;SACR;QAED,MAAM,KAAK,GAAG,IAAI,aAAK,CAAC,EAAE,CAAC,CAAC;QAC5B,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE;YACf,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACvC,qCAAqC;gBACrC,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;YAEH,uBAAA,IAAI,iCAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC5B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,iCAAiC;QACxE,uBAAA,IAAI,iCAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAChC,uBAAA,IAAI,kCAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,cAAc,CAAC,GAAY;QACvC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,MAAM,uBAAA,IAAI,oCAAW,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACzD,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,MAAM,EAAE,EAAE;YACV,OAAO,EAAE,yBAAW,CAAC,SAAS;YAC9B,OAAO,EAAE,GAAG,CAAC,OAAO;SACrB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,MAAc;QACvB,MAAM,IAAI,GAAG,CAAC,GAAG,uBAAA,IAAI,kCAAS,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAC9C,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,SAAS,KAAK,MAAM,CACzC,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBACpB,MAAM,KAAK,GAAG,uBAAA,IAAI,iCAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACnC,IAAI,KAAK,EAAE;oBACT,KAAK,CAAC,MAAM,EAAE,CAAC;oBACf,uBAAA,IAAI,iCAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBACxB,uBAAA,IAAI,kCAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;iBAC1B;YACH,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;;OAKG;IACK,qBAAqB,CAAC,KAAa,EAAE,OAAe;QAC1D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG;gBAClB,OAAO;aACR,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAE/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,MAAM,GAAG,IAAA,iCAAmB,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACnD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC;YACjD,gFAAgF;YAChF,IACE,OAAO,KAAK,SAAS;gBACrB,MAAM,CAAC,OAAO,EAAE;gBAChB,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,OAAO,EACjC;gBACA,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;aAChC;YAED,kEAAkE;YAClE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SACpB;QAED,uBAAA,IAAI,iCAAe,IAAI,aAAK,CAAC,qBAAa,CAAC,MAAA,CAAC;QAC5C,uBAAA,IAAI,qCAAY,CAAC,KAAK,CAAC,GAAG,EAAE;YAC1B,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAClC,qCAAqC;gBACrC,IAAA,sBAAQ,EAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,OAAO;QACL,KAAK,CAAC,OAAO,EAAE,CAAC;QAEhB,sDAAsD;QACtD,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,8BAA8B,EAC9B,IAAI,CAAC,yBAAyB,CAC/B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,4BAA4B,EAC5B,IAAI,CAAC,uBAAuB,CAC7B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,4BAA4B,EAC5B,IAAI,CAAC,uBAAuB,CAC7B,CAAC;QACF,qDAAqD;QAErD,uBAAA,IAAI,kCAAS,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC/B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,yBAAyB,CAAC,IAAmB;QACnD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACK,uBAAuB,CAAC,IAAmB;QACjD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACK,uBAAuB,CAAC,IAAmB;QACjD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;CACF;AA3RD,8CA2RC","sourcesContent":["import {\n  BaseControllerV2 as BaseController,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport { GetPermissions } from '@metamask/permission-controller';\nimport {\n  HandlerType,\n  SnapId,\n  TruncatedSnap,\n  CronjobSpecification,\n  parseCronExpression,\n  logError,\n} from '@metamask/snaps-utils';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport {\n  GetAllSnaps,\n  getRunnableSnaps,\n  HandleSnapRequest,\n  SnapEndowments,\n  SnapInstalled,\n  SnapRemoved,\n  SnapUpdated,\n} 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: SnapId;\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: SnapId): 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: SnapId) {\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"]}