ignore test for incomplete JSON response in v26.0

Author: jaeyson

CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## major.minor.patch (yyyy.mm.dd)
 
-## 0.2.0 (2024.12.xx)
+## 0.2.0 (2024.12.14)
 
 ### Changed
 
@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Default client, currently using [`Req`](https://hexdocs.pm/req).
 * `Connection` module, which is taken from [`ExTypesense`](https://hexdocs.pm/ex_typesense) because someone requested for loading of credentials at runtime.
 * `defstruct` in Modules `Debug`, `Documents` and `Stopwords` because it is throwing undefined struct error.
+* Few descriptions in `priv/open_api.yml` for 4XX response.
 
 ## 0.1.0 (2024.11.08)
 

coveralls.json

@@ -2,6 +2,7 @@
   "skip_files": [
     "test",
     "deps",
-    "lib/open_api_typesense/schemas"
+    "lib/open_api_typesense/schemas",
+    "lib/open_api_typesense.ex"
   ]
 }

lib/open_api_typesense.ex

@@ -1,3 +1,8 @@
 defmodule OpenApiTypesense do
   @moduledoc false
+
+  @doc false
+  def count_uniq_atom_keys do
+    nil
+  end
 end

lib/open_api_typesense/client.ex

@@ -79,8 +79,8 @@ defmodule OpenApiTypesense.Client do
       {:ok, %OpenApiTypesense.HealthStatus{ok: true}}
   """
   @doc since: "0.2.0"
-  @spec request(Connection.t(), map()) :: response()
-  def request(conn, opts \\ %{}) do
+  @spec request(Connection.t(), list()) :: response()
+  def request(conn, opts \\ []) do
     # Req.Request.append_error_steps and its retry option are used here.
     # options like retry, max_retries, etc. can be found in:
     # https://hexdocs.pm/req/Req.Steps.html#retry/1
@@ -118,6 +118,8 @@ defmodule OpenApiTypesense.Client do
         url: url,
         retry: retry,
         max_retries: max_retries,
+        compress_body: opts[:opts][:compress] || false,
+        cache: opts[:opts][:cache] || false,
         decode_json: [keys: :atoms]
       ]
       |> Req.new()
@@ -145,7 +147,7 @@ defmodule OpenApiTypesense.Client do
     parse_values(code, values, resp.body)
   end
 
-  defp parse_values(code, :map, body) when is_map(body) do
+  defp parse_values(code, :map, body) do
     status = if code in 200..299, do: :ok, else: :error
 
     {status, body}

test/operations/analytics_test.exs

@@ -104,7 +104,7 @@ defmodule AnalyticsTest do
     assert {:error, %ApiResponse{message: _}} = Analytics.create_analytics_rule(body)
   end
 
-  @tag ["27.1": true, "26.0": true, "0.25.2": true]
+  @tag ["27.1": true, "26.0": true, "0.25.2": false]
   test "success: upsert analytics rule" do
     name = "product_no_hits"
 
@@ -161,10 +161,12 @@ defmodule AnalyticsTest do
     assert length(rules) >= 0
   end
 
-  @tag ["27.1": true, "26.0": true, "0.25.2": true]
-  test "success: create analytics rule and event" do
+  @tag ["27.1": true, "26.0": false, "0.25.2": false]
+  test "success (v27.1): create analytics rule and event" do
     name = "product_popularity"
 
+    event_name = "products_click_event#{System.unique_integer()}"
+
     body =
       %{
         "name" => name,
@@ -173,7 +175,7 @@ defmodule AnalyticsTest do
           "source" => %{
             "collections" => ["products"],
             "events" => [
-              %{"type" => "click", "weight" => 1, "name" => "products_click_event"}
+              %{"type" => "click", "weight" => 1, "name" => event_name}
             ]
           },
           "destination" => %{
@@ -187,19 +189,22 @@ defmodule AnalyticsTest do
     assert {:ok, %AnalyticsRuleSchema{name: ^name}} = Analytics.create_analytics_rule(body)
     assert {:ok, %AnalyticsRuleSchema{name: ^name}} = Analytics.retrieve_analytics_rule(name)
 
-    name = "products_click_event"
-
     body =
       %{
-        "name" => name,
+        "name" => event_name,
         "type" => "click",
         "data" => %{
+          "q" => "nike_shoes",
           "doc_id" => "2468",
           "user_id" => "9903"
         }
       }
       |> Jason.encode_to_iodata!()
 
+    # Here's the reason why v26.0 is not tested
+    # Docs v26.0: https://typesense.org/docs/26.0/api/analytics-query-suggestions.html#sending-click-events
+    # Problem: the response JSON body is actually {"ok": true
+    # where it is missing a closing curly bracket "}"
     assert {:ok, %AnalyticsEventCreateResponse{ok: true}} = Analytics.create_analytics_event(body)
   end
 end