chore: bump `@metamask/providers` to `^17.2.0` #27049

jiexi · 2024-09-10T20:56:14Z

Description

Related issues

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-09-10T20:56:25Z

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 · 2024-09-10T20:56:55Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/extension-port-stream@3.0.0	None	`0`	10.5 kB	lgbot

🚮 Removed packages: npm/@metamask/providers@17.2.0, npm/detect-browser@5.2.0, npm/extension-port-stream@4.2.0, npm/json-rpc-middleware-stream@5.0.1

View full report↗︎

jiexi · 2024-09-10T21:15:05Z

@metamaskbot update-policies

metamaskbot · 2024-09-10T21:24:36Z

Policies updated

…/bump-provider-17.2.0

jiexi · 2024-09-10T22:56:20Z

development/webpack/utils/loaders/swcLoader.ts

              },
              additionalProperties: false,
              required: ['syntax'],
            },
          ],
        },
+        experimental: {
+          description: 'TODO',


jiexi · 2024-09-10T22:56:37Z

development/webpack/utils/loaders/swcLoader.ts

these changes probably should be moved into a separate PR

jiexi · 2024-09-10T22:57:10Z

development/webpack/utils/loaders/swcLoader.ts

+                importAssertions: {
+                  default: false,
+                  type: 'boolean',
+                }


DRY this importAssertions property somehow

jiexi · 2024-09-11T16:50:24Z

@metamaskbot update-policies

metamaskbot · 2024-09-11T17:01:39Z

Policies updated

…/bump-provider-17.2.0

sonarcloud · 2024-09-11T17:44:06Z

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

metamaskbot · 2024-09-11T18:21:33Z

Builds ready [1c0282a]

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, 11, 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 (1683 ± 88 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	307	2295	1499	508	244
		domContentLoaded	1475	2256	1658	178	86
		load	1479	2288	1683	183	88
		domInteractive	21	107	39	26	12

Bundle size diffs [🚀 Bundle size reduced!]

background: -24 Bytes (-0.00%)
ui: 0 Bytes (0.00%)
common: -64 Bytes (-0.00%)

codecov · 2024-09-11T18:22:25Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.06%. Comparing base (a61b938) to head (1c0282a).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #27049      +/-   ##
===========================================
- Coverage    70.11%   70.06%   -0.05%     
===========================================
  Files         1426     1410      -16     
  Lines        49689    49589     -100     
  Branches     13902    13861      -41     
===========================================
- Hits         34835    34740      -95     
+ Misses       14854    14849       -5

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

jiexi · 2024-09-11T18:31:41Z

development/webpack/utils/loaders/swcLoader.ts

+          importAssertions: true,
+        },
+        experimental: {
+          keepImportAttributes: true,
+          emitAssertForImportAttributes: true,


unsure if all three or only some are needed, but definitely something needs to be set to deal with the import assertion

If these are all false, I get the following from yarn webpack

ERROR in ../node_modules/@metamask/providers/dist/extension-provider/createExternalExtensionProvider.mjs Module build failed (from ../development/webpack/utils/loaders/swcLoader.ts): Error: × Expected ';', got 'assert' ╭─[/Users/jiexi/Projects/metamask-extension/node_modules/@metamask/providers/dist/extension-provider/createExternalExtensionProvider.mjs:1:1] 1 │ import { detect } from "detect-browser"; 2 │ import $extensionportstream from "extension-port-stream"; 3 │ const { PortDuplexStream: PortStream } = $extensionportstream; 4 │ import config from "./external-extension-config.json" assert { type: "json" }; · ────── 5 │ import { MetaMaskInpageProviderStreamName } from "../MetaMaskInpageProvider.mjs"; 6 │ import { StreamProvider } from "../StreamProvider.mjs"; 7 │ import { getDefaultExternalMiddleware } from "../utils.mjs"; ╰────

jiexi · 2024-09-11T18:32:02Z

// node_modules/@metamask/providers/dist/extension-provider/createExternalExtensionProvider.mjs
import { detect } from "detect-browser";
import $extensionportstream from "extension-port-stream";
const { PortDuplexStream: PortStream } = $extensionportstream;
import config from "./external-extension-config.json" assert { type: "json" };
import { MetaMaskInpageProviderStreamName } from "../MetaMaskInpageProvider.mjs";
import { StreamProvider } from "../StreamProvider.mjs";
import { getDefaultExternalMiddleware } from "../utils.mjs";
const browser = detect();
/**
 * Creates an external extension provider for the given extension type or ID.
 *
 * @param typeOrId - The extension type or ID.
 * @returns The external extension provider.
 */
export function createExternalExtensionProvider(typeOrId = 'stable') {
    let provider;
    try {
        const extensionId = getExtensionId(typeOrId);
        const metamaskPort = chrome.runtime.connect(extensionId);
        const pluginStream = new PortStream(metamaskPort);
        provider = new StreamProvider(pluginStream, {
            jsonRpcStreamName: MetaMaskInpageProviderStreamName,
            logger: console,
            rpcMiddleware: getDefaultExternalMiddleware(console),
        });
        // This is asynchronous but merely logs an error and does not throw upon
        // failure. Previously this just happened as a side-effect in the
        // constructor.
        // eslint-disable-next-line @typescript-eslint/no-floating-promises
        provider.initialize();
    }
    catch (error) {
        console.dir(`MetaMask connect error.`, error);
        throw error;
    }
    return provider;
}
/**
 * Gets the extension ID for the given extension type or ID.
 *
 * @param typeOrId - The extension type or ID.
 * @returns The extension ID.
 */
function getExtensionId(typeOrId) {
    const ids = browser?.name === 'firefox' ? config.firefoxIds : config.chromeIds;
    return ids[typeOrId] ?? typeOrId;
}
//# sourceMappingURL=createExternalExtensionProvider.mjs.map

jiexi · 2024-09-11T18:48:02Z

.yarn/patches/@metamask-providers-npm-17.2.0-cb0cfcdadc.patch

+diff --git a/dist/extension-provider/createExternalExtensionProvider.mjs b/dist/extension-provider/createExternalExtensionProvider.mjs
+index f2aa9285d84cd5e25c20f5202437c476cdacc326..121a9099e456d3444d8aae79574ba9c53e7f2699 100644
+--- a/dist/extension-provider/createExternalExtensionProvider.mjs
+++ b/dist/extension-provider/createExternalExtensionProvider.mjs
+@@ -1,5 +1,4 @@
+-import $detectbrowser from "detect-browser";
+-const { detect } = $detectbrowser;
+import { detect } from "detect-browser";
+ import $extensionportstream from "extension-port-stream";
+ const { PortDuplexStream: PortStream } = $extensionportstream;
+ import config from "./external-extension-config.json" assert { type: "json" };


without this patch, I get the following from the inpage provider in the dapp web console

createExternalExtensionProvider.mjs:2 Uncaught TypeError: Cannot destructure property 'detect' of 'detect_browser__WEBPACK_IMPORTED_MODULE_0__.default' as it is undefined. at 193000 (createExternalExtensionProvider.mjs:2:9) at __webpack_require__ (bootstrap:19:1) at 701043 (createExternalExtensionProvider.mjs:49:61) at __webpack_require__ (bootstrap:19:1) at make namespace object:7:1 at inpage.js:70:1 at inpage.js:70:1

MajorLift · 2024-09-11T20:12:34Z

app/scripts/inpage.js

@@ -34,7 +34,7 @@ cleanContextForImports();
 import log from 'loglevel';
 import { v4 as uuid } from 'uuid';
 import { WindowPostMessageStream } from '@metamask/post-message-stream';
-import { initializeProvider } from '@metamask/providers/dist/initializeInpageProvider';


Relevant: MetaMask/snaps#2445 (comment)

app/scripts/inpage.js

legobeat · 2024-10-24T04:51:07Z

package.json

-    "@trezor/connect-web@npm:^9.1.11": "patch:@trezor/connect-web@npm%3A9.3.0#~/.yarn/patches/@trezor-connect-web-npm-9.3.0-040ab10d9a.patch"
+    "@trezor/connect-web@npm:^9.1.11": "patch:@trezor/connect-web@npm%3A9.3.0#~/.yarn/patches/@trezor-connect-web-npm-9.3.0-040ab10d9a.patch",
+    "@metamask/providers@npm:^17.1.2": "patch:@metamask/providers@npm%3A17.2.0#~/.yarn/patches/@metamask-providers-npm-17.2.0-cb0cfcdadc.patch",
+    "@metamask/providers@npm:^15.0.0": "patch:@metamask/providers@npm%3A17.2.0#~/.yarn/patches/@metamask-providers-npm-17.2.0-cb0cfcdadc.patch"


Is it safe to force usage expecting v15 to use v17 instead?

socket-security · 2024-10-24T05:36:35Z

👍 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/extension-port-stream@3.0.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

legobeat · 2024-10-24T08:19:33Z

@SocketSecurity ignore npm/extension-port-stream@3.0.0

## **Description** - Bump `@babel/core` and `@babel/runtime` to latest - Fix: replace previous usage of unpatched `@babel/runtime` with consistent usage of patched version - The unpatched version was inadvertently used by `@metamask/smart-transactions-controller` [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/28068?quickstart=1) ## **Related issues** - #27049 - #27923 ## **Manual testing steps** ## **Screenshots/Recordings** ### **Before** ### **After** ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). 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.

…tream@^8 (#28060) ## **Description** - Replace legacy `json-rpc-middleware-stream@^5` (2023-09-27) with `@metamask/json-rpc-middleware-stream@^8` (2024-10-16) [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/28060?quickstart=1) ## **Related issues** - Fully removing usage of old version and aligning versions depends on updating `@metamask/providers`, done in either/both of: - #27049 - #27923 ## **Manual testing steps** ## **Screenshots/Recordings** ### **Before** ### **After** ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). 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.

jiexi · 2024-10-29T21:18:28Z

@metamaskbot update-policies

metamaskbot · 2024-10-29T21:30:01Z

Policies updated.
👀 Please review the diff for suspicious new powers.

🧠 Learn how: https://lavamoat.github.io/guides/policy-diff/#what-to-look-for-when-reviewing-a-policy-diff

Gudahtt · 2024-11-27T23:46:33Z

Replaced by #28757

bump @metamask/providers to ^17.2.0

c2ab0db

github-actions bot added the team-wallet-api-platform label Sep 10, 2024

Fix initializeProvider import

26c9dae

Update LavaMoat policies

79642c4

jiexi added 2 commits September 10, 2024 14:35

dedupe

1374c7f

Merge remote-tracking branch 'origin/jl/bump-provider-17.2.0' into jl…

03d402f

…/bump-provider-17.2.0

jiexi changed the title ~~bump @metamask/providers to ^17.2.0~~ chore: bump @metamask/providers to ^17.2.0 Sep 10, 2024

Webpack import assertion support

32a30e1

jiexi commented Sep 10, 2024

View reviewed changes

development/webpack/utils/loaders/swcLoader.ts

Copy link

Contributor Author

jiexi Sep 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these changes probably should be moved into a separate PR

jiexi commented Sep 10, 2024

View reviewed changes

jiexi added 4 commits September 10, 2024 16:04

lint

d7c0512

keepImportAttributes

cbda740

Merge branch 'develop' into jl/bump-provider-17.2.0

375d390

add emitAssertForImportAttributes

48dd437

Update LavaMoat policies

dddf498

jiexi added 3 commits September 11, 2024 10:41

see getDetect import default was issue

80dc1e5

Merge remote-tracking branch 'origin/jl/bump-provider-17.2.0' into jl…

71c801f

…/bump-provider-17.2.0

Merge branch 'develop' into jl/bump-provider-17.2.0

1c0282a

jiexi commented Sep 11, 2024

View reviewed changes

MajorLift reviewed Sep 11, 2024

View reviewed changes

legobeat reviewed Oct 24, 2024

View reviewed changes

app/scripts/inpage.js Outdated Show resolved Hide resolved

fix: work around broken import/export of @metamask/providers

17c36d0

legobeat mentioned this pull request Oct 24, 2024

fix(deps): @metamask/eth-json-rpc-middleware 15 #27923

Closed

11 tasks

legobeat reviewed Oct 24, 2024

View reviewed changes

legobeat added 2 commits October 24, 2024 05:07

Merge branch 'develop' into jl/bump-provider-17.2.0

9de1ea4

chore: update lavamoat policies

9d33738

fixup merge

77b6e4e

legobeat mentioned this pull request Oct 24, 2024

fix: json-rpc-middleware-stream@^5 -> @metamask/json-rpc-middleware-stream@^8 #28060

Merged

7 tasks

chore: update webpack swcLoader snapshot

dd44d55

legobeat force-pushed the jl/bump-provider-17.2.0 branch from 013a1e0 to dd44d55 Compare October 24, 2024 08:10

chore: webpack test fix

2c4af5d

This was referenced Oct 24, 2024

fix: bump and dedupe @swc and babel packages #28066

Draft

fix(devDeps): babel@7.23.2->7.25.9 #28068

Merged

Merge branch 'develop' into jl/bump-provider-17.2.0

cf3132e

legobeat and others added 3 commits October 29, 2024 11:19

Merge branch 'develop' into jl/bump-provider-17.2.0

640d766

Merge branch 'develop' into jl/bump-provider-17.2.0

4062d54

yarn

cac5cf0

Update LavaMoat policies

ab43fd0

Gudahtt closed this Nov 27, 2024

github-actions bot locked and limited conversation to collaborators Nov 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: bump `@metamask/providers` to `^17.2.0` #27049

chore: bump `@metamask/providers` to `^17.2.0` #27049

jiexi commented Sep 10, 2024 •

edited by legobeat

Loading

github-actions bot commented Sep 10, 2024

socket-security bot commented Sep 10, 2024 •

edited

Loading

jiexi commented Sep 10, 2024

metamaskbot commented Sep 10, 2024

jiexi Sep 10, 2024

jiexi Sep 10, 2024

jiexi Sep 10, 2024

jiexi commented Sep 11, 2024

metamaskbot commented Sep 11, 2024

sonarcloud bot commented Sep 11, 2024

metamaskbot commented Sep 11, 2024

codecov bot commented Sep 11, 2024

jiexi Sep 11, 2024

jiexi Sep 11, 2024 •

edited

Loading

jiexi commented Sep 11, 2024

jiexi Sep 11, 2024

MajorLift Sep 11, 2024

legobeat Oct 24, 2024

socket-security bot commented Oct 24, 2024 •

edited

Loading

legobeat commented Oct 24, 2024

jiexi commented Oct 29, 2024

metamaskbot commented Oct 29, 2024

Gudahtt commented Nov 27, 2024

chore: bump @metamask/providers to ^17.2.0 #27049

chore: bump @metamask/providers to ^17.2.0 #27049

Conversation

jiexi commented Sep 10, 2024 • edited by legobeat Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Sep 10, 2024

socket-security bot commented Sep 10, 2024 • edited Loading

jiexi commented Sep 10, 2024

metamaskbot commented Sep 10, 2024

jiexi Sep 10, 2024

Choose a reason for hiding this comment

jiexi Sep 10, 2024

Choose a reason for hiding this comment

jiexi Sep 10, 2024

Choose a reason for hiding this comment

jiexi commented Sep 11, 2024

metamaskbot commented Sep 11, 2024

sonarcloud bot commented Sep 11, 2024

Quality Gate passed

metamaskbot commented Sep 11, 2024

codecov bot commented Sep 11, 2024

Codecov Report

jiexi Sep 11, 2024

Choose a reason for hiding this comment

jiexi Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

jiexi commented Sep 11, 2024

jiexi Sep 11, 2024

Choose a reason for hiding this comment

MajorLift Sep 11, 2024

Choose a reason for hiding this comment

legobeat Oct 24, 2024

Choose a reason for hiding this comment

socket-security bot commented Oct 24, 2024 • edited Loading

Next steps

legobeat commented Oct 24, 2024

jiexi commented Oct 29, 2024

metamaskbot commented Oct 29, 2024

Gudahtt commented Nov 27, 2024

chore: bump `@metamask/providers` to `^17.2.0` #27049

chore: bump `@metamask/providers` to `^17.2.0` #27049

jiexi commented Sep 10, 2024 •

edited by legobeat

Loading

socket-security bot commented Sep 10, 2024 •

edited

Loading

jiexi Sep 11, 2024 •

edited

Loading

socket-security bot commented Oct 24, 2024 •

edited

Loading