ci: a new prep-deps workflow with caching

[HowardBraham]

Description

Major changes

• prep-deps
  • There's a new workflow that parallels the CircleCI workflow. prep-deps runs first and caches the result, then prep-build-test-webpack makes an artifact, then the benchmarks run.
  • Several of the existing workflows were changed to now depend on prep-deps
  • Many of the file changes are just using the new checkout-and-setup@caching and deleting the independent "Checkout repository" step
• vars.USE_CACHING No longer using this
  • This allows us to toggle the caching feature on and off in a centralized way. I left instructions as a comment in main.yml for how to toggle it. We can discuss implementing this in a different way, but passing this variable through different workflows is actually kind of a pain (that's the first way I implemented it). Several of the jobs are 30-60 seconds faster when this is turned on.
• test-short-suite repository-health-checks
  • I think this could be slightly controversial, but I think it's for the better.
  • I noticed that there were 7 individual really short tests, that each ran on their own VM. Each VM instance took about 1m30s to execute. I combined these together into a single VM that runs all the short tests in sequence, and takes about 1m20s combined. The if: always() statements make all independent tests run, even if one fails.
  • The 7 jobs were: test-lint-shellcheck, test-lint-changelog, test-lint-lockfile, test-deps-audit, test-yarn-dedupe, test-deps-depcheck, validate-lavamoat-allow-scripts
  • If this were running on VMs that cost money, this would be a no-brainer. As is on GitHub runners, it doesn't really cost us any time or money. All we can really say is 7 separate jobs burn fossil fuels for a slight bit of convenience in terms of seeing individual test failures in the GitHub PR page.

Prerequisites to merging this PR

• Depends on feat: GitHub-hosted runners for benchmarks #29955 MERGED
• Merge this caching branch of github-tools: ci: new checkout-and-setup to support prep-deps and caching github-tools#42 MERGED
• Change checkout-and-setup@caching and checkout-and-setup-secure@caching to new @hash

Related issues

Split off from: #29955

[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.

[metamaskbot]

Builds ready [1283bfe]

• builds: chrome, firefox
• builds (flask): chrome, firefox
• builds (MMI): chrome
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5, 6, 7
  • 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

Page Load Metrics (1641 ± 69 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1406	1928	1642	145	69
		domContentLoaded	1398	1902	1620	139	67
		load	1407	1926	1641	144	69
		domInteractive	21	118	38	24	11
		backgroundConnect	10	63	24	15	7
		firstReactRender	15	101	36	24	11
		getState	4	79	19	21	10
		initialActions	0	1	0	0	0
		loadScripts	998	1388	1177	115	55
		setupStore	6	63	16	16	8
		uiStartup	1586	2435	1885	200	96

[NicholasEllul]

Left one question & reviewed usage of caching from a security POV. No concerns from our end. I'll let the others chime in with regards to reviewing the functionality

[NicholasEllul]

Change setup-environment@caching back to setup-environment@main

(Not blocking) Are there plans to version changes? While for now pointing directly to the main branch allows for immediate updates, it can result in challenges down the road if a breaking change is introduced. Could be handy to have things set up now to save time in the long run.

[metamaskbot]

Builds ready [5973f94]

• builds: chrome, firefox
• builds (flask): chrome, firefox
• builds (MMI): chrome
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Bundle Size Stats
• mv2: E2e 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, 14
  • ui: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
  • content-script: 0
  • offscreen: 0

Page Load Metrics (1899 ± 62 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1615	2125	1899	125	60
		domContentLoaded	1600	2057	1859	118	57
		load	1609	2130	1899	128	62
		domInteractive	29	104	45	21	10
		backgroundConnect	10	92	39	25	12
		firstReactRender	16	73	32	19	9
		getState	6	68	21	19	9
		initialActions	0	1	0	0	0
		loadScripts	1125	1604	1388	119	57
		setupStore	8	65	15	15	7
		uiStartup	1834	2443	2162	158	76

Bundle size diffs

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

[HowardBraham]

@NicholasEllul @itsyoboieltr @Gudahtt
The dependent PR MetaMask/github-tools#42 has been updated, and now this PR needs another look from you guys

[NicholasEllul]

Overall changes look good 👍

[metamaskbot]

Builds ready [a25ff4b]

• builds: chrome, firefox
• builds (flask): chrome, firefox
• builds (MMI): chrome
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Bundle Size Stats
• mv2: E2e 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
  • content-script: 0
  • offscreen: 0

Page Load Metrics (1548 ± 37 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1429	1803	1547	77	37
		domContentLoaded	1394	1737	1523	71	34
		load	1433	1806	1548	77	37
		domInteractive	16	108	35	21	10
		backgroundConnect	10	71	28	15	7
		firstReactRender	14	78	28	23	11
		getState	5	65	16	20	9
		initialActions	0	1	0	0	0
		loadScripts	997	1339	1127	67	32
		setupStore	8	48	13	12	6
		uiStartup	1637	2041	1748	87	42

Bundle size diffs

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

[NicholasEllul]

Reviewed from a security POV, LGTM!

[metamaskbot]

Builds ready [d6851b8]

• builds: chrome, firefox
• builds (flask): chrome, firefox
• builds (MMI): chrome
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Bundle Size Stats
• mv2: E2e 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
  • content-script: 0
  • offscreen: 0

Page Load Metrics (1873 ± 128 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	603	2341	1775	351	168
		domContentLoaded	1493	2543	1831	270	130
		load	1532	2553	1873	267	128
		domInteractive	22	210	45	41	20
		backgroundConnect	12	86	41	23	11
		firstReactRender	15	71	36	20	10
		getState	5	51	16	12	6
		initialActions	0	1	0	0	0
		loadScripts	1090	2088	1382	247	119
		setupStore	7	64	20	19	9
		uiStartup	1768	2854	2128	301	145

Bundle size diffs

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