Improved adding GraphQLOptions (#479)

xperiandri · web-flow · commit c63746db7814 · 2024-05-07T23:18:18.000+02:00
* Improved adding `GraphQLOptions`
* Simplified `AddGraphQLOptions` usage
diff --git a/.github/workflows/publish_ci.yml b/.github/workflows/publish_ci.yml
@@ -31,7 +31,7 @@ jobs:
 
     - name: Add version to global.json
       run: |
-        $version = "7.0.406"
+        $version = "7.0.408"
         $globalJsonPath = "global.json"
         $globalJson = Get-Content -Raw -Path $globalJsonPath | ConvertFrom-Json
         if ($null -eq $globalJson.sdk.version) {
@@ -45,7 +45,7 @@ jobs:
     - name: Install .NET Core
       uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: 7.0.406
+        dotnet-version: 7.0.408
 
     - name: Add the GitHub source
       run: dotnet nuget add source --username USERNAME --password ${{secrets.GITHUB_TOKEN}} --store-password-in-clear-text --name "github.com" "https://nuget.pkg.github.com/fsprojects/index.json"
diff --git a/.github/workflows/publish_release.yml b/.github/workflows/publish_release.yml
@@ -33,7 +33,7 @@ jobs:
 
     - name: Add version to global.json
       run: |
-        $version = "7.0.406"
+        $version = "7.0.408"
         $globalJsonPath = "global.json"
         $globalJson = Get-Content -Raw -Path $globalJsonPath | ConvertFrom-Json
         if ($null -eq $globalJson.sdk.version) {
@@ -47,7 +47,7 @@ jobs:
     - name: Install .NET Core
       uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: 7.0.406
+        dotnet-version: 7.0.408
 
     - name: Install local tools
       run: dotnet tool restore
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -21,17 +21,22 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macOS-latest]
-        dotnet: [7.0.406]
+        dotnet: [7.0.408]
     runs-on: ${{ matrix.os }}
 
     steps:
     - uses: actions/checkout@v4
 
-    - name: Setup .NET Core
+    - name: Install .NET Core 7
       uses: actions/setup-dotnet@v4
       with:
         dotnet-version: ${{ matrix.dotnet }}
 
+    - name: Install .NET Core 6
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: "6.0.421"
+
     - name: Add version to global.json
       run: |
         $version = "${{ matrix.dotnet }}"
diff --git a/build/Program.fs b/build/Program.fs
@@ -25,7 +25,7 @@ execContext
 |> Fake.Core.Context.setExecutionContext
 
 module DotNetCli =
-    let setVersion (o : DotNet.Options) = { o with Version = Some "7.0.401" }
+    let setVersion (o : DotNet.Options) = { o with Version = Some "7.0.408" }
     let setRestoreOptions (o : DotNet.RestoreOptions) = o.WithCommon setVersion
 
 let configurationString = Environment.environVarOrDefault "CONFIGURATION" "Release"
@@ -68,10 +68,10 @@ Target.create RestoreTarget <| fun _ ->
 let [<Literal>] BuildTarget = "Build"
 Target.create BuildTarget <| fun _ ->
     "FSharp.Data.GraphQL.sln"
-    |> DotNet.build (fun o -> {
-        o with
+    |> DotNet.build (fun options -> {
+        options with
             Configuration = configuration
-            MSBuildParams = { o.MSBuildParams with DisableInternalBinLog = true }
+            MSBuildParams = { options.MSBuildParams with DisableInternalBinLog = true }
     })
 
 let startGraphQLServer (project : string) port (streamRef : DataRef<Stream>) =
@@ -104,6 +104,7 @@ let runTests (project : string) (args : string) =
     DotNet.build
         (fun options -> {
             options with
+                Framework = Some DotNetMoniker
                 Configuration = configuration
                 MSBuildParams = { options.MSBuildParams with DisableInternalBinLog = true }
         })
@@ -115,8 +116,13 @@ let runTests (project : string) (args : string) =
         (fun options ->
             {
                 options with
+                    Framework = Some DotNetMoniker
                     Configuration = configuration
-                    MSBuildParams = { options.MSBuildParams with DisableInternalBinLog = true }
+                    MSBuildParams = {
+                        options.MSBuildParams with
+                            DisableInternalBinLog = true
+                            Verbosity = Some Normal
+                    }
                     Common = { options.Common with CustomParams = Some customParams }
             }
                 .WithCommon
diff --git a/samples/chat-app/server/Program.fs b/samples/chat-app/server/Program.fs
@@ -21,7 +21,7 @@ let main args =
     let builder = WebApplication.CreateBuilder (args)
     builder.Services
         .AddGiraffe()
-        .AddGraphQLOptions<Root> (Schema.executor, rootFactory, "/ws")
+        .AddGraphQLOptions<Root> (Schema.executor, rootFactory)
     |> ignore
 
     let app = builder.Build ()
diff --git a/samples/star-wars-api/Startup.fs b/samples/star-wars-api/Startup.fs
@@ -22,7 +22,7 @@ type Startup private () =
     member _.ConfigureServices (services : IServiceCollection) =
         services
             .AddGiraffe()
-            .AddGraphQLOptions<Root> (Schema.executor, rootFactory, "/ws")
+            .AddGraphQLOptions<Root> (Schema.executor, rootFactory)
         |> ignore
 
     member _.Configure
diff --git a/src/FSharp.Data.GraphQL.Server.AspNetCore/GraphQLOptions.fs b/src/FSharp.Data.GraphQL.Server.AspNetCore/GraphQLOptions.fs
@@ -8,9 +8,16 @@ open Microsoft.AspNetCore.Http
 
 type PingHandler = IServiceProvider -> JsonDocument voption -> Task<JsonDocument voption>
 
+[<RequireQualifiedAccess>]
+module GraphQLOptionsDefaults =
+
+    let [<Literal>] ReadBufferSize = 4096
+    let [<Literal>] WebSocketEndpoint = "/ws"
+    let [<Literal>] WebSocketConnectionInitTimeoutInMs = 3000
+
 type GraphQLTransportWSOptions = {
     EndpointUrl : string
-    ConnectionInitTimeoutInMs : int
+    ConnectionInitTimeout : TimeSpan
     CustomPingHandler : PingHandler voption
 }
 
@@ -30,3 +37,4 @@ type GraphQLOptions<'Root> = {
     interface IGraphQLOptions with
         member this.SerializerOptions = this.SerializerOptions
         member this.WebsocketOptions = this.WebsocketOptions
+
diff --git a/src/FSharp.Data.GraphQL.Server.AspNetCore/GraphQLWebsocketMiddleware.fs b/src/FSharp.Data.GraphQL.Server.AspNetCore/GraphQLWebsocketMiddleware.fs
@@ -35,7 +35,7 @@ type GraphQLWebSocketMiddleware<'Root>
     let serializerOptions = options.SerializerOptions
     let pingHandler = options.WebsocketOptions.CustomPingHandler
     let endpointUrl = PathString options.WebsocketOptions.EndpointUrl
-    let connectionInitTimeout = options.WebsocketOptions.ConnectionInitTimeoutInMs
+    let connectionInitTimeout = options.WebsocketOptions.ConnectionInitTimeout
 
     let serializeServerMessage (jsonSerializerOptions : JsonSerializerOptions) (serverMessage : ServerMessage) = task {
         let raw =
diff --git a/src/FSharp.Data.GraphQL.Server.AspNetCore/StartupExtensions.fs b/src/FSharp.Data.GraphQL.Server.AspNetCore/StartupExtensions.fs
@@ -15,11 +15,11 @@ module ServiceCollectionExtensions =
     let createStandardOptions executor rootFactory endpointUrl = {
         SchemaExecutor = executor
         RootFactory = rootFactory
-        ReadBufferSize = 4096
+        ReadBufferSize = GraphQLOptionsDefaults.ReadBufferSize
         SerializerOptions = Json.serializerOptions
         WebsocketOptions = {
             EndpointUrl = endpointUrl
-            ConnectionInitTimeoutInMs = 3000
+            ConnectionInitTimeout = TimeSpan.FromMilliseconds (GraphQLOptionsDefaults.WebSocketConnectionInitTimeoutInMs)
             CustomPingHandler = ValueNone
         }
     }
@@ -31,16 +31,24 @@ module ServiceCollectionExtensions =
 
     type IServiceCollection with
 
+        /// <summary>
+        /// Adds GraphQL options to the service collection.
+        /// <para>
+        /// It also adds converters to <see href="Microsoft.AspNetCore.Http.Json.JsonOptions" />
+        /// to support serialization of GraphQL responses.
+        /// </para>
+        /// </summary>
         [<Extension; CompiledName "AddGraphQLOptions">]
         member services.AddGraphQLOptions<'Root>
             (
-                executor : Executor<'Root>,
+                executorFactory : Func<IServiceProvider, Executor<'Root>>,
                 rootFactory : HttpContext -> 'Root,
-                endpointUrl : string,
+                [<Optional; DefaultParameterValue (GraphQLOptionsDefaults.WebSocketEndpoint)>] webSocketEndpointUrl : string,
                 [<Optional>] configure : Func<GraphQLOptions<'Root>, GraphQLOptions<'Root>>
             ) =
-            let options =
-                let options = createStandardOptions executor rootFactory endpointUrl
+            let getOptions sp =
+                let executor = executorFactory.Invoke sp
+                let options = createStandardOptions executor rootFactory webSocketEndpointUrl
                 match configure with
                 | null -> options
                 | _ -> configure.Invoke options
@@ -54,9 +62,10 @@ module ServiceCollectionExtensions =
                     )
                 )
                 .AddSingleton<IOptionsFactory<GraphQLOptions<'Root>>>(
-                    { new IOptionsFactory<GraphQLOptions<'Root>> with
-                        member this.Create name = options
-                    }
+                    fun sp ->
+                        { new IOptionsFactory<GraphQLOptions<'Root>> with
+                            member this.Create name = (getOptions sp)
+                        }
                 )
                 .Configure<GraphQLOptions<'Root>>(Giraffe.HttpHandlers.IndentedOptionsName, (fun o -> o.SerializerOptions.WriteIndented <- true))
                 .AddSingleton<IOptionsFactory<IGraphQLOptions>>(fun sp ->
@@ -66,6 +75,44 @@ module ServiceCollectionExtensions =
                     }
                 )
 
+        /// <summary>
+        /// Adds GraphQL options to the service collection. Requires an executor instance to be provided.
+        /// <para>
+        /// It also adds converters to <see href="Microsoft.AspNetCore.Http.Json.JsonOptions" />
+        /// to support serialization of GraphQL responses.
+        /// </para>
+        /// </summary>
+        [<Extension; CompiledName "AddGraphQLOptions">]
+        member services.AddGraphQLOptions<'Root>
+            (
+                executor : Executor<'Root>,
+                rootFactory : HttpContext -> 'Root,
+                [<Optional; DefaultParameterValue (GraphQLOptionsDefaults.WebSocketEndpoint)>] webSocketEndpointUrl : string,
+                [<Optional>] configure : Func<GraphQLOptions<'Root>, GraphQLOptions<'Root>>
+            ) =
+            services.AddGraphQLOptions ((fun _ -> executor), rootFactory, webSocketEndpointUrl, configure)
+
+        /// <summary>
+        /// Adds GraphQL options to the service collection. It gets the executor from the service provider.
+        /// <para>
+        /// It also adds converters to <see href="Microsoft.AspNetCore.Http.Json.JsonOptions" />
+        /// to support serialization of GraphQL responses.
+        /// </para>
+        /// </summary>
+        /// <remarks>
+        /// The executor must be registered as a singleton service.
+        /// </remarks>
+        [<Extension; CompiledName "AddGraphQLOptions">]
+        member services.AddGraphQLOptions<'Root>
+            (
+                rootFactory : HttpContext -> 'Root,
+                [<Optional; DefaultParameterValue (GraphQLOptionsDefaults.WebSocketEndpoint)>] webSocketEndpointUrl : string,
+                [<Optional>] configure : Func<GraphQLOptions<'Root>, GraphQLOptions<'Root>>
+            ) =
+            let getExecutorService (sp : IServiceProvider) = sp.GetRequiredService<Executor<'Root>>()
+            services.AddGraphQLOptions (getExecutorService, rootFactory, webSocketEndpointUrl, configure)
+
+
 [<AutoOpen; Extension>]
 module ApplicationBuilderExtensions =
 
