fix `cabal install --program-suffix/prefix` (fix #10290 and #10476) #10483

ulysses4ever · 2024-10-28T17:54:40Z

#10290 shows: when checking for existing installations, cabal would not account for an affix (suffix or prefix). So, if you had a hello binary installed, installing a second one with a non-empty affix (a perfectly legal operation) would fail.

The reason seemed to be a typo in 09c04e9, which passed the arguments to the Symlink structure in a wrong order.

#10476 shows: when failing to install a binary because of an existing one, cabal would report suffix-less existing target even if a suffix was set.

This turned out to be a little issue in pretty printing.

I haven't gotten around to adding tests, sadly.

QA notes

Try to check that both #10290 and #10476 don't reproduce with this patch (they both have clear instructions for reproduction).

Template Α: This PR modifies behaviour or interface

Include the following checklist in your PR:

Patches conform to the coding conventions.
Any changes that could be relevant to users have been recorded in the changelog.
The documentation has been updated, if necessary.
Manual QA notes have been included.
Tests have been added. (Ask for help if you don’t know how to write them! Ask for an exemption if tests are too complex for too little coverage!)

geekosaur

Manual QA passes here also.

fendor

While this looks reasonable (and very much like how I remember the patch to be), we should add a regression test for this. I can try to contribute one

ulysses4ever · 2024-10-28T20:44:42Z

Thanks! It'd be awesome to get a test. I don't know when I could get to it, so please contribute!

fendor · 2024-10-29T09:27:40Z

~~I wrote a test and I think I found another bug~~ EDIT: I did not find a bug, I ran the wrong binary 🙃
Is everyone fine with me adding another 60s testcase? 😅

geekosaur · 2024-10-29T12:58:23Z

The more tests, the better!

ulysses4ever · 2024-10-29T13:11:18Z

Yes, the more the merrier! We can spare some seconds on this provided how tricky this is.

ulysses4ever · 2024-10-30T03:41:42Z

@fendor just to double-check: did you mean to add one more test or is it the currently posted one that takes those 60 seconds?

fendor · 2024-10-30T07:23:26Z

@ulysses4ever The added test takes 60s on my machine, and I think it is pretty exhaustively testing the overwrite policy code path.

ulysses4ever · 2024-10-30T10:52:52Z

Awesome!

ulysses4ever · 2024-11-02T22:11:01Z

mm,I wonder why this is not being merged...

geekosaur · 2024-11-02T22:12:52Z

@mergify refresh

mergify · 2024-11-02T22:12:58Z

refresh

✅ Pull request refreshed

When checking for existing installations, cabal would not account for an affix (suffix or prefix). So, if you had a `hello` binary installed, installing a second one with a non-empty affix (a perfectly legal operation) would fail. The reason seemed to be a typo in 09c04e9, which passed the arguments to the Symlink structure in a wrong order. When failing to install a binary because of an existing one, cabal would report suffix-less existing target even if a suffix was set.

Add regression tests for the `program-prefix` and `program-suffix` flags combined with the overwrite-policy. In short, the overwrite-policy needs to take potential program affixes into account when deciding whether it will need to overwrite a program path during installation.

geekosaur · 2024-11-02T22:19:37Z

Uh, there's a #commits-behind=0 in the wrong place; it's supposed to be on merge+no rebase.

geekosaur · 2024-11-02T22:27:06Z

It should go in after CI completes. Meanwhile I offer you #10505 which should probably go in quickly before this happens again.

ulysses4ever · 2024-11-03T14:42:19Z

@mergify backport 3.14

…10483) * fix cabal install --program-suffix/prefix (fix #10290 and #10476) When checking for existing installations, cabal would not account for an affix (suffix or prefix). So, if you had a `hello` binary installed, installing a second one with a non-empty affix (a perfectly legal operation) would fail. The reason seemed to be a typo in 09c04e9, which passed the arguments to the Symlink structure in a wrong order. When failing to install a binary because of an existing one, cabal would report suffix-less existing target even if a suffix was set. * Add regression tests for overwrite policies and porgram-affixes Add regression tests for the `program-prefix` and `program-suffix` flags combined with the overwrite-policy. In short, the overwrite-policy needs to take potential program affixes into account when deciding whether it will need to overwrite a program path during installation. --------- Co-authored-by: Fendor <[email protected]> (cherry picked from commit ee3c313)

geekosaur · 2024-11-03T14:47:27Z

@mergify backport 3.12

mergify · 2024-11-03T14:47:31Z

backport 3.12

✅ Backports have been created

#10511 Backport #10483: fix cabal install --program-suffix/prefix (fix #10290 and #10476) has been created for branch 3.12

…10483) * fix cabal install --program-suffix/prefix (fix #10290 and #10476) When checking for existing installations, cabal would not account for an affix (suffix or prefix). So, if you had a `hello` binary installed, installing a second one with a non-empty affix (a perfectly legal operation) would fail. The reason seemed to be a typo in 09c04e9, which passed the arguments to the Symlink structure in a wrong order. When failing to install a binary because of an existing one, cabal would report suffix-less existing target even if a suffix was set. * Add regression tests for overwrite policies and porgram-affixes Add regression tests for the `program-prefix` and `program-suffix` flags combined with the overwrite-policy. In short, the overwrite-policy needs to take potential program affixes into account when deciding whether it will need to overwrite a program path during installation. --------- Co-authored-by: Fendor <[email protected]> (cherry picked from commit ee3c313)

Kleidukos · 2024-11-03T18:39:22Z

`cabal-3.10.3.0` ❌


❯ cabal-3.10.3.0 install hello --overwrite-policy=never --install-method=symlink                      
Warning: /home/hecate/.cabal/config: Unrecognized field token on line 118
Warning: /home/hecate/.cabal/config: Unrecognized field token on line 118
Resolving dependencies...
Build profile: -w ghc-9.6.6 -O1
In order, the following will be built (use -v for more details):
 - hello-1.0.0.2 (exe:hello) (requires build)
Starting     hello-1.0.0.2 (all, legacy fallback)
Building     hello-1.0.0.2 (all, legacy fallback)
Installing   hello-1.0.0.2 (all, legacy fallback)
Completed    hello-1.0.0.2 (all, legacy fallback)
Symlinking 'hello' to '/home/hecate/.cabal/bin/hello'


❯ cabal-3.10.3.0 install --program-suffix=-new --overwrite-policy=never --install-method=symlink hello
Warning: /home/hecate/.cabal/config: Unrecognized field token on line 118
Warning: /home/hecate/.cabal/config: Unrecognized field token on line 118
Resolving dependencies...
Symlinking 'hello' to '/home/hecate/.cabal/bin/hello-new'


❯ file /home/hecate/.cabal/bin/hello-new
/home/hecate/.cabal/bin/hello-new: broken symbolic link to ../store/ghc-9.6.6/hello-1.0.0.2-5aff93f5d5a6eb8064efe52d47134888c59c06746f361b6b851fcc60f37cef30/bin/hello


❯ file .cabal/store/ghc-9.6.6/hello-1.0.0.2-5aff93f5d5a6eb8064efe52d47134888c59c06746f361b6b851fcc60f37cef30/bin/hello-new
.cabal/store/ghc-9.6.6/hello-1.0.0.2-5aff93f5d5a6eb8064efe52d47134888c59c06746f361b6b851fcc60f37cef30/bin/hello-new: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, for GNU/Linux 3.2.0, BuildID[sha1]=e4ecc7f21d79228ab55971c98920692e145b5a86, not stripped

Verdict: cabal tries to link hello-new to the path of the package in the store, but does not take into account the program suffix and mistakenly creates a link to bin/hello instead of bin/hello-new

`cabal-3.12.1.0` ❌

❯ cabal-3.12.1.0 install hello --overwrite-policy=never --install-method=symlink 
Resolving dependencies...
Build profile: -w ghc-9.6.6 -O1
In order, the following will be built (use -v for more details):
 - hello-1.0.0.2 (exe:hello) (requires build)
Starting     hello-1.0.0.2 (all, legacy fallback: cabal-version is less than 1.8)
Building     hello-1.0.0.2 (all, legacy fallback: cabal-version is less than 1.8)
Installing   hello-1.0.0.2 (all, legacy fallback: cabal-version is less than 1.8)
Completed    hello-1.0.0.2 (all, legacy fallback: cabal-version is less than 1.8)
Symlinking 'hello' to '/home/hecate/.cabal/bin/hello'


❯ file /home/hecate/.cabal/bin/hello                                                                                      
/home/hecate/.cabal/bin/hello: symbolic link to ../store/ghc-9.6.6/hello-1.0.0.2-324cc9d163477527beb3b1762a148ce1b1e097f545de95778fa0323d77272764/bin/hello


❯ cabal-3.12.1.0 install hello --overwrite-policy=never --install-method=symlink --program-suffix=-new
Resolving dependencies...
Error: [Cabal-7149]
Path '/home/hecate/.cabal/bin/hello' already exists. Use --overwrite-policy=always to overwrite.

Verdict: cabal does not take the program suffix into account at all, and tries to create a symbolic link under the un-suffixed name. Should it manage to do this at all, it will create a link to the un-suffixed binary name, which will have been installed this time:

❯ file /home/hecate/.cabal/bin/hello-new
/home/hecate/.cabal/bin/hello-new: symbolic link to ../store/ghc-9.6.6/hello-1.0.0.2-324cc9d163477527beb3b1762a148ce1b1e097f545de95778fa0323d77272764/bin/hello

`cabal-head` from November 4th ❌

❯ ls -lah =cabal        
lrwxrwxrwx. 1 hecate hecate 10  4 nov.  15:09 /home/hecate/.ghcup/bin/cabal -> cabal-head*

❯ cabal install hello --overwrite-policy=never --install-method=symlink                      
Warning: this is a debug build of cabal-install with assertions enabled.
Resolving dependencies...
Build profile: -w ghc-9.6.6 -O1
In order, the following will be built (use -v for more details):
 - hello-1.0.0.2 (exe:hello) (requires build)
Starting     hello-1.0.0.2 (all, legacy fallback: cabal-version is less than 1.8)
Building     hello-1.0.0.2 (all, legacy fallback: cabal-version is less than 1.8)
Installing   hello-1.0.0.2 (all, legacy fallback: cabal-version is less than 1.8)
Completed    hello-1.0.0.2 (all, legacy fallback: cabal-version is less than 1.8)
Symlinking 'hello' to '/home/hecate/.cabal/bin/hello'

❯ cabal install hello --overwrite-policy=never --install-method=symlink --program-suffix=-new
Warning: this is a debug build of cabal-install with assertions enabled.
Resolving dependencies...
Error: [Cabal-7149]
Path '/home/hecate/.cabal/bin/hello' already exists. Use --overwrite-policy=always to overwrite.

Verdict: Can still reproduce the bug.

geekosaur · 2024-11-03T18:41:20Z

Right, that's part of what's being fixed (and for 3.12 was the source of the regression tickets, I believe). I have a backport in progress for whenever we put out 3.12.2.0.

Kleidukos · 2024-11-03T18:44:28Z

I'm just waiting for the next nightly to test this PR. :)

ulysses4ever · 2024-11-04T14:52:40Z

@Kleidukos cabal-head is busted, it looks: https://github.com/haskell/cabal/releases/tag/cabal-head says October 3rd is the last time it's updated. Filed #10515

ulysses4ever · 2024-11-05T03:27:32Z

@Kleidukos can you try again with the current cabal-head?

geekosaur · 2024-11-05T03:37:27Z

There still isn't a current one; since my fix today was based on an up-to-date repo and nobody else pushed anything while it was in CI, Mergify pushed it straight in without running the workflow. That's why part of my major CI shakeup is moving prereleases to nightly jobs; there's no way to reliably do a prerelease on merge (if we switched to GitHub's merge queues there would be a way to do it as part of the merge, but we are at this point agreed that we need Mergify AIUI).

ulysses4ever · 2024-11-05T04:04:01Z

@geekosaur do you know why it says "7 hours ago" by the binaries on the pre-release page although it shows the commit from October 3?

ulysses4ever · 2024-11-05T04:04:56Z

I assume at this point @Kleidukos could be better off with building master locally ☺️

geekosaur · 2024-11-05T08:25:57Z

@geekosaur do you know why it says "7 hours ago" by the binaries on the pre-release page although it shows the commit from October 3?

I have no idea. Certainly the commit matches the date.

geekosaur · 2024-11-05T08:29:44Z

The binary inside the artifact has a date that agrees with the display above, but I note the source code links are dated October 3rd. No idea what's going on here since it shouldn't be able to access the older artifacts at this point.

geekosaur · 2024-11-05T08:30:36Z

I wonder if cabal --version on a non-release build should include a Git commit.

Kleidukos · 2024-11-05T08:48:47Z

@geekosaur This has been bugging me too, as a daily user of cabal-head, this would be greatly appreciated

Kleidukos · 2024-11-05T20:11:31Z

cabal-head from November 5th ✔️

❯ cabal install hello --overwrite-policy=never --install-method=symlink                      
Warning: this is a debug build of cabal-install with assertions enabled.
Resolving dependencies...
Symlinking 'hello' to '/home/hecate/.cabal/bin/hello'

❯ file =hello    
/home/hecate/.cabal/bin/hello: symbolic link to ../store/ghc-9.6.6/hello-1.0.0.2-324cc9d163477527beb3b1762a148ce1b1e097f545de95778fa0323d77272764/bin/hello

❯ cabal install hello --overwrite-policy=never --install-method=symlink --program-suffix=-new
Warning: this is a debug build of cabal-install with assertions enabled.
Resolving dependencies...
Symlinking 'hello' to '/home/hecate/.cabal/bin/hello-new'

❯ file =hello-new                                                                                                             
/home/hecate/.cabal/bin/hello-new: symbolic link to ../store/ghc-9.6.6/hello-1.0.0.2-324cc9d163477527beb3b1762a148ce1b1e097f545de95778fa0323d77272764/bin/hello

It's good to go!

…10483) (#10510) * fix cabal install --program-suffix/prefix (fix #10290 and #10476) When checking for existing installations, cabal would not account for an affix (suffix or prefix). So, if you had a `hello` binary installed, installing a second one with a non-empty affix (a perfectly legal operation) would fail. The reason seemed to be a typo in 09c04e9, which passed the arguments to the Symlink structure in a wrong order. When failing to install a binary because of an existing one, cabal would report suffix-less existing target even if a suffix was set. * Add regression tests for overwrite policies and porgram-affixes Add regression tests for the `program-prefix` and `program-suffix` flags combined with the overwrite-policy. In short, the overwrite-policy needs to take potential program affixes into account when deciding whether it will need to overwrite a program path during installation. --------- Co-authored-by: Fendor <[email protected]> (cherry picked from commit ee3c313) Co-authored-by: Artem Pelenitsyn <[email protected]>

ulysses4ever force-pushed the program-suffix-broken-issue-10290 branch from 374c1d7 to 5770ba3 Compare October 28, 2024 17:54

ulysses4ever added the attention: needs-review label Oct 28, 2024

ulysses4ever requested a review from fendor October 28, 2024 17:55

geekosaur added attention: needs-backport 3.12 attention: needs-backport 3.14 cabal-install: cmd/install labels Oct 28, 2024

geekosaur approved these changes Oct 28, 2024

View reviewed changes

fendor approved these changes Oct 28, 2024

View reviewed changes

ulysses4ever removed the attention: needs-review label Oct 28, 2024

ulysses4ever added the squash+merge me Tell Mergify Bot to squash-merge label Oct 30, 2024

mergify bot added ready and waiting Mergify is waiting out the cooldown period merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days labels Oct 30, 2024

ulysses4ever and others added 2 commits November 2, 2024 18:18

geekosaur force-pushed the program-suffix-broken-issue-10290 branch from fa72c05 to 85a4ead Compare November 2, 2024 22:18

mergify bot merged commit ee3c313 into master Nov 2, 2024
49 checks passed

mergify bot deleted the program-suffix-broken-issue-10290 branch November 2, 2024 23:41

mergify bot mentioned this pull request Nov 3, 2024

Backport #10483: fix cabal install --program-suffix/prefix (fix #10290 and #10476) #10510

Merged

5 tasks

mergify bot mentioned this pull request Nov 3, 2024

Backport #10483: fix cabal install --program-suffix/prefix (fix #10290 and #10476) #10511

Open

5 tasks

Kleidukos self-assigned this Nov 3, 2024

geekosaur mentioned this pull request Nov 4, 2024

Mattp/cabal glob perf improvements 2 #10523

Closed

geekosaur mentioned this pull request Nov 5, 2024

cabal --version on a non-release build should include a Git commit #10528

Open

geekosaur removed attention: needs-backport 3.12 attention: needs-backport 3.14 labels Nov 5, 2024

ulysses4ever mentioned this pull request Nov 7, 2024

cabal-head is busted since October 3 #10515

Closed

ulysses4ever mentioned this pull request Nov 30, 2024

doing cabal install --program-suffix=blah produces a confusing message #10476

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix `cabal install --program-suffix/prefix` (fix #10290 and #10476) #10483

fix `cabal install --program-suffix/prefix` (fix #10290 and #10476) #10483

ulysses4ever commented Oct 28, 2024 •

edited

Loading

geekosaur left a comment

fendor left a comment

ulysses4ever commented Oct 28, 2024 •

edited

Loading

fendor commented Oct 29, 2024 •

edited

Loading

geekosaur commented Oct 29, 2024

ulysses4ever commented Oct 29, 2024

ulysses4ever commented Oct 30, 2024

fendor commented Oct 30, 2024

ulysses4ever commented Oct 30, 2024

ulysses4ever commented Nov 2, 2024

geekosaur commented Nov 2, 2024

mergify bot commented Nov 2, 2024

geekosaur commented Nov 2, 2024

geekosaur commented Nov 2, 2024

ulysses4ever commented Nov 3, 2024

geekosaur commented Nov 3, 2024

mergify bot commented Nov 3, 2024 •

edited

Loading

Kleidukos commented Nov 3, 2024 •

edited

Loading

geekosaur commented Nov 3, 2024

Kleidukos commented Nov 3, 2024

ulysses4ever commented Nov 4, 2024 •

edited

Loading

ulysses4ever commented Nov 5, 2024 •

edited

Loading

geekosaur commented Nov 5, 2024

ulysses4ever commented Nov 5, 2024

ulysses4ever commented Nov 5, 2024

geekosaur commented Nov 5, 2024

geekosaur commented Nov 5, 2024

geekosaur commented Nov 5, 2024

Kleidukos commented Nov 5, 2024

Kleidukos commented Nov 5, 2024

fix cabal install --program-suffix/prefix (fix #10290 and #10476) #10483

fix cabal install --program-suffix/prefix (fix #10290 and #10476) #10483

Conversation

ulysses4ever commented Oct 28, 2024 • edited Loading

QA notes

geekosaur left a comment

Choose a reason for hiding this comment

fendor left a comment

Choose a reason for hiding this comment

ulysses4ever commented Oct 28, 2024 • edited Loading

fendor commented Oct 29, 2024 • edited Loading

geekosaur commented Oct 29, 2024

ulysses4ever commented Oct 29, 2024

ulysses4ever commented Oct 30, 2024

fendor commented Oct 30, 2024

ulysses4ever commented Oct 30, 2024

ulysses4ever commented Nov 2, 2024

geekosaur commented Nov 2, 2024

mergify bot commented Nov 2, 2024

✅ Pull request refreshed

geekosaur commented Nov 2, 2024

geekosaur commented Nov 2, 2024

ulysses4ever commented Nov 3, 2024

geekosaur commented Nov 3, 2024

mergify bot commented Nov 3, 2024 • edited Loading

✅ Backports have been created

Kleidukos commented Nov 3, 2024 • edited Loading

cabal-3.10.3.0 ❌

cabal-3.12.1.0 ❌

cabal-head from November 4th ❌

geekosaur commented Nov 3, 2024

Kleidukos commented Nov 3, 2024

ulysses4ever commented Nov 4, 2024 • edited Loading

ulysses4ever commented Nov 5, 2024 • edited Loading

geekosaur commented Nov 5, 2024

ulysses4ever commented Nov 5, 2024

ulysses4ever commented Nov 5, 2024

geekosaur commented Nov 5, 2024

geekosaur commented Nov 5, 2024

geekosaur commented Nov 5, 2024

Kleidukos commented Nov 5, 2024

Kleidukos commented Nov 5, 2024

cabal-head from November 5th ✔️

fix `cabal install --program-suffix/prefix` (fix #10290 and #10476) #10483

fix `cabal install --program-suffix/prefix` (fix #10290 and #10476) #10483

ulysses4ever commented Oct 28, 2024 •

edited

Loading

ulysses4ever commented Oct 28, 2024 •

edited

Loading

fendor commented Oct 29, 2024 •

edited

Loading

mergify bot commented Nov 3, 2024 •

edited

Loading

Kleidukos commented Nov 3, 2024 •

edited

Loading

`cabal-3.10.3.0` ❌

`cabal-3.12.1.0` ❌

`cabal-head` from November 4th ❌

ulysses4ever commented Nov 4, 2024 •

edited

Loading

ulysses4ever commented Nov 5, 2024 •

edited

Loading