REPL command in project requires a target #10684

philderbeast · 2024-12-28T13:20:47Z

Fixes #10527 and #9983. Depend-on: #10688.

Doesn't allow an empty list of targets with a project context.

With a project, the REPL command requires a target. If one is not given then a message is shown explaining this and naming the project if the --project-file option was given (but not when the default 'cabal.project' project name is used implicitly). We're not yet able to list project targets so in the meantime, the messages lists the packages of the project.

When the implicit default cabal.project is used:

$ cat cabal.project
packages: pkg-one pkg-two

$ cabal repl
Error: [Cabal-7076]
With a project, the REPL command requires a single target. The packages in this
project are:
 - pkg-one
 - pkg-two

When the --project-file option is used, the file name is included:

$ cat some.project 
packages: pkg-one pkg-two

$ cabal repl --project-file=some.project
...
Error: [Cabal-7076]
With a project, the REPL command requires a single target. The packages in this
project, 'some.project', are:
 - pkg-one
 - pkg-two

When the project has no packages, this is mentioned in the message:

$ cat empty.project

$ cabal repl --project-file=empty.project
...
Error: [Cabal-7076]
With a project, the REPL command requires a single target but there are no
packages in this project, 'empty.project', to choose a package (library) or
other component from as the target for this command.

Before the fix the message mentioned a fake-package-0. This was confusing:

$ ~/.ghcup/bin/cabal-3.12.1.0 repl --project-file=some.project
...
Error: [Cabal-7076]
Internal error when trying to open a repl for the package fake-package-0. The
package is not in the set of available targets for the project plan, which would
suggest an inconsistency between readTargetSelectors and resolveTargets.

Earlier cabal-install:exe:cabal versions mentioned using all as the target but this won't work for the REPL command:

$ ~/.ghcup/bin/cabal-3.10.3.0 repl --project-file=some.project
Error: cabal-3.10.3.0: No targets given and there is no package in the current
directory. Use the target 'all' for all packages in the project or specify
packages or components by name or location. See 'cabal build --help' for more
details on target options.

Patches conform to the coding conventions.
Any changes that could be relevant to users have been recorded in the changelog.
- Is the change significant? If so, remember to add significance: significant in the changelog file.
The documentation has been updated, if necessary.
Manual QA notes have been included.
Tests have been added.

philderbeast · 2025-06-16T20:04:19Z

This pull request will be easier to review once the cfgVerbosity changes are merged.

geekosaur

Approving despite suggestions because they're not functional changes.

cabal-install/src/Distribution/Client/CmdRepl.hs

changelog.d/pr-10684.md

cabal-install/src/Distribution/Client/CmdRepl.hs

ulysses4ever

Thanks for this patch and the test! I have a couple questions...

@mpickering could you take a brief look at this (it's a small patch)? Especially my comment under the -- NOTE:.

changelog.d/pr-10684.md

cabal-install/src/Distribution/Client/CmdRepl.hs

ulysses4ever · 2025-06-18T17:47:44Z

cabal-install/src/Distribution/Client/CmdRepl.hs

+                    text "There are no packages in"
+                      <+> (project <> char '.')
+                      <+> text "Please add a package to the project and pick a component to use as the target of the REPL command."


the no-packages case is certainly already handled in other places today, right? (people keep forgetting packages:... and get an error message.) Is it possible to not duplicate this logic?

After removing the target string manipulation, the current behaviour (#9983) is bad and doesn't cover this case:

$ ~/.ghcup/bin/cabal --numeric-version 3.14.2.0 $ ~/.ghcup/bin/cabal repl --project-dir=cabal-testsuite/PackageTests/ReplProjectTarget --project-file=empty.project Configuration is affected by the following files: - empty.project Warning: There are no packages or optional-packages in the project Resolving dependencies... Error: [Cabal-7076] Internal error when trying to open a repl for the package fake-package-0. The package is not in the set of available targets for the project plan, which would suggest an inconsistency between readTargetSelectors and resolveTargets.

Also I'd be curious to know how to get better output from a debug build of cabal-install with assertions enabled because that version gives me a poorer error report with no line number:

$ cabal repl --project-dir=cabal-testsuite/PackageTests/ReplProjectTarget --project-file=empty.project Warning: this is a debug build of cabal-install with assertions enabled. Configuration is affected by the following files: - empty.project Warning: There are no packages or optional-packages in the project Resolving dependencies... Assertion failed

Warning: There are no packages or optional-packages in the project

is a different issue, I think, (#8679 probably) so it may be wise to try to avoid solving it here.

assertion failure is bad but also looks like a future work. We're minutes from cutting the 3.16 branch and all backporting will have to go through extra careful consideration (mostly deciding the tradeoff: scarse resource for the release vs profit from performing the backport)

The assertion bothers me. I could cut back on the scope of this pull request or dig in more about the assertion.

cabal-install/src/Distribution/Client/CmdRepl.hs

ulysses4ever · 2025-06-26T13:31:04Z

@philderbeast could you post a little summary on the state of this patch? Do you believe you addressed all Matt's concerns? If you're done, please ping Matt for re-reviewing.

Rebasing on master is also advisable.

There's still a chance we could get this into 3.16 but it's getting tight...

philderbeast · 2025-07-03T11:40:35Z

could you post a little summary on the state of this patch?

I'm currently stumbling over assertions.

mpickering · 2025-07-03T11:42:03Z

Let me know if you need some help with this @philderbeast

philderbeast · 2025-07-07T20:57:57Z

Thanks @mpickering. I'd like to be able to get a line number for the assertion I'm triggering here on this branch. Is that possible?

Assertion failed with backtrace for `cabal init` generated package

I'm able to run cabal init for a new package, alter the generated main as follows, add -fno-ignore-asserts to the executable in the .cabal file and then trigger the assertion and get a line number with the stack backtrace.

main :: IO ()
main = do
+   assert False (pure ())
    putStrLn "Hello, Haskell!"

$ cabal run assert
Resolving dependencies...
Build profile: -w ghc-9.12.2 -O1
In order, the following will be built (use -v for more details):
 - assert-0.1.0.0 (exe:assert) (configuration changed)
Configuring executable 'assert' for assert-0.1.0.0...
Preprocessing executable 'assert' for assert-0.1.0.0...
Building executable 'assert' for assert-0.1.0.0...
[1 of 1] Compiling Main             ( app/Main.hs, dist-newstyle/build/x86_64-linux/ghc-9.12.2/assert-0.1.0.0/x/assert/build/assert/assert-tmp/Main.o ) [Optimisation flags changed]
[2 of 2] Linking dist-newstyle/build/x86_64-linux/ghc-9.12.2/assert-0.1.0.0/x/assert/build/assert/assert [Objects changed]
assert: Uncaught exception ghc-internal:GHC.Internal.IO.Exception.AssertionFailed:

Assertion failed

HasCallStack backtrace:
  throwIO, called at libraries/ghc-internal/src/GHC/Internal/IO/Exception.hs:444:5 in ghc-internal:GHC.Internal.IO.Exception
  assert, called at app/Main.hs:7:5 in assert-0.1.0.0-inplace-assert:Main

Assertion failed (without backtrace so far 😢) for `cabal-install`

On wip/assertion-failed, I've added an assertion to warnIfAssertionsAreEnabled to see if I can trigger an assertion and get back a line number for cabal-install but no luck so far.

$ cabal run cabal-install:exe:cabal -- build all --dry-run
Configuration is affected by the following files:
- cabal.project
Build profile: -w ghc-9.12.2 -O1
In order, the following will be built (use -v for more details):
 - cabal-install-3.17.0.0 (exe:cabal) (configuration changed)
Configuring executable 'cabal' for cabal-install-3.17.0.0...
Preprocessing executable 'cabal' for cabal-install-3.17.0.0...
Building executable 'cabal' for cabal-install-3.17.0.0...
Warning: this is a debug build of cabal-install with assertions enabled.
Assertion failed
Assertion failed

mpickering · 2025-07-08T13:03:53Z

@philderbeast I run the test which is failing

-----BEGIN CABAL OUTPUT-----
Resolving dependencies...
-----END CABAL OUTPUT-----
Assertion failed
CallStack (from HasCallStack):
  assert, called at src/Distribution/Client/ProjectOrchestration.hs:1061:3 in cabal-install-3.17.0.0-inplace:Distribution.Client.ProjectOrchestration

which points to this code:

1053 -- | Wrapper around 'ProjectPlanning.pruneInstallPlanToTargets' that adjusts    
1054 -- for the extra unneeded info in the 'TargetsMap'.                             
1055 pruneInstallPlanToTargets                                                       
1056   :: TargetAction                                                               
1057   -> TargetsMap                                                                 
1058   -> ElaboratedInstallPlan                                                      
1059   -> ElaboratedInstallPlan                                                      
1060 pruneInstallPlanToTargets targetActionType targetsMap elaboratedPlan =          
1061   assert (Map.size targetsMap > 0) $                                            
1062     ProjectPlanning.pruneInstallPlanToTargets                                   
1063       targetActionType                                                          
1064       (Map.map (map fst) targetsMap)                                            
1065       elaboratedPlan

Is that what you are looking for?

- Show packages when no --project-file is given - Handle the case with no packages in the project - Add a changelog - Add tests - Satisfy hlint - Satisfy fourmolu - Don't need a target when there is one package - Adjust target strings for sole package - Add alt.project tests for ReplOptions - Silence the 1st withCtx call's verbosity - Don't repeat configuration is affected by - Satisfy whitespace - Fixups after rebase - Remove punct variable

- Comma with but joining indep' clauses - Use single package Co-Authored-By: brandon s allbery kf8nh <[email protected]>

Improve test descriptions

- Don't use -XRecordWildCards for configFlags

philderbeast · 2025-07-10T12:58:07Z

I run the test which is failing

Interesting. Shouldn't all CI runs have a backtrace that points to the same location for the failing assertion?

Validate ubuntu-22.04 ghc-9.8.4 has the backtrace location you shared @mpickering but Validate ubuntu-22.04 ghc-9.12.2 doesn't.

Here's a quick diff of a snippet of the output from those above CI runs (ghc-9.8.4 first in red).

- Assertion failed
- CallStack (from HasCallStack):
-   assert, called at src/Distribution/Client/ProjectOrchestration.hs:1061:3 in cabal-install-3.17.0.0-inplace:Distribution.Client.ProjectOrchestration
+   | Assertion failed
+   |
+ 
+ HasCallStack backtrace:
+   throwIO, called at src/Test/Cabal/Server.hs:213:21 in cabal-testsuite-3-inplace:Test.Cabal.Server

philderbeast marked this pull request as draft December 28, 2024 13:20

philderbeast force-pushed the fix/repl-project-null-target branch 4 times, most recently from 09fcf06 to 6dd178f Compare December 28, 2024 16:31

philderbeast marked this pull request as ready for review December 28, 2024 16:31

philderbeast added attention: needs-review cabal-install: cmd/repl labels Dec 28, 2024

philderbeast marked this pull request as draft December 28, 2024 19:48

philderbeast removed the attention: needs-review label Dec 28, 2024

philderbeast force-pushed the fix/repl-project-null-target branch 2 times, most recently from 2782ef9 to 5a50424 Compare December 29, 2024 16:28

philderbeast force-pushed the fix/repl-project-null-target branch 2 times, most recently from 35477a0 to 1b8edc1 Compare January 12, 2025 12:37

philderbeast force-pushed the fix/repl-project-null-target branch from 1b8edc1 to 2a587e3 Compare March 22, 2025 20:31

philderbeast force-pushed the fix/repl-project-null-target branch from 2a587e3 to 59869f3 Compare April 19, 2025 12:42

philderbeast force-pushed the fix/repl-project-null-target branch from 59869f3 to d34ecf2 Compare June 16, 2025 19:24

philderbeast mentioned this pull request Jun 16, 2025

Add cfgVerbosity #10688

Merged

2 tasks

philderbeast force-pushed the fix/repl-project-null-target branch from d34ecf2 to 80875e2 Compare June 16, 2025 19:52

philderbeast mentioned this pull request Jun 16, 2025

make cabal less chatty w.r.t. project files in use #10940

Merged

6 tasks

philderbeast marked this pull request as ready for review June 16, 2025 20:01

philderbeast added the attention: needs-review label Jun 16, 2025

geekosaur approved these changes Jun 16, 2025

View reviewed changes

cabal-install/src/Distribution/Client/CmdRepl.hs Outdated Show resolved Hide resolved

changelog.d/pr-10684.md Outdated Show resolved Hide resolved

cabal-install/src/Distribution/Client/CmdRepl.hs Outdated Show resolved Hide resolved

philderbeast force-pushed the fix/repl-project-null-target branch 5 times, most recently from 2e359e9 to 88c7a58 Compare June 17, 2025 16:26

ulysses4ever reviewed Jun 18, 2025

View reviewed changes

mpickering reviewed Jun 19, 2025

View reviewed changes

cabal-install/src/Distribution/Client/CmdRepl.hs Outdated Show resolved Hide resolved

philderbeast force-pushed the fix/repl-project-null-target branch 3 times, most recently from fc542e2 to 236d5b8 Compare June 23, 2025 14:41

ulysses4ever added this to the Considered for 3.16 milestone Jun 26, 2025

ulysses4ever mentioned this pull request Jun 25, 2025

Cabal/cabal-install 3.16.0.0 release checklist #11010

Open

37 tasks

philderbeast force-pushed the fix/repl-project-null-target branch 2 times, most recently from b632961 to a49a505 Compare June 30, 2025 01:12

philderbeast removed the attention: needs-review label Jul 3, 2025

philderbeast force-pushed the fix/repl-project-null-target branch from a49a505 to c9d2b55 Compare July 6, 2025 20:08

philderbeast and others added 13 commits July 10, 2025 07:35

Review comment changes

27422ce

- Comma with but joining indep' clauses - Use single package Co-Authored-By: brandon s allbery kf8nh <[email protected]>

Update tests, adding more assertions

59bb15e

Improve test descriptions

Mention [package:][ctype:]component

3ae3995

Don't repeat [package:][ctype:]component

cc6ebf1

Lift validatedTargets, rename r as replFlags

7ff2a35

- Don't use -XRecordWildCards for configFlags

Add a one.project one pkg test

a231e08

Remove target string manipulation

b9d1598

Make reportProjectNoTarget a function

d8565fa

Add back implicit package target

e2ac35f

Redo ReplProjectTarget tests

265cacd

Redo ReplProjectNoneTarget tests

998038d

Satisfy fix-whitespace

354f434

philderbeast force-pushed the fix/repl-project-null-target branch from c9d2b55 to 354f434 Compare July 10, 2025 11:35

REPL command in project requires a target #10684

Are you sure you want to change the base?

REPL command in project requires a target #10684

Uh oh!

Conversation

philderbeast commented Dec 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

philderbeast commented Jun 16, 2025

Uh oh!

geekosaur left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ulysses4ever left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ulysses4ever Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

philderbeast Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

ulysses4ever Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

ulysses4ever Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

philderbeast Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ulysses4ever commented Jun 26, 2025

Uh oh!

philderbeast commented Jul 3, 2025

Uh oh!

mpickering commented Jul 3, 2025

Uh oh!

philderbeast commented Jul 7, 2025

Assertion failed with backtrace for cabal init generated package

Assertion failed (without backtrace so far 😢) for cabal-install

Uh oh!

mpickering commented Jul 8, 2025

Uh oh!

philderbeast commented Jul 10, 2025

Uh oh!

Uh oh!

philderbeast commented Dec 28, 2024 •

edited

Loading

ulysses4ever left a comment •

edited

Loading

Assertion failed with backtrace for `cabal init` generated package

Assertion failed (without backtrace so far 😢) for `cabal-install`