Add 'optional-target' field to plan.json #5659

DanielG · 2018-11-03T22:58:41Z

Having this enables tooling to give better error messages when build output is
missing. cabal-install can choose to include optional components in the build
plan even though they weren't requested explicitly by the user. Currently
tooling would have to assume missing build output after a v2-build all call
means the component is currently disabled, which is just not very clean.

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

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-7.8.4" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-7.6.3" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-7.10.3" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-8.2.2" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-8.4.4" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-8.0.2" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-8.4.4-fdebug-expensive-assertions" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"osx-7.8.4" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"osx-7.10.3" }

hvr

When designing the plan.json scheme we intentionally did not include this information (I remember discussing this with ezyang a couple years ago). However, while I'm not happy about conflating a degree of freedom frontend-UI concern into plan.json which is supposed to be UI-agnostic; but since we don't have a buildinfo.json companion metadata file yet, this seems like a tolerable tech debt to incur if it helps get us HIE support sooner rather than later.

cabal-install/Distribution/Client/ProjectPlanOutput.hs

hvr · 2018-11-10T14:23:22Z

@23Skidoo I just realised after talking to the HIE devs, this is really important for the haskell-ide-engine integration of new-build, hence I intend to get this ready for merging today and inclusion in the 2.4 point rls of exe:cabal

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-7.10.3" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-8.0.2" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-7.6.3" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-8.2.2" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-7.8.4" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-8.4.4" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-8.6.2" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-8.4.4-fdebug-expensive-assertions" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"osx-7.8.4" }

23Skidoo · 2018-11-10T17:16:01Z

@hvr OK, noted.

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"osx-7.10.3" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"osx-8.0.2" }

hvr · 2018-11-10T19:00:30Z

@23Skidoo I've rebased this and renamed the flag; I've been dogfooding this a bit and it looks good to me;

IOW, it's ready to merge from my POV

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-7.10.3" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-8.0.2" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-8.2.2" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-7.8.4" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-7.6.3" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-8.4.4" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-8.6.2" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-8.4.4-fdebug-expensive-assertions" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"osx-7.8.4" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"osx-8.0.2" }

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"osx-7.10.3" }

Having this enables tooling to give better error messages when build output is missing. cabal-install can choose to include optional components in the build plan even though they weren't requested explicitly by the user. Currently tooling would have to assume missing build output after a `v2-build all` call means the component is currently disabled, which is just not very clean.

I prefer the convention that omitted boolean JSON fields default to being `false`. Also, "target" makes it a bit more evident this is about CLI targets.

phadej · 2018-11-11T20:37:04Z

Is there a ticket about buildinfo.json?

…

Sent from my iPhone

On 11 Nov 2018, at 22.32, Mikhail Glushenkov ***@***.***> wrote: Merged #5659 into master. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

23Skidoo · 2018-11-11T20:37:28Z

Merged, thanks! Also cherry-picked to 2.4.

Add 'optional-target' field to plan.json (cherry picked from commit bba31e6)

hvr · 2018-11-11T21:22:13Z

@phadej re buildinfo.json -- there's a ticket about a variant of it: #2771

See #5659 and #5695 for details.

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 4, 2018

{"origin":"haskell/cabal/pull/5659",

098bbc4

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-7.8.4" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 4, 2018

{"origin":"haskell/cabal/pull/5659",

40a3835

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-7.6.3" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 4, 2018

{"origin":"haskell/cabal/pull/5659",

ec973e7

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-7.10.3" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 4, 2018

{"origin":"haskell/cabal/pull/5659",

3fced32

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-8.2.2" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 4, 2018

{"origin":"haskell/cabal/pull/5659",

83e5e01

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-8.4.4" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 4, 2018

{"origin":"haskell/cabal/pull/5659",

4850dcb

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"linux-8.0.2" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 4, 2018

{"origin":"haskell/cabal/pull/5659",

ef5bfb8

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"osx-7.8.4" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 4, 2018

{"origin":"haskell/cabal/pull/5659",

7dd85c6

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "1b520a8ea291898781b8f2da74c7d30d034ecae7", "tag":"osx-7.10.3" }

DanielG requested a review from hvr November 4, 2018 15:59

hvr requested changes Nov 5, 2018

View reviewed changes

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

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

hvr added the cabal-install: nix-local-build label Nov 5, 2018

23Skidoo added the blocked: action-required label Nov 7, 2018

hvr added the priority: high 🔥 label Nov 10, 2018

hvr self-assigned this Nov 10, 2018

hvr added this to the 2.4.0.1 milestone Nov 10, 2018

DanielG force-pushed the plan-json-req-by-default branch from 1b520a8 to adfc927 Compare November 10, 2018 15:43

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

d5b2761

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-7.10.3" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

5927006

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-8.0.2" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

026c353

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-7.6.3" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

1c7954c

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-8.2.2" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

a0b6e19

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-7.8.4" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

3f40e16

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-8.4.4" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

a6589ab

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"linux-8.6.2" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

35b2b40

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"osx-7.8.4" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

c507411

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"osx-7.10.3" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

30c1bfb

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "adfc9279a234a06ec6d7ec93090a5d74c480185a", "tag":"osx-8.0.2" }

hvr changed the title ~~Add 'requested-by-default' field to plan.json~~ Add 'optional-target' field to plan.json Nov 10, 2018

hvr approved these changes Nov 10, 2018

View reviewed changes

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

a5d96ae

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-7.10.3" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

b9c093a

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-8.0.2" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

e65be6b

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-8.2.2" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

31aaf1f

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-7.8.4" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

a83906a

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-7.6.3" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

33906d2

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-8.4.4" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

e77db39

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"linux-8.6.2" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

edd41e7

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"osx-7.8.4" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

982a144

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"osx-8.0.2" }

haskell-pushbot pushed a commit to haskell-pushbot/cabal-binaries that referenced this pull request Nov 10, 2018

{"origin":"haskell/cabal/pull/5659",

d1cbde3

"url":"pull/5659", "account":"haskell", "repo":"cabal", "commit": "e90007d2a064c8036625a8d9485df2fa4428925c", "tag":"osx-7.10.3" }

hvr added attention: needs-backport 3.4 and removed blocked: action-required labels Nov 10, 2018

DanielG and others added 4 commits November 11, 2018 20:20

Rename requested-by-default to optional-target

0ea892c

I prefer the convention that omitted boolean JSON fields default to being `false`. Also, "target" makes it a bit more evident this is about CLI targets.

Tweak naming.

a385034

Formatting.

b20f3f5

23Skidoo force-pushed the plan-json-req-by-default branch from e90007d to b20f3f5 Compare November 11, 2018 20:31

23Skidoo merged commit bba31e6 into haskell:master Nov 11, 2018

23Skidoo added a commit that referenced this pull request Nov 11, 2018

Merge pull request #5659 from DanielG/plan-json-req-by-default

8b7e60a

Add 'optional-target' field to plan.json (cherry picked from commit bba31e6)

hvr added a commit that referenced this pull request Nov 20, 2018

Add changelog entries for plan.json additions

5c49e01

See #5659 and #5695 for details.

DanielG deleted the plan-json-req-by-default branch November 21, 2018 20:39

hvr removed attention: needs-backport 3.4 priority: high 🔥 labels Jan 9, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add 'optional-target' field to plan.json #5659

Add 'optional-target' field to plan.json #5659

DanielG commented Nov 3, 2018

hvr left a comment •

edited

hvr commented Nov 10, 2018

23Skidoo commented Nov 10, 2018

hvr commented Nov 10, 2018

phadej commented Nov 11, 2018 via email

23Skidoo commented Nov 11, 2018

hvr commented Nov 11, 2018

Add 'optional-target' field to plan.json #5659

Add 'optional-target' field to plan.json #5659

Conversation

DanielG commented Nov 3, 2018

hvr left a comment • edited

Choose a reason for hiding this comment

hvr commented Nov 10, 2018

23Skidoo commented Nov 10, 2018

hvr commented Nov 10, 2018

phadej commented Nov 11, 2018 via email

23Skidoo commented Nov 11, 2018

hvr commented Nov 11, 2018

hvr left a comment •

edited