feat: add api spec test infrastructure

[tmashuang]

Description

This PR adds tests using api-specs via the @open-rpc/test-coverage tool.

Related issues

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

Manual testing steps

1. yarn setup
2. yarn test:e2e:ios:debug:build
3. yarn test:api-specs

Screenshots/Recordings

Pre-merge author checklist

• I’ve followed MetaMask 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]

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.

[tmashuang]

I have read the CLA Document and I hereby sign the CLA

[socket-security]

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

Package	New capabilities	Transitives	Size	Publisher
npm/@babel/runtime@7.24.6	None	0	249 kB	nicolo-ribaudo
npm/@json-schema-tools/meta-schema@1.6.19	None	0	31.9 kB	belfordz
npm/@json-schema-tools/reference-resolver@1.2.4	filesystem	+2	59.7 kB	belfordz
npm/@json-schema-tools/traverse@1.10.3	None	0	26.4 kB	belfordz
npm/@open-rpc/mock-server@1.7.5	Transitive: filesystem, network	+18	1.56 MB	belfordz
npm/@open-rpc/schema-utils-js@1.16.2	filesystem	+4	190 kB	belfordz
npm/@open-rpc/test-coverage@2.2.2	filesystem, shell Transitive: environment, eval, network	+27	60.7 MB	belfordz
npm/@types/lodash@4.17.0	None	0	862 kB	types
npm/fast-safe-stringify@2.1.1	None	0	39.7 kB	matteo.collina
npm/json-schema-faker@0.5.6	environment Transitive: filesystem, network, unsafe	+5	3.68 MB	pateketrueke
npm/react-remove-scroll-bar@2.3.6	None	+2	48.5 kB	kashey
npm/type-fest@4.18.3	None	0	365 kB	sindresorhus

🚮 Removed packages: npm/@babel/runtime@7.24.5, npm/@types/lodash@4.14.198

View full report↗︎

[socket-security]

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: npm/@mantine/hooks@7.8.0, npm/@open-rpc/server-js@1.9.3, npm/@open-rpc/test-coverage@2.2.2, npm/json-schema-ref-parser@6.1.0

View full report↗︎

Next steps

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

[cortisiko]

@shanejonas @adonesky1 I take it that we intend on including this as part of our test pipeline? If so, we should add the tests to the smoke pipeline. So that you know, our CI platform (bitrise) operates slightly differently than circleCI.

Here is a visual representation of what our smoke pipeline looks like on bitrise:

Now here are the steps we can do for now just as a proof of concept and iterate in the future:

• we can duplicate this workflow and call it a different name (ios_rpc_coverage_e2e). then change the test script to run your tests:

• we then can create a separate workflow that we will add in the run_smoke_e2e_ios_android_stage
  basically, duplicate https://github.com/MetaMask/metamask-mobile/blob/main/bitrise.yml#L471, call it whatever you want

• make sure the workflow you created above to the run_smoke_e2e_ios_android_stage : https://github.com/MetaMask/metamask-mobile/blob/main/bitrise.yml#L118

• You can rinse and repeat for Android

Feel free to reach out if anything.

[cortisiko]

good stuff @shanejonas I left a few comments. Sharing https://github.com/MetaMask/contributor-docs/blob/main/docs/e2e/mobile-e2e-guidelines.md#step-2-create-the-networks-page-object in case you want a quick run down on how we create page objects within our tests!

[jiexi]

getting this error when running things for the first time using just detox test -c ios.sim.apiSpecs

Failed to find the app binary at:
/Users/jiexi/Projects/metamask-mobile/ios/build/Build/Products/Debug-iphonesimulator/MetaMask.app

[Cal-L]

@shanejonas nice work on this! Just curious, were you ever able to get the mock server working?

[shanejonas]

@Cal-L mock server stuff is working now, but an unrelated android e2e suite is failing.

[shanejonas]

@SocketSecurity ignore npm/json-schema-ref-parser@6.1.0
@SocketSecurity ignore npm/@mantine/hooks@7.8.0
@SocketSecurity ignore npm/@open-rpc/server-js@1.9.3
@SocketSecurity ignore npm/@open-rpc/test-coverage@2.2.2

[github-actions]

Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 576cb10
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/ee977b50-594a-488d-8dfd-52eddb5421be

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

[cortisiko]

🌮 🌮 🌮 Looks good!

[tommasini]

LGTM

[sonarqubecloud]

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

[cortisiko]

LGTM!