Add weeder (dead code elimination tool) to dev environment #4088
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zebot
added
the
ok-to-test
This was referenced Jun 8, 2024
elland
reviewed
Jun 12, 2024
nix/manual-overrides.nix
Outdated
| @@ -70,4 +70,5 @@ hself: hsuper: { | |||
| types-common-journal = hlib.addBuildTool hsuper.types-common-journal protobuf; | |||
| wire-api = hlib.addBuildTool hsuper.wire-api mls-test-cli; | |||
| wire-message-proto-lens = hlib.addBuildTool hsuper.wire-message-proto-lens protobuf; | |||
| # weeder = hlib.addBuildTool hsuper.weeder; | |||
|
This doesn't install the pinned version of weeder, but the one from hackage (2.7). |
fisx
commented
Jun 13, 2024
Since we added weeder patch to the haskell-pins.nix, it doesn't exist in the pkgs.haskelPackages package set. N.B.: This still doesn't work because some dependency of weeder doesn't compile, we should try to move it to pkgs.haskellPackages using overlay.nix and see if it works.
…kages." This reverts commit 98dc98b. (`package *` refers to all packages, but we only want local packages here.)
Makefile
Outdated
|
|
||
| .PHONY: weeder | ||
| weeder: | ||
| time weeder -N || echo -e '\n\n*** make sure you have added this to your cabal.project.local and make clean before building wire-server:\n\npackage *\n ghc-options: -fwrite-ide-info\n\n' |
There was a problem hiding this comment.
Suggested change
| time weeder -N || echo -e '\n\n*** make sure you have added this to your cabal.project.local and make clean before building wire-server:\n\npackage *\n ghc-options: -fwrite-ide-info\n\n' | |
| weeder -N || echo -e '\n\n*** make sure you have added this to your cabal.project.local and make clean before building wire-server:\n\npackage *\n ghc-options: -fwrite-ide-info\n\n' |
Also it seems like we're gonna print this message on any failure, my guess is that it will definitely be confusing in future.
There was a problem hiding this comment.
why are you opposed to the time thingy? ok, fine, let's remove it.
nix/overlay.nix
Outdated
Comment on lines
93
to
95
| overrides = hself: hsuper: { | ||
| weeder = self.haskell.lib.dontCheck (hself.callPackage ./pkgs/weeder { }); | ||
| }; |
There was a problem hiding this comment.
We should write the reason we're using a fork and link to a PR if we have expectation that this is temporary.
weeder.toml
Outdated
Comment on lines
5
to
6
| # TODO: unused-types = true | ||
| # TODO: type-class-roots = false, and see how bad it gets |
weeder.toml
Outdated
| @@ -0,0 +1,6 @@ | |||
| # weeder intro and further reading: https://github.com/ocharles/weeder?tab=readme-ov-file#weeder | |||
| roots = ["^Main.main$", "^Paths_.*\\..*"] | |||
There was a problem hiding this comment.
I just ran weeder and I think this is not complete.
There was a problem hiding this comment.
the purpose of this PR is not to have a perfectly calibrated weeder.toml, but for devs to be able to run weeder and calibrate it.
i'll clarify in the PR description and title. 👍
fisx
changed the title
akshaymankar
approved these changes
Jun 17, 2024
echoes-hq
bot
added
echoes: technical-roadmap/technical-debt
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://wearezeta.atlassian.net/browse/WPB-9667
i've run weeder from a PR locally with success (>1400 weeds, but many of them are false positives). now we only need to add that patch to our nix envs. (we should probably not run it on ci for now, until we have fine-tuned weeder.toml and eliminated all the legitimate weed.)
the purpose of this PR is:
the purpose of this PR is NOT:
Checklist
changelog.d