`--via-ir` flag is ignored when running `forge coverage`

Question

`--via-ir` flag is ignored when running `forge coverage`

Opened this issue 2 years ago · 19 comments

colinnielsen commented 2 years ago

Component

Forge

Have you ensured that all of these are up to date?

Foundry
Foundryup

What version of Foundry are you on?

forge 0.2.0 (d896050 2022-10-21T00:08:06.615745Z)

What command(s) is the bug in?

forge coverage --via-ir --report lcov

Operating System

macOS (Apple Silicon)

Describe the bug

Looks like COMPILER OPTIONS are listed when forge coverage -h is run, however it appears that the coverage command does not build through the YUL pipeline.

Answer 1 · 2022-10-21T23:37:35.000Z

Looks like forge coverage also ignores the via_ir flag in the foundry.toml

Answer 2 · 2022-10-22T07:57:54.000Z

this is unfortunately a limitation, because --via-ir transforms the AST so there is no good way of keeping track afterwards.

Answer 3 · 2022-10-24T15:11:17.000Z

Shoot... Is there a way around this? I'm worried that this feature would be bricked once solidity moves to the IR pipeline.

Answer 4 · 2022-11-03T18:04:42.000Z

I've been having this same error without using --via-ir. My project compiles fine with forge build and forge test, but throws Stack too deep when running forge coverage. Also on Apple Silicon with forge 0.2.0 (7f4fb5 2022-11-02).

Answer 5 · 2022-11-03T18:52:56.000Z

this is unfortunately a limitation, because --via-ir transforms the AST so there is no good way of keeping track of the original AST afterward right now.

we should make this clearer on the website.

Answer 6 · 2022-11-28T09:51:36.000Z

this is unfortunately a limitation, because --via-ir transforms the AST so there is no good way of keeping track afterwards.

Is the need for tracking AST isolated to the test contracts? Or does it apply to the primary source code as well?

Answer 7 · 2022-12-23T09:26:59.000Z

this is unfortunately a limitation, because --via-ir transforms the AST so there is no good way of keeping track afterwards.

I'm facing the same issue. Having this limitation in mind, do we have any alternative to see test coverage when getting Stack too deep error?

Answer 8 · 2022-12-27T21:26:58.000Z

we should make this clearer on the website.

@mattsse what do you mean by "website"? The Foundry Book? Because if yes, I don't see any documentation about coverage on there.

I am not sufficiently experienced with test coverage software to understand why it is difficult (or impossible) to run coverage over IR-optimized code, but I agree with the commend made by @colinnielsen above - if coverage is not made to work with IR, it will not be as popular as it could be.

Answer 9 · 2023-06-13T05:28:32.000Z

My code compile without --via-ir, and tests works fine, but still getting stack too deep in coverage.

forge 0.2.0 (08a629a 2023-06-03T00:04:10.749254000Z)

Answer 10 · 2023-06-13T05:50:00.000Z

My code compile without --via-ir, but still getting stack too deep in coverage.
forge 0.2.0 (08a629a 2023-06-03T00:04:10.749254000Z)

This is an annoying error and probably will be a big blocker for Foundry adoption.Also, how to get more output from the CLI command, it does not show to me where the stack too deep error exactly is:

[⠰] Compiling...
[⠒] Compiling 100 files with 0.8.20
[⠘] Solc 0.8.20 finished in 4.24s
Error:
Compiler run failed:
Error: Compiler error (/solidity/libyul/backends/evm/AsmCodeGen.cpp:68):Stack too deep. Try compiling with `--via-ir` (cli) or the equivalent `viaIR: true` (standard JSON) while enabling the optimizer. Otherwise, try removing local variables. When compiling inline assembly: Variable headStart is 1 slot(s) too deep inside the stack. Stack too deep. Try compiling with `--via-ir` (cli) or the equivalent `viaIR: true` (standard JSON) while enabling the optimizer. Otherwise, try removing local variables.

Answer 11 · 2023-06-26T09:49:31.000Z

I have the same issue with forge coverage command.

Answer 12 · 2023-10-19T17:08:03.000Z

I've been having this same error without using --via-ir. My project compiles fine with forge build and forge test, but throws Stack too deep when running forge coverage. Also on Apple Silicon with forge 0.2.0 (7f4fb5 2022-11-02).

i have the exact same issue

Answer 13 · 2023-10-25T08:56:02.000Z

Hi, I have the exact same issue, is this fix planned?

Answer 14 · 2023-11-20T10:29:28.000Z

I can pass forge build without --via-ir, but still occur the same error while running forge coverage.

Does anyone know how to fix it?

Answer 15 · 2024-01-26T19:41:10.000Z

Same issue here

Answer 16 · 2024-01-27T11:42:21.000Z

Do we have any workarounds for this issue yet?

Answer 17 · 2024-01-31T15:46:36.000Z

forge coverage --ir-minimum works

Answer 18 · 2024-06-07T10:07:17.000Z

forge coverage --ir-minimum is a life saver!

I also had to replace all my assembly { with assembly ("memory-safe") { for it to start working.

Answer 19 · 2024-06-07T13:26:21.000Z

forge coverage --ir-minimum is a life saver!

I also had to replace all my assembly { with assembly ("memory-safe") { for it to start working.

@sanbir To confirm, your assembly blocks are in fact memory safe before you add the annotation?