feat: add support for ingress path params #652
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,234 @@ | ||
| package ingress | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "math/rand" | ||
| "net/http" | ||
| "reflect" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "github.com/TBD54566975/ftl/backend/common/slices" | ||
| "github.com/TBD54566975/ftl/backend/controller/dal" | ||
| "github.com/TBD54566975/ftl/backend/schema" | ||
| ) | ||
|
|
||
| type path []string | ||
|
|
||
| func (p path) String() string { | ||
| return strings.TrimLeft(strings.Join(p, ""), ".") | ||
| } | ||
|
|
||
| func GetIngressRoute(routes []dal.IngressRoute, method string, path string) (*dal.IngressRoute, error) { | ||
| var matchedRoutes = slices.Filter(routes, func(route dal.IngressRoute) bool { | ||
| return matchSegments(route.Path, path, func(segment, value string) {}) | ||
| }) | ||
|
|
||
| if len(matchedRoutes) == 0 { | ||
| return nil, dal.ErrNotFound | ||
| } | ||
|
|
||
| // TODO: add load balancing at some point | ||
| route := matchedRoutes[rand.Intn(len(matchedRoutes))] //nolint:gosec | ||
| return &route, nil | ||
| } | ||
|
|
||
| func matchSegments(pattern, urlPath string, onMatch func(segment, value string)) bool { | ||
| patternSegments := strings.Split(strings.Trim(pattern, "/"), "/") | ||
| urlSegments := strings.Split(strings.Trim(urlPath, "/"), "/") | ||
|
|
||
| if len(patternSegments) != len(urlSegments) { | ||
| return false | ||
| } | ||
|
|
||
| for i, segment := range patternSegments { | ||
| if segment == "" && urlSegments[i] == "" { | ||
| continue // Skip empty segments | ||
| } | ||
|
|
||
| if strings.HasPrefix(segment, "{") && strings.HasSuffix(segment, "}") { | ||
| key := strings.Trim(segment, "{}") // Dynamic segment | ||
| onMatch(key, urlSegments[i]) | ||
| } else if segment != urlSegments[i] { | ||
| return false | ||
| } | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| // ValidateAndExtractBody validates the request body against the schema and extracts the request body as a JSON blob. | ||
| func ValidateAndExtractBody(route *dal.IngressRoute, r *http.Request, sch *schema.Schema) ([]byte, error) { | ||
|
There was a problem hiding this comment. A doc comment here would be good. |
||
| requestMap, err := buildRequestMap(route, r) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| verb := sch.ResolveVerbRef(&schema.VerbRef{Name: route.Verb, Module: route.Module}) | ||
| if verb == nil { | ||
| return nil, fmt.Errorf("unknown verb %s", route.Verb) | ||
| } | ||
|
|
||
| dataRef := verb.Request | ||
| if dataRef.Module == "" { | ||
| dataRef.Module = route.Module | ||
| } | ||
|
|
||
| err = validateRequestMap(dataRef, []string{dataRef.String()}, requestMap, sch) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| body, err := json.Marshal(requestMap) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return body, nil | ||
| } | ||
|
|
||
| func buildRequestMap(route *dal.IngressRoute, r *http.Request) (map[string]any, error) { | ||
| requestMap := map[string]any{} | ||
| matchSegments(route.Path, r.URL.Path, func(segment, value string) { | ||
| requestMap[segment] = value | ||
| }) | ||
|
|
||
| switch r.Method { | ||
| case http.MethodPost, http.MethodPut: | ||
| var bodyMap map[string]any | ||
| err := json.NewDecoder(r.Body).Decode(&bodyMap) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("HTTP request body is not valid JSON: %w", err) | ||
| } | ||
|
|
||
| // Merge bodyMap into params | ||
| for k, v := range bodyMap { | ||
| requestMap[k] = v | ||
| } | ||
| default: | ||
| // TODO: Support query params correctly for map and array | ||
|
There was a problem hiding this comment. This pained me 😂 |
||
| for key, value := range r.URL.Query() { | ||
| requestMap[key] = value[len(value)-1] | ||
| } | ||
| } | ||
|
|
||
| return requestMap, nil | ||
| } | ||
|
|
||
| func validateRequestMap(dataRef *schema.DataRef, path path, request map[string]any, sch *schema.Schema) error { | ||
| data := sch.ResolveDataRef(dataRef) | ||
| if data == nil { | ||
| return fmt.Errorf("unknown data %v", dataRef) | ||
| } | ||
|
|
||
| var errs []error | ||
| for _, field := range data.Fields { | ||
| fieldPath := append(path, "."+field.Name) //nolint:gocritic | ||
|
|
||
| _, isOptional := field.Type.(*schema.Optional) | ||
| value, haveValue := request[field.Name] | ||
| if !isOptional && !haveValue { | ||
| errs = append(errs, fmt.Errorf("%s is required", fieldPath)) | ||
| continue | ||
| } | ||
|
|
||
| if haveValue { | ||
| err := validateValue(field.Type, fieldPath, value, sch) | ||
| if err != nil { | ||
| errs = append(errs, err) | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| return errors.Join(errs...) | ||
| } | ||
|
|
||
| func validateValue(fieldType schema.Type, path path, value any, sch *schema.Schema) error { | ||
| var typeMatches bool | ||
| switch fieldType := fieldType.(type) { | ||
| case *schema.Int: | ||
| switch value := value.(type) { | ||
| case float64: | ||
| typeMatches = true | ||
| case string: | ||
| if _, err := strconv.ParseFloat(value, 64); err == nil { | ||
| typeMatches = true | ||
| } | ||
| } | ||
| case *schema.Float: | ||
| switch value := value.(type) { | ||
| case float64: | ||
| typeMatches = true | ||
| case string: | ||
| if _, err := strconv.ParseFloat(value, 64); err == nil { | ||
| typeMatches = true | ||
| } | ||
| } | ||
| case *schema.String: | ||
| _, typeMatches = value.(string) | ||
| case *schema.Bool: | ||
| switch value := value.(type) { | ||
| case bool: | ||
| typeMatches = true | ||
| case string: | ||
| if _, err := strconv.ParseBool(value); err == nil { | ||
| typeMatches = true | ||
| } | ||
| } | ||
| case *schema.Array: | ||
| rv := reflect.ValueOf(value) | ||
| if rv.Kind() != reflect.Slice { | ||
| return fmt.Errorf("%s is not a slice", path) | ||
| } | ||
| elementType := fieldType.Element | ||
| for i := 0; i < rv.Len(); i++ { | ||
| elemPath := append(path, fmt.Sprintf("[%d]", i)) //nolint:gocritic | ||
| elem := rv.Index(i).Interface() | ||
| if err := validateValue(elementType, elemPath, elem, sch); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| typeMatches = true | ||
| case *schema.Map: | ||
| rv := reflect.ValueOf(value) | ||
| if rv.Kind() != reflect.Map { | ||
| return fmt.Errorf("%s is not a map", path) | ||
| } | ||
| keyType := fieldType.Key | ||
| valueType := fieldType.Value | ||
| for _, key := range rv.MapKeys() { | ||
| elemPath := append(path, fmt.Sprintf("[%q]", key)) //nolint:gocritic | ||
| elem := rv.MapIndex(key).Interface() | ||
| if err := validateValue(keyType, elemPath, key.Interface(), sch); err != nil { | ||
| return err | ||
| } | ||
| if err := validateValue(valueType, elemPath, elem, sch); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| typeMatches = true | ||
| case *schema.DataRef: | ||
| if valueMap, ok := value.(map[string]any); ok { | ||
| if err := validateRequestMap(fieldType, path, valueMap, sch); err != nil { | ||
| return err | ||
| } | ||
| typeMatches = true | ||
| } | ||
| case *schema.Optional: | ||
| if value == nil { | ||
| typeMatches = true | ||
| } else { | ||
| return validateValue(fieldType.Type, path, value, sch) | ||
| } | ||
|
|
||
| default: | ||
| return fmt.Errorf("%s has unsupported type %T", path, fieldType) | ||
| } | ||
|
|
||
| if !typeMatches { | ||
| return fmt.Errorf("%s has wrong type, expected %s found %T", path, fieldType, value) | ||
| } | ||
| return nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you also want the
if errors.Is(err, dal.ErrNotFound)check here too.