Skip to content

feat: Add new metadata properties to Web3Auth controllers #6504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Sep 10, 2025
Merged

feat: Add new metadata properties to Web3Auth controllers #6504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9a33677
add metadata properties to `SubscriptionController`
GuillaumeRx Sep 9, 2025
16432b9
add metadata properties to `ShieldController`
GuillaumeRx Sep 9, 2025
0d338d2
add metadata properties to `SeedlessOnboardingController`
mikesposito Sep 9, 2025
6377abd
update changelogs
mikesposito Sep 9, 2025
365d207
update `includeInStateLogs` properties in `SeedlessOnboardingController`
GuillaumeRx Sep 9, 2025
1aae447
revert CHANGELOG update
GuillaumeRx Sep 9, 2025
ecd6a85
remove unused import
GuillaumeRx Sep 9, 2025
38bd6b5
Revert "update `includeInStateLogs` properties in `SeedlessOnboarding…
GuillaumeRx Sep 10, 2025
0c95596
update `pendingToBeRevokedTokens` metadata
GuillaumeRx Sep 10, 2025
e66248b
update tests
GuillaumeRx Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/seedless-onboarding-controller/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6504](https://github.com/MetaMask/core/pull/6504))

## [4.0.0]

### Added
Expand Down
241 changes: 240 additions & 1 deletion packages/seedless-onboarding-controller/src/SeedlessOnboardingController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import { keccak256AndHexify } from '@metamask/auth-network-utils';
import type { Messenger } from '@metamask/base-controller';
import {
deriveStateFromMetadata,
type Messenger,
} from '@metamask/base-controller';
import type { EncryptionKey } from '@metamask/browser-passworder';
import {
encrypt,
Expand Down Expand Up @@ -5432,4 +5435,240 @@ describe('SeedlessOnboardingController', () => {
);
});
});

describe('metadata', () => {
it('includes expected state in debug snapshots', async () => {
await withController(
{
state: {
accessToken: 'accessToken',
authPubKey: 'authPubKey',
authConnection: AuthConnection.Google,
authConnectionId: 'authConnectionId',
encryptedKeyringEncryptionKey: 'encryptedKeyringEncryptionKey',
encryptedSeedlessEncryptionKey: 'encryptedSeedlessEncryptionKey',
groupedAuthConnectionId: 'groupedAuthConnectionId',
isSeedlessOnboardingUserAuthenticated: true,
metadataAccessToken: 'metadataAccessToken',
nodeAuthTokens: [],
passwordOutdatedCache: {
isExpiredPwd: false,
timestamp: 1234567890,
},
pendingToBeRevokedTokens: [
{ refreshToken: 'refreshToken', revokeToken: 'revokeToken' },
],
refreshToken: 'refreshToken',
revokeToken: 'revokeToken',
socialBackupsMetadata: [],
socialLoginEmail: 'socialLoginEmail',
userId: 'userId',
vault: 'vault',
vaultEncryptionKey: 'vaultEncryptionKey',
vaultEncryptionSalt: 'vaultEncryptionSalt',
},
},
({ controller }) => {
expect(
deriveStateFromMetadata(
controller.state,
controller.metadata,
'anonymous',
),
).toMatchInlineSnapshot(`
Object {
"authConnection": "google",
"authConnectionId": "authConnectionId",
"groupedAuthConnectionId": "groupedAuthConnectionId",
"isSeedlessOnboardingUserAuthenticated": false,
"passwordOutdatedCache": Object {
"isExpiredPwd": false,
"timestamp": 1234567890,
},
}
`);
},
);
});

it('includes expected state in state logs', async () => {
await withController(
{
state: {
accessToken: 'accessToken',
authPubKey: 'authPubKey',
authConnection: AuthConnection.Google,
authConnectionId: 'authConnectionId',
encryptedKeyringEncryptionKey: 'encryptedKeyringEncryptionKey',
encryptedSeedlessEncryptionKey: 'encryptedSeedlessEncryptionKey',
groupedAuthConnectionId: 'groupedAuthConnectionId',
isSeedlessOnboardingUserAuthenticated: true,
metadataAccessToken: 'metadataAccessToken',
nodeAuthTokens: [],
passwordOutdatedCache: {
isExpiredPwd: false,
timestamp: 1234567890,
},
pendingToBeRevokedTokens: [
{ refreshToken: 'refreshToken', revokeToken: 'revokeToken' },
],
refreshToken: 'refreshToken',
revokeToken: 'revokeToken',
socialBackupsMetadata: [],
socialLoginEmail: 'socialLoginEmail',
userId: 'userId',
vault: 'vault',
vaultEncryptionKey: 'vaultEncryptionKey',
vaultEncryptionSalt: 'vaultEncryptionSalt',
},
},
({ controller }) => {
expect(
deriveStateFromMetadata(
controller.state,
controller.metadata,
'includeInStateLogs',
),
).toMatchInlineSnapshot(`
Object {
"accessToken": true,
"authConnection": "google",
"authConnectionId": "authConnectionId",
"authPubKey": "authPubKey",
"groupedAuthConnectionId": "groupedAuthConnectionId",
"isSeedlessOnboardingUserAuthenticated": false,
"metadataAccessToken": true,
"nodeAuthTokens": true,
"passwordOutdatedCache": Object {
"isExpiredPwd": false,
"timestamp": 1234567890,
},
"pendingToBeRevokedTokens": true,
"refreshToken": true,
"revokeToken": true,
"userId": "userId",
}
`);
},
);
});

it('persists expected state', async () => {
await withController(
{
state: {
accessToken: 'accessToken',
authPubKey: 'authPubKey',
authConnection: AuthConnection.Google,
authConnectionId: 'authConnectionId',
encryptedKeyringEncryptionKey: 'encryptedKeyringEncryptionKey',
encryptedSeedlessEncryptionKey: 'encryptedSeedlessEncryptionKey',
groupedAuthConnectionId: 'groupedAuthConnectionId',
isSeedlessOnboardingUserAuthenticated: true,
metadataAccessToken: 'metadataAccessToken',
nodeAuthTokens: [],
passwordOutdatedCache: {
isExpiredPwd: false,
timestamp: 1234567890,
},
pendingToBeRevokedTokens: [
{ refreshToken: 'refreshToken', revokeToken: 'revokeToken' },
],
refreshToken: 'refreshToken',
revokeToken: 'revokeToken',
socialBackupsMetadata: [],
socialLoginEmail: 'socialLoginEmail',
userId: 'userId',
vault: 'vault',
vaultEncryptionKey: 'vaultEncryptionKey',
vaultEncryptionSalt: 'vaultEncryptionSalt',
},
},
({ controller }) => {
expect(
deriveStateFromMetadata(
controller.state,
controller.metadata,
'persist',
),
).toMatchInlineSnapshot(`
Object {
"authConnection": "google",
"authConnectionId": "authConnectionId",
"authPubKey": "authPubKey",
"encryptedKeyringEncryptionKey": "encryptedKeyringEncryptionKey",
"encryptedSeedlessEncryptionKey": "encryptedSeedlessEncryptionKey",
"groupedAuthConnectionId": "groupedAuthConnectionId",
"isSeedlessOnboardingUserAuthenticated": false,
"metadataAccessToken": "metadataAccessToken",
"nodeAuthTokens": Array [],
"passwordOutdatedCache": Object {
"isExpiredPwd": false,
"timestamp": 1234567890,
},
"pendingToBeRevokedTokens": Array [
Object {
"refreshToken": "refreshToken",
"revokeToken": "revokeToken",
},
],
"refreshToken": "refreshToken",
"socialBackupsMetadata": Array [],
"socialLoginEmail": "socialLoginEmail",
"userId": "userId",
"vault": "vault",
}
`);
},
);
});

it('exposes expected state to UI', async () => {
await withController(
{
state: {
accessToken: 'accessToken',
authPubKey: 'authPubKey',
authConnection: AuthConnection.Google,
authConnectionId: 'authConnectionId',
encryptedKeyringEncryptionKey: 'encryptedKeyringEncryptionKey',
encryptedSeedlessEncryptionKey: 'encryptedSeedlessEncryptionKey',
groupedAuthConnectionId: 'groupedAuthConnectionId',
isSeedlessOnboardingUserAuthenticated: true,
metadataAccessToken: 'metadataAccessToken',
nodeAuthTokens: [],
passwordOutdatedCache: {
isExpiredPwd: false,
timestamp: 1234567890,
},
pendingToBeRevokedTokens: [
{ refreshToken: 'refreshToken', revokeToken: 'revokeToken' },
],
refreshToken: 'refreshToken',
revokeToken: 'revokeToken',
socialBackupsMetadata: [],
socialLoginEmail: 'socialLoginEmail',
userId: 'userId',
vault: 'vault',
vaultEncryptionKey: 'vaultEncryptionKey',
vaultEncryptionSalt: 'vaultEncryptionSalt',
},
},
({ controller }) => {
expect(
deriveStateFromMetadata(
controller.state,
controller.metadata,
'usedInUi',
),
).toMatchInlineSnapshot(`
Object {
"authConnection": "google",
"socialLoginEmail": "socialLoginEmail",
}
`);
},
);
});
});
});
Loading
Loading