Skip to content

Commit

Permalink
fix: Cursor just decided to swallow all errors, so I've fixed that (#…
Browse files Browse the repository at this point in the history 
…4739)

Also added a test case for string body request/response.
  • Loading branch information
@alecthomas
alecthomas authored Mar 2, 2025
1 parent 0316215 commit b2342f0
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 44 deletions.
2 changes: 1 addition & 1 deletion .vscode/settings.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@
"go.testFlags": [
"-race"
],
"go.buildTags": "infrastructure"
// "go.buildTags": "infrastructure"
}
99 changes: 59 additions & 40 deletions backend/ingress/openapi.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
)

// SchemaToOpenAPI converts an FTL schema to an OpenAPI specification.
func SchemaToOpenAPI(sch *schema.Schema) *spec.Swagger {
func SchemaToOpenAPI(sch *schema.Schema) (*spec.Swagger, error) {
swagger := &spec.Swagger{
SwaggerProps: spec.SwaggerProps{
Swagger: "2.0",
Expand Down Expand Up @@ -48,18 +48,20 @@ func SchemaToOpenAPI(sch *schema.Schema) *spec.Swagger {
}

// Add path to OpenAPI spec
addPathFromVerb(swagger, sch, module.Name, verb, ingressMeta)
if err := addPathFromVerb(swagger, sch, module.Name, verb, ingressMeta); err != nil {
return nil, fmt.Errorf("failed to add path for verb %s.%s: %w", module.Name, verb.Name, err)
}
}
}

// Add all data types used in the API
addDefinitions(swagger, sch)

return swagger
return swagger, nil
}

// addPathFromVerb adds a path to the OpenAPI spec from an FTL verb with ingress metadata.
func addPathFromVerb(swagger *spec.Swagger, sch *schema.Schema, moduleName string, verb *schema.Verb, ingressMeta *schema.MetadataIngress) {
func addPathFromVerb(swagger *spec.Swagger, sch *schema.Schema, moduleName string, verb *schema.Verb, ingressMeta *schema.MetadataIngress) error {
// Get the path from the ingress metadata
path := ingressMeta.PathString()

Expand Down Expand Up @@ -88,10 +90,14 @@ func addPathFromVerb(swagger *spec.Swagger, sch *schema.Schema, moduleName strin
operation.ID = fmt.Sprintf("%s.%s", moduleName, verb.Name)

// Process request parameters
processRequestParameters(operation, sch, verb)
if err := processRequestParameters(operation, sch, verb); err != nil {
return fmt.Errorf("failed to process request parameters: %w", err)
}

// Process response
processResponse(operation, sch, verb)
if err := processResponse(operation, sch, verb); err != nil {
return fmt.Errorf("failed to process response: %w", err)
}

// Add the operation to the path item based on the HTTP method
switch strings.ToUpper(ingressMeta.Method) {
Expand All @@ -103,45 +109,49 @@ func addPathFromVerb(swagger *spec.Swagger, sch *schema.Schema, moduleName strin
pathItem.Put = operation
case "DELETE":
pathItem.Delete = operation
default:
return fmt.Errorf("unsupported HTTP method: %s", ingressMeta.Method)
}

// Update the path in the swagger spec
swagger.Paths.Paths[openAPIPath] = pathItem
return nil
}

// processRequestParameters processes the request parameters for an operation.
func processRequestParameters(operation *spec.Operation, sch *schema.Schema, verb *schema.Verb) {
func processRequestParameters(operation *spec.Operation, sch *schema.Schema, verb *schema.Verb) error {
// Get the request type
requestRef, ok := verb.Request.(*schema.Ref)
if !ok {
return
return fmt.Errorf("request type must be a reference")
}

// Resolve the request type
httpRequestData, err := sch.ResolveMonomorphised(requestRef)
if err != nil {
return
return fmt.Errorf("failed to resolve request type: %w", err)
}

// Process path parameters
pathParamsField := httpRequestData.FieldByName("pathParameters")
if pathParamsField != nil && !isUnitType(pathParamsField.Type) {
pathParamsType, err := resolveType(sch, pathParamsField.Type)
if err == nil {
if pathParamsData, ok := pathParamsType.(*schema.Data); ok {
for _, field := range pathParamsData.Fields {
schema := schemaForType(field.Type)
param := spec.Parameter{
ParamProps: spec.ParamProps{
Name: field.Name,
In: "path",
Description: strings.Join(field.Comments, "\n"),
Required: true,
Schema: &schema,
},
}
operation.Parameters = append(operation.Parameters, param)
if err != nil {
return fmt.Errorf("failed to resolve path parameters type: %w", err)
}
if pathParamsData, ok := pathParamsType.(*schema.Data); ok {
for _, field := range pathParamsData.Fields {
schema := schemaForType(field.Type)
param := spec.Parameter{
ParamProps: spec.ParamProps{
Name: field.Name,
In: "path",
Description: strings.Join(field.Comments, "\n"),
Required: true,
Schema: &schema,
},
}
operation.Parameters = append(operation.Parameters, param)
}
}
}
Expand All @@ -150,20 +160,21 @@ func processRequestParameters(operation *spec.Operation, sch *schema.Schema, ver
queryParamsField := httpRequestData.FieldByName("query")
if queryParamsField != nil && !isUnitType(queryParamsField.Type) {
queryParamsType, err := resolveType(sch, queryParamsField.Type)
if err == nil {
if queryParamsData, ok := queryParamsType.(*schema.Data); ok {
for _, field := range queryParamsData.Fields {
schema := schemaForType(field.Type)
param := spec.Parameter{
ParamProps: spec.ParamProps{
Name: field.Name,
In: "query",
Description: strings.Join(field.Comments, "\n"),
Schema: &schema,
},
}
operation.Parameters = append(operation.Parameters, param)
if err != nil {
return fmt.Errorf("failed to resolve query parameters type: %w", err)
}
if queryParamsData, ok := queryParamsType.(*schema.Data); ok {
for _, field := range queryParamsData.Fields {
schema := schemaForType(field.Type)
param := spec.Parameter{
ParamProps: spec.ParamProps{
Name: field.Name,
In: "query",
Description: strings.Join(field.Comments, "\n"),
Schema: &schema,
},
}
operation.Parameters = append(operation.Parameters, param)
}
}
}
Expand All @@ -176,27 +187,29 @@ func processRequestParameters(operation *spec.Operation, sch *schema.Schema, ver
ParamProps: spec.ParamProps{
Name: "body",
In: "body",
Description: "Request body",
Description: strings.Join(bodyField.Comments, "\n"),
Required: true,
Schema: &schema,
},
}
operation.Parameters = append(operation.Parameters, param)
}

return nil
}

// processResponse processes the response for an operation.
func processResponse(operation *spec.Operation, sch *schema.Schema, verb *schema.Verb) {
func processResponse(operation *spec.Operation, sch *schema.Schema, verb *schema.Verb) error {
// Get the response type
responseRef, ok := verb.Response.(*schema.Ref)
if !ok {
return
return fmt.Errorf("response type must be a reference")
}

// Resolve the response type
httpResponseData, err := sch.ResolveMonomorphised(responseRef)
if err != nil {
return
return fmt.Errorf("failed to resolve response type: %w", err)
}

// Process success response
Expand Down Expand Up @@ -224,6 +237,8 @@ func processResponse(operation *spec.Operation, sch *schema.Schema, verb *schema
}
operation.Responses.StatusCodeResponses[400] = errorResponse
}

return nil
}

// addDefinitions adds all data types used in the API to the OpenAPI spec.
Expand Down Expand Up @@ -499,6 +514,10 @@ func schemaForType(t schema.Type) spec.Schema {
Type: []string{"object"},
},
}
case *schema.Any:
return spec.Schema{
SchemaProps: spec.SchemaProps{},
}
default:
panic(fmt.Sprintf("unknown type: %T", t))
}
Expand Down
46 changes: 43 additions & 3 deletions backend/ingress/openapi_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,17 @@ func TestOpenAPI(t *testing.T) {
// curl -X POST http://localhost:8891/post -d '{"name": "wicket", "age": 10}'
export verb post(builtin.HttpRequest<http.PostRequest, Unit, Unit>) builtin.HttpResponse<http.PostResponse, http.ApiError>
+ingress http POST /post
// Posts a string and returns a string
export verb postStrings(builtin.HttpRequest<String, Unit, Unit>) builtin.HttpResponse<String, http.ApiError>
+ingress http POST /post/name
}
`)
assert.NoError(t, err)

// Convert the schema to OpenAPI
swagger := SchemaToOpenAPI(s)
swagger, err := SchemaToOpenAPI(s)
assert.NoError(t, err)

// Convert the OpenAPI spec to JSON
actualJSON, err := json.MarshalIndent(swagger, "", " ")
Expand Down Expand Up @@ -123,7 +128,6 @@ func TestOpenAPI(t *testing.T) {
"operationId": "http.post",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
Expand All @@ -147,6 +151,42 @@ func TestOpenAPI(t *testing.T) {
}
}
}
},
"/post/name": {
"post": {
"description": "Posts a string and returns a string",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"operationId": "http.postStrings",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"type": "string"
}
},
"400": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/http.ApiError"
}
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -211,5 +251,5 @@ func TestOpenAPI(t *testing.T) {
}
}`

assert.Equal(t, string(actualJSON), expectedJSON)
assert.Equal(t, expectedJSON, string(actualJSON))
}

0 comments on commit b2342f0

Please sign in to comment.