Provide arguments to NewGitServer and NewGitProtocol as Opts structs

There are now way too many arguments for these functions, so let's do a small API-breaking change to make it easier to extend. #major
omegaup · Dec 1, 2021 · ae2b260 · ae2b260
1 parent 261b874
commit ae2b260
Show file tree

Hide file tree

Showing 7 changed files with 189 additions and 289 deletions.
diff --git a/README.md b/README.md
@@ -12,15 +12,18 @@ the `git_repositories/` directory:
 package main
 
 import (
-        "github.com/inconshreveable/log15"
-        "github.com/omegaup/githttp"
-        "net/http"
+	"net/http"
+
+	"github.com/omegaup/githttp"
 )
 
 func main() {
-        panic(http.Server{
-                Addr:    ":80",
-                Handler: githttp.GitServer("git_repositories", true, nil, nil, nil, log15.New()),
-        }.ListenAndServe())
+	panic(http.Server{
+		Addr:    ":80",
+		Handler: githttp.NewGitServer(githttp.GitServerOpts{
+			RootPath:     "git_repositories",
+			EnableBrowse: true,
+		}),
+	}.ListenAndServe())
 }
 ```
diff --git a/browser_test.go b/browser_test.go
@@ -15,14 +15,9 @@ import (
 
 func TestHandleRefs(t *testing.T) {
 	log := base.StderrLog(false)
-	protocol := NewGitProtocol(
-		nil,
-		nil,
-		nil,
-		nil,
-		false,
-		log,
-	)
+	protocol := NewGitProtocol(GitProtocolOpts{
+		Log: log,
+	})
 
 	repository, err := git.OpenRepository("testdata/repo.git")
 	if err != nil {
@@ -60,20 +55,16 @@ func TestHandleRefs(t *testing.T) {
 
 func TestHandleRefsWithReferenceDiscoveryCallback(t *testing.T) {
 	log := base.StderrLog(false)
-	protocol := NewGitProtocol(
-		nil,
-		func(
+	protocol := NewGitProtocol(GitProtocolOpts{
+		ReferenceDiscoveryCallback: func(
 			ctx context.Context,
 			repository *git.Repository,
 			referenceName string,
 		) bool {
 			return referenceName == "refs/heads/public"
 		},
-		nil,
-		nil,
-		false,
-		log,
-	)
+		Log: log,
+	})
 
 	repository, err := git.OpenRepository("testdata/repo.git")
 	if err != nil {
@@ -100,14 +91,9 @@ func TestHandleRefsWithReferenceDiscoveryCallback(t *testing.T) {
 
 func TestHandleRestrictedRefs(t *testing.T) {
 	log := base.StderrLog(false)
-	protocol := NewGitProtocol(
-		nil,
-		nil,
-		nil,
-		nil,
-		false,
-		log,
-	)
+	protocol := NewGitProtocol(GitProtocolOpts{
+		Log: log,
+	})
 
 	repository, err := git.OpenRepository("testdata/repo.git")
 	if err != nil {
@@ -142,14 +128,9 @@ func TestHandleRestrictedRefs(t *testing.T) {
 
 func TestHandleArchiveCommit(t *testing.T) {
 	log := base.StderrLog(false)
-	protocol := NewGitProtocol(
-		nil,
-		nil,
-		nil,
-		nil,
-		false,
-		log,
-	)
+	protocol := NewGitProtocol(GitProtocolOpts{
+		Log: log,
+	})
 
 	repository, err := git.OpenRepository("testdata/repo.git")
 	if err != nil {
@@ -184,14 +165,9 @@ func TestHandleArchiveCommit(t *testing.T) {
 
 func TestHandleLog(t *testing.T) {
 	log := base.StderrLog(false)
-	protocol := NewGitProtocol(
-		nil,
-		nil,
-		nil,
-		nil,
-		false,
-		log,
-	)
+	protocol := NewGitProtocol(GitProtocolOpts{
+		Log: log,
+	})
 
 	repository, err := git.OpenRepository("testdata/repo.git")
 	if err != nil {
@@ -254,14 +230,9 @@ func TestHandleLog(t *testing.T) {
 
 func TestHandleLogCommit(t *testing.T) {
 	log := base.StderrLog(false)
-	protocol := NewGitProtocol(
-		nil,
-		nil,
-		nil,
-		nil,
-		false,
-		log,
-	)
+	protocol := NewGitProtocol(GitProtocolOpts{
+		Log: log,
+	})
 
 	repository, err := git.OpenRepository("testdata/repo.git")
 	if err != nil {
@@ -308,14 +279,9 @@ func TestHandleLogCommit(t *testing.T) {
 
 func TestHandleShowCommit(t *testing.T) {
 	log := base.StderrLog(false)
-	protocol := NewGitProtocol(
-		nil,
-		nil,
-		nil,
-		nil,
-		false,
-		log,
-	)
+	protocol := NewGitProtocol(GitProtocolOpts{
+		Log: log,
+	})
 
 	repository, err := git.OpenRepository("testdata/repo.git")
 	if err != nil {
@@ -359,14 +325,9 @@ func TestHandleShowCommit(t *testing.T) {
 
 func TestHandleShowTree(t *testing.T) {
 	log := base.StderrLog(false)
-	protocol := NewGitProtocol(
-		nil,
-		nil,
-		nil,
-		nil,
-		false,
-		log,
-	)
+	protocol := NewGitProtocol(GitProtocolOpts{
+		Log: log,
+	})
 
 	repository, err := git.OpenRepository("testdata/repo.git")
 	if err != nil {
@@ -414,14 +375,9 @@ func TestHandleShowTree(t *testing.T) {
 
 func TestHandleShowBlob(t *testing.T) {
 	log := base.StderrLog(false)
-	protocol := NewGitProtocol(
-		nil,
-		nil,
-		nil,
-		nil,
-		false,
-		log,
-	)
+	protocol := NewGitProtocol(GitProtocolOpts{
+		Log: log,
+	})
 
 	repository, err := git.OpenRepository("testdata/repo.git")
 	if err != nil {
@@ -461,20 +417,16 @@ func TestHandleShowBlob(t *testing.T) {
 
 func TestHandleNotFound(t *testing.T) {
 	log := base.StderrLog(false)
-	protocol := NewGitProtocol(
-		nil,
-		func(
+	protocol := NewGitProtocol(GitProtocolOpts{
+		ReferenceDiscoveryCallback: func(
 			ctx context.Context,
 			repository *git.Repository,
 			referenceName string,
 		) bool {
 			return referenceName == "refs/heads/public"
 		},
-		nil,
-		nil,
-		false,
-		log,
-	)
+		Log: log,
+	})
 
 	repository, err := git.OpenRepository("testdata/repo.git")
 	if err != nil {

diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/omegaup/githttp
+module github.com/omegaup/githttp/v2
 
 go 1.17
 

diff --git a/protocol.go b/protocol.go
@@ -125,38 +125,43 @@ type GitProtocol struct {
 	log                        log15.Logger
 }
 
+// GitProtocolOpts contains all the possible options to initialize the git Server.
+type GitProtocolOpts struct {
+	doNotCompare
+
+	AuthCallback               AuthorizationCallback
+	ReferenceDiscoveryCallback ReferenceDiscoveryCallback
+	UpdateCallback             UpdateCallback
+	PreprocessCallback         PreprocessCallback
+	AllowNonFastForward        bool
+	Log                        log15.Logger
+}
+
 // NewGitProtocol returns a new instance of GitProtocol.
-func NewGitProtocol(
-	authCallback AuthorizationCallback,
-	referenceDiscoveryCallback ReferenceDiscoveryCallback,
-	updateCallback UpdateCallback,
-	preprocessCallback PreprocessCallback,
-	allowNonFastForward bool,
-	log log15.Logger,
-) *GitProtocol {
-	if authCallback == nil {
-		authCallback = noopAuthorizationCallback
+func NewGitProtocol(opts GitProtocolOpts) *GitProtocol {
+	if opts.AuthCallback == nil {
+		opts.AuthCallback = noopAuthorizationCallback
 	}
-
-	if referenceDiscoveryCallback == nil {
-		referenceDiscoveryCallback = noopReferenceDiscoveryCallback
+	if opts.ReferenceDiscoveryCallback == nil {
+		opts.ReferenceDiscoveryCallback = noopReferenceDiscoveryCallback
 	}
-
-	if updateCallback == nil {
-		updateCallback = noopUpdateCallback
+	if opts.UpdateCallback == nil {
+		opts.UpdateCallback = noopUpdateCallback
 	}
-
-	if preprocessCallback == nil {
-		preprocessCallback = noopPreprocessCallback
+	if opts.PreprocessCallback == nil {
+		opts.PreprocessCallback = noopPreprocessCallback
+	}
+	if opts.Log == nil {
+		opts.Log = log15.New()
 	}
 
 	return &GitProtocol{
-		AuthCallback:               authCallback,
-		ReferenceDiscoveryCallback: referenceDiscoveryCallback,
-		UpdateCallback:             updateCallback,
-		PreprocessCallback:         preprocessCallback,
-		AllowNonFastForward:        allowNonFastForward,
-		log:                        log,
+		AuthCallback:               opts.AuthCallback,
+		ReferenceDiscoveryCallback: opts.ReferenceDiscoveryCallback,
+		UpdateCallback:             opts.UpdateCallback,
+		PreprocessCallback:         opts.PreprocessCallback,
+		AllowNonFastForward:        opts.AllowNonFastForward,
+		log:                        opts.Log,
 	}
 }