lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

lfs: don't write hooks when they haven't changed

Browse Source 
Some people store their hooks inside their repository.  This isn't a
secure approach, but in some cases it can be acceptable if all users are
trusted.

In such a case, if Git LFS always rewrites a hook even if it hasn't
changed, it can result in the file being marked as modified by `git
status`, since `git status` can invoke Git LFS, which in turn invokes
Git LFS, which updates the hooks.  Thus, the hooks will always appear
modified.

Let's solve this by not writing the hooks if they haven't changed.  We
don't include tests here because the only way to determine if changes
have occurred is the mtime, and that's difficult to effectively test in
the testsuite in a portable way without introducing sleeps, which would
make our tests slow.
This commit is contained in:
brian m. carlson 2022-04-11 15:47:32 +00:00
parent a52712cbbd
commit e0551f8be7
No known key found for this signature in database
GPG Key ID: 2D0C9BC12F82B3A1
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
lfs/hook.go
View File

@ -107,12 +107,12 @@ func (h *Hook) write() error {
// the member variable `Upgradeables`. It halts and returns any errors as they
// arise.
func (h *Hook) Upgrade() error {
match, err := h.matchesCurrent()
upgradable, match, err := h.matchesCurrent()
if err != nil {
return err
}
if !match {
if !upgradable || match {
return nil
}
@ -124,12 +124,12 @@ func (h *Hook) Upgrade() error {
func (h *Hook) Uninstall() error {
msg := fmt.Sprintf("Uninstall hook: %s, path=%s", h.Type, h.Path())
match, err := h.matchesCurrent()
upgradable, _, err := h.matchesCurrent()
if err != nil {
return err
}
if !match {
if !upgradable {
tracerx.Printf(msg + ", doesn't match...")
return nil
}
@ -139,31 +139,33 @@ func (h *Hook) Uninstall() error {
}
// matchesCurrent returns whether or not an existing git hook is able to be
// written to or upgraded. A git hook matches those conditions if and only if
// its contents match the current contents, or any past "upgrade-able" contents
// of this hook.
func (h *Hook) matchesCurrent() (bool, error) {
// written to or upgraded and additionally whether it is identical to the
// current hook. A git hook matches those conditions if and only if its contents
// match the current contents, or any past "upgrade-able" contents of this hook.
func (h *Hook) matchesCurrent() (bool, bool, error) {
file, err := os.Open(h.Path())
if err != nil {
return false, err
return false, false, err
}
by, err := ioutil.ReadAll(io.LimitReader(file, 1024))
file.Close()
if err != nil {
return false, err
return false, false, err
}
contents := strings.TrimSpace(tools.Undent(string(by)))
if contents == h.Contents || len(contents) == 0 {
return true, nil
if contents == h.Contents {
return true, true, nil
} else if len(contents) == 0 {
return true, false, nil
}
for _, u := range h.upgradeables {
if u == contents {
return true, nil
return true, false, nil
}
}
return false, errors.New(fmt.Sprintf("%s\n\n%s\n", tr.Tr.Get("Hook already exists: %s", string(h.Type)), tools.Indent(contents)))
return false, false, errors.New(fmt.Sprintf("%s\n\n%s\n", tr.Tr.Get("Hook already exists: %s", string(h.Type)), tools.Indent(contents)))
}