Added FieldDef<'Val, 'Res> to support resolver changing middlewares (#492)

Author: xperiandri

samples/chat-app/server/Schema.fs

@@ -151,8 +151,7 @@ module Schema =
             name = nameof Member,
             description = "An organization member",
             isTypeOf = (fun o -> o :? Member),
-            fieldsFn =
-                fun () -> [
+            fields = [
                     Define.Field (
                         "id",
                         GuidType,
@@ -170,8 +169,7 @@ module Schema =
             name = nameof MeAsAMember,
             description = "An organization member",
             isTypeOf = (fun o -> o :? MeAsAMember),
-            fieldsFn =
-                fun () -> [
+            fields = [
                     Define.Field (
                         "privId",
                         GuidType,
@@ -193,7 +191,7 @@ module Schema =
         )
 
     let ChatMemberType =
-        Define.Object<ChatMember> (
+        DefineRec.Object<ChatMember> (
             name = nameof ChatMember,
             description = "A chat member is an organization member participating in a chat room",
             isTypeOf = (fun o -> o :? ChatMember),
@@ -213,7 +211,7 @@ module Schema =
         )
 
     let MeAsAChatMemberType =
-        Define.Object<MeAsAChatMember> (
+        DefineRec.Object<MeAsAChatMember> (
             name = nameof MeAsAChatMember,
             description = "A chat member is an organization member participating in a chat room",
             isTypeOf = (fun o -> o :? MeAsAChatMember),
@@ -241,7 +239,7 @@ module Schema =
         )
 
     let ChatRoomStatsType =
-        Define.Object<ChatRoom> (
+        DefineRec.Object<ChatRoom> (
             name = nameof ChatRoom,
             description = "A chat room as viewed from the outside",
             isTypeOf = (fun o -> o :? ChatRoom),
@@ -261,7 +259,7 @@ module Schema =
         )
 
     let ChatRoomDetailsType =
-        Define.Object<ChatRoomForMember> (
+        DefineRec.Object<ChatRoomForMember> (
             name = nameof ChatRoomForMember,
             description = "A chat room as viewed by a chat room member",
             isTypeOf = (fun o -> o :? ChatRoomForMember),
@@ -292,7 +290,7 @@ module Schema =
         )
 
     let OrganizationStatsType =
-        Define.Object<Organization> (
+        DefineRec.Object<Organization> (
             name = nameof Organization,
             description = "An organization as seen from the outside",
             isTypeOf = (fun o -> o :? Organization),
@@ -313,7 +311,7 @@ module Schema =
         )
 
     let OrganizationDetailsType =
-        Define.Object<OrganizationForMember> (
+        DefineRec.Object<OrganizationForMember> (
             name = nameof OrganizationForMember,
             description = "An organization as seen by one of the organization's members",
             isTypeOf = (fun o -> o :? OrganizationForMember),
@@ -354,8 +352,7 @@ module Schema =
             name = name,
             description = description,
             isTypeOf = (fun o -> o :? ChatRoomMessage),
-            fieldsFn =
-                fun () -> [
+            fields = [
                     Define.Field (
                         "id",
                         GuidType,
@@ -395,8 +392,7 @@ module Schema =
             name = name,
             description = description,
             isTypeOf = (fun o -> o :? unit),
-            fieldsFn =
-                fun () -> [
+            fields = [
                     Define.Field ("doNotUse", BooleanType, "this is just to satify the expected structure of this type", (fun _ _ -> true))
                 ]
         )
@@ -406,8 +402,7 @@ module Schema =
             name = name,
             description = description,
             isTypeOf = (fun o -> o :? MessageId),
-            fieldsFn =
-                (fun () -> [
+            fields = [
                     Define.Field (
                         "messageId",
                         GuidType,
@@ -416,16 +411,15 @@ module Schema =
                             match x with
                             | MessageId theId -> theId
                     )
-                ])
+                ]
         )
 
     let aChatRoomEventForMemberIdAndName description name =
         Define.Object<MemberId * string> (
             name = name,
             description = description,
             isTypeOf = (fun o -> o :? (MemberId * string)),
-            fieldsFn =
-                (fun () -> [
+            fields = [
                     Define.Field (
                         "memberId",
                         GuidType,
@@ -435,7 +429,7 @@ module Schema =
                             | MemberId theId -> theId
                     )
                     Define.Field ("memberName", StringType, "this is the member's name", (fun _ (_ : MemberId, name : string) -> name))
-                ])
+                ]
         )
 
     let newMessageDef =
@@ -478,7 +472,7 @@ module Schema =
         )
 
     let ChatRoomEventType =
-        Define.Object<ChatRoomEvent> (
+        DefineRec.Object<ChatRoomEvent> (
             name = nameof ChatRoomEvent,
             description = "Something that happened in the chat room, like a new message sent",
             isTypeOf = (fun o -> o :? ChatRoomEvent),
@@ -831,8 +825,7 @@ module Schema =
             name = "Root",
             description = "contains general request information",
             isTypeOf = (fun o -> o :? Root),
-            fieldsFn =
-                fun () -> [
+            fields = [
                     Define.Field ("requestId", StringType, "The request's unique ID.", (fun _ (r : Root) -> r.RequestId))
                 ]
         )

samples/star-wars-api/Schema.fs

@@ -155,7 +155,7 @@ module Schema =
         )
 
     and HumanType : ObjectDef<Human> =
-        Define.Object<Human> (
+        DefineRec.Object<Human> (
             name = "Human",
             description = "A humanoid creature in the Star Wars universe.",
             isTypeOf = (fun o -> o :? Human),
@@ -210,7 +210,7 @@ module Schema =
         )
 
     and DroidType =
-        Define.Object<Droid> (
+        DefineRec.Object<Droid> (
             name = "Droid",
             description = "A mechanical creature in the Star Wars universe.",
             isTypeOf = (fun o -> o :? Droid),
@@ -235,19 +235,19 @@ module Schema =
             name = "Planet",
             description = "A planet in the Star Wars universe.",
             isTypeOf = (fun o -> o :? Planet),
-            fieldsFn =
-                fun () ->
-                    [ Define.Field ("id", StringType, "The id of the planet", (fun _ p -> p.Id))
-                      Define.Field ("name", Nullable StringType, "The name of the planet.", (fun _ p -> p.Name))
-                      Define.Field ("isMoon", Nullable BooleanType, "Is that a moon?", (fun _ p -> p.IsMoon)) ]
+            fields = [
+                Define.Field ("id", StringType, "The id of the planet", (fun _ p -> p.Id))
+                Define.Field ("name", Nullable StringType, "The name of the planet.", (fun _ p -> p.Name))
+                Define.Field ("isMoon", Nullable BooleanType, "Is that a moon?", (fun _ p -> p.IsMoon))
+            ]
         )
 
     and RootType =
         Define.Object<Root> (
             name = "Root",
             description = "The Root type to be passed to all our resolvers.",
             isTypeOf = (fun o -> o :? Root),
-            fieldsFn = fun () -> [ Define.Field ("requestId", StringType, "The ID of the client.", (fun _ (r : Root) -> r.RequestId)) ]
+            fields = [ Define.Field ("requestId", StringType, "The ID of the client.", (fun _ (r : Root) -> r.RequestId)) ]
         )
 
     let Query =
@@ -281,7 +281,7 @@ module Schema =
         Define.Object<Root> (
             name = "Mutation",
             fields =
-                [ Define.Field (
+                [ Define.Field(
                       "setMoon",
                       Nullable PlanetType,
                       "Defines if a planet is actually a moon or not.",
@@ -293,7 +293,8 @@ module Schema =
                               schemaConfig.SubscriptionProvider.Publish<Planet> "watchMoon" x
                               schemaConfig.LiveFieldSubscriptionProvider.Publish<Planet> "Planet" "isMoon" x
                               x)
-                  ) ]
+                  )
+                ]
         )
 
     let schema : ISchema<Root> = upcast Schema (Query, Mutation, Subscription, schemaConfig)

src/FSharp.Data.GraphQL.Server.Middleware/MiddlewareDefinitions.fs

@@ -4,9 +4,9 @@ open FsToolkit.ErrorHandling
 open FSharp.Data.GraphQL
 open FSharp.Data.GraphQL.Types.Patterns
 open FSharp.Data.GraphQL.Types
-open FSharp.Data.GraphQL.Execution
 
 type internal QueryWeightMiddleware(threshold : float, reportToMetadata : bool) =
+
     let middleware (threshold : float) (ctx : ExecutionContext) (next : ExecutionContext -> AsyncVal<GQLExecutionResult>) =
         let measureThreshold (threshold : float) (fields : ExecutionInfo list) =
             let getWeight f =
@@ -56,13 +56,15 @@ type internal QueryWeightMiddleware(threshold : float, reportToMetadata : bool)
         if pass
         then next ctx
         else error ctx
+
     interface IExecutorMiddleware with
         member _.CompileSchema = None
         member _.PostCompileSchema = None
         member _.PlanOperation = None
         member _.ExecuteOperationAsync = Some (middleware threshold)
 
 type internal ObjectListFilterMiddleware<'ObjectType, 'ListType>(reportToMetadata : bool) =
+
     let compileMiddleware (ctx : SchemaCompileContext) (next : SchemaCompileContext -> unit) =
         let modifyFields (object : ObjectDef<'ObjectType>) (fields : FieldDef<'ObjectType> seq) =
             let args = [ Define.Input("filter", Nullable ObjectListFilter) ]
@@ -78,6 +80,7 @@ type internal ObjectListFilterMiddleware<'ObjectType, 'ListType>(reportToMetadat
             |> Seq.cast<NamedDef>
         ctx.TypeMap.AddTypes(modifiedTypes, overwrite = true)
         next ctx
+
     let reportMiddleware (ctx : ExecutionContext) (next : ExecutionContext -> AsyncVal<GQLExecutionResult>) =
         let rec collectArgs (acc : (string * ObjectListFilter) list) (fields : ExecutionInfo list) =
             let fieldArgs field =
@@ -133,6 +136,7 @@ type internal ObjectListFilterMiddleware<'ObjectType, 'ListType>(reportToMetadat
 type IdentityNameResolver = ObjectDef -> string
 
 type internal LiveQueryMiddleware(identityNameResolver : IdentityNameResolver) =
+
     let middleware (ctx : SchemaCompileContext) (next : SchemaCompileContext -> unit) =
         let identity (identityName : string) (x : obj) =
             x.GetType().GetProperty(identityName).GetValue(x)
@@ -165,6 +169,7 @@ type internal LiveQueryMiddleware(identityNameResolver : IdentityNameResolver) =
             if not (ctx.Schema.LiveFieldSubscriptionProvider.IsRegistered x.TypeName x.FieldName)
             then ctx.Schema.LiveFieldSubscriptionProvider.Register x)
         next ctx
+
     interface IExecutorMiddleware with
         member _.CompileSchema = Some middleware
         member _.PostCompileSchema = None

src/FSharp.Data.GraphQL.Server.Middleware/TypeSystemExtensions.fs

@@ -5,22 +5,24 @@ open FSharp.Data.GraphQL.Types
 /// Contains extensions for the type system.
 [<AutoOpen>]
 module TypeSystemExtensions =
+
     type FieldDef<'Val> with
+
         /// <summary>
         /// Creates a new field definition based on the existing one, containing
         /// the existing metadata information, plus a new entry used to calculate the query
         /// weight by the QueryWeightMiddleware.
         /// </summary>
         /// <param name="weight">A float value representing the weight that this field have on the query.</param>
-        member this.WithQueryWeight(weight : float) : FieldDef<'Val> =
-            this.WithMetadata(this.Metadata.Add("queryWeight", weight))
+        member this.WithQueryWeight (weight : float) : FieldDef<'Val> = this.WithMetadata (this.Metadata.Add ("queryWeight", weight))
 
     type ResolveFieldContext with
+
         /// <summary>
         /// Gets the filter argument value for this field, if it does have one.
         /// Field argument is defined by the ObjectFilterMiddleware.
         /// </summary>
         member this.Filter =
-            match this.Args.TryFind("filter") with
+            match this.Args.TryFind ("filter") with
             | Some (:? ObjectListFilter as f) -> Some f
-            | _ -> None
+            | _ -> None

src/FSharp.Data.GraphQL.Server.Relay/FSharp.Data.GraphQL.Server.Relay.fsproj

@@ -20,5 +20,4 @@
     <PackageReference Condition="$(IsNuGet) != ''" Include="FSharp.Data.GraphQL.Shared" VersionOverride="$(Version)" />
     <PackageReference Condition="$(IsNuGet) != ''" Include="FSharp.Data.GraphQL.Server" VersionOverride="$(Version)" />
   </ItemGroup>
-
 </Project>