feat: use Segment (batch 1) #8067

NicolasMassart · 2023-12-11T16:02:08Z

Description

Batch PR to group changes from:

Related issues

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

Manual testing steps

See each PR for details

Screenshots/Recordings

See each PR for details

Before

See each PR for details

After

See each PR for details

Pre-merge author checklist

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.

…proxy (Batch 2 of 4) (#7520) # What is the reason for the change? - Implement a new metrics system for the Segment SDK. - Make it work alongside the old one so that we can remove the old one progressively. # What is the improvement/solution? - Create a new class to handle metrics with segment - abstract all segment SDK calls - provide our own user and anonymous Ids for improved privacy - Reuse the Mixpanel user id it available, otherwise generates a new one with the same format - patch Segment SDK to allow the privacy aware user and anonymous Ids - No event sent at all if user haven't accepted to send metrics info - Total reset of the infos in case user asks to reset (in settings) - Ability to disable all metrics - Ability to ask for deletion of all data Fixes MetaMask/mobile-planning#1222

…4) (#7990) - Initialise MetaMetrics on app start without removing Analytics yet as we still uses it outside of onboarding - create a `trackAfterInteractions` utility function to reduce code when tracking events. - Replace calls to Analytics with calls to `trackAfterInteractions` in all components involved in onboarding screens (see [`OnboardingNav`](https://github.com/MetaMask/metamask-mobile/blob/feat%2F1275_segment_onboarding_impl/app/components/Nav/App/index.js#L122-L175) in `app/components/Nav/App/index.js`) - Fix onboarding events queue usage in `app/components/UI/OptinMetrics/index.js` - Update Opt-on/Opt-out in onboarding - Extract Analytics User profil properties in UserProfileMetaData util and inject it in MetaMetrics identify request alongside device metadata Fixes MetaMask/mobile-planning#1275

- rename Segment env vars: - `SEGMENT_WRITE_KEY` - `SEGMENT_PROXY_URL` - add env var placeholders in example file Fixes missing variables naming change in MetaMask/mobile-planning#1222

…k-mobile into feat/batch_1129_segment

github-actions · 2023-12-11T16:02:23Z

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.

socket-security · 2023-12-11T16:06:29Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@segment/analytics-react-native@2.17.0	network Transitive: environment, eval, filesystem, shell, unsafe	`+480`	155 MB	oscb
npm/@segment/sovran-react-native@1.0.4	Transitive: environment, eval, filesystem, network, shell, unsafe	`+374`	150 MB	oscb
npm/@stdlib/complex-float32@0.0.7	Transitive: environment, filesystem	`+59`	2.45 MB	stdlib-bot
npm/@stdlib/complex-float64@0.0.8	Transitive: environment, filesystem	`+60`	2.52 MB	stdlib-bot
npm/@stdlib/complex-reim@0.0.6	Transitive: environment, filesystem	`+64`	2.73 MB	stdlib-bot
npm/@stdlib/complex-reimf@0.0.1	Transitive: environment, filesystem	`+60`	2.49 MB	stdlib-bot
npm/@stdlib/utils-library-manifest@0.0.8	Transitive: environment, filesystem	`+51`	2.09 MB	stdlib-bot

🚮 Removed packages: npm/@segment/analytics-react-native@2.13.0, npm/@segment/sovran-react-native@0.4.5

View full report↗︎

socket-security · 2023-12-11T16:06:33Z

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert	Package	Note	Source
New author	npm/@stdlib/assert-has-tostringtag-support@0.0.9	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/assert-is-object-like@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/assert-is-regexp-string@0.0.9	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/assert-is-string@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/buffer-from-string@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/constants-float64-exponent-bias@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/constants-float64-high-word-exponent-mask@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/constants-float64-max-base2-exponent@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/constants-float64-max-base2-exponent-subnormal@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/constants-float64-min-base2-exponent-subnormal@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/constants-float64-ninf@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/constants-float64-pinf@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/constants-float64-smallest-normal@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/math-base-napi-unary@0.0.9	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/math-base-special-copysign@0.0.7	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/number-float64-base-to-float32@0.0.7	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/number-float64-base-to-words@0.0.7	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/regexp-regexp@0.0.8	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/string-lowercase@0.0.9	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/string-replace@0.0.11	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/utils-escape-regexp-string@0.0.9	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@stdlib/utils-regexp-from-string@0.0.9	New Author: kgryte Previous Author: stdlib-bot	`package.json`
New author	npm/@segment/tsub@2.0.0	New Author: nsandhu-segment Previous Author: ariel.silvestri	`package.json`
Deprecated	npm/@segment/analytics-react-native@2.17.0	Reason: Version causing issues with RN 0.71+	`package.json`

View full report↗︎

Next steps

What is new author?

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Scrutinize new collaborator additions to packages because they now have the ability to publish code into your dependency tree. Packages should avoid frequent or unnecessary additions or changes to publishing rights.

What is a deprecated package?

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Research the state of the package and determine if there are non-deprecated versions that can be used, or if it should be replaced with a new, supported solution.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

@SocketSecurity ignore npm/@stdlib/assert-has-tostringtag-support@0.0.9
@SocketSecurity ignore npm/@stdlib/assert-is-object-like@0.0.8
@SocketSecurity ignore npm/@stdlib/assert-is-regexp-string@0.0.9
@SocketSecurity ignore npm/@stdlib/assert-is-string@0.0.8
@SocketSecurity ignore npm/@stdlib/buffer-from-string@0.0.8
@SocketSecurity ignore npm/@stdlib/constants-float64-exponent-bias@0.0.8
@SocketSecurity ignore npm/@stdlib/constants-float64-high-word-exponent-mask@0.0.8
@SocketSecurity ignore npm/@stdlib/constants-float64-max-base2-exponent@0.0.8
@SocketSecurity ignore npm/@stdlib/constants-float64-max-base2-exponent-subnormal@0.0.8
@SocketSecurity ignore npm/@stdlib/constants-float64-min-base2-exponent-subnormal@0.0.8
@SocketSecurity ignore npm/@stdlib/constants-float64-ninf@0.0.8
@SocketSecurity ignore npm/@stdlib/constants-float64-pinf@0.0.8
@SocketSecurity ignore npm/@stdlib/constants-float64-smallest-normal@0.0.8
@SocketSecurity ignore npm/@stdlib/math-base-napi-unary@0.0.9
@SocketSecurity ignore npm/@stdlib/math-base-special-copysign@0.0.7
@SocketSecurity ignore npm/@stdlib/number-float64-base-to-float32@0.0.7
@SocketSecurity ignore npm/@stdlib/number-float64-base-to-words@0.0.7
@SocketSecurity ignore npm/@stdlib/regexp-regexp@0.0.8
@SocketSecurity ignore npm/@stdlib/string-lowercase@0.0.9
@SocketSecurity ignore npm/@stdlib/string-replace@0.0.11
@SocketSecurity ignore npm/@stdlib/utils-escape-regexp-string@0.0.9
@SocketSecurity ignore npm/@stdlib/utils-regexp-from-string@0.0.9
@SocketSecurity ignore npm/@segment/tsub@2.0.0
@SocketSecurity ignore npm/@segment/analytics-react-native@2.17.0

codecov-commenter · 2023-12-12T16:34:36Z

Codecov Report

Attention: 113 lines in your changes are missing coverage. Please review.

Comparison is base (542af2c) 41.05% compared to head (af34152) 41.44%.
Report is 6 commits behind head on main.

Files	Patch %	Lines
app/core/Analytics/MetaMetrics.ts	88.19%	11 Missing and 6 partials ⚠️
app/components/UI/OptinMetrics/index.js	0.00%	15 Missing ⚠️
...csMetaData/generateUserProfileAnalyticsMetaData.ts	9.09%	10 Missing ⚠️
app/components/Views/Onboarding/index.js	0.00%	9 Missing ⚠️
...ents/Views/ImportFromSecretRecoveryPhrase/index.js	0.00%	8 Missing ⚠️
...ews/Settings/SecuritySettings/SecuritySettings.tsx	42.85%	8 Missing ⚠️
app/components/Views/ChoosePassword/index.js	0.00%	7 Missing ⚠️
app/components/Views/AccountBackupStep1/index.js	0.00%	6 Missing ⚠️
app/components/Views/OnboardingCarousel/index.js	0.00%	6 Missing ⚠️
...ecuritySettings/Sections/DeleteMetaMetricsData.tsx	66.66%	5 Missing and 1 partial ⚠️
... and 7 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8067      +/-   ##
==========================================
+ Coverage   41.05%   41.44%   +0.38%     
==========================================
  Files        1247     1254       +7     
  Lines       30371    30566     +195     
  Branches     2965     3001      +36     
==========================================
+ Hits        12468    12667     +199     
+ Misses      17158    17146      -12     
- Partials      745      753       +8

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

# Conflicts: # app/components/Views/AccountBackupStep1/index.js # app/components/Views/AccountBackupStep1B/index.js # app/components/Views/ChoosePassword/index.js # app/components/Views/ManualBackupStep1/index.js # app/components/Views/ManualBackupStep2/index.js # app/components/Views/ManualBackupStep3/index.js

# Conflicts: # app/components/Views/Settings/SecuritySettings/SecuritySettings.tsx

# Conflicts: # yarn.lock

github-actions · 2024-02-16T18:31:03Z

E2E test started on Bitrise: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/88255595-f8ea-4a47-ba22-73df25fca7b2
You can also kick off another Bitrise E2E smoke test by removing and re-applying the (Run Smoke E2E) label

app/core/Analytics/MetaMetrics.constants.ts

tommasini

AMAZING WORK! LGTM! Just left a nit pick that i've found but it's okay to merge it without it!

app/components/Views/Settings/SecuritySettings/Sections/DeleteMetaMetricsData.tsx

tommasini

Actually it seems that the unit tests are failing! We will need to address that

remove useless async move log to configure fix trackEvent param type update test

app/core/Analytics/MetaMetrics.ts

tommasini

LGTM!

sonarcloud · 2024-02-20T11:49:04Z

Quality Gate passed

Issues
0 New issues

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

See analysis details on SonarCloud

tommasini

LGTM!

github-actions · 2024-02-20T13:21:29Z

E2E test started on Bitrise: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/0e74e625-dee6-4c29-b021-2756941883f2
You can also kick off another Bitrise E2E smoke test by removing and re-applying the (Run Smoke E2E) label

NicolasMassart and others added 8 commits December 6, 2023 11:14

Merge branch 'main' into feat/batch_1129_segment

886a8b1

Merge branch 'main' into feat/batch_1129_segment

e6dcad4

Merge branch 'main' into feat/batch_1129_segment

e457b27

fix: rename Segment env vars and add in example file (#8059)

92c5dc9

- rename Segment env vars: - `SEGMENT_WRITE_KEY` - `SEGMENT_PROXY_URL` - add env var placeholders in example file Fixes missing variables naming change in MetaMask/mobile-planning#1222

Merge branch 'main' into feat/batch_1129_segment

6cac642

Merge branch 'feat/batch_1129_segment' of github.com:MetaMask/metamas…

c2af79a

…k-mobile into feat/batch_1129_segment

NicolasMassart changed the title ~~Feat: use Segment (batch)~~ feat: use Segment (batch) Dec 12, 2023

NicolasMassart added the DO-NOT-MERGE Pull requests that should not be merged label Dec 12, 2023

NicolasMassart added 2 commits December 12, 2023 15:46

Merge branch 'main' into feat/batch_1129_segment

265d1a9

Merge branch 'main' into feat/batch_1129_segment

e34d62e

NicolasMassart and others added 4 commits December 14, 2023 01:32

Merge branch 'main' into feat/batch_1129_segment

b43425f

Merge branch 'main' into feat/batch_1129_segment

ad1022d

# Conflicts: # app/components/Views/Settings/SecuritySettings/SecuritySettings.tsx

Merge branch 'main' into feat/batch_1129_segment

da3f72d

NicolasMassart self-assigned this Jan 8, 2024

gauthierpetetin added team-mobile-client team-mobile-platform in-progress labels Jan 9, 2024

Merge branch 'main' into feat/batch_1129_segment

054b3b6

metamaskbot added needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) and removed in-progress labels Jan 9, 2024

Merge branch 'main' into feat/batch_1129_segment

df791dd

metamaskbot removed the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Jan 10, 2024

Merge branch 'main' into feat/batch_1129_segment

8e795c6

# Conflicts: # yarn.lock

Merge branch 'main' into feat/batch_1129_segment

0ff5c5a

NicolasMassart marked this pull request as ready for review February 16, 2024 18:29

NicolasMassart requested a review from a team as a code owner February 16, 2024 18:29

github-actions bot added the Run Smoke E2E Triggers smoke e2e on Bitrise label Feb 16, 2024

sethkfman reviewed Feb 16, 2024

View reviewed changes

app/core/Analytics/MetaMetrics.constants.ts Outdated Show resolved Hide resolved

NicolasMassart added 3 commits February 19, 2024 12:49

use env var for endpoint

729cbfa

add test env for metametrics

8629533

make type for track consistent between class and hook

61bbe56

tommasini approved these changes Feb 19, 2024

View reviewed changes

app/components/Views/Settings/SecuritySettings/Sections/DeleteMetaMetricsData.tsx Outdated Show resolved Hide resolved

app/components/Views/Settings/SecuritySettings/Sections/DeleteMetaMetricsData.tsx Outdated Show resolved Hide resolved

tommasini requested changes Feb 19, 2024

View reviewed changes

NicolasMassart added 3 commits February 20, 2024 10:07

fix configure

bfaa528

remove useless async move log to configure fix trackEvent param type update test

fix test

00b0f3a

fix type

af34152

tommasini reviewed Feb 20, 2024

View reviewed changes

app/core/Analytics/MetaMetrics.ts Show resolved Hide resolved

tommasini previously approved these changes Feb 20, 2024

View reviewed changes

optimise metrics settings

502a9ff

NicolasMassart dismissed tommasini’s stale review via 502a9ff February 20, 2024 11:37

tommasini approved these changes Feb 20, 2024

View reviewed changes

NicolasMassart changed the title ~~feat: use Segment (batch)~~ feat: use Segment (batch 1) Feb 20, 2024

NicolasMassart added needs-smoke-e2e Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Feb 20, 2024

NicolasMassart merged commit 9d6f8ee into main Feb 20, 2024
35 checks passed

NicolasMassart deleted the feat/batch_1129_segment branch February 20, 2024 14:36

github-actions bot locked and limited conversation to collaborators Feb 20, 2024

metamaskbot added the release-7.18.0 Issue or pull request that will be included in release 7.18.0 label Feb 20, 2024

metamaskbot added the in-progress label Feb 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: use Segment (batch 1) #8067

feat: use Segment (batch 1) #8067

NicolasMassart commented Dec 11, 2023 •

edited

github-actions bot commented Dec 11, 2023

socket-security bot commented Dec 11, 2023 •

edited

socket-security bot commented Dec 11, 2023 •

edited

codecov-commenter commented Dec 12, 2023 •

edited

github-actions bot commented Feb 16, 2024

tommasini left a comment

tommasini left a comment

tommasini left a comment

sonarcloud bot commented Feb 20, 2024

tommasini left a comment

github-actions bot commented Feb 20, 2024

feat: use Segment (batch 1) #8067

feat: use Segment (batch 1) #8067

Conversation

NicolasMassart commented Dec 11, 2023 • edited

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Dec 11, 2023

socket-security bot commented Dec 11, 2023 • edited

socket-security bot commented Dec 11, 2023 • edited

Next steps

codecov-commenter commented Dec 12, 2023 • edited

Codecov Report

github-actions bot commented Feb 16, 2024

tommasini left a comment

Choose a reason for hiding this comment

tommasini left a comment

Choose a reason for hiding this comment

tommasini left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Feb 20, 2024

Quality Gate passed

tommasini left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 20, 2024

NicolasMassart commented Dec 11, 2023 •

edited

socket-security bot commented Dec 11, 2023 •

edited

socket-security bot commented Dec 11, 2023 •

edited

codecov-commenter commented Dec 12, 2023 •

edited