bnkamalesh / webgo Goto Github PK

Hi

https://godoc.org/github.com/bnkamalesh/webgo#WC name is confusing. For that reason, comment on the type documents only the meaning of WC shortcut. Please consider renaming it for the next major release

Is your feature request related to a problem? Please describe.

If you want to group a set of APIs under a particular prefix (e.g. all URIs starting with /v2), it's tedious or have to verify manually at multiple places.

Describe the solution you'd like

Create a Route group capability where we append to the current list of routes. e.g.

v2Routes := webgo.NewGroup("/v2", <skipRouterMiddleware>, routes...)
v2Routes.Add(*Route...)

// skipRouterMiddleware is a boolean, which if set to true, all middleware applied using router.Use will be skipped from this route group

Each URI should be automatically be prefixed with the group prefix. In the above example, the group prefix is /v2. After adding the prefix, the URI would look like /v2/<URI>

Describe alternatives you've considered

The same can be easily achieved outside of webgo's scope. Since it is merely maintaining a list of *Route. Though all the methods and implementation adds to the convenience of developers

Additional context
N/A

file: responses.go

When responses are send using SendResponse or SendError, in case of a JSON encoding error within these functions, the following happens:

w.WriteHeader(rCode) // Write header is already called here, this cannot be overwritten if err := json.NewEncoder(w).Encode(&dOutput{data, rCode}); err != nil { Log.Println(err) R500(w, ErrInternalServer) // HTTP response status set by this function will not work }

So the response in such cases would look like this:
HTTP Status: 200 { errors: "Internal server error occurred", status: 500 }

Is your feature request related to a problem? Please describe.
I wanted to get some examples of how to add login authentication. I have some ideas myself, but curious what the world has in mind.

Describe the solution you'd like
I would like to see examples for:
Firebase auth
3rd party Auth
perhaps some JWT and or cookie solutions

Hi

as you can see in https://github.com/bnkamalesh/webgo#graceful-shutdown, you did not subscribed to osSig, so program will hang forever

ATM the order of the middleware is LIFO which causes to much thinking when adding middlewares, would be nice to be able to change that to FIFO via the webgo config.

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. git clone https://github.com/bnkamalesh/webgo/blob/master/cmd/main.go
2. go run main
3. curl http://localhost:8080/matchall/
   curl http://localhost:8080/matchall/webgo/
4. "status":200

Expected behavior
A clear and concise description of what you expected to happen.

curl http://localhost:8080/matchall/ return 404
curl http://localhost:8080/matchall/xxx/ return 404
like net/http

package main
import (
    "fmt"
    "net/http"
)
func main() {
    http.HandleFunc("/matchall/webgo", func (w http.ResponseWriter, r *http.Request) {
        fmt.Fprintf(w, "Welcome to my website!")
    })
   http.ListenAndServe(":80", nil)
}

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS:win7
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

CORS middleware provided with the package currently responds with a wildcard *. It should be updated to accept a list of domains, and default to wildcard if no domains provided.

• All CORS middleware functions should accept an optional list of domains
• Do not break backward compatibility / New functions if cannot maitnain backward compatibility

Is your feature request related to a problem? Please describe.

Adding routes currently requires the developer to prepare a single list of *Route with all the routes defined in one go. This can be split up and made easier for the developer

Describe the solution you'd like

We can add convenience method for each type of HTTP method supported by webgo (). e.g.

router.Add(*Route)
router.Get("URI",[]Handlers{}, opts...)
router.Head("URI",[]Handlers{}, opts...)
router.Post("URI",[]Handlers{}, opts...)
router.Put("URI",[]Handlers{}, opts...)
router.Patch("URI",[]Handlers{}, opts...)
router.Delete("URI",[]Handlers{}, opts...)
router.Option("URI",[]Handlers{},opts...)

Each method should keep updating routes of the router, for the respective HTTP method.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Hello. This code in the readme:

import (
	"github.com/bnkamalesh/webgo"
	"github.com/bnkamalesh/webgo/middleware"
)

func routes() []*webgo.Route {
	return []*webgo.Route{
		&webo.Route{
			Name: "home",
			Pattern: "/",
			Handlers: []http.HandlerFunc{
				func(w http.ResponseWriter, r *http.Request) {
					webgo.R200(w, "home")
				}
			},
		},
	}
}

func main() {
	router := webgo.NewRouter(*webgo.Config, routes())

	router.UseOnSpecialHandlers(middleware.AccessLog)
	
	router.Use(middleware.AccessLog)

	router.Start()
}

Doesn't work. You need to define a Method field in the Route struct. Also it complains about *webgo.Config not being an expression (unless it was intentional as a placeholder for any pointer to Config). This works:

func routes() []*webgo.Route {
	return []*webgo.Route{
		&webo.Route{
			Name: "home",
			Method: "GET",	
			Pattern: "/",
			Handlers: []http.HandlerFunc{
				func(w http.ResponseWriter, r *http.Request) {
					webgo.R200(w, "home")
				}
			},
		},
	}
}

func main() {
	config := webgo.Config{
		Host: "localhost",
		Port: "8888",
	}
	router := webgo.NewRouter(&config, routes())

	router.UseOnSpecialHandlers(middleware.AccessLog)
	
	router.Use(middleware.AccessLog)

	router.Start()
}

Is your feature request related to a problem? Please describe.
An HTTP cache system would be great in webgo to avoid the execution of unchanged response.

Describe the solution you'd like
I can implement Souin as the HTTP cache middleware. With that it will support the CDN validation/invalidation too, set default cache-control header, store in a distributed system using olric or in memory with badger.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
It's already available as Træfik/Tyk plugin, skipper/gin/echo middleware, and is used in the official caddy cache-handler.

Cheers ✌️

Is your feature request related to a problem? Please describe.
Unable to use optional parameters

Describe the solution you'd like
To have the ability to use optional parameters that would allow the use of /user or /user/1

Additional context

// something like
Pattern: "/user/:id?"

Hello,

Thanks for developing this simple framework.
As a non-voice developer I can easily lift up with your framework.
file word written as fil in errors.go file.

//C003 Error Code 3
C003 = "App environment provided in config fil Accepted values are production or development"

-Vasu

Since all the handlers are std lib compliant, it's difficult to do a centralized/easy of error logging. Hence, implementing Webgotcontext.SetErrror(err error) & Webgocontext.Error() error would be useful. And we could write a normal middleware which fetches the the error from webgocontext and handle appropriately

The project was installed on the net/http package as the base. In addition, we can bring fasthttp support. I can even develop it. :)

URI params does not support wildcard expression *<param name>, after removing HTTPRouter.

Comparison benchmark done between multiple frameworks, in an identical environment and the exact same functionality.

If autoTLS is enabled, it should do the following:

• Check if there's a certificate path provided, if not, default to a path
• Inject acme routes for Letsencrypt verification
• Accept list of domains to provide HTTPS
• Check expiry of all generated Letsencrypt certificates
• Update certificates automatically N days prior to expiry

A new field was added to the Config struct, but it's not used to set the router's log configuration. But this can be set manually after retrieving the router, as follows:

router := webgo.InitRouter(routes)
router.HideAccessLog = true

By default the logs are printed to stdout. Though, there should be a provision of providing an output of users' choice. Need to update the logging mechanism to use an interface, so that it can be set to a thirdparty/external logger

• Convert current logs to use an interface
• Expose a method to replace the logging interface on the fly (should be concurrency safe)

Hello, I'm wondering how can I plug sqlx in order to use MySQL database. A sample code would be very appreciated.