Skip to content

Commit

Permalink
Odb: use a callback instead of a channel for ForEach
Browse files Browse the repository at this point in the history
A channel provides no way to specify whether we stopped sending data
because of an error or because there is no more data.

Therefore, make Odb.ForEach() take a callback with which the user is free to
do whatever they need, letting us return en error.
  • Loading branch information
carlosmn committed May 6, 2014
1 parent 9a8b80f commit 2594f3f
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 18 deletions.
44 changes: 27 additions & 17 deletions odb.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,30 +84,40 @@ func (v *Odb) Read(oid *Oid) (obj *OdbObject, err error) {
return obj, nil
}

type OdbForEachCallback func(id *Oid) error

type foreachData struct {
callback OdbForEachCallback
err error
}

//export odbForEachCb
func odbForEachCb(id *C.git_oid, payload unsafe.Pointer) int {
ch := *(*chan *Oid)(payload)
oid := newOidFromC(id)
// Because the channel is unbuffered, we never read our own data. If ch is
// readable, the user has sent something on it, which means we should
// abort.
select {
case ch <- oid:
case <-ch:
return -1
data := (*foreachData)(payload)

err := data.callback(newOidFromC(id))
if err != nil {
data.err = err
return C.GIT_EUSER
}

return 0
}

func (v *Odb) forEachWrap(ch chan *Oid) {
C._go_git_odb_foreach(v.ptr, unsafe.Pointer(&ch))
close(ch)
}
func (v *Odb) ForEach(callback OdbForEachCallback) error {
data := foreachData {
callback: callback,
err: nil,
}

func (v *Odb) ForEach() chan *Oid {
ch := make(chan *Oid, 0)
go v.forEachWrap(ch)
return ch
ret := C._go_git_odb_foreach(v.ptr, unsafe.Pointer(&data))
if ret == C.GIT_EUSER {
return data.err
} else if ret < 0 {
return MakeGitError(ret)
}

return nil
}

// Hash determines the object-ID (sha1) of a data buffer.
Expand Down
36 changes: 35 additions & 1 deletion odb_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package git
import (
"io"
"os"
"errors"
"testing"
)

Expand Down Expand Up @@ -48,7 +49,7 @@ parent 66e1c476199ebcd3e304659992233132c5a52c6c
author John Doe <john@doe.com> 1390682018 +0000
committer John Doe <john@doe.com> 1390682018 +0000
Initial commit.`;
Initial commit.`

oid, error := odb.Hash([]byte(str), ObjectCommit)
checkFatal(t, error)
Expand All @@ -60,3 +61,36 @@ Initial commit.`;
t.Fatal("Hash and write Oids are different")
}
}

func TestOdbForeach(t *testing.T) {
repo := createTestRepo(t)
defer os.RemoveAll(repo.Workdir())
_, _ = seedTestRepo(t, repo)

odb, err := repo.Odb()
checkFatal(t, err)

expect := 3
count := 0
err = odb.ForEach(func(id *Oid) error {
count++
return nil
})

checkFatal(t, err)
if count != expect {
t.Fatalf("Expected %v objects, got %v")
}

expect = 1
count = 0
to_return := errors.New("not really an error")
err = odb.ForEach(func(id *Oid) error {
count++
return to_return
})

if err != to_return {
t.Fatalf("Odb.ForEach() did not return the expected error, got %v", err)
}
}

0 comments on commit 2594f3f

Please sign in to comment.