Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC] Add support for generic IDictionary<string,obj> query inputs - for #472 #475

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

[RFC] Add support for generic IDictionary<string,obj> query inputs - for #472 #475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8cb230d
Add support for generic IDictionary<string,obj> query inputs
pkese Apr 6, 2024
8c34550
Skip populating Nullable fields with nulls
pkese Apr 6, 2024
bed4cc6
Hack around the case where field.ExecuteInput is null
pkese Apr 9, 2024
6adcc75
Executor: allow overriding AsyncExecute
pkese Oct 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions src/FSharp.Data.GraphQL.Server/Executor.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,8 @@ type Executor<'Root>(schema: ISchema<'Root>, middlewares : IExecutorMiddleware s
new(schema) =
Executor(schema, middlewares = Seq.empty)

abstract member AsyncExecute: ExecutionPlan * 'Root option * ImmutableDictionary<string, JsonElement> option -> Async<GQLExecutionResult>

/// <summary>
/// Asynchronously executes a provided execution plan. In case of repetitive queries, execution plan may be preprocessed
/// and cached using `documentId` as an identifier.
Expand All @@ -186,7 +188,7 @@ type Executor<'Root>(schema: ISchema<'Root>, middlewares : IExecutorMiddleware s
/// <param name="executionPlan">Execution plan for the operation.</param>
/// <param name="data">Optional object provided as a root to all top level field resolvers</param>
/// <param name="variables">Map of all variable values provided by the client request.</param>
member _.AsyncExecute(executionPlan: ExecutionPlan, ?data: 'Root, ?variables: ImmutableDictionary<string, JsonElement>): Async<GQLExecutionResult> =
default _.AsyncExecute(executionPlan: ExecutionPlan, ?data: 'Root, ?variables: ImmutableDictionary<string, JsonElement>): Async<GQLExecutionResult> =
execute (executionPlan, data, variables)

/// <summary>
Expand All @@ -200,10 +202,10 @@ type Executor<'Root>(schema: ISchema<'Root>, middlewares : IExecutorMiddleware s
/// <param name="variables">Map of all variable values provided by the client request.</param>
/// <param name="operationName">In case when document consists of many operations, this field describes which of them to execute.</param>
/// <param name="meta">A plain dictionary of metadata that can be used through execution customizations.</param>
member _.AsyncExecute(ast: Document, ?data: 'Root, ?variables: ImmutableDictionary<string, JsonElement>, ?operationName: string, ?meta : Metadata): Async<GQLExecutionResult> =
member this.AsyncExecute(ast: Document, ?data: 'Root, ?variables: ImmutableDictionary<string, JsonElement>, ?operationName: string, ?meta : Metadata): Async<GQLExecutionResult> =
let meta = defaultArg meta Metadata.Empty
match createExecutionPlan (ast, operationName, meta) with
| Ok executionPlan -> execute (executionPlan, data, variables)
| Ok executionPlan -> this.AsyncExecute (executionPlan, data, variables)
| Error (documentId, errors) -> async.Return <| GQLExecutionResult.Invalid(documentId, errors, meta)

/// <summary>
Expand All @@ -217,11 +219,11 @@ type Executor<'Root>(schema: ISchema<'Root>, middlewares : IExecutorMiddleware s
/// <param name="variables">Map of all variable values provided by the client request.</param>
/// <param name="operationName">In case when document consists of many operations, this field describes which of them to execute.</param>
/// <param name="meta">A plain dictionary of metadata that can be used through execution customizations.</param>
member _.AsyncExecute(queryOrMutation: string, ?data: 'Root, ?variables: ImmutableDictionary<string, JsonElement>, ?operationName: string, ?meta : Metadata): Async<GQLExecutionResult> =
member this.AsyncExecute(queryOrMutation: string, ?data: 'Root, ?variables: ImmutableDictionary<string, JsonElement>, ?operationName: string, ?meta : Metadata): Async<GQLExecutionResult> =
let meta = defaultArg meta Metadata.Empty
let ast = parse queryOrMutation
match createExecutionPlan (ast, operationName, meta) with
| Ok executionPlan -> execute (executionPlan, data, variables)
| Ok executionPlan -> this.AsyncExecute (executionPlan, data, variables)
| Error (documentId, errors) -> async.Return <| GQLExecutionResult.Invalid(documentId, errors, meta)

/// Creates an execution plan for provided GraphQL document AST without
Expand Down
47 changes: 42 additions & 5 deletions src/FSharp.Data.GraphQL.Server/Values.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,35 @@ let rec internal compileByType

| InputObject objDef ->
let objtype = objDef.Type
let ctor = ReflectionHelper.matchConstructor objtype (objDef.Fields |> Array.map (fun x -> x.Name))
let (constructor : obj[] -> obj), (parameterInfos : Reflection.ParameterInfo[]) =
if typeof<IDictionary<string,obj>>.IsAssignableFrom(objtype) then
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also check for IReadOnlyDictionary<string, obj> and obj and create ImmutableDictionary<string, obj> in that case

let parameterInfos = [|
for f in objDef.Fields ->
{ new Reflection.ParameterInfo() with
member _.Name = f.Name
member _.ParameterType = f.TypeDef.Type
member _.Attributes =
match f.TypeDef with
| Nullable _ -> Reflection.ParameterAttributes.Optional
| _ -> Reflection.ParameterAttributes.None
}
|]
let constructor (args:obj[]) =
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And format according to the Fantomas settings

Suggested change
let constructor (args:obj[]) =
let constructor (args : obj[]) =

let o = Activator.CreateInstance(objtype)
let dict = o :?> IDictionary<string, obj>
for fld,arg in Seq.zip objDef.Fields args do
match arg, fld.TypeDef with
| null, Nullable _ -> () // skip populating Nullable fields with nulls
pkese marked this conversation as resolved.
Show resolved Hide resolved
| _, _ -> dict.Add(fld.Name, arg)
box o
constructor, parameterInfos
else
let ctor = ReflectionHelper.matchConstructor objtype (objDef.Fields |> Array.map (fun x -> x.Name))
ctor.Invoke, ctor.GetParameters()


let struct (mapper, nullableMismatchParameters, missingParameters) =
ctor.GetParameters ()
parameterInfos
|> Array.fold
(fun struct (all : ResizeArray<_>, areNullable : HashSet<_>, missing : HashSet<_>) param ->
match
Expand Down Expand Up @@ -180,6 +205,19 @@ let rec internal compileByType
| None ->
Ok
<| wrapOptionalNone param.ParameterType field.TypeDef.Type
| Some input when isNull (box field.ExecuteInput) ->
// hack around the case where field.ExecuteInput is null
let rec extract = function
| NullValue -> null
| IntValue i -> box i
| FloatValue f -> box f
| BooleanValue b -> box b
| StringValue s -> box s
| EnumValue e -> box e
| ListValue l -> box (l |> List.map extract)
| ObjectValue o -> o |> Map.map (fun k v -> extract v) |> box
| VariableName v -> failwithf "Todo: extract variable"
extract input |> Ok
| Some prop ->
field.ExecuteInput prop variables
|> Result.map (normalizeOptional param.ParameterType)
Expand All @@ -188,7 +226,7 @@ let rec internal compileByType

let! args = argResults |> splitSeqErrorsList

let instance = ctor.Invoke args
let instance = constructor args
do!
objDef.Validator instance
|> ValidationResult.mapErrors (fun err ->
Expand All @@ -201,7 +239,6 @@ let rec internal compileByType
| true, found ->
match found with
| :? IReadOnlyDictionary<string, obj> as objectFields ->

let argResults =
mapper
|> Seq.map (fun struct (field, param) -> result {
Expand All @@ -217,7 +254,7 @@ let rec internal compileByType

let! args = argResults |> splitSeqErrorsList

let instance = ctor.Invoke args
let instance = constructor args
do!
objDef.Validator instance
|> ValidationResult.mapErrors (fun err ->
Expand Down