Make dot and ls dependencies work without ghc installed #4405

waddlaw · 2018-11-18T06:46:24Z

Note: Documentation fixes for https://docs.haskellstack.org/en/stable/ should target the "stable" branch, not master.

Please include the following checklist in your PR:

Any changes that could be relevant to users have been recorded in the ChangeLog.md
The documentation has been updated, if necessary.

Please also shortly describe how you tested your change. Bonus points for added tests!

@dbaynard fixed #4390. Could you please confirm it?

ChangeLog.md

snoyberg · 2018-11-19T07:08:52Z

src/Stack/Runners.hs

+      . updateOpts True                   (globalOptsL.configMonoidInstallGHCL)                   (Just False)
+
+-- helper function for update some option
+updateOpts :: Bool -> Lens' opts v -> v -> opts -> opts


I like this combinator 👍

snoyberg · 2018-11-19T07:10:20Z

src/Stack/Runners.hs

+    updateGlobalOpts
+      = updateOpts (dotTestTargets opts)  (globalOptsBuildOptsMonoidL.buildOptsMonoidTestsL)      (Just True)
+      . updateOpts (dotBenchTargets opts) (globalOptsBuildOptsMonoidL.buildOptsMonoidBenchmarksL) (Just True)
+      . updateOpts True                   (globalOptsL.configMonoidSkipGHCCheckL)                 (Just True)


It doesn't look like the updateOpts is really useful here, how about just set (globalOptsL...) (Just True)? I think it would be clearer that this is always being set.

Co-Authored-By: waddlaw <waddlaw@users.noreply.github.com>

waddlaw · 2018-11-19T09:44:06Z

Thank you for the review. updated!

dbaynard · 2018-11-19T23:16:15Z

Great job, @waddlaw! I'll review shortly. I thought I might have a little longer to find you the next issue to tackle 🤩

dbaynard

Generally good — just a few minor changes required.

It would be good to add some tests, too, perhaps modifying the integration test that checks this for stack clean from the fix to #4181 (although that test needs a little work, too).

dbaynard · 2018-11-21T22:21:53Z

src/Stack/Setup.hs

@@ -206,6 +206,17 @@ instance Show SetupException where
    show UnsupportedSetupConfiguration =
        "I don't know how to install GHC on your system configuration, please install manually"

+checkDownloadCompiler :: (HasConfig env, HasGHCVariant env)


As @qrilka noted, this could do with some documentation. We may want to change the WithDownloadCompiler enum as a result.

dbaynard · 2018-11-21T22:23:42Z

ChangeLog.md

@@ -97,6 +97,7 @@ Bug fixes:
  [#4314](https://github.com/commercialhaskell/stack/pull/4314)
 * Add `--cabal-files` flag to `stack ide targets` command.
 * Don't download ghc when using `stack clean`.
+* `dot` and `ls dependencies` commands no longer require GHC to be installed. Also, ensures the `--no-install-ghc` flag is respected. See: [#4390](https://github.com/commercialhaskell/stack/issues/4390)


This would be better as two lines; respecting --no-install-ghc in bug fixes and the lack of GHC requirement merged with the stack clean line above, and moved to Other enhancements.

I think that 2nd second sentence is misleading, the flag was respected at least in version 1.7.1 already:

qrilka@qdesktop ~/ws/h/stack-test-ghc-7.8.4 $ cat stack.yaml resolver: ghc-7.8.4 qrilka@qdesktop ~/ws/h/stack-test-ghc-7.8.4 $ stack --no-install-ghc clean No compiler found, expected minor version match with ghc-7.8.4 (x86_64-tinfo6) (based on resolver setting in /home/qrilka/ws/h/stack-test-ghc-7.8.4/stack.yaml). To install the correct GHC into /home/qrilka/.stack/programs/x86_64-linux/, try running "stack setup" or use the "--install-ghc" flag. qrilka@qdesktop ~/ws/h/stack-test-ghc-7.8.4 $ stack --numeric-version 1.7.1

It's perfectly clear, thanks!!

dbaynard · 2018-11-21T22:25:43Z

src/Stack/Runners.hs

+      . set (globalOptsL.configMonoidSkipGHCCheckL) (Just True)
+      . set (globalOptsL.configMonoidInstallGHCL)   (Just False)
+
+-- helper function for update some option


Suggested change

-- helper function for update some option

-- helper function to update an option

It would be good to document what the Bool represents.

waddlaw · 2018-11-23T04:34:21Z

@dbaynard I was able to do it.--system-ghc flag is needed that resolve this issue.

$ stack --numeric-version
1.9.1

$ stack --no-install-ghc --skip-ghc-check --system-ghc dot --external
strict digraph deps {
"clean" [style=dashed];
{rank=max; "rts" [shape=box]; };
"base" -> "ghc-prim";
"base" -> "integer-gmp";
"base" -> "rts";
"clean" -> "base";
"ghc-prim" -> "rts";
"integer-gmp" -> "ghc-prim";
}

$ stack --no-install-ghc --skip-ghc-check dot --external
No compiler found...

msystem is Nothing if missing --system-ghc.

stack/src/Stack/Setup.hs

Lines 386 to 391 in 0b68efc

    
           msystem <- 
        
               if soptsUseSystem sopts 
        
                   then do 
        
                       logDebug "Getting system compiler version" 
        
                       getSystemCompiler wc 
        
                   else return Nothing

stack/src/Stack/Setup.hs

Lines 395 to 399 in 0b68efc

    
           let canUseCompiler compilerVersion arch 
        
                   | soptsSkipGhcCheck sopts = True 
        
                   | otherwise = isWanted compilerVersion && arch == expectedArch 
        
               isWanted = isWantedCompiler (soptsCompilerCheck sopts) (soptsWantedCompiler sopts) 
        
               needLocal = not (any (uncurry canUseCompiler) msystem)

In other words, needLocal = not (any (uncurry canUseCompiler) Nothing).

ghci> :t any
any :: Foldable t => (a -> Bool) -> t a -> Bool

ghci> any (const True) Nothing
False

I think that we should just only enable these option in dot (and ls), or add new --skip-ensure-compiler flag. (This flag is like completely skip ensureCompiler function)

What do you think?

qrilka · 2018-11-23T05:54:28Z

I don't think enabling --system-ghc is a way to go here - it could be of a different and maybe incompatible version or there could be no system GHC at all. And the last one is the starting use case in #4390
Also I don't think that having a CLI flag --skip-ensure-compiler is a good idea - it's better to have that option internal-only and disable it only for a selected number of commands which should not fail without proper GHC available

waddlaw · 2018-11-23T07:45:41Z

Thanks @qrilka. I understand it.

My implemented checkDownloadCompiler is possibly wrong...?(always skipping ensureCompiler if --no-install-ghc specified)

checkDownloadCompiler _     SkipDownloadCompiler = return (Nothing, Nothing, False)
checkDownloadCompiler sopts WithDownloadCompiler
  | installIfMissing = ensureCompiler sopts
  | otherwise = return (Nothing, Nothing, False)
  where
    installIfMissing = soptsInstallIfMissing sopts

Hence, stack --no-install-ghc --skip-ghc-check dot --external works fine.

qrilka · 2018-11-23T08:17:35Z

I think it's wrong, yes, disabling GHC installation doesn't mean that compiler check should get skipped. For dot we should be able to go on without a compiler so SkipDownloadCompiler (or SkipCompilerCheck) should be OK for it. At least that's my understanding of these things.

waddlaw · 2018-11-23T08:28:25Z

All right. It was my mistake. I will fix asap!

dbaynard · 2019-02-10T21:43:22Z

There are some changes in progress (e.g. #4500) which may affect this.

waddlaw · 2019-02-11T02:16:29Z

@dbaynard
Sorry for the delay in work.I think I will work on it.
Is it better to work after # 4500 is merged?

dbaynard · 2019-02-11T14:55:31Z

It should be merged soon — but if you work on it before then just take into account those changes. I think the only changes left for that PR are in the test suite.

snoyberg · 2019-03-18T08:03:55Z

I'm looking into this right now as part of my work on cleaning up Stack.Runners. I'm confused as to why this is supposed to work at all. stack dot depends on knowing information about dependencies of global packages, which in turn requires having a locally installed GHC. It seems like the only way to make this work is to ignore global packages entirely, which this PR isn't doing.

This is towards addressing: * #4390 * #4405

qrilka · 2019-03-18T08:48:17Z

@snoyberg previously we didn't look into global packages and that's why I filed #4324

snoyberg · 2019-03-18T10:58:44Z

Thanks for clarifying @qrilka. I've opened up #4632, which will supersede this PR.

waddlaw added 5 commits November 18, 2018 14:27

respect --no-install-ghc flag

55504f1

Add helper lens functions

c0ed27c

dot and ls ls dependencies work without ghc

3fc58f8

fix hlint suggestion, and small refactoring

8bee990

update Changelog

7412fc0

snoyberg requested changes Nov 19, 2018

View reviewed changes

snoyberg and others added 2 commits November 19, 2018 18:31

Update ChangeLog.md

0ac8a8b

Co-Authored-By: waddlaw <waddlaw@users.noreply.github.com>

simplify

3167481

dbaynard mentioned this pull request Nov 21, 2018

To prevent download ghc when using stack clean. #4268

Merged

2 tasks

dbaynard requested changes Nov 21, 2018

View reviewed changes

mihaimaruseac changed the title ~~Fix t4390 - dot and ls dependencies work without ghc installed~~ Make dot and ls dependencies work without ghc installed Jan 22, 2019

dbaynard added the needs changes label Feb 11, 2019

snoyberg added a commit that referenced this pull request Mar 18, 2019

Refactor to make it clearer where dot needs EnvConfig

e86cd86

This is towards addressing: * #4390 * #4405

snoyberg mentioned this pull request Mar 18, 2019

Make dot and ls dependencies not require GHC #4632

Merged

2 tasks

snoyberg closed this in e34bfe2 Mar 18, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make dot and ls dependencies work without ghc installed #4405

Make dot and ls dependencies work without ghc installed #4405

waddlaw commented Nov 18, 2018 •

edited

Loading

snoyberg Nov 19, 2018

snoyberg Nov 19, 2018

waddlaw Nov 19, 2018

waddlaw commented Nov 19, 2018

dbaynard commented Nov 19, 2018

dbaynard left a comment

dbaynard Nov 21, 2018

dbaynard Nov 21, 2018

qrilka Nov 22, 2018

waddlaw Nov 23, 2018

dbaynard Nov 21, 2018

waddlaw commented Nov 23, 2018 •

edited

Loading

qrilka commented Nov 23, 2018

waddlaw commented Nov 23, 2018

qrilka commented Nov 23, 2018

waddlaw commented Nov 23, 2018

dbaynard commented Feb 10, 2019

waddlaw commented Feb 11, 2019

dbaynard commented Feb 11, 2019

snoyberg commented Mar 18, 2019

qrilka commented Mar 18, 2019

snoyberg commented Mar 18, 2019

	-- helper function for update some option
	-- helper function to update an option

Make dot and ls dependencies work without ghc installed #4405

Make dot and ls dependencies work without ghc installed #4405

Conversation

waddlaw commented Nov 18, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

waddlaw commented Nov 19, 2018

dbaynard commented Nov 19, 2018

dbaynard 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

waddlaw commented Nov 23, 2018 • edited Loading

qrilka commented Nov 23, 2018

waddlaw commented Nov 23, 2018

qrilka commented Nov 23, 2018

waddlaw commented Nov 23, 2018

dbaynard commented Feb 10, 2019

waddlaw commented Feb 11, 2019

dbaynard commented Feb 11, 2019

snoyberg commented Mar 18, 2019

qrilka commented Mar 18, 2019

snoyberg commented Mar 18, 2019

waddlaw commented Nov 18, 2018 •

edited

Loading

waddlaw commented Nov 23, 2018 •

edited

Loading