feat: Add initial tracing to `SignatureController` by OGPoyraz · Pull Request #4655 · MetaMask/core

OGPoyraz · 2024-09-05T10:45:53Z

Explanation

Add an optional trace constructor callback to the TransactionController to support generating Sentry traces within the controller, without coupling to the Sentry package.

Add an optional traceContext argument to addTransaction to facilitate generating nested traces within a parent trace generated within a client.

Add initial instrumentation of the transaction lifecycle.

References

https://github.com/MetaMask/MetaMask-planning/issues/2904

Changelog

`@metamask/controller-utils`

ADDED: Add Trace types

`@metamask/signature-controller`

ADDED: Add optional trace callback to constructor.
ADDED: Add optional traceContext option to newUnsignedTypedMessage and newUnsignedPersonalMessage methods.

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 highlighted breaking changes using the "BREAKING" category above as appropriate

OGPoyraz · 2024-09-05T10:52:11Z

@metamaskbot publish-preview

github-actions · 2024-09-05T10:55:25Z

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
"@metamask-previews/accounts-controller": "18.1.1-preview-473880a1",
"@metamask-previews/address-book-controller": "6.0.0-preview-473880a1",
"@metamask-previews/announcement-controller": "7.0.0-preview-473880a1",
"@metamask-previews/approval-controller": "7.0.3-preview-473880a1",
"@metamask-previews/assets-controllers": "38.0.0-preview-473880a1",
"@metamask-previews/base-controller": "7.0.0-preview-473880a1",
"@metamask-previews/build-utils": "3.0.0-preview-473880a1",
"@metamask-previews/chain-controller": "0.1.1-preview-473880a1",
"@metamask-previews/composable-controller": "9.0.0-preview-473880a1",
"@metamask-previews/controller-utils": "11.2.0-preview-473880a1",
"@metamask-previews/ens-controller": "14.0.0-preview-473880a1",
"@metamask-previews/eth-json-rpc-provider": "4.1.3-preview-473880a1",
"@metamask-previews/gas-fee-controller": "20.0.0-preview-473880a1",
"@metamask-previews/json-rpc-engine": "9.0.2-preview-473880a1",
"@metamask-previews/json-rpc-middleware-stream": "8.0.2-preview-473880a1",
"@metamask-previews/keyring-controller": "17.2.0-preview-473880a1",
"@metamask-previews/logging-controller": "6.0.0-preview-473880a1",
"@metamask-previews/message-manager": "10.1.0-preview-473880a1",
"@metamask-previews/name-controller": "8.0.0-preview-473880a1",
"@metamask-previews/network-controller": "21.0.0-preview-473880a1",
"@metamask-previews/notification-controller": "6.0.0-preview-473880a1",
"@metamask-previews/notification-services-controller": "0.2.1-preview-473880a1",
"@metamask-previews/permission-controller": "11.0.1-preview-473880a1",
"@metamask-previews/permission-log-controller": "3.0.0-preview-473880a1",
"@metamask-previews/phishing-controller": "12.0.1-preview-473880a1",
"@metamask-previews/polling-controller": "10.0.0-preview-473880a1",
"@metamask-previews/preferences-controller": "13.0.2-preview-473880a1",
"@metamask-previews/profile-sync-controller": "0.2.1-preview-473880a1",
"@metamask-previews/queued-request-controller": "5.0.0-preview-473880a1",
"@metamask-previews/rate-limit-controller": "6.0.0-preview-473880a1",
"@metamask-previews/selected-network-controller": "18.0.0-preview-473880a1",
"@metamask-previews/signature-controller": "19.0.0-preview-473880a1",
"@metamask-previews/transaction-controller": "36.0.0-preview-473880a1",
"@metamask-previews/user-operation-controller": "15.0.0-preview-473880a1"
}

OGPoyraz · 2024-09-06T06:40:37Z

@metamaskbot publish-preview

github-actions · 2024-09-06T06:43:48Z

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
"@metamask-previews/accounts-controller": "18.1.1-preview-6ea311ff",
"@metamask-previews/address-book-controller": "6.0.0-preview-6ea311ff",
"@metamask-previews/announcement-controller": "7.0.0-preview-6ea311ff",
"@metamask-previews/approval-controller": "7.0.3-preview-6ea311ff",
"@metamask-previews/assets-controllers": "38.0.0-preview-6ea311ff",
"@metamask-previews/base-controller": "7.0.0-preview-6ea311ff",
"@metamask-previews/build-utils": "3.0.0-preview-6ea311ff",
"@metamask-previews/chain-controller": "0.1.1-preview-6ea311ff",
"@metamask-previews/composable-controller": "9.0.0-preview-6ea311ff",
"@metamask-previews/controller-utils": "11.2.0-preview-6ea311ff",
"@metamask-previews/ens-controller": "14.0.0-preview-6ea311ff",
"@metamask-previews/eth-json-rpc-provider": "4.1.3-preview-6ea311ff",
"@metamask-previews/gas-fee-controller": "20.0.0-preview-6ea311ff",
"@metamask-previews/json-rpc-engine": "9.0.2-preview-6ea311ff",
"@metamask-previews/json-rpc-middleware-stream": "8.0.2-preview-6ea311ff",
"@metamask-previews/keyring-controller": "17.2.0-preview-6ea311ff",
"@metamask-previews/logging-controller": "6.0.0-preview-6ea311ff",
"@metamask-previews/message-manager": "10.1.0-preview-6ea311ff",
"@metamask-previews/name-controller": "8.0.0-preview-6ea311ff",
"@metamask-previews/network-controller": "21.0.0-preview-6ea311ff",
"@metamask-previews/notification-controller": "6.0.0-preview-6ea311ff",
"@metamask-previews/notification-services-controller": "0.2.1-preview-6ea311ff",
"@metamask-previews/permission-controller": "11.0.1-preview-6ea311ff",
"@metamask-previews/permission-log-controller": "3.0.0-preview-6ea311ff",
"@metamask-previews/phishing-controller": "12.0.1-preview-6ea311ff",
"@metamask-previews/polling-controller": "10.0.0-preview-6ea311ff",
"@metamask-previews/preferences-controller": "13.0.2-preview-6ea311ff",
"@metamask-previews/profile-sync-controller": "0.2.1-preview-6ea311ff",
"@metamask-previews/queued-request-controller": "5.0.0-preview-6ea311ff",
"@metamask-previews/rate-limit-controller": "6.0.0-preview-6ea311ff",
"@metamask-previews/selected-network-controller": "18.0.0-preview-6ea311ff",
"@metamask-previews/signature-controller": "19.0.0-preview-6ea311ff",
"@metamask-previews/transaction-controller": "36.0.0-preview-6ea311ff",
"@metamask-previews/user-operation-controller": "15.0.0-preview-6ea311ff"
}

OGPoyraz · 2024-09-06T10:43:19Z

@metamaskbot publish-preview

github-actions · 2024-09-06T10:46:35Z

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.

{
"@metamask-previews/accounts-controller": "18.1.1-preview-39802fe2",
"@metamask-previews/address-book-controller": "6.0.0-preview-39802fe2",
"@metamask-previews/announcement-controller": "7.0.0-preview-39802fe2",
"@metamask-previews/approval-controller": "7.0.3-preview-39802fe2",
"@metamask-previews/assets-controllers": "38.0.0-preview-39802fe2",
"@metamask-previews/base-controller": "7.0.0-preview-39802fe2",
"@metamask-previews/build-utils": "3.0.0-preview-39802fe2",
"@metamask-previews/chain-controller": "0.1.1-preview-39802fe2",
"@metamask-previews/composable-controller": "9.0.0-preview-39802fe2",
"@metamask-previews/controller-utils": "11.2.0-preview-39802fe2",
"@metamask-previews/ens-controller": "14.0.0-preview-39802fe2",
"@metamask-previews/eth-json-rpc-provider": "4.1.3-preview-39802fe2",
"@metamask-previews/gas-fee-controller": "20.0.0-preview-39802fe2",
"@metamask-previews/json-rpc-engine": "9.0.2-preview-39802fe2",
"@metamask-previews/json-rpc-middleware-stream": "8.0.2-preview-39802fe2",
"@metamask-previews/keyring-controller": "17.2.0-preview-39802fe2",
"@metamask-previews/logging-controller": "6.0.0-preview-39802fe2",
"@metamask-previews/message-manager": "10.1.0-preview-39802fe2",
"@metamask-previews/name-controller": "8.0.0-preview-39802fe2",
"@metamask-previews/network-controller": "21.0.0-preview-39802fe2",
"@metamask-previews/notification-controller": "6.0.0-preview-39802fe2",
"@metamask-previews/notification-services-controller": "0.2.1-preview-39802fe2",
"@metamask-previews/permission-controller": "11.0.1-preview-39802fe2",
"@metamask-previews/permission-log-controller": "3.0.0-preview-39802fe2",
"@metamask-previews/phishing-controller": "12.0.1-preview-39802fe2",
"@metamask-previews/polling-controller": "10.0.0-preview-39802fe2",
"@metamask-previews/preferences-controller": "13.0.2-preview-39802fe2",
"@metamask-previews/profile-sync-controller": "0.2.1-preview-39802fe2",
"@metamask-previews/queued-request-controller": "5.0.0-preview-39802fe2",
"@metamask-previews/rate-limit-controller": "6.0.0-preview-39802fe2",
"@metamask-previews/selected-network-controller": "18.0.0-preview-39802fe2",
"@metamask-previews/signature-controller": "19.0.0-preview-39802fe2",
"@metamask-previews/transaction-controller": "36.0.0-preview-39802fe2",
"@metamask-previews/user-operation-controller": "15.0.0-preview-39802fe2"
}

…o-signature-controller

Add initial tracing to SignatureController
6d14545

OGPoyraz requested a review from a team as a code owner September 5, 2024 10:45

OGPoyraz requested a review from a teamSeptember 5, 2024 10:45

Remove unused option
473880a

matthewwalsh0 requested changes Sep 5, 2024
View reviewed changes

Comment threadpackages/signature-controller/src/types.ts Outdated
Comment threadpackages/signature-controller/src/SignatureController.ts Outdated
Comment threadpackages/signature-controller/src/SignatureController.ts

OGPoyraz added 4 commits September 5, 2024 15:13

Add options bag
4389c98

Import types from controller-utils
a8e4e15

Remove Trace types from transaction-controller
bd89147

Revert unwanted type changes
6ea311f

matthewwalsh0 previously approved these changes Sep 6, 2024
View reviewed changes

Add actionId while sending trace
39802fe

OGPoyraz dismissed matthewwalsh0’s stale review via 39802feSeptember 6, 2024 10:40

OGPoyraz added 2 commits September 6, 2024 13:02

Merge branch 'main' into 2901-add-performance-metric-infrastructure-t…
fae45db
…o-signature-controller

Merge branch 'main' into 2901-add-performance-metric-infrastructure-t…
cfe4af3
…o-signature-controller

matthewwalsh0 approved these changes Sep 11, 2024
View reviewed changes

Merge branch 'main' into 2901-add-performance-metric-infrastructure-t…
309f8f5
…o-signature-controller

OGPoyraz merged commit f8872e5 into mainSep 11, 2024

OGPoyraz deleted the 2901-add-performance-metric-infrastructure-to-signature-controller branch September 11, 2024 13:43

OGPoyraz mentioned this pull request Sep 12, 2024
Release 202.0.0 #4688
Closed
3 tasks

Navigation Menu

Uh oh!

Uh oh!

feat: Add initial tracing to `SignatureController` - #4655

feat: Add initial tracing to `SignatureController`#4655
OGPoyraz merged 10 commits into
mainfrom
2901-add-performance-metric-infrastructure-to-signature-controller

OGPoyraz commented Sep 5, 2024

Uh oh!

OGPoyraz commented Sep 5, 2024

Uh oh!

github-actionsBot commented Sep 5, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

OGPoyraz commented Sep 6, 2024

Uh oh!

github-actionsBot commented Sep 6, 2024

Uh oh!

OGPoyraz commented Sep 6, 2024

Uh oh!

github-actionsBot commented Sep 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

OGPoyraz commented Sep 5, 2024

Explanation

References

Changelog

@metamask/controller-utils

@metamask/signature-controller

Checklist

Uh oh!

OGPoyraz commented Sep 5, 2024

Uh oh!

github-actionsBot commented Sep 5, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

OGPoyraz commented Sep 6, 2024

Uh oh!

github-actionsBot commented Sep 6, 2024

Uh oh!

OGPoyraz commented Sep 6, 2024

Uh oh!

github-actionsBot commented Sep 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

`@metamask/controller-utils`

`@metamask/signature-controller`