Merge pull request #79 from martosaur/am-compliance-adapter-polish

Some polish for sdk compliance

Author: rafaeelaudibert

.github/workflows/ci.yml

@@ -15,12 +15,18 @@ jobs:
     # See https://hexdocs.pm/elixir/compatibility-and-deprecations.html#between-elixir-and-erlang-otp
     strategy:
       matrix:
-        elixir: ["1.17.x", "1.18.x"]
+        elixir: ["1.17.x", "1.18.x", "1.19.x"]
         otp: ["25.x", "26.x", "27.x", "28.x"]
         exclude:
           # Elixir 1.17 doesn't support OTP 28
           - elixir: "1.17.x"
             otp: "28.x"
+          # Elixir 1.18 doesn't support OTP 28
+          - elixir: "1.18.x"
+            otp: "28.x"
+          # Elixir 1.19 doesn't support OTP 25
+          - elixir: "1.19.x"
+            otp: "25.x"
 
     steps:
       - uses: actions/checkout@v3

.sampo/changesets/fabled-warden-aurelien.md

@@ -0,0 +1,5 @@
+---
+hex/posthog: minor
+---
+
+Implement proper retry behavior for requests. Also respects X-Retry-Later header.

.tool-versions

@@ -1,2 +1,2 @@
-elixir 1.18.3-otp-27
-erlang 27.3.3
+elixir 1.19.5-otp-28
+erlang 28.3.1

lib/posthog/api/client.ex

@@ -48,7 +48,7 @@ defmodule PostHog.API.Client do
   @impl __MODULE__
   def client(api_key, api_host) do
     client =
-      Req.new(base_url: api_host)
+      Req.new(base_url: api_host, retry: :transient)
       |> Req.Request.put_private(:api_key, api_key)
 
     %__MODULE__{client: client, module: __MODULE__}

lib/posthog/handler.ex

@@ -2,11 +2,15 @@ defmodule PostHog.Handler do
   @moduledoc """
   A [`logger handler`](https://www.erlang.org/doc/apps/kernel/logger_chapter.html#handlers).
   """
-  @behaviour :logger_handler
+  if System.otp_release() |> String.to_integer() >= 27 do
+    @behaviour :logger_handler
+  end
 
   alias PostHog.Context
 
-  @impl :logger_handler
+  # credo:disable-for-next-line Credo.Check.Design.TagTODO
+  # TODO: add @impl :logger_handler once we drop support for OTP < 27
+  @doc false
   def log(log_event, %{config: config}) do
     maybe_properties =
       cond do

sdk_compliance_adapter/.gitignore

@@ -0,0 +1,20 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez

sdk_compliance_adapter/Dockerfile

@@ -1,5 +1,5 @@
 # Build stage - use Debian for better compatibility
-FROM elixir:1.17 AS builder
+FROM hexpm/elixir:1.19.5-erlang-28.3.1-debian-bookworm-20260112-slim AS builder
 
 WORKDIR /app
 
@@ -21,7 +21,7 @@ COPY sdk_compliance_adapter/config ./sdk_compliance_adapter/config
 
 # Fetch and compile dependencies for the adapter
 WORKDIR /app/sdk_compliance_adapter
-RUN mix deps.get --only prod
+RUN mix deps.get --only $MIX_ENV
 RUN mix compile
 
 # Build release

sdk_compliance_adapter/lib/sdk_compliance_adapter.ex

@@ -5,8 +5,4 @@ defmodule SdkComplianceAdapter do
   This adapter wraps the posthog-elixir SDK for compliance testing with the
   PostHog SDK Test Harness.
   """
-
-  @version "1.0.0"
-
-  def version, do: @version
 end

sdk_compliance_adapter/lib/sdk_compliance_adapter/router.ex

@@ -11,12 +11,13 @@ defmodule SdkComplianceAdapter.Router do
 
   # Capture SDK version at compile time since Mix isn't available at runtime
   @sdk_version Application.spec(:posthog, :vsn) |> to_string()
+  @adapter_version Application.spec(:sdk_compliance_adapter, :vsn) |> to_string()
 
   plug(Plug.Logger)
   plug(:match)
   plug(Plug.Parsers,
     parsers: [:json],
-    json_decoder: Jason,
+    json_decoder: JSON,
     pass: ["*/*"]
   )
   plug(:dispatch)
@@ -27,15 +28,15 @@ defmodule SdkComplianceAdapter.Router do
 
     conn
     |> put_resp_content_type("application/json")
-    |> send_resp(500, Jason.encode!(%{success: false, error: inspect(reason)}))
+    |> send_resp(500, JSON.encode!(%{success: false, error: inspect(reason)}))
   end
 
   # GET /health - Health check endpoint
   get "/health" do
     response = %{
       sdk_name: "posthog-elixir",
       sdk_version: @sdk_version,
-      adapter_version: SdkComplianceAdapter.version()
+      adapter_version: @adapter_version
     }
 
     json_response(conn, 200, response)
@@ -56,13 +57,8 @@ defmodule SdkComplianceAdapter.Router do
     SdkComplianceAdapter.State.set_config(config)
 
     # Start PostHog with the new configuration
-    case start_posthog(config) do
-      {:ok, _pid} ->
-        json_response(conn, 200, %{success: true})
-
-      {:error, reason} ->
-        json_response(conn, 500, %{success: false, error: inspect(reason)})
-    end
+    {:ok, _pid} = start_posthog(config)
+    json_response(conn, 200, %{success: true})
   end
 
   # POST /capture - Capture a single event
@@ -124,14 +120,9 @@ defmodule SdkComplianceAdapter.Router do
 
   # POST /reset - Reset SDK state
   post "/reset" do
-    try do
-      stop_posthog()
-      SdkComplianceAdapter.State.reset()
-      json_response(conn, 200, %{success: true})
-    rescue
-      e ->
-        json_response(conn, 500, %{success: false, error: Exception.message(e)})
-    end
+    stop_posthog()
+    SdkComplianceAdapter.State.reset()
+    json_response(conn, 200, %{success: true})
   end
 
   match _ do
@@ -143,7 +134,7 @@ defmodule SdkComplianceAdapter.Router do
   defp json_response(conn, status, data) do
     conn
     |> put_resp_content_type("application/json")
-    |> send_resp(status, Jason.encode!(data))
+    |> send_resp(status, JSON.encode!(data))
   end
 
   defp build_config(params) do
@@ -195,15 +186,12 @@ defmodule SdkComplianceAdapter.Router do
     case Process.whereis(SdkComplianceAdapter.PostHog) do
       nil ->
         :ok
-
+  
       pid ->
         # terminate_child can return :ok or {:error, :not_found}
         # We don't care about the result - just try to stop it
         _ = DynamicSupervisor.terminate_child(SdkComplianceAdapter.DynamicSupervisor, pid)
         :ok
     end
-  rescue
-    # Catch any errors during termination
-    _ -> :ok
   end
 end

sdk_compliance_adapter/lib/sdk_compliance_adapter/tracked_client.ex

@@ -9,75 +9,43 @@ defmodule SdkComplianceAdapter.TrackedClient do
 
   @impl true
   def client(api_key, api_host) do
-    # Create the underlying Req client
-    client =
-      Req.new(base_url: api_host)
-      |> Req.Request.put_private(:api_key, api_key)
-
-    # Return the standard PostHog.API.Client struct with our module
-    %PostHog.API.Client{client: client, module: __MODULE__}
+    client = PostHog.API.Client.client(api_key, api_host)
+    instrumented_client = 
+      client.client
+      |> Req.Request.append_response_steps(track: &track/1)
+      |> Req.Request.append_error_steps(track_error: &track_error/1)
+      
+    %{client | client: instrumented_client}
   end
-
+  
   @impl true
-  def request(client, method, url, opts) do
-    # Build the request
-    req =
-      client
-      |> Req.merge(method: method, url: url)
-      |> Req.merge(opts)
-      |> then(fn req ->
-        req
-        |> Req.Request.fetch_option(:json)
-        |> case do
-          {:ok, json} ->
-            api_key = Req.Request.get_private(req, :api_key)
-            Req.merge(req, json: Map.put_new(json, :api_key, api_key))
-
-          :error ->
-            req
-        end
-      end)
-
-    # Extract UUIDs from the batch before sending
-    uuid_list = extract_uuids(opts)
-    event_count = count_events(opts)
-
-    # Make the request
-    result = Req.request(req)
-
-    # Track the request
-    case result do
-      {:ok, %{status: status}} ->
-        SdkComplianceAdapter.State.record_request(status, event_count, uuid_list)
-
-      {:error, reason} ->
-        SdkComplianceAdapter.State.set_last_error(inspect(reason))
-    end
-
-    result
+  defdelegate request(client, method, url, opts), to: PostHog.API.Client 
+  
+  def track({request, response}) do
+    req_body = 
+      request.body
+      |> to_string()
+      |> JSON.decode!()
+    
+    uuid_list = extract_uuids(req_body)
+    event_count = count_events(req_body)
+    
+    SdkComplianceAdapter.State.record_request(response.status, event_count, uuid_list)
+    
+    {request, response}
   end
-
-  defp extract_uuids(opts) do
-    case Keyword.get(opts, :json) do
-      %{batch: batch} when is_list(batch) ->
-        Enum.map(batch, fn event ->
-          # Check event level first, then properties
-          Map.get(event, :uuid) ||
-            Map.get(event, "uuid") ||
-            get_in(event, [:properties, :uuid]) ||
-            get_in(event, ["properties", "uuid"])
-        end)
-        |> Enum.reject(&is_nil/1)
-
-      _ ->
-        []
-    end
+  
+  def track_error({request, exception}) do
+    SdkComplianceAdapter.State.set_last_error(inspect(exception))
+    {request, exception}
   end
 
-  defp count_events(opts) do
-    case Keyword.get(opts, :json) do
-      %{batch: batch} when is_list(batch) -> length(batch)
-      _ -> 0
-    end
+  defp extract_uuids(request) do
+    request
+    |> get_in([Access.key("batch", []), Access.all(), "uuid"])
+    |> Enum.reject(&is_nil/1)
   end
+
+  defp count_events(%{"batch" => events}) when is_list(events), do: length(events)
+  defp count_events(_), do: 0
 end