@metamask-previews/ramps-controller 13.2.0-preview-95a687acf → 13.2.0-preview-4e0ae1bc9

package/CHANGELOG.md

@@ -12,6 +12,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Bump `@metamask/messenger` from `^1.1.1` to `^1.2.0` ([#8632](https://github.com/MetaMask/core/pull/8632))
 - `RampsService` routes `RampsEnvironment.Development` to dev-api base URLs; regions requests in development omit the `-cache` hostname segment used in staging and production ([#8574](https://github.com/MetaMask/core/pull/8574))
 
+### Fixed
+
+- Tag circuit-breaker errors in `RampsController` with a stable `CIRCUIT_BREAKER_OPEN` error key so clients can localize the fallback copy without depending on internal Cockatiel text ([#8596](https://github.com/MetaMask/core/pull/8596)).
+
 ## [13.2.0]
 
 ### Changed

package/dist/RampsController.cjs

@@ -10,10 +10,12 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     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 _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_pendingResourceGeneration, _RampsController_orderPollingMeta, _RampsController_orderPollingTimer, _RampsController_isPolling, _RampsController_initPromise, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_abortDependentRequests, _RampsController_mutateRequests, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_requireRegion, _RampsController_isRegionCurrent, _RampsController_isTokenCurrent, _RampsController_isProviderCurrent, _RampsController_updateResourceField, _RampsController_setResourceLoading, _RampsController_setResourceError, _RampsController_updateRequestState, _RampsController_runInit, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _RampsController_syncTransakAuthOnError;
+var _RampsController_instances, _RampsController_requestCacheTTL, _RampsController_requestCacheMaxSize, _RampsController_pendingRequests, _RampsController_pendingResourceCount, _RampsController_pendingResourceGeneration, _RampsController_orderPollingMeta, _RampsController_orderPollingTimer, _RampsController_isPolling, _RampsController_initPromise, _RampsController_clearPendingResourceCountForDependentResources, _RampsController_abortDependentRequests, _RampsController_mutateRequests, _RampsController_removeRequestState, _RampsController_cleanupState, _RampsController_requireRegion, _RampsController_isRegionCurrent, _RampsController_isTokenCurrent, _RampsController_isProviderCurrent, _RampsController_updateResourceField, _RampsController_setResourceLoading, _RampsController_setResourceError, _RampsController_updateRequestState, _RampsController_runInit, _RampsController_refreshOrder, _RampsController_pollPendingOrders, _RampsController_syncTransakAuthOnError, _RampsController_getNormalizedTransakError;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RampsController = exports.normalizeProviderCode = exports.getDefaultRampsControllerState = exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+const rampsErrorCodes_1 = require("./rampsErrorCodes.cjs");
 const RampsService_1 = require("./RampsService.cjs");
 const RequestCache_1 = require("./RequestCache.cjs");
 // === GENERAL ===
@@ -68,6 +70,60 @@ exports.RAMPS_CONTROLLER_REQUIRED_SERVICE_ACTIONS = [
  * Quotes are time-sensitive and should have a shorter cache duration.
  */
 const DEFAULT_QUOTES_TTL = 15000;
+const CIRCUIT_BREAKER_OPEN_ERROR = 'Execution prevented because the circuit breaker is open';
+function hasStringMessage(error) {
+    return (typeof error === 'object' &&
+        error !== null &&
+        typeof error.message === 'string');
+}
+function hasHttpStatus(error) {
+    return (error instanceof Error &&
+        typeof error.httpStatus === 'number');
+}
+function getRampsErrorInfo(error) {
+    if (error instanceof controller_utils_1.BrokenCircuitError && hasStringMessage(error)) {
+        return {
+            errorKey: rampsErrorCodes_1.RAMPS_ERROR_CODES.CIRCUIT_BREAKER_OPEN,
+            message: error.message,
+        };
+    }
+    let rawMessage;
+    if (hasStringMessage(error)) {
+        rawMessage = error.message;
+    }
+    else if (typeof error === 'string') {
+        rawMessage = error;
+    }
+    if (rawMessage?.includes(CIRCUIT_BREAKER_OPEN_ERROR)) {
+        return {
+            errorKey: rampsErrorCodes_1.RAMPS_ERROR_CODES.CIRCUIT_BREAKER_OPEN,
+            message: rawMessage,
+        };
+    }
+    return {
+        errorKey: null,
+        message: rawMessage ?? 'Unknown error',
+    };
+}
+function getNormalizedRampsError(error) {
+    const errorInfo = getRampsErrorInfo(error);
+    return {
+        errorInfo,
+        normalizedError: normalizeRampsErrorForRethrow(error, errorInfo),
+    };
+}
+function normalizeRampsErrorForRethrow(error, errorInfo) {
+    if (!errorInfo.errorKey) {
+        return error;
+    }
+    if (error instanceof Error) {
+        error.errorKey = errorInfo.errorKey;
+        return error;
+    }
+    return Object.assign(new Error(errorInfo.message), {
+        errorKey: errorInfo.errorKey,
+    });
+}
 /**
  * The metadata for each property in {@link RampsControllerState}.
  */
@@ -179,12 +235,28 @@ const DEPENDENT_RESOURCE_KEYS = [
     'paymentMethods',
 ];
 const DEPENDENT_RESOURCE_KEYS_SET = new Set(DEPENDENT_RESOURCE_KEYS);
+function getResourceState(state, resourceType) {
+    switch (resourceType) {
+        case 'countries':
+            return state.countries;
+        case 'providers':
+            return state.providers;
+        case 'tokens':
+            return state.tokens;
+        case 'paymentMethods':
+            return state.paymentMethods;
+        /* istanbul ignore next -- ResourceType is a closed internal union. */
+        default:
+            throw new Error(`Unsupported resource type: ${resourceType}`);
+    }
+}
 function resetResource(state, resourceType, defaultResource) {
-    const resource = state[resourceType];
+    const resource = getResourceState(state, resourceType);
     resource.data = defaultResource.data;
     resource.selected = defaultResource.selected;
     resource.isLoading = defaultResource.isLoading;
     resource.error = defaultResource.error;
+    resource.errorKey = defaultResource.errorKey ?? null;
 }
 /**
  * Resets region-dependent resources (userRegion, providers, tokens, paymentMethods).
@@ -474,15 +546,15 @@ class RampsController extends base_controller_1.BaseController {
                 if (abortController.signal.aborted) {
                     throw error;
                 }
-                const errorMessage = error?.message ?? 'Unknown error';
-                __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_updateRequestState).call(this, cacheKey, (0, RequestCache_1.createErrorState)(errorMessage, lastFetchedAt));
+                const { errorInfo, normalizedError } = getNormalizedRampsError(error);
+                __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_updateRequestState).call(this, cacheKey, (0, RequestCache_1.createErrorState)(errorInfo.message, lastFetchedAt, errorInfo.errorKey));
                 if (resourceType) {
                     const isCurrent = !options?.isResultCurrent || options.isResultCurrent();
                     if (isCurrent) {
-                        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceError).call(this, resourceType, errorMessage);
+                        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_setResourceError).call(this, resourceType, errorInfo);
                     }
                 }
-                throw error;
+                throw normalizedError;
             }
             finally {
                 if (__classPrivateFieldGet(this, _RampsController_pendingRequests, "f").get(cacheKey)?.abortController ===
@@ -1179,7 +1251,12 @@ class RampsController extends base_controller_1.BaseController {
      * @returns The OTP response containing a state token for verification.
      */
     async transakSendUserOtp(email) {
-        return this.messenger.call('TransakService:sendUserOtp', email);
+        try {
+            return await this.messenger.call('TransakService:sendUserOtp', email);
+        }
+        catch (error) {
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error).normalizedError;
+        }
     }
     /**
      * Verifies a one-time password and authenticates the user with Transak.
@@ -1191,9 +1268,14 @@ class RampsController extends base_controller_1.BaseController {
      * @returns The access token for subsequent authenticated requests.
      */
     async transakVerifyUserOtp(email, verificationCode, stateToken) {
-        const token = await this.messenger.call('TransakService:verifyUserOtp', email, verificationCode, stateToken);
-        this.transakSetAuthenticated(true);
-        return token;
+        try {
+            const token = await this.messenger.call('TransakService:verifyUserOtp', email, verificationCode, stateToken);
+            this.transakSetAuthenticated(true);
+            return token;
+        }
+        catch (error) {
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error).normalizedError;
+        }
     }
     /**
      * Logs the user out of Transak. Clears authentication state and user details
@@ -1203,8 +1285,10 @@ class RampsController extends base_controller_1.BaseController {
      */
     async transakLogout() {
         try {
-            const result = await this.messenger.call('TransakService:logout');
-            return result;
+            return await this.messenger.call('TransakService:logout');
+        }
+        catch (error) {
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error).normalizedError;
         }
         finally {
             this.transakClearAccessToken();
@@ -1223,6 +1307,7 @@ class RampsController extends base_controller_1.BaseController {
         this.update((state) => {
             state.nativeProviders.transak.userDetails.isLoading = true;
             state.nativeProviders.transak.userDetails.error = null;
+            delete state.nativeProviders.transak.userDetails.errorKey;
         });
         try {
             const details = await this.messenger.call('TransakService:getUserDetails');
@@ -1233,13 +1318,15 @@ class RampsController extends base_controller_1.BaseController {
             return details;
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            const errorMessage = error?.message ?? 'Unknown error';
+            const { errorInfo, normalizedError } = __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, {
+                syncAuth: true,
+            });
             this.update((state) => {
                 state.nativeProviders.transak.userDetails.isLoading = false;
-                state.nativeProviders.transak.userDetails.error = errorMessage;
+                state.nativeProviders.transak.userDetails.error = errorInfo.message;
+                state.nativeProviders.transak.userDetails.errorKey = errorInfo.errorKey;
             });
-            throw error;
+            throw normalizedError;
         }
     }
     /**
@@ -1257,6 +1344,7 @@ class RampsController extends base_controller_1.BaseController {
         this.update((state) => {
             state.nativeProviders.transak.buyQuote.isLoading = true;
             state.nativeProviders.transak.buyQuote.error = null;
+            delete state.nativeProviders.transak.buyQuote.errorKey;
         });
         try {
             const quote = await this.messenger.call('TransakService:getBuyQuote', fiatCurrency, cryptoCurrency, network, paymentMethod, fiatAmount);
@@ -1267,12 +1355,13 @@ class RampsController extends base_controller_1.BaseController {
             return quote;
         }
         catch (error) {
-            const errorMessage = error?.message ?? 'Unknown error';
+            const { errorInfo, normalizedError } = __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error);
             this.update((state) => {
                 state.nativeProviders.transak.buyQuote.isLoading = false;
-                state.nativeProviders.transak.buyQuote.error = errorMessage;
+                state.nativeProviders.transak.buyQuote.error = errorInfo.message;
+                state.nativeProviders.transak.buyQuote.errorKey = errorInfo.errorKey;
             });
-            throw error;
+            throw normalizedError;
         }
     }
     /**
@@ -1286,6 +1375,7 @@ class RampsController extends base_controller_1.BaseController {
         this.update((state) => {
             state.nativeProviders.transak.kycRequirement.isLoading = true;
             state.nativeProviders.transak.kycRequirement.error = null;
+            delete state.nativeProviders.transak.kycRequirement.errorKey;
         });
         try {
             const requirement = await this.messenger.call('TransakService:getKycRequirement', quoteId);
@@ -1296,13 +1386,16 @@ class RampsController extends base_controller_1.BaseController {
             return requirement;
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            const errorMessage = error?.message ?? 'Unknown error';
+            const { errorInfo, normalizedError } = __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, {
+                syncAuth: true,
+            });
             this.update((state) => {
                 state.nativeProviders.transak.kycRequirement.isLoading = false;
-                state.nativeProviders.transak.kycRequirement.error = errorMessage;
+                state.nativeProviders.transak.kycRequirement.error = errorInfo.message;
+                state.nativeProviders.transak.kycRequirement.errorKey =
+                    errorInfo.errorKey;
             });
-            throw error;
+            throw normalizedError;
         }
     }
     /**
@@ -1316,8 +1409,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:getAdditionalRequirements', quoteId);
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
     /**
@@ -1334,8 +1427,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:createOrder', quoteId, walletAddress, paymentMethodId);
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
     /**
@@ -1347,7 +1440,12 @@ class RampsController extends base_controller_1.BaseController {
      * @returns The deposit order details.
      */
     async transakGetOrder(orderId, wallet, paymentDetails) {
-        return this.messenger.call('TransakService:getOrder', orderId, wallet, paymentDetails);
+        try {
+            return await this.messenger.call('TransakService:getOrder', orderId, wallet, paymentDetails);
+        }
+        catch (error) {
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error).normalizedError;
+        }
     }
     /**
      * Fetches the user's spending limits for a given currency and payment method.
@@ -1362,8 +1460,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:getUserLimits', fiatCurrency, paymentMethod, kycType);
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
     /**
@@ -1376,8 +1474,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:requestOtt');
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
     /**
@@ -1403,8 +1501,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:submitPurposeOfUsageForm', purpose);
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
     /**
@@ -1418,8 +1516,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:patchUser', data);
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
     /**
@@ -1434,8 +1532,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:submitSsnDetails', ssn, quoteId);
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
     /**
@@ -1450,8 +1548,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:confirmPayment', orderId, paymentMethodId);
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
     /**
@@ -1461,7 +1559,12 @@ class RampsController extends base_controller_1.BaseController {
      * @returns The translated Transak-specific identifiers.
      */
     async transakGetTranslation(request) {
-        return this.messenger.call('TransakService:getTranslation', request);
+        try {
+            return await this.messenger.call('TransakService:getTranslation', request);
+        }
+        catch (error) {
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error).normalizedError;
+        }
     }
     /**
      * Checks the status of an ID proof submission for KYC.
@@ -1474,8 +1577,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:getIdProofStatus', workFlowRunId);
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
     /**
@@ -1489,8 +1592,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:cancelOrder', depositOrderId);
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
     /**
@@ -1504,8 +1607,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:cancelAllActiveOrders');
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
     /**
@@ -1518,8 +1621,8 @@ class RampsController extends base_controller_1.BaseController {
             return await this.messenger.call('TransakService:getActiveOrders');
         }
         catch (error) {
-            __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
-            throw error;
+            throw __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_getNormalizedTransakError).call(this, error, { syncAuth: true })
+                .normalizedError;
         }
     }
 }
@@ -1569,15 +1672,17 @@ _RampsController_requestCacheTTL = new WeakMap(), _RampsController_requestCacheM
     return current === normalizedProviderId;
 }, _RampsController_updateResourceField = function _RampsController_updateResourceField(resourceType, field, value) {
     this.update((state) => {
-        const resource = state[resourceType];
-        if (resource) {
-            resource[field] = value;
-        }
+        const resource = getResourceState(state, resourceType);
+        resource[field] = value;
     });
 }, _RampsController_setResourceLoading = function _RampsController_setResourceLoading(resourceType, loading) {
     __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_updateResourceField).call(this, resourceType, 'isLoading', loading);
-}, _RampsController_setResourceError = function _RampsController_setResourceError(resourceType, error) {
-    __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_updateResourceField).call(this, resourceType, 'error', error);
+}, _RampsController_setResourceError = function _RampsController_setResourceError(resourceType, errorInfo) {
+    this.update((state) => {
+        const resource = getResourceState(state, resourceType);
+        resource.error = errorInfo?.message ?? null;
+        resource.errorKey = errorInfo?.errorKey ?? null;
+    });
 }, _RampsController_updateRequestState = function _RampsController_updateRequestState(cacheKey, requestState) {
     const maxSize = __classPrivateFieldGet(this, _RampsController_requestCacheMaxSize, "f");
     const ttl = __classPrivateFieldGet(this, _RampsController_requestCacheTTL, "f");
@@ -1697,10 +1802,13 @@ async function _RampsController_refreshOrder(order) {
         __classPrivateFieldSet(this, _RampsController_isPolling, false, "f");
     }
 }, _RampsController_syncTransakAuthOnError = function _RampsController_syncTransakAuthOnError(error) {
-    if (error instanceof Error &&
-        'httpStatus' in error &&
-        error.httpStatus === 401) {
+    if (hasHttpStatus(error) && error.httpStatus === 401) {
         this.transakSetAuthenticated(false);
     }
+}, _RampsController_getNormalizedTransakError = function _RampsController_getNormalizedTransakError(error, options = {}) {
+    if (options.syncAuth) {
+        __classPrivateFieldGet(this, _RampsController_instances, "m", _RampsController_syncTransakAuthOnError).call(this, error);
+    }
+    return getNormalizedRampsError(error);
 };
 //# sourceMappingURL=RampsController.cjs.map