feat: expose solidity test runner config via user config #5837

galargh · 2024-10-21T15:44:03Z

Because this PR includes a bug fix, relevant tests have been included.
Because this PR includes a new feature, the change was previously discussed on an Issue or with someone from the team.
I didn't do anything of this.

This PR implements https://www.notion.so/nomicfoundation/Configuration-122578cdeaf58049a477dc4c585834f4

In particular, it:

adds a test key to the solidity.profiles.* user config (or solidity.* or solidity if the user uses a less granular setup than build profiles)
replaces the --timeout flag with a solidity.profiles.*.test.timeout in user config
exposes the entirety of https://github.com/NomicFoundation/edr/blob/feat/solidity-tests/crates/edr_napi/src/solidity_tests/config.rs#L23 via solidity.profiles.*.test without exposing any EDR types

changeset-bot · 2024-10-21T15:44:08Z

⚠️ No Changeset found

Latest commit: 545f1bc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2024-10-21T15:44:10Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hardhat	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 13, 2025 9:07am

github-actions · 2024-10-21T15:45:32Z

hardhat

Total size of the bundle: 225M
Total number of dependencies (including transitive): 58

List of dependencies (sorted by size)

220M	total
30M	@ignored/edr-optimism-linux-x64-musl
30M	@ignored/edr-optimism-linux-x64-gnu
27M	@ignored/edr-optimism-linux-arm64-musl
27M	@ignored/edr-optimism-linux-arm64-gnu
22M	@ignored/edr-optimism-win32-x64-msvc
21M	@ignored/edr-optimism-darwin-x64
20M	esbuild
20M	@ignored/edr-optimism-darwin-arm64
8.9M	solc
2.8M	@sentry/tracing
1.9M	@noble/curves
1.7M	undici
1.2M	@sentry/types
1.2M	@noble/hashes
932K	@sentry/node
920K	@sentry/utils
824K	zod
796K	@ignored/hardhat-vnext-utils
576K	tsx
548K	@sentry/core
504K	fast-equals
492K	@scure/bip39
460K	@ignored/edr
384K	@ignored/edr-optimism
368K	ethereum-cryptography
344K	@sentry/hub
320K	enquirer
284K	semver
268K	@ignored/hardhat-vnext-errors
188K	commander
168K	@scure/base
136K	adm-zip
128K	get-tsconfig
96K	@scure/bip32
92K	chalk
88K	tslib
88K	@sentry/minimal
84K	js-sha3
76K	agent-base
72K	@nomicfoundation/solidity-analyzer
68K	debug
64K	lru_map
64K	https-proxy-agent
60K	@ignored/hardhat-vnext-zod-utils
56K	rfdc
56K	follow-redirects
48K	memorystream
48K	command-exists
48K	ansi-colors
44K	tmp
40K	resolve-pkg-maps
36K	p-map
32K	cookie
24K	strip-ansi
24K	env-paths
24K	ansi-regex
20K	os-tmpdir
20K	ms

…configuration

v-next/hardhat/src/internal/builtin-plugins/solidity/type-extensions.ts

galargh · 2025-01-07T13:02:05Z

v-next/hardhat/src/internal/builtin-plugins/solidity/config.ts

Please note, the changes to the solidity plugin are now purely cosmetic - reducing duplication and unifying how extension points are exposed between single and multi solc versions configs.

galargh · 2025-01-07T13:04:19Z

The PR is now ready for re-review. As discussed on Slack, we'll accept the solidity test config via the solidityTest key in the config (at least for now).

alcuadrado

I left a small comment, but LGTM. Feel free to merge after looking at them.

@schaable I left a comment for you to.

alcuadrado · 2025-01-12T19:59:58Z

v-next/hardhat/src/internal/builtin-plugins/solidity/config.ts

@@ -34,6 +34,8 @@ const solcUserConfigType = z.object({
  profiles: incompatibleFieldType("This field is incompatible with `version`"),
 });

+const singleVersionSolcUserConfigType = solcUserConfigType;


I don't get why this is needed.

NOTE: I read the other change, and now I get that it's to match the types 1:1. Maybe we should have a comment about it.

Yes, totally, adding a comment makes perfect sense.

alcuadrado · 2025-01-12T20:00:40Z

v-next/hardhat/src/internal/builtin-plugins/solidity/config.ts

+    compilers: incompatibleFieldType(
+      "This field is incompatible with `version`",
+    ),
+    overrides: incompatibleFieldType(
+      "This field is incompatible with `version`",
+    ),
+    profiles: incompatibleFieldType(
+      "This field is incompatible with `version`",
+    ),


Aren't these duplicated? I think they were already duplicated in the previous version though. Byt they are already present in the solcUserConfigType.

I think I originally duplicated it to make it explicit.

Yes, I did notice that, but I didn't want to meddle with that in this PR as I felt I had already done enough of that ;) I think we could tackle that in a follow-up if we want to.

alcuadrado · 2025-01-12T20:07:41Z

v-next/hardhat/src/internal/builtin-plugins/solidity/type-extensions.ts

@@ -13,26 +13,33 @@ declare module "../../../types/config.js" {
    settings?: any;
  }

+  // eslint-disable-next-line @typescript-eslint/no-empty-interface -- This could be an extension point
+  export interface SingleVersionSolcUserConfig extends SolcUserConfig {}


Historically, in types that we know could be extended, we favor flatter types without and duplication, as they are more flexible and robust with respect to extensions. e.g. avoiding accidentally extending more than one thing at the same time. This pattern is followed in the rest of the plugins.

Now, the way you implemented it (i.e. with interface I extends Base {}) looks promising.

Maybe we can merge this now, and add an issue to adopt this pattern everywhere after the alpha. WDYT, @schaable ? I think we discussed reducing the duplication this at one point.

This is definitely interesting. Maybe we could create a short document comparing the two patterns to summarize their pros and cons, and then make a decision based on that.

github-actions bot added the status:ready This issue is ready to be worked on label Oct 21, 2024

galargh changed the title ~~Feat/solidity test configuration~~ WIP: Explore how to configure solidity test task Oct 21, 2024

galargh force-pushed the feat/solidity-test-configuration branch from 2ecb430 to e62a664 Compare October 23, 2024 12:42

vercel bot deployed to Preview October 23, 2024 12:43 View deployment

galargh force-pushed the feat/solidity-test-configuration branch from e62a664 to 27c734f Compare October 23, 2024 12:53

vercel bot deployed to Preview October 23, 2024 12:55 View deployment

galargh force-pushed the feat/solidity-test-configuration branch from 27c734f to 3693970 Compare October 25, 2024 12:00

vercel bot deployed to Preview October 25, 2024 12:01 View deployment

alcuadrado added the v-next A Hardhat v3 development task label Oct 25, 2024

galargh force-pushed the feat/solidity-test-configuration branch from 3693970 to 58fa591 Compare October 28, 2024 15:35

vercel bot deployed to Preview October 28, 2024 15:36 View deployment

galargh changed the base branch from v-next to unified-test-workflow October 28, 2024 15:36

galargh changed the base branch from unified-test-workflow to v-next October 28, 2024 15:37

galargh force-pushed the feat/solidity-test-configuration branch from 58fa591 to 1c5f1a1 Compare October 28, 2024 15:37

vercel bot deployed to Preview October 28, 2024 15:39 View deployment

galargh force-pushed the feat/solidity-test-configuration branch from 1c5f1a1 to b99dd9a Compare October 28, 2024 17:43

vercel bot deployed to Preview October 28, 2024 17:44 View deployment

galargh changed the title ~~WIP: Explore how to configure solidity test task~~ feat: expose solidity test runner config via user config Oct 28, 2024

galargh force-pushed the feat/solidity-test-configuration branch from b99dd9a to 1131ca0 Compare October 28, 2024 18:11

vercel bot deployed to Preview October 28, 2024 18:12 View deployment

galargh added 3 commits October 28, 2024 19:12

feat: add test config to the solidity config

a743692

feat: expose the entire runSolidityTests config

1079f78

chore: do not expose edr types via user config

8d1e133

galargh force-pushed the feat/solidity-test-configuration branch from 1131ca0 to 8d1e133 Compare October 28, 2024 18:13

vercel bot deployed to Preview October 28, 2024 18:14 View deployment

galargh changed the title ~~feat: expose solidity test runner config via user config~~ [WIP] feat: expose solidity test runner config via user config Oct 28, 2024

galargh changed the title ~~[WIP] feat: expose solidity test runner config via user config~~ feat: expose solidity test runner config via user config Oct 28, 2024

galargh changed the title ~~feat: expose solidity test runner config via user config~~ [WIP] feat: expose solidity test runner config via user config Oct 28, 2024

Merge remote-tracking branch 'origin/v-next' into feat/solidity-test-…

a4f01e1

…configuration

vercel bot deployed to Preview October 30, 2024 09:38 View deployment

galargh changed the title ~~[WIP] feat: expose solidity test runner config via user config~~ feat: expose solidity test runner config via user config Oct 30, 2024

Merge remote-tracking branch 'origin/v-next' into feat/solidity-test-…

e883990

…configuration

galargh requested a review from alcuadrado December 4, 2024 11:38

galargh marked this pull request as ready for review December 4, 2024 11:38

vercel bot deployed to Preview December 4, 2024 11:38 View deployment

alcuadrado reviewed Jan 3, 2025

View reviewed changes

v-next/hardhat/src/internal/builtin-plugins/solidity/type-extensions.ts Outdated Show resolved Hide resolved

Merge branch 'v-next' into feat/solidity-test-configuration

6edeb44

vercel bot deployed to Preview January 3, 2025 20:57 View deployment

galargh added 2 commits January 3, 2025 22:25

chore: move the test configuration of solidity tests to top-level

de9a8e6

chore: move the solidity test config to solidity test plugin

aa8a23f

vercel bot deployed to Preview January 3, 2025 21:51 View deployment

chore: fix the name of the solidity test config helpers

4b46227

vercel bot deployed to Preview January 3, 2025 22:03 View deployment

galargh commented Jan 7, 2025

View reviewed changes

Merge branch 'v-next' into feat/solidity-test-configuration

2bca92d

vercel bot deployed to Preview January 7, 2025 13:03 View deployment

galargh requested a review from alcuadrado January 7, 2025 13:03

alcuadrado approved these changes Jan 12, 2025

View reviewed changes

galargh added 2 commits January 13, 2025 09:05

Merge branch 'v-next' into feat/solidity-test-configuration

40da395

chore: add a comment next to singleVersionSolcUserConfigType definition

545f1bc

galargh enabled auto-merge January 13, 2025 09:06

vercel bot deployed to Preview January 13, 2025 09:07 View deployment

galargh added this pull request to the merge queue Jan 13, 2025

Merged via the queue into v-next with commit 047919c Jan 13, 2025
55 checks passed

galargh deleted the feat/solidity-test-configuration branch January 13, 2025 09:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: expose solidity test runner config via user config #5837

feat: expose solidity test runner config via user config #5837

galargh commented Oct 21, 2024 •

edited

Loading

changeset-bot bot commented Oct 21, 2024 •

edited

Loading

vercel bot commented Oct 21, 2024 •

edited

Loading

github-actions bot commented Oct 21, 2024 •

edited

Loading

galargh Jan 7, 2025

galargh commented Jan 7, 2025

alcuadrado left a comment

alcuadrado Jan 12, 2025

alcuadrado Jan 12, 2025

galargh Jan 13, 2025

alcuadrado Jan 12, 2025

alcuadrado Jan 12, 2025

galargh Jan 13, 2025

alcuadrado Jan 12, 2025

schaable Jan 13, 2025

feat: expose solidity test runner config via user config #5837

feat: expose solidity test runner config via user config #5837

Conversation

galargh commented Oct 21, 2024 • edited Loading

changeset-bot bot commented Oct 21, 2024 • edited Loading

⚠️ No Changeset found

vercel bot commented Oct 21, 2024 • edited Loading

github-actions bot commented Oct 21, 2024 • edited Loading

hardhat

Choose a reason for hiding this comment

galargh commented Jan 7, 2025

alcuadrado left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

galargh commented Oct 21, 2024 •

edited

Loading

changeset-bot bot commented Oct 21, 2024 •

edited

Loading

vercel bot commented Oct 21, 2024 •

edited

Loading

github-actions bot commented Oct 21, 2024 •

edited

Loading