feat: Add `--features` option to legacy build system CLI #33485

rekmarks · 2025-06-05T00:08:20Z

Description

Teams have been testing features in different build types by modifying builds.yml without committing the changes. To improve upon this situation, this PR adds a --features option to the legacy build system CLI. You can specify any feature defined under the top-level features property of builds.yml. Redundantly specified features are permitted.

The "active features" are implemented as a frozen array private to development/build/config.js. This array is set once, by setActiveFeatures() during parseArgv() in development/build/index.js. Attempting to set the array multiple times will throw. Rather than threading the active features through the various build system functions, we always retrieve mutable copies of the computed active features via getActiveFeatures().

Manual testing steps

Additional features

Any feature not in the active build type will do, but for example:

yarn start --features bitcoin
Wait for the build to finish
Open the dev console for the background service worker
Observe errors in the background console about various Bitcoin things

Redundant features

yarn start --features build-main
This should behave identically to yarn start

Non-existent features

yarn start --features foo
This should error

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.

metamaskbot · 2025-06-05T00:37:57Z

Builds ready [25539ed]

builds: chrome, firefox
builds (beta): chrome, firefox
builds (flask): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
bundle size: Bundle Size Stats
user-actions-benchmark: User Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

UI Startup Metrics (1232 ± 62 ms)

Platform	BuildType	Page	Metric	Mean (ms)	Min (ms)	Max (ms)	Std Dev (ms)	P 75 (ms)	P 95 (ms)
Chrome	Browserify	Home	uiStartup	1232	1083	1377	62	1281	1343
			load	1068	944	1215	64	1117	1181
			domContentLoaded	1062	940	1209	64	1113	1163
			domInteractive	17	13	104	10	16	29
			firstPaint	740	79	1163	421	1088	1141
			backgroundConnect	8	4	30	5	8	23
			firstReactRender	20	15	40	4	21	28
			getState	14	5	64	8	19	25
			initialActions	0	0	1	0	0	1
			loadScripts	813	701	953	62	865	915
			setupStore	8	5	32	4	8	12
	Webpack	Home	uiStartup	2126	1571	2633	232	2271	2555
			load	1658	1235	2005	179	1775	1969
			domContentLoaded	1651	1231	1996	178	1770	1957
			domInteractive	15	11	60	9	13	45
			firstPaint	165	62	385	64	216	292
			backgroundConnect	22	10	65	9	24	44
			firstReactRender	142	44	364	106	219	347
			getState	14	4	332	33	13	29
			initialActions	3	1	5	1	3	4
			loadScripts	1648	1230	1985	176	1768	1946
			setupStore	26	6	314	58	17	44
Firefox	Browserify	Home	uiStartup	1371	1186	1956	130	1423	1599
			load	1215	1057	1503	107	1287	1441
			domContentLoaded	1214	1056	1502	107	1287	1441
			domInteractive	98	36	375	36	109	138
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	23	13	302	29	21	45
			firstReactRender	23	20	34	2	24	28
			getState	10	4	181	18	8	20
			initialActions	0	0	36	4	0	1
			loadScripts	1196	1039	1479	104	1265	1418
			setupStore	7	3	87	8	6	12
	Webpack	Home	uiStartup	1647	1391	2306	178	1744	2031
			load	1428	1216	1975	168	1512	1829
			domContentLoaded	1427	1216	1975	168	1512	1828
			domInteractive	77	38	151	20	86	112
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	23	16	94	8	24	31
			firstReactRender	43	31	54	4	46	50
			getState	13	6	197	20	10	32
			initialActions	1	0	2	1	1	1
			loadScripts	1407	1200	1953	166	1492	1805
			setupStore	10	5	84	12	8	17

Benchmark value 1063 exceeds gate value 1061 for chrome browserify home mean domContentLoaded
Benchmark value 24 exceeds gate value 18 for chrome browserify home p95 backgroundConnect
Benchmark value 2556 exceeds gate value 2454 for chrome webpack home p95 uiStartup
Benchmark value 1647 exceeds gate value 1615 for firefox webpack home mean uiStartup
Benchmark value 1428 exceeds gate value 1380 for firefox webpack home mean load
Benchmark value 1428 exceeds gate value 1380 for firefox webpack home mean domContentLoaded
Benchmark value 44 exceeds gate value 38 for firefox webpack home mean firstReactRender
Benchmark value 1407 exceeds gate value 1360 for firefox webpack home mean loadScripts
Benchmark value 2031 exceeds gate value 1935 for firefox webpack home p95 uiStartup
Benchmark value 1829 exceeds gate value 1660 for firefox webpack home p95 load
Benchmark value 1828 exceeds gate value 1660 for firefox webpack home p95 domContentLoaded
Benchmark value 1805 exceeds gate value 1630 for firefox webpack home p95 loadScripts
Sum of mean exceeds: 183ms | Sum of p95 exceeds: 716ms
Sum of all benchmark exceeds: 899ms

Bundle size diffs

background: 0 Bytes (0%)
ui: 0 Bytes (0%)
common: 0 Bytes (0%)

metamaskbot · 2025-06-05T02:49:41Z

Builds ready [fc59f41]

builds: chrome, firefox
builds (beta): chrome, firefox
builds (flask): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
bundle size: Bundle Size Stats
user-actions-benchmark: User Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

UI Startup Metrics (1206 ± 62 ms)

Platform	BuildType	Page	Metric	Mean (ms)	Min (ms)	Max (ms)	Std Dev (ms)	P 75 (ms)	P 95 (ms)
Chrome	Browserify	Home	uiStartup	1206	1087	1390	62	1247	1322
			load	1037	919	1205	59	1071	1146
			domContentLoaded	1029	913	1199	60	1063	1138
			domInteractive	16	13	40	5	15	28
			firstPaint	679	134	1216	412	1046	1135
			backgroundConnect	9	4	44	7	9	25
			firstReactRender	22	15	63	8	22	40
			getState	14	5	37	7	19	28
			initialActions	0	0	1	0	0	1
			loadScripts	781	670	952	59	816	896
			setupStore	8	4	43	4	8	11
	Webpack	Home	uiStartup	2131	1673	2629	241	2306	2541
			load	1663	1287	2162	199	1783	1978
			domContentLoaded	1656	1282	2150	198	1773	1967
			domInteractive	16	11	84	11	13	45
			firstPaint	168	66	414	72	189	324
			backgroundConnect	25	10	326	31	26	41
			firstReactRender	145	44	364	112	301	351
			getState	11	4	39	5	12	21
			initialActions	3	1	5	1	3	4
			loadScripts	1653	1281	2139	197	1770	1961
			setupStore	28	6	326	60	18	264
Firefox	Browserify	Home	uiStartup	1334	1144	1709	103	1396	1538
			load	1188	1021	1559	104	1257	1404
			domContentLoaded	1188	1021	1558	104	1257	1403
			domInteractive	99	37	270	33	112	169
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	20	14	83	9	19	30
			firstReactRender	23	20	32	2	23	28
			getState	8	4	68	8	8	10
			initialActions	0	0	1	0	0	1
			loadScripts	1170	1005	1539	104	1234	1380
			setupStore	6	4	22	2	6	10
	Webpack	Home	uiStartup	1565	1368	2109	163	1642	1970
			load	1363	1187	1934	153	1443	1727
			domContentLoaded	1362	1186	1934	153	1443	1727
			domInteractive	81	57	213	24	87	134
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	21	15	46	6	22	39
			firstReactRender	41	27	56	5	44	50
			getState	8	4	30	4	8	18
			initialActions	1	0	2	1	1	1
			loadScripts	1345	1171	1918	153	1424	1706
			setupStore	8	5	59	6	8	12

Benchmark value 26 exceeds gate value 18 for chrome browserify home p95 backgroundConnect
Benchmark value 2541 exceeds gate value 2454 for chrome webpack home p95 uiStartup
Benchmark value 264 exceeds gate value 65 for chrome webpack home p95 setupStore
Benchmark value 42 exceeds gate value 38 for firefox webpack home mean firstReactRender
Benchmark value 1970 exceeds gate value 1935 for firefox webpack home p95 uiStartup
Benchmark value 1727 exceeds gate value 1660 for firefox webpack home p95 load
Benchmark value 1727 exceeds gate value 1660 for firefox webpack home p95 domContentLoaded
Benchmark value 1706 exceeds gate value 1630 for firefox webpack home p95 loadScripts
Sum of mean exceeds: 4ms | Sum of p95 exceeds: 539ms
Sum of all benchmark exceeds: 543ms

Bundle size diffs

background: 0 Bytes (0%)
ui: 0 Bytes (0%)
common: 0 Bytes (0%)

metamaskbot · 2025-06-09T23:50:13Z

Builds ready [2cd977d]

builds: chrome, firefox
builds (beta): chrome, firefox
builds (flask): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
bundle size: Bundle Size Stats
user-actions-benchmark: User Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7, 8
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

UI Startup Metrics (1206 ± 57 ms)

Platform	BuildType	Page	Metric	Mean (ms)	Min (ms)	Max (ms)	Std Dev (ms)	P 75 (ms)	P 95 (ms)
Chrome	Browserify	Home	uiStartup	1206	1093	1380	57	1241	1292
			load	1042	934	1156	54	1079	1137
			domContentLoaded	1034	930	1152	55	1073	1129
			domInteractive	16	13	45	5	15	29
			firstPaint	754	81	1151	403	1055	1129
			backgroundConnect	8	4	36	6	8	26
			firstReactRender	20	16	48	4	20	27
			getState	15	6	64	9	20	30
			initialActions	0	0	1	0	0	1
			loadScripts	790	689	905	54	827	884
			setupStore	8	4	26	3	8	13
	Webpack	Home	uiStartup	2074	1569	2649	253	2218	2477
			load	1594	1231	2004	186	1736	1885
			domContentLoaded	1588	1227	1992	185	1730	1875
			domInteractive	15	11	64	9	13	39
			firstPaint	168	65	373	67	202	314
			backgroundConnect	21	12	49	7	23	36
			firstReactRender	124	44	357	96	118	336
			getState	14	4	328	32	13	22
			initialActions	3	1	6	1	3	4
			loadScripts	1585	1226	1982	183	1727	1864
			setupStore	52	7	321	98	21	309
Firefox	Browserify	Home	uiStartup	1320	1135	1803	121	1365	1547
			load	1165	1012	1565	97	1217	1339
			domContentLoaded	1164	1012	1565	97	1217	1339
			domInteractive	97	34	376	44	99	173
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	24	13	193	21	21	69
			firstReactRender	23	20	58	6	23	29
			getState	11	5	190	21	8	36
			initialActions	0	0	1	0	0	1
			loadScripts	1143	995	1438	91	1199	1325
			setupStore	11	4	185	24	6	28
	Webpack	Home	uiStartup	1550	1357	1960	132	1658	1779
			load	1352	1163	1696	130	1460	1555
			domContentLoaded	1351	1163	1696	130	1459	1555
			domInteractive	83	32	375	40	85	144
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	20	15	40	5	21	32
			firstReactRender	41	28	47	3	43	45
			getState	7	5	12	1	8	10
			initialActions	0	0	2	1	1	1
			loadScripts	1334	1152	1678	130	1439	1539
			setupStore	7	5	20	2	8	11

Benchmark value 27 exceeds gate value 18 for chrome browserify home p95 backgroundConnect
Benchmark value 53 exceeds gate value 32 for chrome webpack home mean setupStore
Benchmark value 2477 exceeds gate value 2454 for chrome webpack home p95 uiStartup
Benchmark value 309 exceeds gate value 65 for chrome webpack home p95 setupStore
Benchmark value 12 exceeds gate value 9 for firefox browserify home mean setupStore
Benchmark value 36 exceeds gate value 24 for firefox browserify home p95 getState
Benchmark value 28 exceeds gate value 27 for firefox browserify home p95 setupStore
Benchmark value 41 exceeds gate value 38 for firefox webpack home mean firstReactRender
Sum of mean exceeds: 27ms | Sum of p95 exceeds: 289ms
Sum of all benchmark exceeds: 316ms

Bundle size diffs

background: 0 Bytes (0%)
ui: 0 Bytes (0%)
common: 0 Bytes (0%)

HowardBraham · 2025-06-10T05:17:38Z

Can we do this through the .manifest-overrides.json system?

My goal is to reduce and simplify the number of independent configuration systems we have.

rekmarks · 2025-06-10T14:53:45Z

Can we do this through the .manifest-overrides.json system?

@HowardBraham no, that's not possible. This PR concerns the build-time feature flags of builds.yml, while .manifest-overrides.json concerns runtime / remote feature flags. This PR also doesn't add a new configuration system, but rather makes using an existing one less complicated.

rekmarks · 2025-06-10T14:55:18Z

(Yes, I fat-fingered "Close pull request".)

metamaskbot · 2025-06-10T15:17:10Z

Builds ready [2cd977d]

builds: chrome, firefox
builds (beta): chrome, firefox
builds (flask): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
bundle size: Bundle Size Stats
user-actions-benchmark: User Actions Stats
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6, 7, 8
- common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
- content-script: 0
- offscreen: 0

UI Startup Metrics (1233 ± 75 ms)

Platform	BuildType	Page	Metric	Mean (ms)	Min (ms)	Max (ms)	Std Dev (ms)	P 75 (ms)	P 95 (ms)
Chrome	Browserify	Home	uiStartup	1233	1110	1453	75	1287	1372
			load	1066	941	1244	68	1120	1179
			domContentLoaded	1060	936	1235	68	1111	1172
			domInteractive	17	14	96	9	16	31
			firstPaint	753	141	1214	418	1089	1170
			backgroundConnect	8	4	29	4	8	22
			firstReactRender	20	16	30	3	20	26
			getState	13	6	38	7	18	27
			initialActions	0	0	1	0	0	0
			loadScripts	814	696	1002	66	864	926
			setupStore	8	4	20	2	8	12
	Webpack	Home	uiStartup	2090	1590	2694	248	2260	2484
			load	1636	1232	2041	193	1769	1895
			domContentLoaded	1630	1224	2008	191	1760	1883
			domInteractive	15	11	66	9	13	41
			firstPaint	171	58	1354	131	185	288
			backgroundConnect	26	12	372	37	24	54
			firstReactRender	124	43	362	97	106	332
			getState	19	5	306	42	12	47
			initialActions	3	1	7	1	3	5
			loadScripts	1626	1221	1997	190	1756	1875
			setupStore	43	7	315	83	18	311
Firefox	Browserify	Home	uiStartup	1389	1232	1819	114	1443	1630
			load	1226	1068	1638	102	1282	1409
			domContentLoaded	1225	1068	1637	101	1282	1409
			domInteractive	105	35	391	49	111	158
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	21	14	51	6	22	32
			firstReactRender	24	20	55	4	24	29
			getState	12	4	357	35	9	15
			initialActions	0	0	1	0	0	1
			loadScripts	1206	1051	1617	101	1266	1392
			setupStore	9	4	177	18	6	27
	Webpack	Home	uiStartup	1545	1345	1864	118	1653	1756
			load	1345	1146	1625	116	1437	1537
			domContentLoaded	1344	1146	1625	116	1436	1537
			domInteractive	80	56	153	19	88	119
			firstPaint	NaN	NaN	NaN	NaN	NaN	NaN
			backgroundConnect	21	15	49	6	21	37
			firstReactRender	40	29	46	3	43	46
			getState	8	4	17	2	9	11
			initialActions	0	0	1	0	1	1
			loadScripts	1326	1122	1605	116	1420	1520
			setupStore	7	5	28	3	8	10

Benchmark value 1372 exceeds gate value 1365 for chrome browserify home p95 uiStartup
Benchmark value 22 exceeds gate value 18 for chrome browserify home p95 backgroundConnect
Benchmark value 43 exceeds gate value 32 for chrome webpack home mean setupStore
Benchmark value 2484 exceeds gate value 2454 for chrome webpack home p95 uiStartup
Benchmark value 311 exceeds gate value 65 for chrome webpack home p95 setupStore
Benchmark value 12 exceeds gate value 11 for firefox browserify home mean getState
Benchmark value 41 exceeds gate value 38 for firefox webpack home mean firstReactRender
Sum of mean exceeds: 15ms | Sum of p95 exceeds: 287ms
Sum of all benchmark exceeds: 302ms

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

background: 1.02 KiB (0.02%)
ui: 2.08 KiB (0.03%)
common: -499 Bytes (-0.01%)

HowardBraham

Ah got it, approved then!

metamaskbot added team-ocap-kernel The Ocap Kernel team INVALID-PR-TEMPLATE PR's body doesn't match template labels Jun 5, 2025

rekmarks marked this pull request as ready for review June 5, 2025 00:15

rekmarks requested a review from Gudahtt June 5, 2025 00:15

rekmarks added the area-buildSystem related to our build system label Jun 5, 2025

rekmarks added this to PR review queue Jun 6, 2025

github-project-automation bot moved this to Needs dev review in PR review queue Jun 6, 2025

rekmarks added 4 commits June 9, 2025 16:28

feat: Add features option to legacy build script

f3cc2e7

refactor: Document active feature helpers, only set active features once

dd0e140

refactor: Freeze cachedActiveFeatures, only expose copies

bf6536e

refactor: Use undefined instead of null

2cd977d

rekmarks force-pushed the rekm/build-features-option branch from fc59f41 to 2cd977d Compare June 9, 2025 23:28

rekmarks enabled auto-merge June 10, 2025 01:18

rekmarks disabled auto-merge June 10, 2025 01:19

rekmarks enabled auto-merge June 10, 2025 01:20

davidmurdoch approved these changes Jun 10, 2025

View reviewed changes

rekmarks closed this Jun 10, 2025

auto-merge was automatically disabled June 10, 2025 14:53
Pull request was closed

github-actions bot locked and limited conversation to collaborators Jun 10, 2025

rekmarks reopened this Jun 10, 2025

rekmarks enabled auto-merge June 10, 2025 14:54

MetaMask unlocked this conversation Jun 10, 2025

HowardBraham approved these changes Jun 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Add `--features` option to legacy build system CLI #33485

feat: Add `--features` option to legacy build system CLI #33485

Uh oh!

rekmarks commented Jun 5, 2025 •

edited

Loading

Uh oh!

metamaskbot commented Jun 5, 2025

Uh oh!

metamaskbot commented Jun 5, 2025

Uh oh!

metamaskbot commented Jun 9, 2025

Uh oh!

HowardBraham commented Jun 10, 2025

Uh oh!

rekmarks commented Jun 10, 2025

Uh oh!

rekmarks commented Jun 10, 2025

Uh oh!

metamaskbot commented Jun 10, 2025

Uh oh!

HowardBraham left a comment

Uh oh!

Uh oh!

feat: Add --features option to legacy build system CLI #33485

Are you sure you want to change the base?

feat: Add --features option to legacy build system CLI #33485

Uh oh!

Conversation

rekmarks commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Manual testing steps

Additional features

Redundant features

Non-existent features

Pre-merge author checklist

Pre-merge reviewer checklist

Uh oh!

metamaskbot commented Jun 5, 2025

Uh oh!

metamaskbot commented Jun 5, 2025

Uh oh!

metamaskbot commented Jun 9, 2025

Uh oh!

HowardBraham commented Jun 10, 2025

Uh oh!

rekmarks commented Jun 10, 2025

Uh oh!

rekmarks commented Jun 10, 2025

Uh oh!

metamaskbot commented Jun 10, 2025

Uh oh!

HowardBraham left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

feat: Add `--features` option to legacy build system CLI #33485

feat: Add `--features` option to legacy build system CLI #33485

rekmarks commented Jun 5, 2025 •

edited

Loading