Implement the HOMEBREW_INSTALL_CLEANUP env to trigger cleanup on reinstall/install/upgrade #5165

Wojonatior · 2018-10-23T19:49:10Z

Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same change?
Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes? Here's an example.
Have you successfully run brew style with your changes locally?
Have you successfully run brew tests with your changes locally?

This PR is thethe implementation of the HOMEBREW_INSTALL_CLEANUP ENV and associated features as discussed in #4760.

Wojonatior · 2018-10-23T19:50:20Z

Library/Homebrew/test/cmd/upgrade_spec.rb

+    setup_test_formula "testball"
+    # allow(ENV).to receive(:[]).and_call_original
+    # allow(ENV).to receive(:[]).with("HOMEBREW_INSTALL_CLEANUP").and_return("1")
+    ENV["HOMEBREW_INSTALL_CLEANUP"] = "1"


I've tried both manually setting into ENV and mocking it out as shown in the 2 commented lines. I wasn't able to get either working even though I could confirm the functionality manually.

@Wojonatior Ideally we wouldn't add another integration test for this (they are really slow). Either add a unit test or omit one entirely.

Wojonatior · 2018-10-23T19:51:34Z

Library/Homebrew/cmd/upgrade.rb

@@ -3,7 +3,7 @@
 #:
 #:    Options for the `install` command are also valid here.
 #:
-#:    If `--cleanup` is specified or `HOMEBREW_UPGRADE_CLEANUP` is set then remove
+#:    If `--cleanup` is specified, `HOMEBREW_INSTALL_CLEANUP` or `HOMEBREW_UPGRADE_CLEANUP` is set then remove


As a clarification around the original feature, is the intent to keep both ENVs or to enhance what the old one did as well a rename it?

@Wojonatior Good question 👍 Let's remove the documentation for HOMEBREW_UPGRADE_CLEANUP in favour of HOMEBREW_INSTALL_CLEANUP but keep the HOMEBREW_UPGRADE_CLEANUP variable functional for people who are still using it.

MikeMcQuaid

Nice start here! I'd like to see cmd/install changed similarly before this is merged.

MikeMcQuaid · 2018-10-24T10:58:15Z

Library/Homebrew/test/cmd/upgrade_spec.rb

+    setup_test_formula "testball"
+    # allow(ENV).to receive(:[]).and_call_original
+    # allow(ENV).to receive(:[]).with("HOMEBREW_INSTALL_CLEANUP").and_return("1")
+    ENV["HOMEBREW_INSTALL_CLEANUP"] = "1"


@Wojonatior Ideally we wouldn't add another integration test for this (they are really slow). Either add a unit test or omit one entirely.

MikeMcQuaid · 2018-10-24T10:58:25Z

Library/Homebrew/cmd/upgrade.rb

@@ -3,7 +3,7 @@
 #:
 #:    Options for the `install` command are also valid here.
 #:
-#:    If `--cleanup` is specified or `HOMEBREW_UPGRADE_CLEANUP` is set then remove
+#:    If `--cleanup` is specified, `HOMEBREW_INSTALL_CLEANUP` or `HOMEBREW_UPGRADE_CLEANUP` is set then remove


@Wojonatior Good question 👍 Let's remove the documentation for HOMEBREW_UPGRADE_CLEANUP in favour of HOMEBREW_INSTALL_CLEANUP but keep the HOMEBREW_UPGRADE_CLEANUP variable functional for people who are still using it.

Wojonatior · 2018-10-29T19:38:11Z

I've added the formula cleanup to the install and reinstall commands. I wasn't sure if it was supposed to be the formula cleanup or the full/regular cleanup. The issue seems to discuss the formula cleanup, but I'm not sure what would need to be cleaned up from the formula on an install/reinstall

MikeMcQuaid · 2018-10-30T07:39:04Z

Library/Homebrew/cmd/install.rb

@@ -73,6 +73,9 @@
 #:
 #:    If `--git` (or `-g`) is passed, Homebrew will create a Git repository, useful for
 #:    creating patches to the software.
+#:
+#:    If `HOMEBREW_INSTALL_CLEANUP` is set then remove previously installed versions
+#:    of upgraded <formulae>.


This also will clean up the HOMEBREW_CACHE for that formula

MikeMcQuaid · 2018-10-30T07:40:30Z

@Wojonatior After fixing the docs please run brew man and commit the results.

MikeMcQuaid · 2018-10-30T07:41:45Z

I wasn't sure if it was supposed to be the formula cleanup or the full/regular cleanup.

Formula cleanup 👍. Could have regular cleanup occurring every e.g. 100 installs or something, though? Thoughts?

The issue seems to discuss the formula cleanup, but I'm not sure what would need to be cleaned up from the formula on an install/reinstall

Nothing specifically but there may be leftover cache and cellar entries that it's worth cleaning up at this stage.

Wojonatior · 2018-10-30T14:37:16Z

@MikeMcQuaid I updated the docs and the manpage. I like the idea of the occasional full clean. Would it make sense to count that in the formula clean or specifically for the install? Is there a pattern established somewhere for how I would persist the number of installs?

MikeMcQuaid · 2018-10-31T09:54:48Z

Would it make sense to count that in the formula clean or specifically for the install? Is there a pattern established somewhere for how I would persist the number of installs?

I was thinking that rather than being by installs it could be by days. brew cleanup could write (or touch if it already exists) a file like HOMEBREW_CACHE/.cleaned which the mtime is checked if HOMEBREW_INSTALL_CLEANUP is set and a full, non-formula cleanup could be run at that time if it hasn't been run for e.g. 30 days (that's how often git gc is run). If we want to be safer still that brew cleanup could also only remove files/directories that would be removed anyway and are 30 days old (but that may be overkill).

MikeMcQuaid · 2018-11-06T10:30:21Z

Thanks so much for your first contribution! Without people like you submitting PRs we couldn't run this project. You rock, @Wojonatior! This is useful as-is so figured it was worth merging. Would still love to see the stuff we talked about in a follow-up PR!

Wojonatior · 2018-11-06T13:37:38Z

@MikeMcQuaid Thanks! Sorry about the lack of communication on my part. I definitely want to make the follow-up PR for this, you should hopefully see something around it in the next week or so.

MikeMcQuaid · 2018-11-07T09:42:00Z

@Wojonatior No worries, looking forward to it!

test and add HOMEBREW_INSTALL_CLEANUP to upgrade

18f8adb

Wojonatior commented Oct 23, 2018

View reviewed changes

MikeMcQuaid reviewed Oct 24, 2018

View reviewed changes

Wojonatior added 2 commits October 29, 2018 11:23

add formula cleanup to install and reinstall

51ca60d

Merge branch 'master' into feature/homebrew_install_cleanup

452d1db

MikeMcQuaid reviewed Oct 30, 2018

View reviewed changes

Update docs and manpage for HOMEBREW_INSTALL_CLEANUP

6c2f41b

MikeMcQuaid approved these changes Oct 31, 2018

View reviewed changes

MikeMcQuaid merged commit 6b1d439 into Homebrew:master Nov 6, 2018

Wojonatior deleted the feature/homebrew_install_cleanup branch November 6, 2018 13:37

lock bot added the outdated PR was locked due to age label Dec 7, 2018

lock bot locked as resolved and limited conversation to collaborators Dec 7, 2018

Implement the HOMEBREW_INSTALL_CLEANUP env to trigger cleanup on reinstall/install/upgrade #5165

Implement the HOMEBREW_INSTALL_CLEANUP env to trigger cleanup on reinstall/install/upgrade #5165

Wojonatior commented Oct 23, 2018 •

edited

Wojonatior Oct 23, 2018

MikeMcQuaid Oct 24, 2018

Wojonatior Oct 23, 2018

MikeMcQuaid Oct 24, 2018

MikeMcQuaid left a comment

MikeMcQuaid Oct 24, 2018

MikeMcQuaid Oct 24, 2018

Wojonatior commented Oct 29, 2018

MikeMcQuaid Oct 30, 2018

MikeMcQuaid commented Oct 30, 2018

MikeMcQuaid commented Oct 30, 2018

Wojonatior commented Oct 30, 2018

MikeMcQuaid commented Oct 31, 2018

MikeMcQuaid commented Nov 6, 2018

Wojonatior commented Nov 6, 2018

MikeMcQuaid commented Nov 7, 2018

Implement the HOMEBREW_INSTALL_CLEANUP env to trigger cleanup on reinstall/install/upgrade #5165

Implement the HOMEBREW_INSTALL_CLEANUP env to trigger cleanup on reinstall/install/upgrade #5165

Conversation

Wojonatior commented Oct 23, 2018 • edited

Wojonatior Oct 23, 2018

Choose a reason for hiding this comment

MikeMcQuaid Oct 24, 2018

Choose a reason for hiding this comment

Wojonatior Oct 23, 2018

Choose a reason for hiding this comment

MikeMcQuaid Oct 24, 2018

Choose a reason for hiding this comment

MikeMcQuaid left a comment

Choose a reason for hiding this comment

MikeMcQuaid Oct 24, 2018

Choose a reason for hiding this comment

MikeMcQuaid Oct 24, 2018

Choose a reason for hiding this comment

Wojonatior commented Oct 29, 2018

MikeMcQuaid Oct 30, 2018

Choose a reason for hiding this comment

MikeMcQuaid commented Oct 30, 2018

MikeMcQuaid commented Oct 30, 2018

Wojonatior commented Oct 30, 2018

MikeMcQuaid commented Oct 31, 2018

MikeMcQuaid commented Nov 6, 2018

Wojonatior commented Nov 6, 2018

MikeMcQuaid commented Nov 7, 2018

Wojonatior commented Oct 23, 2018 •

edited