experiment to convert macaron to chi

Author: lunny

.golangci.yml

@@ -67,7 +67,7 @@ issues:
     - path: modules/log/
       linters:
         - errcheck
-    - path: routers/routes/routes.go
+    - path: routers/routes/macaron.go
       linters:
         - dupl
     - path: routers/repo/view.go

cmd/web.go

@@ -107,8 +107,8 @@ func runWeb(ctx *cli.Context) error {
 
 	routers.GlobalInit()
 
-	m := routes.NewMacaron()
-	routes.RegisterRoutes(m)
+	c := routes.NewChi()
+	routes.RegisterRoutes(c)
 
 	// Flag for port number in case first time run conflict.
 	if ctx.IsSet("port") {
@@ -164,16 +164,16 @@ func runWeb(ctx *cli.Context) error {
 	var err error
 	switch setting.Protocol {
 	case setting.HTTP:
-		err = runHTTP(listenAddr, context2.ClearHandler(m))
+		err = runHTTP(listenAddr, context2.ClearHandler(c))
 	case setting.HTTPS:
 		if setting.EnableLetsEncrypt {
-			err = runLetsEncrypt(listenAddr, setting.Domain, setting.LetsEncryptDirectory, setting.LetsEncryptEmail, context2.ClearHandler(m))
+			err = runLetsEncrypt(listenAddr, setting.Domain, setting.LetsEncryptDirectory, setting.LetsEncryptEmail, context2.ClearHandler(c))
 			break
 		}
 		if setting.RedirectOtherPort {
 			go runHTTPRedirector()
 		}
-		err = runHTTPS(listenAddr, setting.CertFile, setting.KeyFile, context2.ClearHandler(m))
+		err = runHTTPS(listenAddr, setting.CertFile, setting.KeyFile, context2.ClearHandler(c))
 	case setting.FCGI:
 		var listener net.Listener
 		listener, err = net.Listen("tcp", listenAddr)
@@ -185,7 +185,7 @@ func runWeb(ctx *cli.Context) error {
 				log.Fatal("Failed to stop server: %v", err)
 			}
 		}()
-		err = fcgi.Serve(listener, context2.ClearHandler(m))
+		err = fcgi.Serve(listener, context2.ClearHandler(c))
 	case setting.UnixSocket:
 		if err := os.Remove(listenAddr); err != nil && !os.IsNotExist(err) {
 			log.Fatal("Failed to remove unix socket directory %s: %v", listenAddr, err)
@@ -201,7 +201,7 @@ func runWeb(ctx *cli.Context) error {
 		if err = os.Chmod(listenAddr, os.FileMode(setting.UnixSocketPermission)); err != nil {
 			log.Fatal("Failed to set permission of unix socket: %v", err)
 		}
-		err = http.Serve(listener, context2.ClearHandler(m))
+		err = http.Serve(listener, context2.ClearHandler(c))
 	default:
 		log.Fatal("Invalid protocol: %s", setting.Protocol)
 	}

contrib/pr/checkout.go

@@ -114,8 +114,8 @@ func runPR() {
 	//routers.GlobalInit()
 	external.RegisterParsers()
 	markup.Init()
-	m := routes.NewMacaron()
-	routes.RegisterRoutes(m)
+	c := routes.NewChi()
+	routes.RegisterRoutes(c)
 
 	log.Printf("[PR] Ready for testing !\n")
 	log.Printf("[PR] Login with user1, user2, user3, ... with pass: password\n")
@@ -135,7 +135,7 @@ func runPR() {
 	*/
 
 	//Start the server
-	http.ListenAndServe(":8080", context2.ClearHandler(m))
+	http.ListenAndServe(":8080", context2.ClearHandler(c))
 
 	log.Printf("[PR] Cleaning up ...\n")
 	/*

go.mod

@@ -43,6 +43,7 @@ require (
 	github.com/gliderlabs/ssh v0.2.2
 	github.com/glycerine/go-unsnap-stream v0.0.0-20180323001048-9f0cb55181dd // indirect
 	github.com/glycerine/goconvey v0.0.0-20190315024820-982ee783a72e // indirect
+	github.com/go-chi/chi v4.0.2+incompatible
 	github.com/go-macaron/binding v0.0.0-20160711225916-9440f336b443
 	github.com/go-macaron/cache v0.0.0-20151013081102-561735312776
 	github.com/go-macaron/captcha v0.0.0-20151123225153-8aa5919789ab

go.sum

@@ -106,6 +106,8 @@ github.com/glycerine/go-unsnap-stream v0.0.0-20180323001048-9f0cb55181dd h1:r04M
 github.com/glycerine/go-unsnap-stream v0.0.0-20180323001048-9f0cb55181dd/go.mod h1:/20jfyN9Y5QPEAprSgKAUr+glWDY39ZiUEAYOEv5dsE=
 github.com/glycerine/goconvey v0.0.0-20190315024820-982ee783a72e h1:SiEs4J3BKVIeaWrH3tKaz3QLZhJ68iJ/A4xrzIoE5+Y=
 github.com/glycerine/goconvey v0.0.0-20190315024820-982ee783a72e/go.mod h1:Ogl1Tioa0aV7gstGFO7KhffUsb9M4ydbEbbxpcEDc24=
+github.com/go-chi/chi v4.0.2+incompatible h1:maB6vn6FqCxrpz4FqWdh4+lwpyZIQS7YEAUcHlgXVRs=
+github.com/go-chi/chi v4.0.2+incompatible/go.mod h1:eB3wogJHnLi3x/kFX2A+IbTBlXxmMeXJVKy9tTv1XzQ=
 github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
 github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE=
 github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk=

integrations/create_no_session_test.go

@@ -57,8 +57,8 @@ func TestSessionFileCreation(t *testing.T) {
 	oldSessionConfig := setting.SessionConfig.ProviderConfig
 	defer func() {
 		setting.SessionConfig.ProviderConfig = oldSessionConfig
-		mac = routes.NewMacaron()
-		routes.RegisterRoutes(mac)
+		c = routes.NewChi()
+		routes.RegisterRoutes(c)
 	}()
 
 	var config session.Options
@@ -82,8 +82,8 @@ func TestSessionFileCreation(t *testing.T) {
 
 	setting.SessionConfig.ProviderConfig = string(newConfigBytes)
 
-	mac = routes.NewMacaron()
-	routes.RegisterRoutes(mac)
+	c = routes.NewChi()
+	routes.RegisterRoutes(c)
 
 	t.Run("NoSessionOnViewIssue", func(t *testing.T) {
 		PrintCurrentTest(t)

integrations/git_helper_for_declarative_test.go

@@ -52,7 +52,7 @@ func createSSHUrl(gitPath string, u *url.URL) *url.URL {
 func onGiteaRun(t *testing.T, callback func(*testing.T, *url.URL)) {
 	prepareTestEnv(t, 1)
 	s := http.Server{
-		Handler: mac,
+		Handler: c,
 	}
 
 	u, err := url.Parse(setting.AppURL)

integrations/integration_test.go

@@ -34,7 +34,7 @@ import (
 	"gopkg.in/testfixtures.v2"
 )
 
-var mac *macaron.Macaron
+var c chi.Router
 
 type NilResponseRecorder struct {
 	httptest.ResponseRecorder
@@ -55,8 +55,8 @@ func NewNilResponseRecorder() *NilResponseRecorder {
 
 func TestMain(m *testing.M) {
 	initIntegrationTest()
-	mac = routes.NewMacaron()
-	routes.RegisterRoutes(mac)
+	c = routes.NewChi()
+	routes.RegisterRoutes(c)
 
 	var helper testfixtures.Helper
 	if setting.UseMySQL {
@@ -335,7 +335,7 @@ const NoExpectedStatus = -1
 
 func MakeRequest(t testing.TB, req *http.Request, expectedStatus int) *httptest.ResponseRecorder {
 	recorder := httptest.NewRecorder()
-	mac.ServeHTTP(recorder, req)
+	c.ServeHTTP(recorder, req)
 	if expectedStatus != NoExpectedStatus {
 		if !assert.EqualValues(t, expectedStatus, recorder.Code,
 			"Request: %s %s", req.Method, req.URL.String()) {
@@ -347,7 +347,7 @@ func MakeRequest(t testing.TB, req *http.Request, expectedStatus int) *httptest.
 
 func MakeRequestNilResponseRecorder(t testing.TB, req *http.Request, expectedStatus int) *NilResponseRecorder {
 	recorder := NewNilResponseRecorder()
-	mac.ServeHTTP(recorder, req)
+	c.ServeHTTP(recorder, req)
 	if expectedStatus != NoExpectedStatus {
 		if !assert.EqualValues(t, expectedStatus, recorder.Code,
 			"Request: %s %s", req.Method, req.URL.String()) {

modules/public/dynamic.go

@@ -6,11 +6,11 @@
 
 package public
 
-import (
-	"gopkg.in/macaron.v1"
-)
+import "net/http"
 
 // Static implements the macaron static handler for serving assets.
-func Static(opts *Options) macaron.Handler {
-	return opts.staticHandler(opts.Directory)
+func Static(opts *Options) func(next http.Handler) http.Handler {
+	return func(next http.Handler) http.Handler {
+		return opts.staticHandler(opts.Directory)
+	}
 }

modules/public/public.go

@@ -14,13 +14,12 @@ import (
 	"time"
 
 	"code.gitea.io/gitea/modules/setting"
-	"gopkg.in/macaron.v1"
 )
 
 //go:generate go run -mod=vendor main.go
 //go:generate go fmt bindata.go
 
-// Options represents the available options to configure the macaron handler.
+// Options represents the available options to configure the http handler.
 type Options struct {
 	Directory   string
 	IndexFile   string
@@ -32,9 +31,11 @@ type Options struct {
 	Prefix       string
 }
 
-// Custom implements the macaron static handler for serving custom assets.
-func Custom(opts *Options) macaron.Handler {
-	return opts.staticHandler(path.Join(setting.CustomPath, "public"))
+// Custom implements the http static handler for serving custom assets.
+func Custom(opts *Options) func(next http.Handler) http.Handler {
+	return func(next http.Handler) http.Handler {
+		return opts.staticHandler(path.Join(setting.CustomPath, "public"))
+	}
 }
 
 // staticFileSystem implements http.FileSystem interface.
@@ -44,7 +45,7 @@ type staticFileSystem struct {
 
 func newStaticFileSystem(directory string) staticFileSystem {
 	if !filepath.IsAbs(directory) {
-		directory = filepath.Join(macaron.Root, directory)
+		directory = filepath.Join(setting.AppWorkPath, directory)
 	}
 	dir := http.Dir(directory)
 	return staticFileSystem{&dir}
@@ -55,11 +56,13 @@ func (fs staticFileSystem) Open(name string) (http.File, error) {
 }
 
 // StaticHandler sets up a new middleware for serving static files in the
-func StaticHandler(dir string, opts *Options) macaron.Handler {
-	return opts.staticHandler(dir)
+func StaticHandler(dir string, opts *Options) func(next http.Handler) http.Handler {
+	return func(next http.Handler) http.Handler {
+		return opts.staticHandler(dir)
+	}
 }
 
-func (opts *Options) staticHandler(dir string) macaron.Handler {
+func (opts *Options) staticHandler(dir string) http.HandlerFunc {
 	// Defaults
 	if len(opts.IndexFile) == 0 {
 		opts.IndexFile = "index.html"
@@ -77,17 +80,17 @@ func (opts *Options) staticHandler(dir string) macaron.Handler {
 		opts.FileSystem = newStaticFileSystem(dir)
 	}
 
-	return func(ctx *macaron.Context, log *log.Logger) {
-		opts.handle(ctx, log, opts)
+	return func(w http.ResponseWriter, req *http.Request) {
+		opts.handle(w, req, opts)
 	}
 }
 
-func (opts *Options) handle(ctx *macaron.Context, log *log.Logger, opt *Options) bool {
-	if ctx.Req.Method != "GET" && ctx.Req.Method != "HEAD" {
+func (opts *Options) handle(w http.ResponseWriter, req *http.Request, opt *Options) bool {
+	if req.Method != "GET" && req.Method != "HEAD" {
 		return false
 	}
 
-	file := ctx.Req.URL.Path
+	file := req.URL.Path
 	// if we have a prefix, filter requests by stripping the prefix
 	if opt.Prefix != "" {
 		if !strings.HasPrefix(file, opt.Prefix) {
@@ -114,8 +117,8 @@ func (opts *Options) handle(ctx *macaron.Context, log *log.Logger, opt *Options)
 	// Try to serve index file
 	if fi.IsDir() {
 		// Redirect if missing trailing slash.
-		if !strings.HasSuffix(ctx.Req.URL.Path, "/") {
-			http.Redirect(ctx.Resp, ctx.Req.Request, path.Clean(ctx.Req.URL.Path+"/"), http.StatusFound)
+		if !strings.HasSuffix(req.URL.Path, "/") {
+			http.Redirect(w, req, path.Clean(req.URL.Path+"/"), http.StatusFound)
 			return true
 		}
 
@@ -137,16 +140,16 @@ func (opts *Options) handle(ctx *macaron.Context, log *log.Logger, opt *Options)
 
 	// Add an Expires header to the static content
 	if opt.ExpiresAfter > 0 {
-		ctx.Resp.Header().Set("Expires", time.Now().Add(opt.ExpiresAfter).UTC().Format(http.TimeFormat))
+		w.Header().Set("Expires", time.Now().Add(opt.ExpiresAfter).UTC().Format(http.TimeFormat))
 		tag := GenerateETag(string(fi.Size()), fi.Name(), fi.ModTime().UTC().Format(http.TimeFormat))
-		ctx.Resp.Header().Set("ETag", tag)
-		if ctx.Req.Header.Get("If-None-Match") == tag {
-			ctx.Resp.WriteHeader(304)
+		w.Header().Set("ETag", tag)
+		if req.Header.Get("If-None-Match") == tag {
+			w.WriteHeader(304)
 			return false
 		}
 	}
 
-	http.ServeContent(ctx.Resp, ctx.Req.Request, file, fi.ModTime(), f)
+	http.ServeContent(w, req, file, fi.ModTime(), f)
 	return true
 }
 

modules/public/static.go

@@ -6,14 +6,14 @@
 
 package public
 
-import (
-	"gopkg.in/macaron.v1"
-)
+import "net/http"
 
-// Static implements the macaron static handler for serving assets.
-func Static(opts *Options) macaron.Handler {
-	opts.FileSystem = Assets
-	// we don't need to pass the directory, because the directory var is only
-	// used when in the options there is no FileSystem.
-	return opts.staticHandler("")
+// Static implements the http static handler for serving assets.
+func Static(opts *Options) func(next http.Handler) http.Handler {
+	return func(next http.Handler) http.Handler {
+		opts.FileSystem = Assets
+		// we don't need to pass the directory, because the directory var is only
+		// used when in the options there is no FileSystem.
+		return opts.staticHandler("")
+	}
 }