feat: Add metrics event for advanced details section toggling #26083

pedronfigueiredo · 2024-07-24T09:30:05Z

Description

We recently introduced the advanced details toggle for redesigned transactions. This PR adds a metrics event that gets fired every time that toggle is pressed.

Related issues

Fixes: https://github.com/MetaMask/MetaMask-planning/issues/2736

Manual testing steps

Go to this page...

Screenshots/Recordings

Before

After

Pre-merge author checklist

I've followed MetaMask Contributor Docs and MetaMask Extension 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.

github-actions · 2024-07-24T09:30:17Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

greptile-apps

PR Summary

This PR introduces a metrics event for tracking the toggling of the advanced details section in transaction confirmations.

test/e2e/tests/confirmations/transactions/metrics.spec.ts: Added a test case to verify the metrics event for the advanced details toggle.
ui/pages/confirmations/components/confirm/header/header-info.tsx: Implemented the trackEvent function to log the advanced details toggle event.
ui/pages/confirmations/hooks/useTransactionEventFragment.js: Updated to include the fragment object in the returned value, ensuring proper tracking and updating of transaction event fragments.

_{3 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

greptile-apps

PR Summary

(updates since last review)

This PR adds a metrics event for tracking the toggling of the advanced details section in transaction confirmations.

app/scripts/lib/transaction/metrics.test.ts: Added getIsConfirmationAdvancedDetailsOpen mock function to mockTransactionMetricsRequest.
app/scripts/lib/transaction/metrics.ts: Introduced getIsConfirmationAdvancedDetailsOpen method to capture the state of the advanced details section.
app/scripts/metamask-controller.js: Added getIsConfirmationAdvancedDetailsOpen method to controllerActions for state retrieval.
test/e2e/tests/confirmations/transactions/metrics.spec.ts: Added assertions for transaction_advanced_view property in metrics events.
ui/pages/confirmations/components/confirm/header/header-info.tsx: Removed trackEvent call from setShowAdvancedDetails function.

_{5 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

greptile-apps

PR Summary

(updates since last review)

This PR introduces a metrics event for tracking the toggling of the advanced details section in transaction confirmations.

test/e2e/tests/confirmations/transactions/metrics.spec.ts: Added end-to-end test to verify metrics events for advanced details toggling.
app/scripts/lib/transaction/metrics.test.ts: Introduced getIsConfirmationAdvancedDetailsOpen mock function.
app/scripts/lib/transaction/metrics.ts: Added getIsConfirmationAdvancedDetailsOpen method to capture advanced details state.
app/scripts/metamask-controller.js: Integrated getIsConfirmationAdvancedDetailsOpen method for state retrieval.
ui/pages/confirmations/components/confirm/header/header-info.tsx: Removed trackEvent call from setShowAdvancedDetails function.

_{1 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

greptile-apps

PR Summary

(updates since last review)

This PR introduces a metrics event for tracking the toggling of the advanced details section in transaction confirmations.

app/scripts/lib/transaction/metrics.ts: Added getIsConfirmationAdvancedDetailsOpen method to capture advanced details state.
app/scripts/metamask-controller.js: Integrated getIsConfirmationAdvancedDetailsOpen method for state retrieval.
ui/pages/confirmations/components/confirm/header/header-info.tsx: Added metrics event for advanced details toggling.
test/e2e/tests/confirmations/transactions/metrics.spec.ts: Added end-to-end test to verify metrics events for advanced details toggling.
app/scripts/lib/transaction/metrics.test.ts: Introduced getIsConfirmationAdvancedDetailsOpen mock function.

_{115 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

greptile-apps

PR Summary

(updates since last review)

This PR introduces a metrics event for tracking the toggling of the advanced details section in transaction confirmations.

ui/pages/confirmations/components/confirm/header/header-info.tsx: Removed unused import and added a new metrics event for toggling the advanced details section.
app/scripts/metamask-controller.js: Added getIsConfirmationAdvancedDetailsOpen method for state retrieval.
shared/constants/metametrics.ts: Updated to include the new event name for advanced details toggling.

These changes ensure that every time the advanced details section is toggled, a corresponding metrics event is fired.

_{1 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

greptile-apps

PR Summary

(updates since last review)

This PR introduces a metrics event for tracking the toggling of the advanced details section in transaction confirmations.

app/scripts/lib/transaction/metrics.ts: Added getIsConfirmationAdvancedDetailsOpen method and updated buildEventFragmentProperties to include transaction_advanced_view.
app/scripts/metamask-controller.js: Added getIsConfirmationAdvancedDetailsOpen method to controllerActions.
ui/pages/confirmations/components/confirm/header/header-info.tsx: Integrated trackEvent for advanced details toggle.
test/e2e/tests/confirmations/transactions/metrics.spec.ts: Added assertions for transaction_advanced_view property in metrics events.
app/scripts/lib/transaction/metrics.test.ts: Added mock function getIsConfirmationAdvancedDetailsOpen to mockTransactionMetricsRequest.

_{10 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

greptile-apps

PR Summary

(updates since last review)

This PR introduces a metrics event for tracking the toggling of the advanced details section in transaction confirmations.

app/scripts/lib/transaction/metrics.test.ts: Added transaction_advanced_view to expectedProperties for various transaction scenarios.
shared/modules/metametrics.test.ts: Introduced mock function getIsConfirmationAdvancedDetailsOpen in createTransactionMetricsRequest.
ui/pages/confirmations/hooks/useTransactionEventFragment.js: Simplified return object by removing fragment property, exposing only updateTransactionEventFragment.

_{3 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

jpuri

👍

sonarqubecloud · 2024-07-25T08:27:43Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

greptile-apps

PR Summary

(updates since last review)

This PR introduces a metrics event for tracking the toggling of the advanced details section in transaction confirmations.

app/scripts/lib/transaction/metrics.ts: Added getIsConfirmationAdvancedDetailsOpen method and transaction_advanced_view property to track advanced details toggling.
app/scripts/metamask-controller.js: Introduced getIsConfirmationAdvancedDetailsOpen method to controllerActions.
test/e2e/tests/confirmations/transactions/metrics.spec.ts: Added assertions for transaction_advanced_view property in metrics events.
ui/pages/confirmations/components/confirm/header/header-info.tsx: Added metrics event dispatch for advanced details toggle.
app/_locales/en/messages.json: Added onboardingMetametricsPrivacyDescription message key for enhanced onboarding privacy information.

_{23 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

metamaskbot · 2024-07-25T08:55:23Z

Builds ready [f093e6d]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5
- common: 0, 1, 10, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (246 ± 258 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	74	124	100	14	7
		domContentLoaded	11	58	23	14	7
		load	50	2073	246	537	258
		domInteractive	11	58	23	14	7

Bundle size diffs [🚨 Warning! Bundle size has increased!]

background: 216 Bytes (0.01%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

codecov · 2024-07-25T08:55:33Z

Codecov Report

Attention: Patch coverage is 50.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 69.67%. Comparing base (d6b7829) to head (f093e6d).

Files	Patch %	Lines
app/scripts/metamask-controller.js	0.00%	2 Missing ⚠️
app/scripts/lib/transaction/metrics.ts	50.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #26083      +/-   ##
===========================================
- Coverage    69.67%   69.67%   -0.00%     
===========================================
  Files         1405     1405              
  Lines        49733    49737       +4     
  Branches     13751    13751              
===========================================
+ Hits         34651    34652       +1     
- Misses       15082    15085       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pedronfigueiredo added the team-confirmations Push issues to confirmations team label Jul 24, 2024

pedronfigueiredo self-assigned this Jul 24, 2024

pedronfigueiredo requested review from a team as code owners July 24, 2024 09:30

greptile-apps bot reviewed Jul 24, 2024

View reviewed changes

pedronfigueiredo force-pushed the pnf/2736 branch from 6111d2d to abb8454 Compare July 24, 2024 10:57

greptile-apps bot reviewed Jul 24, 2024

View reviewed changes

pedronfigueiredo force-pushed the pnf/2736 branch from 2c1f6f6 to f1a9015 Compare July 24, 2024 16:27

greptile-apps bot reviewed Jul 24, 2024

View reviewed changes

jpuri approved these changes Jul 25, 2024

View reviewed changes

pedronfigueiredo added 6 commits July 25, 2024 09:25

wip

4252e4b

wip

2ab6875

wip

5f05d45

wip

75f5669

wip

a1bf7b2

wip

f093e6d

pedronfigueiredo force-pushed the pnf/2736 branch from 4d7e7c5 to f093e6d Compare July 25, 2024 08:25

greptile-apps bot reviewed Jul 25, 2024

View reviewed changes

matthewwalsh0 approved these changes Jul 25, 2024

View reviewed changes

OGPoyraz approved these changes Jul 25, 2024

View reviewed changes

pedronfigueiredo merged commit bdcea3d into develop Jul 25, 2024
76 checks passed

pedronfigueiredo deleted the pnf/2736 branch July 25, 2024 09:40

github-actions bot locked and limited conversation to collaborators Jul 25, 2024

metamaskbot added the release-12.3.0 Issue or pull request that will be included in release 12.3.0 label Jul 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add metrics event for advanced details section toggling #26083

feat: Add metrics event for advanced details section toggling #26083

pedronfigueiredo commented Jul 24, 2024 •

edited by github-actions bot

Loading

github-actions bot commented Jul 24, 2024

greptile-apps bot left a comment

greptile-apps bot left a comment

greptile-apps bot left a comment

greptile-apps bot left a comment

greptile-apps bot left a comment

greptile-apps bot left a comment

greptile-apps bot left a comment

jpuri left a comment

sonarqubecloud bot commented Jul 25, 2024

greptile-apps bot left a comment

metamaskbot commented Jul 25, 2024

codecov bot commented Jul 25, 2024

feat: Add metrics event for advanced details section toggling #26083

feat: Add metrics event for advanced details section toggling #26083

Conversation

pedronfigueiredo commented Jul 24, 2024 • edited by github-actions bot Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Jul 24, 2024

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

jpuri left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jul 25, 2024

Quality Gate passed

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

metamaskbot commented Jul 25, 2024

codecov bot commented Jul 25, 2024

Codecov Report

pedronfigueiredo commented Jul 24, 2024 •

edited by github-actions bot

Loading