Merge pull request #3 from aosasona/2-fix-lowercase-headers

Lowercase all header keys and prefer opt timeout

Author: aosasona

.github/workflows/publish.yml

@@ -13,6 +13,6 @@ jobs:
       - uses: erlef/setup-beam@v1
         with:
           otp-version: "26.0.2"
-          gleam-version: "0.34.1"
+          gleam-version: "1.0.0"
           rebar3-version: "3"
       - run: gleam publish --yes

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: erlef/setup-beam@v1
         with:
           otp-version: "26.0.2"
-          gleam-version: "0.34.1"
+          gleam-version: "1.0.0"
           rebar3-version: "3"
       - run: gleam format --check src test
       - run: gleam deps download

gleam.toml

@@ -1,20 +1,20 @@
 name = "falcon"
-version = "1.0.1"
-gleam = ">= 0.33.0"
+version = "1.1.0"
+gleam = ">= 0.34.0"
 
 # Fill out these fields if you intend to generate HTML documentation or publish
 # your project to the Hex package manager.
 #
-description = "A smoother way to send HTTP requests in Gleam with Axios-like APIs; an abstraction over Hackney."
+description = "A smoother way to send HTTP requests in Gleam with Axios-like APIs"
 licences = ["Apache-2.0"]
 repository = { type = "github", user = "trulyao", repo = "falcon" }
 # links = [{ title = "Website", href = "https://gleam.run" }]
 
 [dependencies]
 gleam_stdlib = "~> 0.34 or ~> 1.0"
-gleam_http = "~> 3.5"
+gleam_http = "~> 3.6"
+gleam_json = "~> 1.0"
 hackney = "~> 1.20"
-gleam_json = "~> 0.7"
 
 [dev-dependencies]
 gleeunit = "~> 1.0"

manifest.toml

@@ -3,11 +3,11 @@
 
 packages = [
   { name = "certifi", version = "2.12.0", build_tools = ["rebar3"], requirements = [], otp_app = "certifi", source = "hex", outer_checksum = "EE68D85DF22E554040CDB4BE100F33873AC6051387BAF6A8F6CE82272340FF1C" },
-  { name = "gleam_http", version = "3.5.3", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_http", source = "hex", outer_checksum = "C2FC3322203B16F897C1818D9810F5DEFCE347F0751F3B44421E1261277A7373" },
-  { name = "gleam_json", version = "0.7.0", build_tools = ["gleam"], requirements = ["thoas", "gleam_stdlib"], otp_app = "gleam_json", source = "hex", outer_checksum = "CB405BD93A8828BCD870463DE29375E7B2D252D9D124C109E5B618AAC00B86FC" },
+  { name = "gleam_http", version = "3.6.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_http", source = "hex", outer_checksum = "8C07DF9DF8CC7F054C650839A51C30A7D3C26482AC241C899C1CEA86B22DBE51" },
+  { name = "gleam_json", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "thoas"], otp_app = "gleam_json", source = "hex", outer_checksum = "8B197DD5D578EA6AC2C0D4BDC634C71A5BCA8E7DB5F47091C263ECB411A60DF3" },
   { name = "gleam_stdlib", version = "0.34.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "1FB8454D2991E9B4C0C804544D8A9AD0F6184725E20D63C3155F0AEB4230B016" },
   { name = "gleeunit", version = "1.0.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "D364C87AFEB26BDB4FB8A5ABDE67D635DC9FA52D6AB68416044C35B096C6882D" },
-  { name = "hackney", version = "1.20.1", build_tools = ["rebar3"], requirements = ["metrics", "mimerl", "ssl_verify_fun", "certifi", "parse_trans", "unicode_util_compat", "idna"], otp_app = "hackney", source = "hex", outer_checksum = "FE9094E5F1A2A2C0A7D10918FEE36BFEC0EC2A979994CFF8CFE8058CD9AF38E3" },
+  { name = "hackney", version = "1.20.1", build_tools = ["rebar3"], requirements = ["certifi", "idna", "metrics", "mimerl", "parse_trans", "ssl_verify_fun", "unicode_util_compat"], otp_app = "hackney", source = "hex", outer_checksum = "FE9094E5F1A2A2C0A7D10918FEE36BFEC0EC2A979994CFF8CFE8058CD9AF38E3" },
   { name = "idna", version = "6.1.1", build_tools = ["rebar3"], requirements = ["unicode_util_compat"], otp_app = "idna", source = "hex", outer_checksum = "92376EB7894412ED19AC475E4A86F7B413C1B9FBB5BD16DCCD57934157944CEA" },
   { name = "metrics", version = "1.0.1", build_tools = ["rebar3"], requirements = [], otp_app = "metrics", source = "hex", outer_checksum = "69B09ADDDC4F74A40716AE54D140F93BEB0FB8978D8636EADED0C31B6F099F16" },
   { name = "mimerl", version = "1.2.0", build_tools = ["rebar3"], requirements = [], otp_app = "mimerl", source = "hex", outer_checksum = "F278585650AA581986264638EBF698F8BB19DF297F66AD91B18910DFC6E19323" },
@@ -18,8 +18,8 @@ packages = [
 ]
 
 [requirements]
-gleam_http = { version = "~> 3.5" }
-gleam_json = { version = "~> 0.7" }
+gleam_http = { version = "~> 3.6" }
+gleam_json = { version = "~> 1.0" }
 gleam_stdlib = { version = "~> 0.34 or ~> 1.0" }
 gleeunit = { version = "~> 1.0" }
-hackney = { version = "~> 1.20" }
+hackney = { version = "~> 1.20"}

src/falcon.gleam

@@ -3,6 +3,8 @@ import falcon/core.{
 }
 import gleam/bool
 import gleam/list
+import gleam/string
+import gleam/result
 import gleam/http.{type Method, Delete, Get, Patch, Post, Put}
 import gleam/option.{type Option, None, Some}
 import falcon/hackney.{Timeout}
@@ -28,7 +30,8 @@ pub fn new(
   headers headers: Pairs,
   timeout timeout: Option(Int),
 ) -> Client {
-  Client(base_url: base_url, headers: headers, timeout: timeout)
+  let normalized_headers = normalise_headers(headers)
+  Client(base_url: base_url, headers: normalized_headers, timeout: timeout)
 }
 
 fn filter_opts(opts: Opts, keep_headers keep_headers: Bool) -> Opts {
@@ -46,6 +49,10 @@ fn filter_opts(opts: Opts, keep_headers keep_headers: Bool) -> Opts {
   })
 }
 
+fn normalise_headers(headers: Pairs) -> Pairs {
+  list.map(headers, with: fn(pair) { #(string.lowercase(pair.0), pair.1) })
+}
+
 pub fn extract_headers(opts: Opts) -> List(#(String, String)) {
   opts
   |> list.map(fn(opt) {
@@ -59,17 +66,29 @@ pub fn extract_headers(opts: Opts) -> List(#(String, String)) {
 
 /// This is used internally to merge the client options with the request options, it is only exposed for testing purposes
 pub fn merge_opts(client: Client, opts: Opts) -> Opts {
-  // There is a chance this will cause problems if you pass in a timeout in the client and another timeout in the options simply because we are not filtering out duplicates at the moment seeing as it might be too expensive to do that with every single request (it is nested - we'd have to look into opts and then filter out timeout from every single client options before putting them back together)
   let new_opts = case client.timeout {
-    Some(timeout) -> list.concat([[ClientOptions([Timeout(timeout)])], opts])
+    Some(timeout) -> {
+      // If there is a timeout in the client options, we want to ignore it if there is a timeout in the request options
+      let has_timeout =
+        list.find(opts, fn(opt) {
+          case opt {
+            ClientOptions([Timeout(_)]) -> True
+            _ -> False
+          }
+        })
+        |> result.is_ok
+
+      use <- bool.guard(when: has_timeout, return: opts)
+      list.concat([[ClientOptions([Timeout(timeout)])], opts])
+    }
     None -> opts
   }
 
-  // Merge all headers into one list
   let headers =
     new_opts
     |> filter_opts(keep_headers: True)
     |> extract_headers
+    |> normalise_headers
     |> fn(headers) { list.concat([client.headers, headers]) }
 
   // Remove all headers from the original list and replace with the merged list

src/falcon/core.gleam

@@ -93,19 +93,21 @@ pub fn error_to_string(err: FalconError) -> String {
 }
 
 fn with_leading_slash(path: String) -> String {
-  {
+  let path = {
     use <- bool.guard(when: string.starts_with(path, "/"), return: path)
     "/" <> path
   }
-  |> string.trim
+
+  string.trim(path)
 }
 
 fn without_trailing_slash(path: String) -> String {
-  {
+  let path = {
     use <- bool.guard(when: !string.ends_with(path, "/"), return: path)
     string.slice(path, 0, string.length(path) - 1)
   }
-  |> string.trim
+
+  string.trim(path)
 }
 
 pub fn append_path(url: Url, path: String) -> Url {

test/falcon_test.gleam

@@ -237,7 +237,7 @@ pub fn merge_opts_test() {
   |> result.unwrap(None)
   |> should.equal(None)
 
-  // Test that all timeouts are kept if set
+  // Test that only the new timeout is used
   let new_opts =
     new(Url("http://example.com"), [], Some(15_000))
     |> merge_opts([ClientOptions([Timeout(30_000)])])
@@ -248,12 +248,21 @@ pub fn merge_opts_test() {
 
   new_opts
   |> extract_timeouts
-  |> should.equal([Some(15_000), Some(30_000)])
+  |> should.equal([Some(30_000)])
 
   // Test that the last timeout provided by the user in the request itself is used instead of the default
   new(Url("http://example.com"), [], Some(15_000))
   |> merge_opts([ClientOptions([Timeout(30_000), Timeout(10_000)])])
   |> extract_timeouts
   |> list.last
   |> should.equal(Ok(Some(10_000)))
+
+  // Test for case sensitivity in headers
+  let new_opts =
+    new(Url("http://example.com"), [#("X-Api-Key", "default")], Some(5000))
+    |> merge_opts([Headers([#("X-AnoTher-Mixed-Case", "test")])])
+
+  new_opts
+  |> extract_headers
+  |> should.equal([#("x-api-key", "default"), #("x-another-mixed-case", "test")])
 }