feat: Add signature tracing #11453

OGPoyraz · 2024-09-26T08:11:35Z

Description

Adding createTracingMiddleware to start tracing for defined type of messages.
Adding trace callback to SignatureController.
End Notification Display trace after signature confirmation landed on users screen.

Related issues

Fixes: https://github.com/MetaMask/mobile-planning/issues/1883

Manual testing steps

Set MM_SENTRY_DSN_DEV to developer Sentry dsn, see the value here https://github.com/MetaMask/metamask-extension/blob/develop/.metamaskrc.dist
Go test-dapp in app, trigger and personal signature
If you used the mentioned dsn above, your Signature trace will appear on this link: https://metamask.sentry.io/traces/?project=273496&query=signature%3ATransaction&source=traces&statsPeriod=1h

Screenshots/Recordings

Before

After

Pre-merge author checklist

I’ve followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
I've completed the PR template to the best of my ability
I’ve included tests if applicable
I’ve documented my code using JSDoc format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). 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.

…equests-in-mobile

github-actions · 2024-09-26T08:59:03Z

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 7e7823e
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/66431eff-be4e-4076-86ff-2ac6ffcf169c

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

matthewwalsh0 · 2024-09-26T19:19:01Z

app/components/Approvals/SignatureApproval/SignatureApproval.tsx

@@ -14,6 +16,11 @@ const SignatureApproval = () => {
    });
  }, [onConfirm]);

+  useAsyncResult(async () => await endTrace({


Why do we need useAsyncResult here as endTrace isn't asynchronous?

That's right, fixed

matthewwalsh0 · 2024-09-26T19:19:31Z

app/components/Approvals/SignatureApproval/SignatureApproval.tsx

+  useAsyncResult(async () => await endTrace({
+      name: TraceName.NotificationDisplay,
+      id: approvalRequest?.requestData?.requestId,
+    }), [approvalRequest?.requestData?.requestId]);


Is it worth defining a local variable such as signatureRequestId?

matthewwalsh0 · 2024-09-26T19:21:57Z

app/core/RPCMethods/RPCMethodMiddleware.ts

@@ -659,7 +680,12 @@ export const getRpcMethodMiddleware = ({
      eth_signTypedData_v4: async () => {
        const data = JSON.parse(req.params[1]);
        const chainId = data.domain.chainId;
-        PPOMUtil.validateRequest(req);
+
+        trace(


Maybe not in this PR, but I wonder if we'd avoid a lot of duplication by using a generic function for all the signing methods?

I tried that in the beginning but it was looking load of changes so didn't proceed. I definitely agree that it's worth doing some cleaning up on these rpc methods.

…equests-in-mobile

github-actions · 2024-09-30T11:22:25Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 3971aa6
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/45fbcbca-a5f6-4e8e-b51e-d1757b6ee559

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

Tip

Check the documentation if you have any doubts on how to understand the failure on bitrise

…equests-in-mobile

github-actions · 2024-10-01T13:21:39Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: c6109d4
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/5c30026b-809c-4eea-8b1f-379d3bcc98cd

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

Tip

Check the documentation if you have any doubts on how to understand the failure on bitrise

…equests-in-mobile

github-actions · 2024-10-02T11:12:49Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 7a78eaf
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/178f38c0-a9a2-400c-ab14-604bbb21033d

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

Tip

Check the documentation if you have any doubts on how to understand the failure on bitrise

…equests-in-mobile

github-actions · 2024-10-04T09:47:13Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: db91a0d
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/c72eecba-d70b-4521-ba12-8c83550c4a8a

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

Tip

Check the documentation if you have any doubts on how to understand the failure on bitrise

sonarcloud · 2024-10-04T09:56:59Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
92.9% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

OGPoyraz added 2 commits September 26, 2024 09:56

Add signature tracing

83f6750

add trace callback

15c179a

OGPoyraz requested review from a team as code owners September 26, 2024 08:11

github-actions bot added the team-confirmations Push issues to confirmations team label Sep 26, 2024

OGPoyraz added 3 commits September 26, 2024 10:13

Add comment

c6b4d38

Fix lint

4446959

Merge branch 'main' into 1883-add-performance-metrics-for-signature-r…

7296ae0

…equests-in-mobile

OGPoyraz added the No QA Needed Apply this label when your PR does not need any QA effort. label Sep 26, 2024

OGPoyraz added 2 commits September 26, 2024 10:24

fix test

d057315

Fix test

7e7823e

OGPoyraz added the Run Smoke E2E Triggers smoke e2e on Bitrise label Sep 26, 2024

pedronfigueiredo previously approved these changes Sep 26, 2024

View reviewed changes

vinistevam previously approved these changes Sep 26, 2024

View reviewed changes

jpuri previously approved these changes Sep 26, 2024

View reviewed changes

matthewwalsh0 requested changes Sep 26, 2024

View reviewed changes

OGPoyraz added 2 commits September 30, 2024 12:05

Merge branch 'main' into 1883-add-performance-metrics-for-signature-r…

ea0edc6

…equests-in-mobile

Fix suggestions

a5411b0

OGPoyraz dismissed stale reviews from vinistevam, pedronfigueiredo, and jpuri via a5411b0 September 30, 2024 10:08

fix suggestion

3971aa6

matthewwalsh0 approved these changes Sep 30, 2024

View reviewed changes

OGPoyraz added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Sep 30, 2024

Merge branch 'main' into 1883-add-performance-metrics-for-signature-r…

c6109d4

…equests-in-mobile

OGPoyraz added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Oct 1, 2024

Merge branch 'main' into 1883-add-performance-metrics-for-signature-r…

7a78eaf

…equests-in-mobile

OGPoyraz added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Oct 2, 2024

Merge branch 'main' into 1883-add-performance-metrics-for-signature-r…

db91a0d

…equests-in-mobile

OGPoyraz requested a review from a team as a code owner October 4, 2024 09:46

OGPoyraz added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Oct 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add signature tracing #11453

feat: Add signature tracing #11453

OGPoyraz commented Sep 26, 2024

github-actions bot commented Sep 26, 2024 •

edited by metamaskbot

Loading

matthewwalsh0 Sep 26, 2024

OGPoyraz Sep 30, 2024

matthewwalsh0 Sep 26, 2024

OGPoyraz Sep 30, 2024

matthewwalsh0 Sep 26, 2024

OGPoyraz Sep 30, 2024

github-actions bot commented Sep 30, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Oct 1, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Oct 2, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Oct 4, 2024 •

edited by metamaskbot

Loading

sonarcloud bot commented Oct 4, 2024

feat: Add signature tracing #11453

Are you sure you want to change the base?

feat: Add signature tracing #11453

Conversation

OGPoyraz commented Sep 26, 2024

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Sep 26, 2024 • edited by metamaskbot Loading

Bitrise

matthewwalsh0 Sep 26, 2024

Choose a reason for hiding this comment

OGPoyraz Sep 30, 2024

Choose a reason for hiding this comment

matthewwalsh0 Sep 26, 2024

Choose a reason for hiding this comment

OGPoyraz Sep 30, 2024

Choose a reason for hiding this comment

matthewwalsh0 Sep 26, 2024

Choose a reason for hiding this comment

OGPoyraz Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 30, 2024 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Oct 1, 2024 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Oct 2, 2024 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Oct 4, 2024 • edited by metamaskbot Loading

Bitrise

sonarcloud bot commented Oct 4, 2024

Quality Gate passed

github-actions bot commented Sep 26, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Sep 30, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Oct 1, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Oct 2, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Oct 4, 2024 •

edited by metamaskbot

Loading