Skip to content

Conversation

@GuillaumeRx
Copy link
Contributor

@GuillaumeRx GuillaumeRx commented Sep 9, 2025

Explanation

The new metadata properties includeInStateLogs and usedInUi have been added to all controllers maintained by the Web3Auth team.

References

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@GuillaumeRx GuillaumeRx force-pushed the gr/add-new-metadata-web3auth-controllers branch 2 times, most recently from 0957aef to 17317a4 Compare September 9, 2025 12:20
@GuillaumeRx GuillaumeRx marked this pull request as ready for review September 9, 2025 12:21
@GuillaumeRx GuillaumeRx requested review from a team as code owners September 9, 2025 12:21
cursor[bot]

This comment was marked as outdated.

Copy link
Contributor

@matthiasgeihs matthiasgeihs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for creating the PR.

Note that several values need to be changed. In particular, access tokens should not be part of the state log.

@matthiasgeihs
Copy link
Contributor

Note that several values need to be changed. In particular, access tokens should not be part of the state log.

Sorry, that was wrong. I misread the code and thought it would conditionally include the values, depending on whether they are present or not. Now I understand that includeInStateLogs: (refreshToken) => !isNullOrUndefined(refreshToken), converts the token into a boolean value for the state logs. So all these actually looked good. Only for the pendingToBeRevokedTokens value the metadata properties needed to be added. Sorry again.

Copy link
Contributor

@matthiasgeihs matthiasgeihs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, can you please revert some of my requested changes. There was a misunderstanding on my end. See #6504 (comment).

Comment on lines +185 to +187
includeInStateLogs: (pendingToBeRevokedTokens) =>
!isNullOrUndefined(pendingToBeRevokedTokens) &&
pendingToBeRevokedTokens.length > 0,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to be more creative here as the controller sometimes sets this key to an empty array

Copy link
Contributor

@matthiasgeihs matthiasgeihs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@GuillaumeRx GuillaumeRx enabled auto-merge (squash) September 10, 2025 09:58
@GuillaumeRx GuillaumeRx force-pushed the gr/add-new-metadata-web3auth-controllers branch from 9c7ff4f to e66248b Compare September 10, 2025 09:58
@GuillaumeRx GuillaumeRx merged commit cb75a90 into main Sep 10, 2025
239 checks passed
@GuillaumeRx GuillaumeRx deleted the gr/add-new-metadata-web3auth-controllers branch September 10, 2025 10:04
@jeffsmale90 jeffsmale90 mentioned this pull request Sep 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add new metadata properties to Web3Auth controllers

4 participants