Commit a3ec12c
authored
feat(card): Card Authentication migration from CardSDK to CardController (#27656)
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->
## **Description**
Migrates Card authentication to the CardController, introducing a
controller-based auth flow that delegates to BaanxProvider and a new
`useCardAuth` hook for UI consumption.
**Why**: Centralizing auth logic in the CardController aligns with the
MetaMask controller architecture, provides a single source of truth for
auth state, and enables future provider-agnostic auth flows. The new
`useCardAuth` hook exposes mutations (initiate, submit, stepAction,
logout) backed by the controller, with React Query for cache
invalidation on success.
**What changed**:
- **CardController**: Added auth methods `initiateAuth`,
`submitCredentials`, `executeStepAction`, and `logout` that delegate to
the active provider (BaanxProvider). Manages `currentSession` for
multi-step flows (email/password → OTP → complete).
- **BaanxProvider**: Implemented `executeStepAction` (generic OTP
trigger) that posts `userId` to `/v1/auth/login/otp`. Renamed from
provider-specific `sendOtp` to align with `ICardProvider` interface.
- **provider-types**: Added optional `executeStepAction?(session:
CardAuthSession): Promise<void>` to `ICardProvider`.
- **useCardAuth hook**: New hook exposing `currentStep`, `initiate`,
`submit`, `stepAction`, and `logout` mutations. Uses CardController for
all auth operations; updates `currentStep` on submit results (OTP,
onboarding required, done); invalidates card queries on login success;
removes queries on logout.
- **auth queries**: Added `authKeys` (initiate, submit, step-action,
logout) to `cardQueries.auth.keys`.
- **getCardProviderErrorMessage**: New utility mapping
`CardProviderError` codes to localized strings for Card authentication
UI.
- **BaanxService / baanx-config**: Minor adjustments for config
resolution and service usage.
- **Tests**: Updated BaanxProvider tests (`sendOtp` →
`executeStepAction`); fixed baanx-config test mock isolation with
`beforeEach` mock clear; expanded CardController tests for auth methods;
added `useCardAuth` unit tests.
## **Changelog**
CHANGELOG entry: Migrated Card authentication to CardController with new
`useCardAuth` hook for controller-based auth flow.
## **Related issues**
Fixes:
## **Manual testing steps**
```gherkin
Feature: Card authentication via CardController
Scenario: User logs in with email and password (no OTP)
Given I am on the Card authentication screen
And I have valid email and password credentials
When I enter my email and password
And I tap the login button
Then I should be authenticated and see the Card home/dashboard
Scenario: User logs in with email, password, and OTP
Given I am on the Card authentication screen
And I have credentials that require OTP verification
When I enter my email and password
And I tap the login button
Then I should see the OTP input screen
When I tap "Resend code" (or wait for cooldown)
Then an OTP should be sent to my device/email
When I enter the OTP code and submit
Then I should be authenticated and see the Card home/dashboard
Scenario: User logs out
Given I am authenticated in the Card flow
When I log out (or navigate away and return to auth)
Then I should see the login screen again
And card queries should be cleared
```
## **Screenshots/Recordings**
No visual design changes — authentication flow (email/password, OTP,
logout) behaves the same; only the underlying implementation
(CardController + useCardAuth vs SDK) changed.
## **Pre-merge author checklist**
- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I've included tests if applicable
- [x] I've documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I've applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.
## **Pre-merge reviewer checklist**
- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> **High Risk**
> High risk because it introduces a new controller-driven
authentication/session lifecycle (multi-step auth, token storage,
refresh, and logout) and changes default provider selection/state, which
can impact login persistence and security-sensitive flows.
>
> **Overview**
> Migrates card authentication off the UI/SDK path into
`CardController`, adding controller-level methods for `initiateAuth`,
`submitCredentials`, `executeStepAction`, `logout`, and
`validateAndRefreshSession` with token persistence via `CardTokenStore`,
provider delegation, and session/step tracking.
>
> Adds a new UI hook `useCardAuth` backed by React Query mutations (with
new `cardQueries.auth` keys) to drive the multi-step login flow and to
invalidate/remove card queries on login/logout.
>
> Standardizes provider step actions by renaming `ICardProvider.sendOtp`
to `executeStepAction` and updating `BaanxProvider` accordingly, plus
adds localized error mapping via `getCardProviderErrorMessage` and
extends Baanx config/service behavior (env override for base URL;
per-request location override for `x-us-env`).
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
a91ba19. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->1 parent 62cbdf5 commit a3ec12c
18 files changed
Lines changed: 1159 additions & 23 deletions
File tree
- app
- components/UI/Card
- hooks
- queries
- util
- core/Engine/controllers/card-controller
- providers
- services
- util
- logs/__snapshots__
- test
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
| |||
22 | 23 | | |
23 | 24 | | |
24 | 25 | | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
25 | 29 | | |
0 commit comments