Improve content type parser and separate oneOf to multiple operations (…

…#49)

* OAS: Improve the evaluation of unknown content types.
* OAS: If the request body type is a oneOf list the API will be duplicated to multiple operations.

connector/internal/argument/preset.go

@@ -3,7 +3,6 @@ package argument
 import (
 	"errors"
 	"fmt"
-	"log"
 	"strconv"
 	"strings"
 
@@ -124,7 +123,6 @@ func (ap ArgumentPreset) evalNestedField(segments []*spec.Segment, argument any,
 			return argument, nil
 		}
 
-		log.Println(selector, argumentSlice)
 		step := selector.Step()
 		if step < 1 {
 			step = 1

connector/internal/client.go

@@ -25,7 +25,6 @@ import (
 	"github.com/hasura/ndc-sdk-go/utils"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/codes"
-	"go.opentelemetry.io/otel/propagation"
 	"go.opentelemetry.io/otel/trace"
 	"golang.org/x/sync/errgroup"
 )
@@ -303,10 +302,8 @@ func (client *HTTPClient) doRequest(ctx context.Context, request *RetryableReque
 	if retryCount > 0 {
 		span.SetAttributes(attribute.Int("http.request.resend_count", retryCount))
 	}
-	setHeaderAttributes(span, "http.request.header.", request.Headers)
 
-	client.manager.propagator.Inject(ctx, propagation.HeaderCarrier(request.Headers))
-	resp, cancel, err := client.manager.ExecuteRequest(ctx, request, namespace)
+	resp, cancel, err := client.manager.ExecuteRequest(ctx, span, request, namespace)
 	if err != nil {
 		span.SetStatus(codes.Error, "error happened when executing the request")
 		span.RecordError(err)
@@ -552,6 +549,7 @@ func parseContentType(input string) string {
 		return ""
 	}
 	parts := strings.Split(input, ";")
+	contentTypeParts := strings.Split(parts[0], ",")
 
-	return strings.TrimSpace(parts[0])
+	return strings.TrimSpace(contentTypeParts[0])
 }

connector/internal/contenttype/json.go

@@ -9,6 +9,7 @@ import (
 	"strings"
 
 	rest "github.com/hasura/ndc-http/ndc-http-schema/schema"
+	restUtils "github.com/hasura/ndc-http/ndc-http-schema/utils"
 	"github.com/hasura/ndc-sdk-go/schema"
 	"github.com/hasura/ndc-sdk-go/utils"
 )
@@ -27,7 +28,7 @@ func NewJSONDecoder(httpSchema *rest.NDCHttpSchema) *JSONDecoder {
 
 // Decode unmarshals json and evaluate the schema type.
 func (c *JSONDecoder) Decode(r io.Reader, resultType schema.Type) (any, error) {
-	underlyingType, _, err := UnwrapNullableType(resultType)
+	underlyingType, _, err := restUtils.UnwrapNullableType(resultType)
 	if err != nil {
 		return nil, err
 	}

connector/internal/contenttype/utils.go

@@ -7,8 +7,6 @@ import (
 	"reflect"
 	"strconv"
 	"strings"
-
-	"github.com/hasura/ndc-sdk-go/schema"
 )
 
 var quoteEscaper = strings.NewReplacer("\\", "\\\\", `"`, "\\\"")
@@ -51,20 +49,3 @@ func StringifySimpleScalar(val reflect.Value, kind reflect.Kind) (string, error)
 		return string(j), nil
 	}
 }
-
-// UnwrapNullableType unwraps the underlying type of the nullable type
-func UnwrapNullableType(input schema.Type) (schema.TypeEncoder, bool, error) {
-	switch ty := input.Interface().(type) {
-	case *schema.NullableType:
-		childType, _, err := UnwrapNullableType(ty.UnderlyingType)
-		if err != nil {
-			return nil, false, err
-		}
-
-		return childType, true, nil
-	case *schema.NamedType, *schema.ArrayType:
-		return ty, false, nil
-	default:
-		return nil, false, fmt.Errorf("invalid type %v", input)
-	}
-}

connector/internal/request_builder.go

@@ -181,7 +181,7 @@ func (c *RequestBuilder) getRequestUploadBody(rawRequest *rest.Request, bodyInfo
 		return rawRequest.RequestBody
 	}
 
-	bi, ok, err := contenttype.UnwrapNullableType(bodyInfo.Type)
+	bi, ok, err := restUtils.UnwrapNullableType(bodyInfo.Type)
 	if err != nil || !ok {
 		return nil
 	}

connector/internal/upstream.go

@@ -18,6 +18,7 @@ import (
 	"github.com/hasura/ndc-sdk-go/utils"
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/propagation"
+	"go.opentelemetry.io/otel/trace"
 )
 
 // UpstreamManager represents a manager for an upstream.
@@ -133,7 +134,7 @@ func (um *UpstreamManager) CreateHTTPClient(requests *RequestBuilderResults) *HT
 }
 
 // ExecuteRequest executes a request to the upstream server.
-func (um *UpstreamManager) ExecuteRequest(ctx context.Context, request *RetryableRequest, namespace string) (*http.Response, context.CancelFunc, error) {
+func (um *UpstreamManager) ExecuteRequest(ctx context.Context, span trace.Span, request *RetryableRequest, namespace string) (*http.Response, context.CancelFunc, error) {
 	req, cancel, err := request.CreateRequest(ctx)
 	if err != nil {
 		return nil, nil, err
@@ -146,8 +147,12 @@ func (um *UpstreamManager) ExecuteRequest(ctx context.Context, request *Retryabl
 		return nil, nil, err
 	}
 
+	setHeaderAttributes(span, "http.request.header.", req.Header)
+
 	req.Header.Set(acceptEncodingHeader, um.compressors.AcceptEncoding())
 	req.Header.Set("User-Agent", "ndc-http/"+version.BuildVersion)
+	um.propagator.Inject(ctx, propagation.HeaderCarrier(req.Header))
+
 	resp, err := httpClient.Do(req)
 	if err != nil {
 		cancel()

connector/mutation.go

@@ -113,7 +113,9 @@ func (c *HTTPConnector) execMutationOperation(parentCtx context.Context, state *
 	var err error
 	if operation.Name == internal.ProcedureSendHTTPRequest {
 		requests, err = internal.NewRawRequestBuilder(operation, c.config.ForwardHeaders).Build()
-		requests.Operation = &c.procSendHttpRequest
+		if err == nil {
+			requests.Operation = &c.procSendHttpRequest
+		}
 	} else {
 		requests, err = c.explainProcedure(&operation)
 	}

docs/argument_presets.md

@@ -40,13 +40,21 @@ You can use argument presets to set default values to request arguments. Argumen
           "value": 1
         },
         "targets": ["addPet"]
+      },
+      {
+        "path": "body.categories[*].id",
+        "value": {
+          "type": "literal",
+          "value": 1
+        },
+        "targets": []
       }
     ]
   }
 }
 ```
 
-The target argument field is removed from the `arguments` schema if the selector is the root field. If the path selects the nested field the target field becomes nullable.
+The target argument field is removed from the `arguments` schema if the selector is the root field. If the path selects the nested field the target field becomes nullable. Support object properties and array selectors.
 
 ## Configuration options
 

ndc-http-schema/command/convert.go

@@ -61,7 +61,6 @@ func CommandConvertToNDCSchema(args *configuration.ConvertCommandArguments, logg
 		slog.Any("patch_before", config.PatchBefore),
 		slog.Any("patch_after", config.PatchAfter),
 		slog.Any("allowed_content_types", config.AllowedContentTypes),
-		slog.Bool("strict", config.Strict),
 		slog.Bool("pure", config.Pure),
 		slog.Bool("no_deprecation", config.NoDeprecation),
 	)

ndc-http-schema/configuration/convert.go

@@ -31,7 +31,6 @@ func ConvertToNDCSchema(config *ConvertConfig, logger *slog.Logger) (*schema.NDC
 		TrimPrefix:          config.TrimPrefix,
 		EnvPrefix:           config.EnvPrefix,
 		AllowedContentTypes: config.AllowedContentTypes,
-		Strict:              config.Strict,
 		NoDeprecation:       config.NoDeprecation,
 		Logger:              logger,
 	}
@@ -79,9 +78,7 @@ func ResolveConvertConfigArguments(config *ConvertConfig, configDir string, args
 		if args.Pure {
 			config.Pure = args.Pure
 		}
-		if args.Strict {
-			config.Strict = args.Strict
-		}
+
 		if args.NoDeprecation {
 			config.NoDeprecation = args.NoDeprecation
 		}

ndc-http-schema/configuration/types.go

@@ -23,10 +23,10 @@ var fieldNameRegex = regexp.MustCompile(`^[a-zA-Z_]\w+$`)
 type Configuration struct {
 	Output string `json:"output,omitempty" yaml:"output,omitempty"`
 	// Require strict validation
-	Strict         bool                   `json:"strict"         yaml:"strict"`
-	ForwardHeaders ForwardHeadersSettings `json:"forwardHeaders" yaml:"forwardHeaders"`
-	Concurrency    ConcurrencySettings    `json:"concurrency"    yaml:"concurrency"`
-	Files          []ConfigItem           `json:"files"          yaml:"files"`
+	Strict         bool                   `json:"strict"                   yaml:"strict"`
+	ForwardHeaders ForwardHeadersSettings `json:"forwardHeaders,omitempty" yaml:"forwardHeaders,omitempty"`
+	Concurrency    ConcurrencySettings    `json:"concurrency,omitempty"    yaml:"concurrency,omitempty"`
+	Files          []ConfigItem           `json:"files"                    yaml:"files"`
 }
 
 // ConcurrencySettings represent settings for concurrent webhook executions to remote servers.
@@ -212,8 +212,6 @@ type ConvertConfig struct {
 	EnvPrefix string `json:"envPrefix,omitempty" yaml:"envPrefix"`
 	// Return the pure NDC schema only
 	Pure bool `json:"pure,omitempty" yaml:"pure"`
-	// Require strict validation
-	Strict bool `json:"strict,omitempty" yaml:"strict"`
 	// Ignore deprecated fields.
 	NoDeprecation bool `json:"noDeprecation,omitempty" yaml:"noDeprecation"`
 	// Patch files to be applied into the input file before converting

ndc-http-schema/jsonschema/configuration.schema.json

@@ -60,10 +60,6 @@
           "type": "boolean",
           "description": "Return the pure NDC schema only"
         },
-        "strict": {
-          "type": "boolean",
-          "description": "Require strict validation"
-        },
         "noDeprecation": {
           "type": "boolean",
           "description": "Ignore deprecated fields."
@@ -138,8 +134,6 @@
       "type": "object",
       "required": [
         "strict",
-        "forwardHeaders",
-        "concurrency",
         "files"
       ],
       "description": "Configuration contains required settings for the connector."

ndc-http-schema/jsonschema/convert-config.schema.json

@@ -36,10 +36,6 @@
           "type": "boolean",
           "description": "Return the pure NDC schema only"
         },
-        "strict": {
-          "type": "boolean",
-          "description": "Require strict validation"
-        },
         "noDeprecation": {
           "type": "boolean",
           "description": "Ignore deprecated fields."

ndc-http-schema/jsonschema/ndc-http-schema.schema.json

@@ -72,7 +72,9 @@
                 "literal"
               ]
             },
-            "value": true
+            "value": {
+              "description": "The literal value"
+            }
           },
           "type": "object",
           "required": [
@@ -89,7 +91,8 @@
               ]
             },
             "name": {
-              "type": "string"
+              "type": "string",
+              "description": "Environment variable name"
             }
           },
           "type": "object",
@@ -107,7 +110,8 @@
               ]
             },
             "name": {
-              "type": "string"
+              "type": "string",
+              "description": "Header name, require enable headers forwarding"
             }
           },
           "type": "object",
@@ -969,9 +973,6 @@
       },
       "additionalProperties": false,
       "type": "object",
-      "required": [
-        "type"
-      ],
       "description": "TypeSchema represents a serializable object of OpenAPI schema that is used for validation"
     },
     "XMLSchema": {

ndc-http-schema/openapi/internal/oas2.go

@@ -169,37 +169,25 @@ func (oc *OAS2Builder) pathToNDCOperations(pathItem orderedmap.Pair[string, *v2.
 		oc.schema.Functions[funcName] = *funcGet
 	}
 
-	procPost, procPostName, err := newOAS2OperationBuilder(oc, pathKey, "post").BuildProcedure(pathValue.Post, pathValue.Parameters)
+	err = newOAS2OperationBuilder(oc, pathKey, "post").BuildProcedure(pathValue.Post, pathValue.Parameters)
 	if err != nil {
 		return err
 	}
-	if procPost != nil {
-		oc.schema.Procedures[procPostName] = *procPost
-	}
 
-	procPut, procPutName, err := newOAS2OperationBuilder(oc, pathKey, "put").BuildProcedure(pathValue.Put, pathValue.Parameters)
+	err = newOAS2OperationBuilder(oc, pathKey, "put").BuildProcedure(pathValue.Put, pathValue.Parameters)
 	if err != nil {
 		return err
 	}
-	if procPut != nil {
-		oc.schema.Procedures[procPutName] = *procPut
-	}
 
-	procPatch, procPatchName, err := newOAS2OperationBuilder(oc, pathKey, "patch").BuildProcedure(pathValue.Patch, pathValue.Parameters)
+	err = newOAS2OperationBuilder(oc, pathKey, "patch").BuildProcedure(pathValue.Patch, pathValue.Parameters)
 	if err != nil {
 		return err
 	}
-	if procPatch != nil {
-		oc.schema.Procedures[procPatchName] = *procPatch
-	}
 
-	procDelete, procDeleteName, err := newOAS2OperationBuilder(oc, pathKey, "delete").BuildProcedure(pathValue.Delete, pathValue.Parameters)
+	err = newOAS2OperationBuilder(oc, pathKey, "delete").BuildProcedure(pathValue.Delete, pathValue.Parameters)
 	if err != nil {
 		return err
 	}
-	if procDelete != nil {
-		oc.schema.Procedures[procDeleteName] = *procDelete
-	}
 
 	return nil
 }