chore: Improve error handling related to keyring metadata #5316
+54
−12
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a suggestion on how to improve error handling for keyring metadata in the PR #5112.
4 tasks
Gudahtt
commented
Feb 12, 2025
| // If metadata is missing, assume the data is from an installation before | ||
| // we had keyring metadata. | ||
| if (this.#keyringsMetadata.length < this.#keyrings.length) { | ||
| console.log(`Adding missing metadata for '${type}' keyring`); |
There was a problem hiding this comment.
Typically we avoid using console.log in libraries, instead preferring to pass a LogLevel logger into the constructor. This makes it easier for the client to control logging, to disable it if appropriate. You can see an example of this in the NetworkController:
That seems like the nicer way to accomplish this.
But the idea here was that the console log could provide a hint if something unexpected happens. A standard troubleshooting step is to ask for console logs from users. They show up in Sentry breadcrumbs as well.
Gudahtt
commented
Feb 12, 2025
| this.#keyrings.push(keyring); | ||
| this.#keyringsMetadata.push(getDefaultKeyringMetadata()); | ||
| if (this.#keyrings.length !== this.#keyringsMetadata.length) { | ||
| throw new Error('Keyring metadata missing'); |
There was a problem hiding this comment.
This would tell us something has gone catastrophically wrong. This error case is the main benefit I see from this suggestion.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
This is a suggestion on how to improve error handling for keyring metadata in the PR #5112. See #5112 for more details.
References
Related discussion thread: https://github.com/MetaMask/core/pull/5112/files#r1946679193
Changelog
N/A
Checklist