feat: propagate data.cause as cause in JsonRpcError constructor #140

legobeat · 2024-05-12T23:53:02Z

This maps the tc39 error cause field on JsonRpcError instances to data.cause, if it exists and is an object. No further validation is performed.

This is done because adding es2022 or dom to tsconfig lib are not being considered at this point.

Alternative

feat: support native Error causes #141

tsconfig.json

- break out util function dataHasCause with test - comment clarity - use native causes when available note: jest coverage depends on runtime

legobeat · 2024-05-31T01:43:16Z

Validated locally that tests also pass on Node.js v14, which definitely doesn't have support for causes. We also see the expected increase in jest coverage, there.

legobeat · 2024-05-31T01:50:41Z

Updated with some improvements lifted over from #141 :

Try to set cause natively via superclass constructor; fall back to setting manually
- Use safer methods Object.prototype.hasOwnProperty.call and Object.assign in fallback
Comment clarity after feedback
Minor type refactor for consistency

This branch has been published for evaluation as @metamask/[email protected]
Preview in extension

legobeat · 2024-05-31T01:52:06Z

jest.config.js

-      functions: 94.44,
-      lines: 92.85,
-      statements: 92.85,
+      branches: 91.89,


#141 (comment)

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

src/classes.ts

rekmarks

LGTM!

legobeat · 2024-05-31T03:46:21Z

If any reviewers are still looking at this: Pending review in #144 so follow-ups are still NBD, if you see any room for improvement.

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

…edition) (#24496) ## **Description** - Upgrade from obsolete `eth-rpc-errors` to `@metamask/rpc-errors` - This introduce handling of error causes See [here](MetaMask/rpc-errors#140) for some context. [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/24496?quickstart=1) ## **Related issues** - #22871 #### Blocked by - [x] MetaMask/rpc-errors#158 - [x] MetaMask/rpc-errors#144 - [x] MetaMask/rpc-errors#140 #### Blocking - #22875 ## **Manual testing steps** ## **Screenshots/Recordings** ### **Before** ### **After** ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.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-extension/blob/develop/.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.

…edition) (#24496) - Upgrade from obsolete `eth-rpc-errors` to `@metamask/rpc-errors` - This introduce handling of error causes See [here](MetaMask/rpc-errors#140) for some context. [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/24496?quickstart=1) - #22871 - [x] MetaMask/rpc-errors#158 - [x] MetaMask/rpc-errors#144 - [x] MetaMask/rpc-errors#140 - #22875 - [x] I’ve followed [MetaMask Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.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-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. - [ ] 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.

legobeat force-pushed the propagate-data-cause branch from 88f1100 to d4f192d Compare May 12, 2024 23:56

legobeat added 2 commits May 13, 2024 00:05

feat: propagate data.cause as cause in JsonRpcError constructor

6013edf

test: add cases for cause propagation

e6350af

legobeat force-pushed the propagate-data-cause branch from d4f192d to e6350af Compare May 13, 2024 00:05

legobeat requested review from FrederikBolding, Mrtenz and mcmire May 13, 2024 00:07

legobeat mentioned this pull request May 13, 2024

feat: support native Error causes #141

Closed

legobeat marked this pull request as ready for review May 29, 2024 02:00

legobeat requested a review from a team as a code owner May 29, 2024 02:00

rekmarks reviewed May 30, 2024

View reviewed changes

tsconfig.json Outdated Show resolved Hide resolved

legobeat requested a review from rekmarks May 31, 2024 00:12

legobeat force-pushed the propagate-data-cause branch from 74a6837 to 4b265fd Compare May 31, 2024 01:26

improve cause-handling

09d433a

- break out util function dataHasCause with test - comment clarity - use native causes when available note: jest coverage depends on runtime

legobeat force-pushed the propagate-data-cause branch from 4b265fd to 09d433a Compare May 31, 2024 01:26

small comment clarity

99ff7f6

legobeat requested a review from a team May 31, 2024 01:44

legobeat commented May 31, 2024

View reviewed changes

jest.config.js

functions: 94.44,

lines: 92.85,

statements: 92.85,

branches: 91.89,

Copy link

Contributor Author

legobeat May 31, 2024

Choose a reason for hiding this comment

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

#141 (comment)

legobeat requested review from MajorLift, naugtur, kumavis and Gudahtt May 31, 2024 01:52

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

f9f9fde

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

64cc736

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat mentioned this pull request May 31, 2024

fix(deps): update from eth-rpc-errors to @metamask/rpc-errors (cause edition) MetaMask/metamask-extension#24496

Merged

10 tasks

rekmarks reviewed May 31, 2024

View reviewed changes

src/classes.ts Outdated Show resolved Hide resolved

replace Object.prototype.hasOwnProperty with hasProperty

cd562cf

rekmarks approved these changes May 31, 2024

View reviewed changes

legobeat merged commit 1b44940 into MetaMask:main May 31, 2024
18 checks passed

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

357139e

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat mentioned this pull request May 31, 2024

chore(tsconfig): bump lib from es2020 to es2022 #142

Closed

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

123fb06

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

0bdd307

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

e38e232

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

648a319

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

956c71d

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

84e950c

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

1910251

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

35a8225

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

c9d6285

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request May 31, 2024

update @metamask/rpc-errors

c239976

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request Jun 1, 2024

update @metamask/rpc-errors

97473f7

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request Jun 1, 2024

update @metamask/rpc-errors

a9160a4

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request Jun 5, 2024

update @metamask/rpc-errors

8b0a37f

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat added a commit to legobeat/metamask-extension that referenced this pull request Jun 5, 2024

update @metamask/rpc-errors

6f37e59

published from 08108c535cf5ee25603715cbfae0cd9aa3f2dea6 MetaMask/rpc-errors#140

legobeat mentioned this pull request Jun 11, 2024

fix(deps): upgrade eth-json-rpc-filters, eth-json-rpc-engine MetaMask/metamask-mobile#9274

Draft

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: propagate data.cause as cause in JsonRpcError constructor #140

feat: propagate data.cause as cause in JsonRpcError constructor #140

legobeat commented May 12, 2024 •

edited

Loading

legobeat commented May 31, 2024 •

edited

Loading

legobeat commented May 31, 2024 •

edited

Loading

legobeat May 31, 2024

rekmarks left a comment

legobeat commented May 31, 2024 •

edited

Loading

feat: propagate data.cause as cause in JsonRpcError constructor #140

feat: propagate data.cause as cause in JsonRpcError constructor #140

Conversation

legobeat commented May 12, 2024 • edited Loading

Related

Alternative

legobeat commented May 31, 2024 • edited Loading

legobeat commented May 31, 2024 • edited Loading

legobeat May 31, 2024

Choose a reason for hiding this comment

rekmarks left a comment

Choose a reason for hiding this comment

legobeat commented May 31, 2024 • edited Loading

legobeat commented May 12, 2024 •

edited

Loading

legobeat commented May 31, 2024 •

edited

Loading

legobeat commented May 31, 2024 •

edited

Loading

legobeat commented May 31, 2024 •

edited

Loading