https://github.com/crhntr/gitsmart

[WIP] An http.Handler type thing that works well with go-git.
https://github.com/crhntr/gitsmart

git go golang

Last synced: about 2 months ago
JSON representation

[WIP] An http.Handler type thing that works well with go-git.

• Host: GitHub
• URL: https://github.com/crhntr/gitsmart
• Owner: crhntr
• License: mit
• Created: 2020-07-21T05:15:16.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-25T03:14:35.000Z (almost 2 years ago)
• Last Synced: 2024-06-21T15:49:10.173Z (6 months ago)
• Topics: git, go, golang
• Language: Go
• Homepage:
• Size: 39.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitSmart (very early WIP)

An http.Handler type thing that works well with go-git.

The name is based on the name of the more robust/modern HTTP protocal used in the Git plumbing/tranfer stuff.

## Notes

- Introductory notes on git Plumbing https://git-scm.com/book/en/v2/Git-Internals-Plumbing-and-Porcelain

  - Intro to transfer protocols: https://git-scm.com/book/en/v2/Git-Internals-Transfer-Protocols

- Somewhat deeper documentation of the git "Smart HTTP" protocol https://github.com/git/git/blob/master/Documentation/technical/http-protocol.txt

  - Some of the symbols in the specification are documented here: https://github.com/git/git/blob/master/Documentation/technical/protocol-common.txt

## Design 

I would like the API to be something like this.

```go

package gitsmart

import (

	"net/http"

	

    "github.com/go-git/go-git/v5/plumbing"

    

    "github.com/crhntr/gitsmart"

)

type Database interface {

    Session() interface {

        StartTransaction()

        AbortTransaction()

        CommitTransaction()

    }   

}

func MyGitHandler(db Database) http.HandlerFunc {

	return func(res http.ResponseWriter, req *http.Request) {

        s := db.Session()

        	s.StartTransaction()

        

        	userAuth, err := loadUserAuthorizationFromWebToken(req)

        	if err != nil {

        		http.Error(res, "repository not found", http.StatusNotAuthorized)

        		return

        	}

        

        	// note any store that implements github.com/go-git/go-git/v5/plumbing/storer would be permitted.

        	store, err := loadGitStore(db, req.URL.Path)

        	if err != nil {

        		http.Error(res, "repository not found", http.StatusNotFound)

        		return

        	}

        

        	err = Handle(res, req, store,

        		// Handler functionality can be modified with functional options

        		// see: https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis

        		//

        		// For example, we can implement our own access control for individual branches...

        		// or maybe even more fine grained control over git objects

        		gitsmart.BeforeBranchUpdate(CheckIfUserCanUpdateBranch(&userAuth)),

        		//

        		// Another example, because we know our store can handle transactional updates, the

        		// Handler can be notified to broadcast that functionality to clients.

        		gitsmart.BroadcastTransactionalCapability,

        	)

        

        	if err != nil {

        		s.AbortTransaction()

        		return

        	}

        

        	s.CommitTransaction()

    }

}

func CheckIfUserCanUpdateBranch(user *UserAuth) gitsmart.BeforeBranchUpdateFunc {

	return func(ref *plumbing.Reference) error {

		return nil /* check if user allowed to edit reference otherwise return an error */

	}

}

```