Bump cachix/install-nix-action from 26 to 27 (#133)

* Bump ApiSurface from 4.0.36 to 4.0.39

Bumps [ApiSurface](https://github.com/G-Research/ApiSurface) from 4.0.36 to 4.0.39.
- [Release notes](https://github.com/G-Research/ApiSurface/releases)
- [Commits](https://github.com/G-Research/ApiSurface/compare/ApiSurface.4.0.36...ApiSurface.4.0.39)

---
updated-dependencies:
- dependency-name: ApiSurface
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump deps

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Smaug123 <3138005+Smaug123@users.noreply.github.com>

.github/workflows/dotnet.yaml

@@ -28,7 +28,7 @@ jobs:
       with:
         fetch-depth: 0 # so that NerdBank.GitVersioning has access to history
     - name: Install Nix
-      uses: cachix/install-nix-action@v26
+      uses: cachix/install-nix-action@V27
       with:
         extra_nix_config: |
           access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
@@ -49,7 +49,7 @@ jobs:
         with:
           fetch-depth: 0 # so that NerdBank.GitVersioning has access to history
       - name: Install Nix
-        uses: cachix/install-nix-action@v26
+        uses: cachix/install-nix-action@V27
         with:
           extra_nix_config: |
             access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
@@ -66,7 +66,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Install Nix
-        uses: cachix/install-nix-action@v26
+        uses: cachix/install-nix-action@V27
         with:
           extra_nix_config: |
             access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
@@ -79,7 +79,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Install Nix
-        uses: cachix/install-nix-action@v26
+        uses: cachix/install-nix-action@V27
         with:
           extra_nix_config: |
             access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
@@ -92,7 +92,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Install Nix
-        uses: cachix/install-nix-action@v26
+        uses: cachix/install-nix-action@V27
         with:
           extra_nix_config: |
             access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
@@ -105,7 +105,7 @@ jobs:
     steps:
       - uses: actions/checkout@master
       - name: Install Nix
-        uses: cachix/install-nix-action@v26
+        uses: cachix/install-nix-action@V27
         with:
           extra_nix_config: |
             access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
@@ -118,7 +118,7 @@ jobs:
     steps:
       - uses: actions/checkout@master
       - name: Install Nix
-        uses: cachix/install-nix-action@v26
+        uses: cachix/install-nix-action@V27
         with:
           extra_nix_config: |
             access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
@@ -132,7 +132,7 @@ jobs:
       with:
         fetch-depth: 0 # so that NerdBank.GitVersioning has access to history
     - name: Install Nix
-      uses: cachix/install-nix-action@v26
+      uses: cachix/install-nix-action@V27
       with:
         extra_nix_config: |
           access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
@@ -188,7 +188,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Install Nix
-        uses: cachix/install-nix-action@v26
+        uses: cachix/install-nix-action@V27
         with:
           extra_nix_config: |
             access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}

ConsumePlugin/GeneratedRestClient.fs

@@ -288,7 +288,52 @@ module PureGymApi =
                              | v -> v),
                             System.Uri (
                                 ("/v2/gymSessions/member"
-                                 + "?fromDate="
+                                 + (if "/v2/gymSessions/member".IndexOf (char 63) > 0 then
+                                        "&"
+                                    else
+                                        "?")
+                                 + "fromDate="
+                                 + ((fromDate.ToString "yyyy-MM-dd") |> System.Web.HttpUtility.UrlEncode)
+                                 + "&toDate="
+                                 + ((toDate.ToString "yyyy-MM-dd") |> System.Web.HttpUtility.UrlEncode)),
+                                System.UriKind.Relative
+                            )
+                        )
+
+                    let httpMessage =
+                        new System.Net.Http.HttpRequestMessage (
+                            Method = System.Net.Http.HttpMethod.Get,
+                            RequestUri = uri
+                        )
+
+                    let! response = client.SendAsync (httpMessage, ct) |> Async.AwaitTask
+                    let response = response.EnsureSuccessStatusCode ()
+                    let! responseStream = response.Content.ReadAsStreamAsync ct |> Async.AwaitTask
+
+                    let! jsonNode =
+                        System.Text.Json.Nodes.JsonNode.ParseAsync (responseStream, cancellationToken = ct)
+                        |> Async.AwaitTask
+
+                    return Sessions.jsonParse jsonNode
+                }
+                |> (fun a -> Async.StartAsTask (a, ?cancellationToken = ct))
+
+            member _.GetSessionsWithQuery (fromDate : DateOnly, toDate : DateOnly, ct : CancellationToken option) =
+                async {
+                    let! ct = Async.CancellationToken
+
+                    let uri =
+                        System.Uri (
+                            (match client.BaseAddress with
+                             | null -> System.Uri "https://whatnot.com"
+                             | v -> v),
+                            System.Uri (
+                                ("/v2/gymSessions/member?foo=1"
+                                 + (if "/v2/gymSessions/member?foo=1".IndexOf (char 63) > 0 then
+                                        "&"
+                                    else
+                                        "?")
+                                 + "fromDate="
                                  + ((fromDate.ToString "yyyy-MM-dd") |> System.Web.HttpUtility.UrlEncode)
                                  + "&toDate="
                                  + ((toDate.ToString "yyyy-MM-dd") |> System.Web.HttpUtility.UrlEncode)),
@@ -1140,6 +1185,69 @@ module ApiWithHeaders =
             member _.SomeHeader : string = someHeader ()
             member _.SomeOtherHeader : int = someOtherHeader ()
 
+            member this.GetPathParam (parameter : string, ct : CancellationToken option) =
+                async {
+                    let! ct = Async.CancellationToken
+
+                    let uri =
+                        System.Uri (
+                            (match client.BaseAddress with
+                             | null ->
+                                 raise (
+                                     System.ArgumentNullException (
+                                         nameof (client.BaseAddress),
+                                         "No base address was supplied on the type, and no BaseAddress was on the HttpClient."
+                                     )
+                                 )
+                             | v -> v),
+                            System.Uri (
+                                "endpoint/{param}"
+                                    .Replace ("{param}", parameter.ToString () |> System.Web.HttpUtility.UrlEncode),
+                                System.UriKind.Relative
+                            )
+                        )
+
+                    let httpMessage =
+                        new System.Net.Http.HttpRequestMessage (
+                            Method = System.Net.Http.HttpMethod.Get,
+                            RequestUri = uri
+                        )
+
+                    do httpMessage.Headers.Add ("X-Foo", this.SomeHeader.ToString ())
+                    do httpMessage.Headers.Add ("Authorization", this.SomeOtherHeader.ToString ())
+                    do httpMessage.Headers.Add ("Header-Name", "Header-Value")
+                    let! response = client.SendAsync (httpMessage, ct) |> Async.AwaitTask
+                    let response = response.EnsureSuccessStatusCode ()
+                    let! responseString = response.Content.ReadAsStringAsync ct |> Async.AwaitTask
+                    return responseString
+                }
+                |> (fun a -> Async.StartAsTask (a, ?cancellationToken = ct))
+        }
+namespace PureGym
+
+open System
+open System.Threading
+open System.Threading.Tasks
+open System.IO
+open System.Net
+open System.Net.Http
+open RestEase
+
+/// Module for constructing a REST client.
+[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix)>]
+[<RequireQualifiedAccess>]
+module ApiWithHeaders2 =
+    /// Create a REST client. The input functions will be re-evaluated on every HTTP request to obtain the required values for the corresponding header properties.
+    let make
+        (someHeader : unit -> string)
+        (someOtherHeader : unit -> int)
+        (client : System.Net.Http.HttpClient)
+        : IApiWithHeaders2
+        =
+        { new IApiWithHeaders2 with
+            member _.SomeHeader : string = someHeader ()
+            member _.SomeOtherHeader : int = someOtherHeader ()
+
             member this.GetPathParam (parameter : string, ct : CancellationToken option) =
                 async {
                     let! ct = Async.CancellationToken

ConsumePlugin/RestApiExample.fs

@@ -38,6 +38,10 @@ type IPureGymApi =
     abstract GetSessions :
         [<Query>] fromDate : DateOnly * [<Query>] toDate : DateOnly * ?ct : CancellationToken -> Task<Sessions>
 
+    [<Get "/v2/gymSessions/member?foo=1">]
+    abstract GetSessionsWithQuery :
+        [<Query>] fromDate : DateOnly * [<Query>] toDate : DateOnly * ?ct : CancellationToken -> Task<Sessions>
+
     // An example from RestEase's own docs
     [<Post "users/new">]
     abstract CreateUserString : [<Body>] user : string * ?ct : CancellationToken -> Task<string>
@@ -142,3 +146,16 @@ type IApiWithHeaders =
 
     [<Get "endpoint/{param}">]
     abstract GetPathParam : [<Path "param">] parameter : string * ?ct : CancellationToken -> Task<string>
+
+[<WoofWare.Myriad.Plugins.HttpClient>]
+[<WoofWare.Myriad.Plugins.RestEase.Header("Header-Name", "Header-Value")>]
+type IApiWithHeaders2 =
+    [<WoofWare.Myriad.Plugins.RestEase.Header "X-Foo">]
+    abstract SomeHeader : string
+
+    [<WoofWare.Myriad.Plugins.RestEase.Header "Authorization">]
+    abstract SomeOtherHeader : int
+
+    [<Get "endpoint/{param}">]
+    abstract GetPathParam :
+        [<WoofWare.Myriad.Plugins.RestEase.Path "param">] parameter : string * ?ct : CancellationToken -> Task<string>

WoofWare.Myriad.Plugins.Attributes/RestEase.fs

@@ -50,10 +50,14 @@ module RestEase =
 
     /// Indicates that this interface member causes the interface to set a header with the given name,
     /// whose value is obtained whenever required by a fresh call to the interface member.
-    type HeaderAttribute (header : string) =
+    type HeaderAttribute (header : string, value : string option) =
         inherit Attribute ()
+        new (header : string) = HeaderAttribute (header, None)
+        new (header : string, value : string) = HeaderAttribute (header, Some value)
 
     /// Indicates that this argument to a method is interpolated into the request path at runtime
     /// by writing it into the templated string that specifies the HTTP query e.g. in the `[<Get "/foo/{template}">]`.
-    type PathAttribute () =
+    type PathAttribute (path : string option) =
         inherit Attribute ()
+        new (path : string) = PathAttribute (Some path)
+        new () = PathAttribute None

WoofWare.Myriad.Plugins.Attributes/SurfaceBaseline.txt

@@ -29,12 +29,16 @@ WoofWare.Myriad.Plugins.RestEase+GetAttribute..ctor [constructor]: string
 WoofWare.Myriad.Plugins.RestEase+HeadAttribute inherit System.Attribute
 WoofWare.Myriad.Plugins.RestEase+HeadAttribute..ctor [constructor]: string
 WoofWare.Myriad.Plugins.RestEase+HeaderAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+HeaderAttribute..ctor [constructor]: (string, string option)
+WoofWare.Myriad.Plugins.RestEase+HeaderAttribute..ctor [constructor]: (string, string)
 WoofWare.Myriad.Plugins.RestEase+HeaderAttribute..ctor [constructor]: string
 WoofWare.Myriad.Plugins.RestEase+OptionsAttribute inherit System.Attribute
 WoofWare.Myriad.Plugins.RestEase+OptionsAttribute..ctor [constructor]: string
 WoofWare.Myriad.Plugins.RestEase+PatchAttribute inherit System.Attribute
 WoofWare.Myriad.Plugins.RestEase+PatchAttribute..ctor [constructor]: string
 WoofWare.Myriad.Plugins.RestEase+PathAttribute inherit System.Attribute
+WoofWare.Myriad.Plugins.RestEase+PathAttribute..ctor [constructor]: string
+WoofWare.Myriad.Plugins.RestEase+PathAttribute..ctor [constructor]: string option
 WoofWare.Myriad.Plugins.RestEase+PathAttribute..ctor [constructor]: unit
 WoofWare.Myriad.Plugins.RestEase+PostAttribute inherit System.Attribute
 WoofWare.Myriad.Plugins.RestEase+PostAttribute..ctor [constructor]: string

WoofWare.Myriad.Plugins.Attributes/Test/WoofWare.Myriad.Plugins.Attributes.Test.fsproj

@@ -12,7 +12,7 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="ApiSurface" Version="4.0.36" />
+        <PackageReference Include="ApiSurface" Version="4.0.39" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0"/>
         <PackageReference Include="NUnit" Version="4.1.0"/>
         <PackageReference Include="NUnit3TestAdapter" Version="4.5.0"/>

WoofWare.Myriad.Plugins.Attributes/version.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.3",
+  "version": "3.0",
   "publicReleaseRefSpec": [
     "^refs/heads/main$"
   ],

WoofWare.Myriad.Plugins.Test/TestHttpClient/TestPureGymRestApi.fs

@@ -234,6 +234,33 @@ module TestPureGymRestApi =
 
         api.GetSessions(startDate, endDate).Result |> shouldEqual expected
 
+    [<TestCaseSource(nameof sessionsCases)>]
+    let ``Test GetSessionsWithQuery``
+        (baseUri : Uri, (startDate : DateOnly, (endDate : DateOnly, (json : string, expected : Sessions))))
+        =
+        let proc (message : HttpRequestMessage) : HttpResponseMessage Async =
+            async {
+                message.Method |> shouldEqual HttpMethod.Get
+
+                // This one is specified as being absolute, in its attribute on the IPureGymApi type
+                let expectedUri =
+                    let fromDate = dateOnlyToString startDate
+                    let toDate = dateOnlyToString endDate
+                    $"https://example.com/v2/gymSessions/member?foo=1&fromDate=%s{fromDate}&toDate=%s{toDate}"
+
+                message.RequestUri.ToString () |> shouldEqual expectedUri
+
+                let content = new StringContent (json)
+                let resp = new HttpResponseMessage (HttpStatusCode.OK)
+                resp.Content <- content
+                return resp
+            }
+
+        use client = HttpClientMock.make baseUri proc
+        let api = PureGymApi.make client
+
+        api.GetSessionsWithQuery(startDate, endDate).Result |> shouldEqual expected
+
     [<Test>]
     let ``URI example`` () =
         let proc (message : HttpRequestMessage) : HttpResponseMessage Async =

WoofWare.Myriad.Plugins.Test/WoofWare.Myriad.Plugins.Test.fsproj

@@ -33,7 +33,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="ApiSurface" Version="4.0.36"/>
+    <PackageReference Include="ApiSurface" Version="4.0.39"/>
     <PackageReference Include="FsCheck" Version="2.16.6"/>
     <PackageReference Include="FsUnit" Version="6.0.0"/>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0"/>

WoofWare.Myriad.Plugins/HttpClientGenerator.fs

@@ -1,8 +1,6 @@
 namespace WoofWare.Myriad.Plugins
 
-open System
 open System.Net.Http
-open System.Text
 open Fantomas.FCS.Syntax
 open Fantomas.FCS.SyntaxTrivia
 open Fantomas.FCS.Xml
@@ -143,7 +141,8 @@ module internal HttpClientGenerator =
         |> List.choose (fun attr ->
             match attr.TypeName.AsString with
             | "Header"
-            | "RestEase.Header" ->
+            | "RestEase.Header"
+            | "WoofWare.Myriad.Plugins.RestEase.Header" ->
                 match attr.ArgExpr with
                 | SynExpr.Paren (SynExpr.Tuple (_, [ v1 ; v2 ], _, _), _, _, _) ->
                     Some [ SynExpr.stripOptionalParen v1 ; SynExpr.stripOptionalParen v2 ]
@@ -309,6 +308,27 @@ module internal HttpClientGenerator =
                     | None -> failwith "Unable to get parameter variable name from anonymous parameter"
                     | Some id -> id
 
+                let urlSeparator =
+                    // apparent Myriad bug: `IndexOf '?'` gets formatted as `IndexOf ?` which is clearly wrong
+                    let questionMark =
+                        SynExpr.CreateParen (
+                            SynExpr.CreateApp (
+                                SynExpr.CreateIdentString "char",
+                                SynExpr.CreateConst (SynConst.Int32 63)
+                            )
+                        )
+
+                    let containsQuestion =
+                        info.UrlTemplate
+                        |> SynExpr.callMethodArg "IndexOf" questionMark
+                        |> SynExpr.greaterThanOrEqual (SynExpr.CreateConst (SynConst.Int32 0))
+
+                    SynExpr.ifThenElse
+                        containsQuestion
+                        (SynExpr.CreateConst (SynConst.CreateString "?"))
+                        (SynExpr.CreateConst (SynConst.CreateString "&"))
+                    |> SynExpr.CreateParen
+
                 let prefix =
                     SynExpr.CreateIdent firstValueId
                     |> SynExpr.toString firstValue.Type
@@ -317,7 +337,7 @@ module internal HttpClientGenerator =
                         SynExpr.CreateLongIdent (SynLongIdent.Create [ "System" ; "Web" ; "HttpUtility" ; "UrlEncode" ])
                     )
                     |> SynExpr.CreateParen
-                    |> SynExpr.plus (SynExpr.CreateConstString ("?" + firstKey + "="))
+                    |> SynExpr.plus (SynExpr.plus urlSeparator (SynExpr.CreateConstString (firstKey + "=")))
 
                 (prefix, queryParams)
                 ||> List.fold (fun uri (paramKey, paramValue) ->
@@ -725,6 +745,10 @@ module internal HttpClientGenerator =
         attrs
         |> List.choose (fun attr ->
             match attr.TypeName.AsString with
+            | "RestEase.Query"
+            | "RestEase.QueryAttribute"
+            | "WoofWare.Myriad.Plugins.RestEase.Query"
+            | "WoofWare.Myriad.Plugins.RestEase.QueryAttribute"
             | "Query"
             | "QueryAttribute" ->
                 match attr.ArgExpr with
@@ -733,6 +757,10 @@ module internal HttpClientGenerator =
                     Some (HttpAttribute.Query (Some s))
                 | SynExpr.Const (a, _) -> failwith $"unrecognised constant arg to the Query attribute: %+A{a}"
                 | _ -> None
+            | "RestEase.Path"
+            | "RestEase.PathAttribute"
+            | "WoofWare.Myriad.Plugins.RestEase.Path"
+            | "WoofWare.Myriad.Plugins.RestEase.PathAttribute"
             | "Path"
             | "PathAttribute" ->
                 match attr.ArgExpr with
@@ -741,6 +769,10 @@ module internal HttpClientGenerator =
                 | SynExpr.Const (SynConst.Unit, _) -> Some (HttpAttribute.Path PathSpec.MatchArgName)
                 | SynExpr.Const (a, _) -> failwith $"unrecognised constant arg to the Path attribute: %+A{a}"
                 | _ -> None
+            | "RestEase.Body"
+            | "RestEase.BodyAttribute"
+            | "WoofWare.Myriad.Plugins.RestEase.Body"
+            | "WoofWare.Myriad.Plugins.RestEase.BodyAttribute"
             | "Body"
             | "BodyAttribute" ->
                 match attr.ArgExpr with
@@ -756,8 +788,10 @@ module internal HttpClientGenerator =
             match attr.TypeName.AsString with
             | "BasePath"
             | "RestEase.BasePath"
+            | "WoofWare.Myriad.Plugins.RestEase.BasePath"
             | "BasePathAttribute"
-            | "RestEase.BasePathAttribute" -> Some attr.ArgExpr
+            | "RestEase.BasePathAttribute"
+            | "WoofWare.Myriad.Plugins.RestEase.BasePathAttribute" -> Some attr.ArgExpr
             | _ -> None
         )
 
@@ -767,8 +801,10 @@ module internal HttpClientGenerator =
             match attr.TypeName.AsString with
             | "BaseAddress"
             | "RestEase.BaseAddress"
+            | "WoofWare.Myriad.Plugins.RestEase.BaseAddress"
             | "BaseAddressAttribute"
-            | "RestEase.BaseAddressAttribute" -> Some attr.ArgExpr
+            | "RestEase.BaseAddressAttribute"
+            | "WoofWare.Myriad.Plugins.RestEase.BaseAddressAttribute" -> Some attr.ArgExpr
             | _ -> None
         )
 

WoofWare.Myriad.Plugins/SynExpr.fs

@@ -311,3 +311,19 @@ module internal SynExpr =
             ),
             x
         )
+
+    /// {y} >= {x}
+    let greaterThanOrEqual (x : SynExpr) (y : SynExpr) : SynExpr =
+        SynExpr.CreateApp (
+            SynExpr.CreateAppInfix (
+                SynExpr.CreateLongIdent (
+                    SynLongIdent.SynLongIdent (
+                        [ Ident.Create "op_GreaterThanOrEqual" ],
+                        [],
+                        [ Some (IdentTrivia.OriginalNotation ">=") ]
+                    )
+                ),
+                y
+            ),
+            x
+        )

nix/deps.nix

@@ -13,8 +13,8 @@
   })
   (fetchNuGet {
     pname = "ApiSurface";
-    version = "4.0.36";
-    sha256 = "sha256-xqIkMvjJD5UaAHYw8B0CU4h+fJvxNSVspMFro2dz0Rc=";
+    version = "4.0.39";
+    sha256 = "sha256-I4K5nJbltsfL/1r+KPTIo2wUd30zsCC2pkrnIRnsRHM=";
   })
   (fetchNuGet {
     pname = "Fantomas.Core";