Skip to content

Avoid stashing changes when all changes are staged - #674

Merged
sds merged 1 commit into
masterfrom
conservative-stash
Sep 29, 2019
Merged

sds merged 1 commit into
masterfrom
conservative-stash

Conversation

@sds

@sds sds commented Sep 29, 2019 •

Copy link
Copy Markdown
Owner

It was suggested in #135 that a potential way to avoid unnecessary file change detection and general stashing woes would be to stash changes only when there were unstaged changes that needed to be excluded from the run.

This presents a nice optimization that I wish we had considered long ago. We can simplify the logic now that we see the purpose of this feature a little more clearly: stash only when you need to.

Issue #669 raised an interesting point about the difficulty to detect if a stash entry was created, so we modified the tests to check if a method call was made to validate the logic. This isn't great as it's peeking deep into the implementation, so we added some additional tests that ensured the methods in question actually existed. Not perfect, but gives us some confidence in the implementation.

While here, we were able to:

  • Extract the stashing logic into a separate stash_changes helper method.

  • Simplify the cleanup_environment logic to just use whether changes were stashed in order to decide whether to restore.

Closes #669.

It was suggested in #135 that a potential way to avoid unnecessary file
change detection and general stashing woes would be to stash changes
only when there were unstaged changes that needed to be excluded from
the run.

This presents a nice optimization that I wish we had considered long
ago. We can simplify the logic now that we see the purpose of this
feature a little more clearly: stash only when you need to.

Issue #669 raised an interesting point about the difficulty to detect if
a stash entry was created, so we modified the tests to check if a method
call was made. This isn't great as it's peeking deep into the
implementation, so we added some additional tests that ensured the
methods in question actually existed. Not perfect, but gives us some
confidence in the implementation.

While here, we were able to:

* Extract the stashing logic into a separate `stash_changes` helper
  method.

* Simplify the `cleanup_environment` logic to just use whether changes
  were stashed in order to decide whether to restore.

Closes #669.
@sds
sds force-pushed the conservative-stash branch from 70ff629 to b3f36ba Compare September 29, 2019 05:02
@sds
sds merged commit 9f82bfb into master Sep 29, 2019
@sds
sds deleted the conservative-stash branch September 29, 2019 06:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Do not run stash operations when not necessary

1 participant