Skip to content

Commit

Permalink
add Party.HandleServer and macro.IsMacro methods
Browse files Browse the repository at this point in the history
  • Loading branch information
kataras committed Dec 5, 2023
1 parent 6e82285 commit 7d540f5
Show file tree
Hide file tree
Showing 6 changed files with 121 additions and 2 deletions.
77 changes: 77 additions & 0 deletions core/router/api_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -1540,6 +1540,83 @@ func (api *APIBuilder) Any(relativePath string, handlers ...context.Handler) (ro
return
}

type (
// ServerHandler is the interface which all server handlers should implement.
// The Iris Application implements it.
// See `Party.HandleServer` method for more.
ServerHandler interface {
ServeHTTPC(*context.Context)
}

serverBuilder interface {
Build() error
}
)

// HandleServer registers a route for all HTTP methods which forwards the requests to the given server.
//
// Usage:
//
// app.HandleServer("/api/identity/{first:string}/orgs/{second:string}/{p:path}", otherApp)
//
// OR
//
// app.HandleServer("/api/identity", otherApp)
func (api *APIBuilder) HandleServer(path string, server ServerHandler) {
if app, ok := server.(serverBuilder); ok {
// Do an extra check for Build() error at any case
// the end-developer didn't call Build before.
if err := app.Build(); err != nil {
panic(err)
}
}

pathParameterName := ""

// Check and get the last parameter name if it's a wildcard one by the end-developer.
parsedPath, err := macro.Parse(path, *api.macros)
if err != nil {
panic(err)
}

if n := len(parsedPath.Params); n > 0 {
lastParam := parsedPath.Params[n-1]
if lastParam.IsMacro(macro.Path) {
pathParameterName = lastParam.Name
// path remains as it was defined by the end-developer.
}
}
//

if pathParameterName == "" {
pathParameterName = fmt.Sprintf("iris_wildcard_path_parameter%d", len(api.routes.routes))
path = fmt.Sprintf("%s/{%s:path}", path, pathParameterName)
}

handler := makeServerHandler(pathParameterName, server.ServeHTTPC)
api.Any(path, handler)
}

func makeServerHandler(givenPathParameter string, handler context.Handler) context.Handler {
return func(ctx *context.Context) {
pathValue := ""
if givenPathParameter == "" {
pathValue = ctx.Params().GetEntryAt(ctx.Params().Len() - 1).ValueRaw.(string)
} else {
pathValue = ctx.Params().Get(givenPathParameter)
}

apiPath := "/" + pathValue

r := ctx.Request()
r.URL.Path = apiPath
r.URL.RawPath = apiPath
ctx.Params().Reset()

handler(ctx)
}
}

func (api *APIBuilder) registerResourceRoute(reqPath string, h context.Handler) *Route {
api.Head(reqPath, h)
return api.Get(reqPath, h)
Expand Down
11 changes: 11 additions & 0 deletions core/router/party.go
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,17 @@ type Party interface {
// Connect
// Trace
Any(registeredPath string, handlers ...context.Handler) []*Route
// HandleServer registers a route for all HTTP methods which forwards the requests to the given server.
//
// Usage:
//
// app.HandleServer("/api/identity/{first:string}/orgs/{second:string}/{p:path}", otherApp)
//
// OR
//
// app.HandleServer("/api/identity", otherApp)
HandleServer(path string, server ServerHandler)

// CreateRoutes returns a list of Party-based Routes.
// It does NOT registers the route. Use `Handle, Get...` methods instead.
// This method can be used for third-parties Iris helpers packages and tools
Expand Down
21 changes: 21 additions & 0 deletions core/router/router_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -196,3 +196,24 @@ func TestNewSubdomainPartyRedirectHandler(t *testing.T) {
e.GET("/").WithURL("http://testold.mydomain.com/notfound").Expect().Status(iris.StatusNotFound).Body().IsEqual("test 404")
e.GET("/").WithURL("http://leveled.testold.mydomain.com").Expect().Status(iris.StatusOK).Body().IsEqual("leveled.testold this can be fired")
}

func TestHandleServer(t *testing.T) {
otherApp := iris.New()
otherApp.Get("/test/me/{first:string}", func(ctx iris.Context) {
ctx.HTML("<h1>Other App: %s</h1>", ctx.Params().Get("first"))
})
otherApp.Build()

app := iris.New()

app.Get("/", func(ctx iris.Context) {
ctx.HTML("<h1>Main App</h1>")
})

app.HandleServer("/api/identity/{first:string}/orgs/{second:string}/{p:path}", otherApp)

e := httptest.New(t, app)
e.GET("/").Expect().Status(iris.StatusOK).Body().IsEqual("<h1>Main App</h1>")
e.GET("/api/identity/first/orgs/second/test/me/kataras").Expect().Status(iris.StatusOK).Body().IsEqual("<h1>Other App: kataras</h1>")
e.GET("/api/identity/first/orgs/second/test/me").Expect().Status(iris.StatusNotFound)
}
3 changes: 2 additions & 1 deletion hero/struct.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,9 @@ func makeStruct(structPtr interface{}, c *Container, partyParamsCount int) *Stru
singleton := true
elem := v.Elem()

// fmt.Printf("makeStruct: bindings length = %d\n", len(bindings))
// fmt.Printf("Service: %s, Bindings(%d):\n", typ, len(bindings))
for _, b := range bindings {
// fmt.Printf("* " + b.String() + "\n")
if b.Dependency.Static {
// Fill now.
input, err := b.Dependency.Handle(nil, b.Input)
Expand Down
2 changes: 1 addition & 1 deletion iris.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import (
)

// Version is the current version of the Iris Web Framework.
const Version = "12.2.8"
const Version = "12.2.9"

// Byte unit helpers.
const (
Expand Down
9 changes: 9 additions & 0 deletions macro/template.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ func (t *Template) IsTrailing() bool {
// TemplateParam is the parsed macro parameter's template
// they are being used to describe the param's syntax result.
type TemplateParam struct {
macro *Macro // keep for reference.

Src string `json:"src"` // the unparsed param'false source
// Type is not useful anywhere here but maybe
// it's useful on host to decide how to convert the path template to specific router's syntax
Expand Down Expand Up @@ -117,6 +119,11 @@ func (p *TemplateParam) Eval(paramValue string) (interface{}, bool) {
return newValue, true
}

// IsMacro reports whether this TemplateParam's underline macro matches the given one.
func (p *TemplateParam) IsMacro(macro *Macro) bool {
return p.macro == macro
}

// Parse takes a full route path and a macro map (macro map contains the macro types with their registered param functions)
// and returns a new Template.
// It builds all the parameter functions for that template
Expand All @@ -138,6 +145,8 @@ func Parse(src string, macros Macros) (Template, error) {
typEval := m.Evaluator

tmplParam := TemplateParam{
macro: m,

Src: p.Src,
Type: p.Type,
Name: p.Name,
Expand Down

0 comments on commit 7d540f5

Please sign in to comment.