@metamask/shield-controller 0.4.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,76 @@
1
+ "use strict";
2
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
3
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
4
+ 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");
5
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
6
+ };
7
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
8
+ if (kind === "m") throw new TypeError("Private method is not writable");
9
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
10
+ 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");
11
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
12
+ };
13
+ var _PollingWithCockatielPolicy_instances, _PollingWithCockatielPolicy_policy, _PollingWithCockatielPolicy_requestEntry, _PollingWithCockatielPolicy_addNewRequestEntry, _PollingWithCockatielPolicy_cleanup, _PollingWithCockatielPolicy_shouldRetry;
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.PollingWithCockatielPolicy = void 0;
16
+ const controller_utils_1 = require("@metamask/controller-utils");
17
+ const cockatiel_1 = require("cockatiel");
18
+ class PollingWithCockatielPolicy {
19
+ constructor(policyOptions = {}) {
20
+ _PollingWithCockatielPolicy_instances.add(this);
21
+ _PollingWithCockatielPolicy_policy.set(this, void 0);
22
+ _PollingWithCockatielPolicy_requestEntry.set(this, new Map());
23
+ const retryFilterPolicy = (0, cockatiel_1.handleWhen)(__classPrivateFieldGet(this, _PollingWithCockatielPolicy_instances, "m", _PollingWithCockatielPolicy_shouldRetry));
24
+ __classPrivateFieldSet(this, _PollingWithCockatielPolicy_policy, (0, controller_utils_1.createServicePolicy)({
25
+ ...policyOptions,
26
+ retryFilterPolicy,
27
+ }), "f");
28
+ }
29
+ async start(requestId, requestFn) {
30
+ const abortController = __classPrivateFieldGet(this, _PollingWithCockatielPolicy_instances, "m", _PollingWithCockatielPolicy_addNewRequestEntry).call(this, requestId);
31
+ try {
32
+ const result = await __classPrivateFieldGet(this, _PollingWithCockatielPolicy_policy, "f").execute(async ({ signal }) => {
33
+ return requestFn(signal);
34
+ }, abortController.signal);
35
+ return result;
36
+ }
37
+ catch (error) {
38
+ if (abortController.signal.aborted) {
39
+ throw new Error('Request cancelled');
40
+ }
41
+ throw error;
42
+ }
43
+ finally {
44
+ // Only cleanup if this abort controller is still active. If a new request with the same
45
+ // requestId started while this one was running, it would have replaced with a new abort controller.
46
+ // We must not delete the new request's controller when this older request finishes.
47
+ if (abortController === __classPrivateFieldGet(this, _PollingWithCockatielPolicy_requestEntry, "f").get(requestId)) {
48
+ __classPrivateFieldGet(this, _PollingWithCockatielPolicy_instances, "m", _PollingWithCockatielPolicy_cleanup).call(this, requestId);
49
+ }
50
+ }
51
+ }
52
+ abortPendingRequest(requestId) {
53
+ const abortController = __classPrivateFieldGet(this, _PollingWithCockatielPolicy_requestEntry, "f").get(requestId);
54
+ abortController?.abort();
55
+ __classPrivateFieldGet(this, _PollingWithCockatielPolicy_instances, "m", _PollingWithCockatielPolicy_cleanup).call(this, requestId);
56
+ }
57
+ }
58
+ exports.PollingWithCockatielPolicy = PollingWithCockatielPolicy;
59
+ _PollingWithCockatielPolicy_policy = new WeakMap(), _PollingWithCockatielPolicy_requestEntry = new WeakMap(), _PollingWithCockatielPolicy_instances = new WeakSet(), _PollingWithCockatielPolicy_addNewRequestEntry = function _PollingWithCockatielPolicy_addNewRequestEntry(requestId) {
60
+ // abort the previous request if it exists
61
+ this.abortPendingRequest(requestId);
62
+ // create a new abort controller for the new request
63
+ const abortController = new AbortController();
64
+ __classPrivateFieldGet(this, _PollingWithCockatielPolicy_requestEntry, "f").set(requestId, abortController);
65
+ return abortController;
66
+ }, _PollingWithCockatielPolicy_cleanup = function _PollingWithCockatielPolicy_cleanup(requestId) {
67
+ __classPrivateFieldGet(this, _PollingWithCockatielPolicy_requestEntry, "f").delete(requestId);
68
+ }, _PollingWithCockatielPolicy_shouldRetry = function _PollingWithCockatielPolicy_shouldRetry(error) {
69
+ if (error instanceof controller_utils_1.HttpError) {
70
+ // Note: we don't retry on 5xx errors, only on 4xx errors.
71
+ // but we won't retry on 400 coz it means that the request body is invalid.
72
+ return error.httpStatus > 400 && error.httpStatus < 500;
73
+ }
74
+ return false;
75
+ };
76
+ //# sourceMappingURL=polling-with-policy.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"polling-with-policy.cjs","sourceRoot":"","sources":["../src/polling-with-policy.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,iEAKoC;AACpC,yCAAuC;AAMvC,MAAa,0BAA0B;IAKrC,YAAY,gBAA4C,EAAE;;QAJjD,qDAAuB;QAEvB,mDAAgB,IAAI,GAAG,EAA2B,EAAC;QAG1D,MAAM,iBAAiB,GAAG,IAAA,sBAAU,EAAC,uBAAA,IAAI,sFAAa,CAAC,CAAC;QACxD,uBAAA,IAAI,sCAAW,IAAA,sCAAmB,EAAC;YACjC,GAAG,aAAa;YAChB,iBAAiB;SAClB,CAAC,MAAA,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK,CAAa,SAAiB,EAAE,SAAgC;QACzE,MAAM,eAAe,GAAG,uBAAA,IAAI,6FAAoB,MAAxB,IAAI,EAAqB,SAAS,CAAC,CAAC;QAE5D,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,0CAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBAC7D,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;YAC3B,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE;gBAClC,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;aACtC;YACD,MAAM,KAAK,CAAC;SACb;gBAAS;YACR,wFAAwF;YACxF,oGAAoG;YACpG,oFAAoF;YACpF,IAAI,eAAe,KAAK,uBAAA,IAAI,gDAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;gBACzD,uBAAA,IAAI,kFAAS,MAAb,IAAI,EAAU,SAAS,CAAC,CAAC;aAC1B;SACF;IACH,CAAC;IAED,mBAAmB,CAAC,SAAiB;QACnC,MAAM,eAAe,GAAG,uBAAA,IAAI,gDAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC1D,eAAe,EAAE,KAAK,EAAE,CAAC;QACzB,uBAAA,IAAI,kFAAS,MAAb,IAAI,EAAU,SAAS,CAAC,CAAC;IAC3B,CAAC;CAwBF;AAhED,gEAgEC;8QAtBqB,SAAiB;IACnC,0CAA0C;IAC1C,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAEpC,oDAAoD;IACpD,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAC9C,uBAAA,IAAI,gDAAc,CAAC,GAAG,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;IACnD,OAAO,eAAe,CAAC;AACzB,CAAC,qFAEQ,SAAiB;IACxB,uBAAA,IAAI,gDAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;AACvC,CAAC,6FAEY,KAAY;IACvB,IAAI,KAAK,YAAY,4BAAS,EAAE;QAC9B,0DAA0D;QAC1D,2EAA2E;QAC3E,OAAO,KAAK,CAAC,UAAU,GAAG,GAAG,IAAI,KAAK,CAAC,UAAU,GAAG,GAAG,CAAC;KACzD;IACD,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import {\n createServicePolicy,\n HttpError,\n type CreateServicePolicyOptions,\n type ServicePolicy,\n} from '@metamask/controller-utils';\nimport { handleWhen } from 'cockatiel';\n\nexport type RequestFn<ReturnType> = (\n signal: AbortSignal,\n) => Promise<ReturnType>;\n\nexport class PollingWithCockatielPolicy {\n readonly #policy: ServicePolicy;\n\n readonly #requestEntry = new Map<string, AbortController>();\n\n constructor(policyOptions: CreateServicePolicyOptions = {}) {\n const retryFilterPolicy = handleWhen(this.#shouldRetry);\n this.#policy = createServicePolicy({\n ...policyOptions,\n retryFilterPolicy,\n });\n }\n\n async start<ReturnType>(requestId: string, requestFn: RequestFn<ReturnType>) {\n const abortController = this.#addNewRequestEntry(requestId);\n\n try {\n const result = await this.#policy.execute(async ({ signal }) => {\n return requestFn(signal);\n }, abortController.signal);\n return result;\n } catch (error) {\n if (abortController.signal.aborted) {\n throw new Error('Request cancelled');\n }\n throw error;\n } finally {\n // Only cleanup if this abort controller is still active. If a new request with the same\n // requestId started while this one was running, it would have replaced with a new abort controller.\n // We must not delete the new request's controller when this older request finishes.\n if (abortController === this.#requestEntry.get(requestId)) {\n this.#cleanup(requestId);\n }\n }\n }\n\n abortPendingRequest(requestId: string) {\n const abortController = this.#requestEntry.get(requestId);\n abortController?.abort();\n this.#cleanup(requestId);\n }\n\n #addNewRequestEntry(requestId: string) {\n // abort the previous request if it exists\n this.abortPendingRequest(requestId);\n\n // create a new abort controller for the new request\n const abortController = new AbortController();\n this.#requestEntry.set(requestId, abortController);\n return abortController;\n }\n\n #cleanup(requestId: string) {\n this.#requestEntry.delete(requestId);\n }\n\n #shouldRetry(error: Error): boolean {\n if (error instanceof HttpError) {\n // Note: we don't retry on 5xx errors, only on 4xx errors.\n // but we won't retry on 400 coz it means that the request body is invalid.\n return error.httpStatus > 400 && error.httpStatus < 500;\n }\n return false;\n }\n}\n"]}
@@ -0,0 +1,9 @@
1
+ import { type CreateServicePolicyOptions } from "@metamask/controller-utils";
2
+ export type RequestFn<ReturnType> = (signal: AbortSignal) => Promise<ReturnType>;
3
+ export declare class PollingWithCockatielPolicy {
4
+ #private;
5
+ constructor(policyOptions?: CreateServicePolicyOptions);
6
+ start<ReturnType>(requestId: string, requestFn: RequestFn<ReturnType>): Promise<ReturnType>;
7
+ abortPendingRequest(requestId: string): void;
8
+ }
9
+ //# sourceMappingURL=polling-with-policy.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"polling-with-policy.d.cts","sourceRoot":"","sources":["../src/polling-with-policy.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,0BAA0B,EAEhC,mCAAmC;AAGpC,MAAM,MAAM,SAAS,CAAC,UAAU,IAAI,CAClC,MAAM,EAAE,WAAW,KAChB,OAAO,CAAC,UAAU,CAAC,CAAC;AAEzB,qBAAa,0BAA0B;;gBAKzB,aAAa,GAAE,0BAA+B;IAQpD,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC;IAuB3E,mBAAmB,CAAC,SAAS,EAAE,MAAM;CA4BtC"}
@@ -0,0 +1,9 @@
1
+ import { type CreateServicePolicyOptions } from "@metamask/controller-utils";
2
+ export type RequestFn<ReturnType> = (signal: AbortSignal) => Promise<ReturnType>;
3
+ export declare class PollingWithCockatielPolicy {
4
+ #private;
5
+ constructor(policyOptions?: CreateServicePolicyOptions);
6
+ start<ReturnType>(requestId: string, requestFn: RequestFn<ReturnType>): Promise<ReturnType>;
7
+ abortPendingRequest(requestId: string): void;
8
+ }
9
+ //# sourceMappingURL=polling-with-policy.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"polling-with-policy.d.mts","sourceRoot":"","sources":["../src/polling-with-policy.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,0BAA0B,EAEhC,mCAAmC;AAGpC,MAAM,MAAM,SAAS,CAAC,UAAU,IAAI,CAClC,MAAM,EAAE,WAAW,KAChB,OAAO,CAAC,UAAU,CAAC,CAAC;AAEzB,qBAAa,0BAA0B;;gBAKzB,aAAa,GAAE,0BAA+B;IAQpD,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC;IAuB3E,mBAAmB,CAAC,SAAS,EAAE,MAAM;CA4BtC"}
@@ -0,0 +1,72 @@
1
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
+ 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");
4
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
+ };
6
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
7
+ if (kind === "m") throw new TypeError("Private method is not writable");
8
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
9
+ 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");
10
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
11
+ };
12
+ var _PollingWithCockatielPolicy_instances, _PollingWithCockatielPolicy_policy, _PollingWithCockatielPolicy_requestEntry, _PollingWithCockatielPolicy_addNewRequestEntry, _PollingWithCockatielPolicy_cleanup, _PollingWithCockatielPolicy_shouldRetry;
13
+ import { createServicePolicy, HttpError } from "@metamask/controller-utils";
14
+ import { handleWhen } from "cockatiel";
15
+ export class PollingWithCockatielPolicy {
16
+ constructor(policyOptions = {}) {
17
+ _PollingWithCockatielPolicy_instances.add(this);
18
+ _PollingWithCockatielPolicy_policy.set(this, void 0);
19
+ _PollingWithCockatielPolicy_requestEntry.set(this, new Map());
20
+ const retryFilterPolicy = handleWhen(__classPrivateFieldGet(this, _PollingWithCockatielPolicy_instances, "m", _PollingWithCockatielPolicy_shouldRetry));
21
+ __classPrivateFieldSet(this, _PollingWithCockatielPolicy_policy, createServicePolicy({
22
+ ...policyOptions,
23
+ retryFilterPolicy,
24
+ }), "f");
25
+ }
26
+ async start(requestId, requestFn) {
27
+ const abortController = __classPrivateFieldGet(this, _PollingWithCockatielPolicy_instances, "m", _PollingWithCockatielPolicy_addNewRequestEntry).call(this, requestId);
28
+ try {
29
+ const result = await __classPrivateFieldGet(this, _PollingWithCockatielPolicy_policy, "f").execute(async ({ signal }) => {
30
+ return requestFn(signal);
31
+ }, abortController.signal);
32
+ return result;
33
+ }
34
+ catch (error) {
35
+ if (abortController.signal.aborted) {
36
+ throw new Error('Request cancelled');
37
+ }
38
+ throw error;
39
+ }
40
+ finally {
41
+ // Only cleanup if this abort controller is still active. If a new request with the same
42
+ // requestId started while this one was running, it would have replaced with a new abort controller.
43
+ // We must not delete the new request's controller when this older request finishes.
44
+ if (abortController === __classPrivateFieldGet(this, _PollingWithCockatielPolicy_requestEntry, "f").get(requestId)) {
45
+ __classPrivateFieldGet(this, _PollingWithCockatielPolicy_instances, "m", _PollingWithCockatielPolicy_cleanup).call(this, requestId);
46
+ }
47
+ }
48
+ }
49
+ abortPendingRequest(requestId) {
50
+ const abortController = __classPrivateFieldGet(this, _PollingWithCockatielPolicy_requestEntry, "f").get(requestId);
51
+ abortController?.abort();
52
+ __classPrivateFieldGet(this, _PollingWithCockatielPolicy_instances, "m", _PollingWithCockatielPolicy_cleanup).call(this, requestId);
53
+ }
54
+ }
55
+ _PollingWithCockatielPolicy_policy = new WeakMap(), _PollingWithCockatielPolicy_requestEntry = new WeakMap(), _PollingWithCockatielPolicy_instances = new WeakSet(), _PollingWithCockatielPolicy_addNewRequestEntry = function _PollingWithCockatielPolicy_addNewRequestEntry(requestId) {
56
+ // abort the previous request if it exists
57
+ this.abortPendingRequest(requestId);
58
+ // create a new abort controller for the new request
59
+ const abortController = new AbortController();
60
+ __classPrivateFieldGet(this, _PollingWithCockatielPolicy_requestEntry, "f").set(requestId, abortController);
61
+ return abortController;
62
+ }, _PollingWithCockatielPolicy_cleanup = function _PollingWithCockatielPolicy_cleanup(requestId) {
63
+ __classPrivateFieldGet(this, _PollingWithCockatielPolicy_requestEntry, "f").delete(requestId);
64
+ }, _PollingWithCockatielPolicy_shouldRetry = function _PollingWithCockatielPolicy_shouldRetry(error) {
65
+ if (error instanceof HttpError) {
66
+ // Note: we don't retry on 5xx errors, only on 4xx errors.
67
+ // but we won't retry on 400 coz it means that the request body is invalid.
68
+ return error.httpStatus > 400 && error.httpStatus < 500;
69
+ }
70
+ return false;
71
+ };
72
+ //# sourceMappingURL=polling-with-policy.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"polling-with-policy.mjs","sourceRoot":"","sources":["../src/polling-with-policy.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,mBAAmB,EACnB,SAAS,EAGV,mCAAmC;AACpC,OAAO,EAAE,UAAU,EAAE,kBAAkB;AAMvC,MAAM,OAAO,0BAA0B;IAKrC,YAAY,gBAA4C,EAAE;;QAJjD,qDAAuB;QAEvB,mDAAgB,IAAI,GAAG,EAA2B,EAAC;QAG1D,MAAM,iBAAiB,GAAG,UAAU,CAAC,uBAAA,IAAI,sFAAa,CAAC,CAAC;QACxD,uBAAA,IAAI,sCAAW,mBAAmB,CAAC;YACjC,GAAG,aAAa;YAChB,iBAAiB;SAClB,CAAC,MAAA,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK,CAAa,SAAiB,EAAE,SAAgC;QACzE,MAAM,eAAe,GAAG,uBAAA,IAAI,6FAAoB,MAAxB,IAAI,EAAqB,SAAS,CAAC,CAAC;QAE5D,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,0CAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBAC7D,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;YAC3B,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE;gBAClC,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;aACtC;YACD,MAAM,KAAK,CAAC;SACb;gBAAS;YACR,wFAAwF;YACxF,oGAAoG;YACpG,oFAAoF;YACpF,IAAI,eAAe,KAAK,uBAAA,IAAI,gDAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;gBACzD,uBAAA,IAAI,kFAAS,MAAb,IAAI,EAAU,SAAS,CAAC,CAAC;aAC1B;SACF;IACH,CAAC;IAED,mBAAmB,CAAC,SAAiB;QACnC,MAAM,eAAe,GAAG,uBAAA,IAAI,gDAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC1D,eAAe,EAAE,KAAK,EAAE,CAAC;QACzB,uBAAA,IAAI,kFAAS,MAAb,IAAI,EAAU,SAAS,CAAC,CAAC;IAC3B,CAAC;CAwBF;8QAtBqB,SAAiB;IACnC,0CAA0C;IAC1C,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAEpC,oDAAoD;IACpD,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAC9C,uBAAA,IAAI,gDAAc,CAAC,GAAG,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;IACnD,OAAO,eAAe,CAAC;AACzB,CAAC,qFAEQ,SAAiB;IACxB,uBAAA,IAAI,gDAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;AACvC,CAAC,6FAEY,KAAY;IACvB,IAAI,KAAK,YAAY,SAAS,EAAE;QAC9B,0DAA0D;QAC1D,2EAA2E;QAC3E,OAAO,KAAK,CAAC,UAAU,GAAG,GAAG,IAAI,KAAK,CAAC,UAAU,GAAG,GAAG,CAAC;KACzD;IACD,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import {\n createServicePolicy,\n HttpError,\n type CreateServicePolicyOptions,\n type ServicePolicy,\n} from '@metamask/controller-utils';\nimport { handleWhen } from 'cockatiel';\n\nexport type RequestFn<ReturnType> = (\n signal: AbortSignal,\n) => Promise<ReturnType>;\n\nexport class PollingWithCockatielPolicy {\n readonly #policy: ServicePolicy;\n\n readonly #requestEntry = new Map<string, AbortController>();\n\n constructor(policyOptions: CreateServicePolicyOptions = {}) {\n const retryFilterPolicy = handleWhen(this.#shouldRetry);\n this.#policy = createServicePolicy({\n ...policyOptions,\n retryFilterPolicy,\n });\n }\n\n async start<ReturnType>(requestId: string, requestFn: RequestFn<ReturnType>) {\n const abortController = this.#addNewRequestEntry(requestId);\n\n try {\n const result = await this.#policy.execute(async ({ signal }) => {\n return requestFn(signal);\n }, abortController.signal);\n return result;\n } catch (error) {\n if (abortController.signal.aborted) {\n throw new Error('Request cancelled');\n }\n throw error;\n } finally {\n // Only cleanup if this abort controller is still active. If a new request with the same\n // requestId started while this one was running, it would have replaced with a new abort controller.\n // We must not delete the new request's controller when this older request finishes.\n if (abortController === this.#requestEntry.get(requestId)) {\n this.#cleanup(requestId);\n }\n }\n }\n\n abortPendingRequest(requestId: string) {\n const abortController = this.#requestEntry.get(requestId);\n abortController?.abort();\n this.#cleanup(requestId);\n }\n\n #addNewRequestEntry(requestId: string) {\n // abort the previous request if it exists\n this.abortPendingRequest(requestId);\n\n // create a new abort controller for the new request\n const abortController = new AbortController();\n this.#requestEntry.set(requestId, abortController);\n return abortController;\n }\n\n #cleanup(requestId: string) {\n this.#requestEntry.delete(requestId);\n }\n\n #shouldRetry(error: Error): boolean {\n if (error instanceof HttpError) {\n // Note: we don't retry on 5xx errors, only on 4xx errors.\n // but we won't retry on 400 coz it means that the request body is invalid.\n return error.httpStatus > 400 && error.httpStatus < 500;\n }\n return false;\n }\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask/shield-controller",
3
- "version": "0.4.0",
3
+ "version": "1.1.0",
4
4
  "description": "Controller handling shield transaction coverage logic",
5
5
  "keywords": [
6
6
  "MetaMask",
@@ -47,16 +47,19 @@
47
47
  "since-latest-release": "../../scripts/since-latest-release.sh"
48
48
  },
49
49
  "dependencies": {
50
- "@metamask/base-controller": "^8.4.2",
51
- "@metamask/utils": "^11.8.1"
50
+ "@metamask/base-controller": "^9.0.0",
51
+ "@metamask/controller-utils": "^11.14.1",
52
+ "@metamask/messenger": "^0.3.0",
53
+ "@metamask/utils": "^11.8.1",
54
+ "cockatiel": "^3.1.2"
52
55
  },
53
56
  "devDependencies": {
54
57
  "@babel/runtime": "^7.23.9",
55
58
  "@lavamoat/allow-scripts": "^3.0.4",
56
59
  "@lavamoat/preinstall-always-fail": "^2.1.0",
57
60
  "@metamask/auto-changelog": "^3.4.4",
58
- "@metamask/signature-controller": "^34.0.1",
59
- "@metamask/transaction-controller": "^60.9.0",
61
+ "@metamask/signature-controller": "^35.0.0",
62
+ "@metamask/transaction-controller": "^61.0.0",
60
63
  "@ts-bridge/cli": "^0.6.1",
61
64
  "@types/jest": "^27.4.1",
62
65
  "deepmerge": "^4.2.2",
@@ -69,8 +72,8 @@
69
72
  "uuid": "^8.3.2"
70
73
  },
71
74
  "peerDependencies": {
72
- "@metamask/signature-controller": "^34.0.0",
73
- "@metamask/transaction-controller": "^60.0.0"
75
+ "@metamask/signature-controller": "^35.0.0",
76
+ "@metamask/transaction-controller": "^61.0.0"
74
77
  },
75
78
  "engines": {
76
79
  "node": "^18.18 || >=20"