Merge pull request #3 from szTheory/release-please--branches--main--components--scrypath

szTheory · web-flow · commit 9ce220d35257 · 2026-04-16T21:11:29.000-04:00
chore(main): release scrypath 0.2.0
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0"
+  ".": "0.2.0"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,35 @@ All notable changes to this project will be documented in this file.
 
 Release Please manages versioned entries after this baseline.
 
+## [0.2.0](https://github.com/szTheory/scrypath/compare/scrypath-v0.1.0...scrypath-v0.2.0) (2026-04-17)
+
+
+### Features
+
+* **06-03:** add release automation baseline ([82306a8](https://github.com/szTheory/scrypath/commit/82306a899f026a93640522e96e00a024ad2e5c49))
+* **06-03:** tighten package metadata and release gate ([226bbf4](https://github.com/szTheory/scrypath/commit/226bbf403b1115bef38eb2efa214e61df395199d))
+* **08-02:** add shared empty-batch no-op handling ([1058269](https://github.com/szTheory/scrypath/commit/1058269c74cef4f366567859a908b4d0d08b7643))
+* **08-03:** add phase 8 verification command ([0cac567](https://github.com/szTheory/scrypath/commit/0cac56711a6766af802affb59bb523eb2e7d5f29))
+* **10-01:** add phase 10 release gate ([4ffd567](https://github.com/szTheory/scrypath/commit/4ffd567788f24cb2d92ccc4897b3031acdc39aa7))
+* **11-02:** add clean consumer smoke verification ([41fa6f8](https://github.com/szTheory/scrypath/commit/41fa6f809ad86c87812bb4f539b68343371b3f8b))
+* **11-02:** enforce the phase 11 release contract ([7a34f44](https://github.com/szTheory/scrypath/commit/7a34f446836228320a891523a1c2f55b3a94fa28))
+* **11-public-release-contract-01:** add phase 11 release alignment gate ([f778312](https://github.com/szTheory/scrypath/commit/f778312453fcdfca15e9e2f3dbea7dccca068a6c))
+* **12-01:** add internal operations seam contracts ([6f9e13f](https://github.com/szTheory/scrypath/commit/6f9e13f31ee0ec70b13889ae16f2d44af11bd688))
+* **12-02:** move sync orchestration onto the operations seam ([a4abdd6](https://github.com/szTheory/scrypath/commit/a4abdd6db0e5295fca156410e2fa130aeec39147))
+* **12-02:** wire seam-owned adapter task references ([fc1471f](https://github.com/szTheory/scrypath/commit/fc1471fe72327deb6cb52d88fad68d71ec8b8285))
+* **12-03:** move backfill and reindex onto seam results ([2b2eaa0](https://github.com/szTheory/scrypath/commit/2b2eaa09958d491a0b0f4876586a1888fc795f4b))
+* **13-01:** add root sync status operator API ([8c2ccae](https://github.com/szTheory/scrypath/commit/8c2ccaec3015fce34907de8682ad7acaeb1199be))
+* **13-01:** tighten status inspection seam coverage ([0017732](https://github.com/szTheory/scrypath/commit/00177329892568831528db302a5f4efc978d4852))
+
+
+### Bug Fixes
+
+* **06-04:** harden release-quality public contracts ([4e1eb59](https://github.com/szTheory/scrypath/commit/4e1eb59393575f487adbbbf1ace35854e7d28794))
+* **06-04:** lock phoenix json pagination example ([5f73cf2](https://github.com/szTheory/scrypath/commit/5f73cf2b317f0db9ad73838e4f589a623f0a1b06))
+* **06:** restore readme operational wording contract ([cfb51ce](https://github.com/szTheory/scrypath/commit/cfb51cee0702f488750dd6347d5eb8a63f03554d))
+* **08-01:** harden meilisearch task normalization ([8db7129](https://github.com/szTheory/scrypath/commit/8db7129b4be33af4038ed87ed2cfe0c320ad7212))
+* **12:** harden seam wait normalization ([aa9f179](https://github.com/szTheory/scrypath/commit/aa9f17952a8697660673ddb548129e4279a032d0))
+
 ## [Unreleased]
 
 - Establish release automation, package metadata checks, and a public release checklist.
diff --git a/lib/scrypath/backfill.ex b/lib/scrypath/backfill.ex
@@ -52,7 +52,13 @@ defmodule Scrypath.Backfill do
         last_primary_key = Map.fetch!(List.last(records), primary_key)
 
         with {:ok, backend_result} <-
-               upsert_documents(schema_module, documents, Keyword.fetch!(config, :backend), config, index) do
+               upsert_documents(
+                 schema_module,
+                 documents,
+                 Keyword.fetch!(config, :backend),
+                 config,
+                 index
+               ) do
           batch_result =
             batch_result(
               backend_result,
@@ -97,8 +103,11 @@ defmodule Scrypath.Backfill do
     config = Keyword.put(config, :index_name, index)
 
     case backend do
-      Scrypath.Meilisearch -> MeilisearchOperations.upsert_documents(schema_module, documents, config)
-      _other -> backend.upsert_documents(schema_module, documents, config)
+      Scrypath.Meilisearch ->
+        MeilisearchOperations.upsert_documents(schema_module, documents, config)
+
+      _other ->
+        backend.upsert_documents(schema_module, documents, config)
     end
   end
 
diff --git a/lib/scrypath/meilisearch.ex b/lib/scrypath/meilisearch.ex
@@ -108,9 +108,7 @@ defmodule Scrypath.Meilisearch do
          raw: response
        }}
     else
-      {:error,
-       {:invalid_task_payload,
-        invalid_task_payload(stage, task_uid, problems, response)}}
+      {:error, {:invalid_task_payload, invalid_task_payload(stage, task_uid, problems, response)}}
     end
   end
 
diff --git a/lib/scrypath/meilisearch/client.ex b/lib/scrypath/meilisearch/client.ex
@@ -7,7 +7,8 @@ defmodule Scrypath.Meilisearch.Client do
   alias Scrypath.Query, as: CommonQuery
   alias Scrypath.Telemetry
 
-  @spec create_index(String.t(), String.t() | atom() | nil, keyword()) :: {:ok, map()} | {:error, term()}
+  @spec create_index(String.t(), String.t() | atom() | nil, keyword()) ::
+          {:ok, map()} | {:error, term()}
   def create_index(index_name, primary_key, config) do
     payload =
       %{"uid" => index_name}
@@ -137,7 +138,9 @@ defmodule Scrypath.Meilisearch.Client do
   defp search_payload(query) when is_map(query), do: query
 
   defp maybe_put_primary_key(payload, nil), do: payload
-  defp maybe_put_primary_key(payload, primary_key), do: Map.put(payload, "primaryKey", to_string(primary_key))
+
+  defp maybe_put_primary_key(payload, primary_key),
+    do: Map.put(payload, "primaryKey", to_string(primary_key))
 
   defp encode_task_filters(filters) do
     Enum.reduce(filters, %{}, fn
diff --git a/lib/scrypath/meilisearch/index_management.ex b/lib/scrypath/meilisearch/index_management.ex
@@ -14,7 +14,8 @@ defmodule Scrypath.Meilisearch.IndexManagement do
     Keyword.get(config, :target_index) || "#{live_index_name(schema_module, config)}__reindex"
   end
 
-  @spec create_index(module(), String.t() | atom() | nil, keyword()) :: {:ok, map()} | {:error, term()}
+  @spec create_index(module(), String.t() | atom() | nil, keyword()) ::
+          {:ok, map()} | {:error, term()}
   def create_index(schema_module, primary_key, config) do
     live_index = live_index_name(schema_module, config)
     target_index = target_index_name(schema_module, config)
diff --git a/lib/scrypath/meilisearch/operations.ex b/lib/scrypath/meilisearch/operations.ex
@@ -8,7 +8,8 @@ defmodule Scrypath.Meilisearch.Operations do
   alias Scrypath.Operations.Result
   alias Scrypath.Operations.Task
 
-  @spec upsert_documents(module(), [Document.t()], keyword()) :: {:ok, Result.t()} | {:error, term()}
+  @spec upsert_documents(module(), [Document.t()], keyword()) ::
+          {:ok, Result.t()} | {:error, term()}
   def upsert_documents(schema_module, documents, config) when is_list(documents) do
     index = Keyword.get(config, :index_name) || Meilisearch.index_name(schema_module, config)
     document_id_field = Scrypath.document_id_field(schema_module)
diff --git a/lib/scrypath/meilisearch/tasks.ex b/lib/scrypath/meilisearch/tasks.ex
@@ -24,7 +24,8 @@ defmodule Scrypath.Meilisearch.Tasks do
         |> Enum.reduce_while({:ok, []}, fn payload, {:ok, acc} ->
           case Meilisearch.normalize_task(payload, :poll) do
             {:ok, normalized_task} ->
-              {:cont, {:ok, [Operations.task_from_backend(normalized_task, source: :meilisearch) | acc]}}
+              {:cont,
+               {:ok, [Operations.task_from_backend(normalized_task, source: :meilisearch) | acc]}}
 
             {:error, reason} ->
               {:halt, {:error, reason}}
@@ -108,7 +109,9 @@ defmodule Scrypath.Meilisearch.Tasks do
             {:ok, normalized_task} ->
               normalized_task
               |> Operations.task_from_backend(source: :meilisearch)
-              |> then(&do_wait_for_task(&1, config, started_at, poll_interval, timeout, polls + 1))
+              |> then(
+                &do_wait_for_task(&1, config, started_at, poll_interval, timeout, polls + 1)
+              )
 
             {:error, reason} ->
               {{:error, reason}, polls + 1}
diff --git a/lib/scrypath/oban/enqueue.ex b/lib/scrypath/oban/enqueue.ex
@@ -88,7 +88,13 @@ defmodule Scrypath.Oban.Enqueue do
           )
 
         {:ok,
-         %{result | metadata: %{index: job.args["index"], oban: %{queue: queue, max_attempts: max_attempts, name: oban}}}}
+         %{
+           result
+           | metadata: %{
+               index: job.args["index"],
+               oban: %{queue: queue, max_attempts: max_attempts, name: oban}
+             }
+         }}
 
       {:error, _reason} = error ->
         error
diff --git a/lib/scrypath/operator/state.ex b/lib/scrypath/operator/state.ex
@@ -68,9 +68,14 @@ defmodule Scrypath.Operator.State do
   defp normalize_backend_state(:completed), do: :completed
   defp normalize_backend_state(_state), do: :pending
 
-  defp normalize_queue_state(state) when state in ["available", "scheduled", "executing"], do: :queued
+  defp normalize_queue_state(state) when state in ["available", "scheduled", "executing"],
+    do: :queued
+
   defp normalize_queue_state(state) when state in ["retryable", :retryable], do: :retrying
-  defp normalize_queue_state(state) when state in ["discarded", "cancelled", :discarded, :cancelled], do: :failed
+
+  defp normalize_queue_state(state)
+       when state in ["discarded", "cancelled", :discarded, :cancelled], do: :failed
+
   defp normalize_queue_state(state) when state in ["completed", :completed], do: :completed
   defp normalize_queue_state(:queued), do: :queued
   defp normalize_queue_state(:retrying), do: :retrying
diff --git a/lib/scrypath/telemetry.ex b/lib/scrypath/telemetry.ex
@@ -6,7 +6,7 @@ defmodule Scrypath.Telemetry do
   @type event_name :: [atom()]
   @type metadata :: map()
 
-  @spec span(event_name(), metadata(), (() -> {term(), metadata()})) :: term()
+  @spec span(event_name(), metadata(), (-> {term(), metadata()})) :: term()
   def span(event_name, metadata, fun) when is_list(event_name) and is_map(metadata) do
     :telemetry.span(event_name, metadata, fn ->
       {result, stop_metadata} = fun.()
@@ -31,7 +31,8 @@ defmodule Scrypath.Telemetry do
   @spec stop_metadata(term(), keyword()) :: metadata()
   def stop_metadata(result, extra \\ [])
 
-  def stop_metadata({:ok, %_{} = result}, extra), do: stop_metadata({:ok, Map.from_struct(result)}, extra)
+  def stop_metadata({:ok, %_{} = result}, extra),
+    do: stop_metadata({:ok, Map.from_struct(result)}, extra)
 
   def stop_metadata({:ok, %{status: :noop, document_count: 0} = result}, extra) do
     %{}
@@ -59,7 +60,10 @@ defmodule Scrypath.Telemetry do
     %{}
     |> maybe_put(:status, Map.get(result, :status))
     |> maybe_put(:mode, Map.get(result, :mode))
-    |> maybe_put(:document_count, Map.get(result, :document_count) || count(Map.get(result, :document_ids)))
+    |> maybe_put(
+      :document_count,
+      Map.get(result, :document_count) || count(Map.get(result, :document_ids))
+    )
     |> maybe_put(:record_count, count(Map.get(result, :records)))
     |> maybe_put(:hit_count, count(Map.get(result, :hits)))
     |> maybe_put(:missing_count, count(Map.get(result, :missing_ids)))
diff --git a/mix.exs b/mix.exs
@@ -1,7 +1,7 @@
 defmodule Scrypath.MixProject do
   use Mix.Project
 
-  @version "0.1.0"
+  @version "0.2.0"
   @source_url "https://github.com/szTheory/scrypath"
   @source_ref "v#{@version}"
   @hexdocs_url "https://hexdocs.pm/scrypath"
diff --git a/test/release/consumer_smoke_test.exs b/test/release/consumer_smoke_test.exs
@@ -33,7 +33,10 @@ defmodule Scrypath.Release.ConsumerSmokeTest do
     run_mix!(["compile"], cd: app_dir)
 
     assert File.exists?(
-             Path.join(app_dir, "_build/dev/lib/consumer_usage/ebin/Elixir.ConsumerUsage.Post.beam")
+             Path.join(
+               app_dir,
+               "_build/dev/lib/consumer_usage/ebin/Elixir.ConsumerUsage.Post.beam"
+             )
            )
   end
 
@@ -138,7 +141,10 @@ defmodule Scrypath.Release.ConsumerSmokeTest do
 
   defp unique_tmp_dir! do
     path =
-      Path.join(System.tmp_dir!(), "scrypath-consumer-smoke-#{System.unique_integer([:positive])}")
+      Path.join(
+        System.tmp_dir!(),
+        "scrypath-consumer-smoke-#{System.unique_integer([:positive])}"
+      )
 
     File.mkdir_p!(path)
     path
diff --git a/test/release/package_metadata_test.exs b/test/release/package_metadata_test.exs
@@ -23,7 +23,8 @@ defmodule Scrypath.Release.PackageMetadataTest do
     assert package[:links] == %{
              "GitHub" => "https://github.com/szTheory/scrypath",
              "HexDocs" => "https://hexdocs.pm/scrypath/#{version}",
-             "Changelog" => "https://github.com/szTheory/scrypath/blob/#{source_ref}/CHANGELOG.md",
+             "Changelog" =>
+               "https://github.com/szTheory/scrypath/blob/#{source_ref}/CHANGELOG.md",
              "Guides" => "https://hexdocs.pm/scrypath/#{version}/readme.html"
            }
   end
diff --git a/test/scrypath/meilisearch/tasks_test.exs b/test/scrypath/meilisearch/tasks_test.exs
@@ -124,7 +124,12 @@ defmodule Scrypath.Meilisearch.TasksTest do
   } do
     assert {:error,
             {:invalid_task_payload,
-             %{stage: :initial, task_uid: nil, problems: [uid: :missing_or_invalid], payload: payload}}} =
+             %{
+               stage: :initial,
+               task_uid: nil,
+               problems: [uid: :missing_or_invalid],
+               payload: payload
+             }}} =
              Tasks.wait_for_task(
                %{"status" => "enqueued"},
                meilisearch_client: SequencedClient,
@@ -160,9 +165,10 @@ defmodule Scrypath.Meilisearch.TasksTest do
     assert payload == %{"uid" => 301, "status" => "weird"}
   end
 
-  test "missing uid on a polled terminal task stays invalid instead of surfacing terminal tuples", %{
-    task_responses: agent
-  } do
+  test "missing uid on a polled terminal task stays invalid instead of surfacing terminal tuples",
+       %{
+         task_responses: agent
+       } do
     Agent.update(agent, fn _ ->
       [
         {:ok, %{"uid" => nil, "status" => "failed"}}
@@ -171,7 +177,12 @@ defmodule Scrypath.Meilisearch.TasksTest do
 
     assert {:error,
             {:invalid_task_payload,
-             %{stage: :poll, task_uid: nil, problems: [uid: :missing_or_invalid], payload: payload}}} =
+             %{
+               stage: :poll,
+               task_uid: nil,
+               problems: [uid: :missing_or_invalid],
+               payload: payload
+             }}} =
              Tasks.wait_for_task(
                %{uid: 301, status: "enqueued"},
                meilisearch_client: SequencedClient,
@@ -262,7 +273,11 @@ defmodule Scrypath.Meilisearch.TasksTest do
     documents = [%Scrypath.Document{id: 1, data: %{title: "One"}, source: :fields}]
 
     assert {:ok,
-            %{index: "tenant_searchable_post", document_ids: [1], task: %{uid: 17, status: :enqueued}}} =
+            %{
+              index: "tenant_searchable_post",
+              document_ids: [1],
+              task: %{uid: 17, status: :enqueued}
+            }} =
              Scrypath.Meilisearch.upsert_documents(SearchablePost, documents,
                index_prefix: "tenant",
                meilisearch_client: RecordingClient
diff --git a/test/scrypath/meilisearch_test.exs b/test/scrypath/meilisearch_test.exs
@@ -102,7 +102,11 @@ defmodule Scrypath.MeilisearchTest do
     ]
 
     assert {:ok,
-            %{index: "tenant_searchable_post", document_ids: [1, 2], task: %{uid: 17, status: :enqueued}}} =
+            %{
+              index: "tenant_searchable_post",
+              document_ids: [1, 2],
+              task: %{uid: 17, status: :enqueued}
+            }} =
              Scrypath.Meilisearch.upsert_documents(SearchablePost, documents,
                index_prefix: "tenant",
                meilisearch_client: RecordingClient
@@ -114,7 +118,11 @@ defmodule Scrypath.MeilisearchTest do
 
   test "delete_documents/3 delegates canonical ids through the client" do
     assert {:ok,
-            %{index: "tenant_searchable_post", document_ids: ["post:1"], task: %{uid: 18, status: :enqueued}}} =
+            %{
+              index: "tenant_searchable_post",
+              document_ids: ["post:1"],
+              task: %{uid: 18, status: :enqueued}
+            }} =
              Scrypath.Meilisearch.delete_documents(SearchablePost, ["post:1"],
                index_prefix: "tenant",
                meilisearch_client: RecordingClient
@@ -361,7 +369,11 @@ defmodule Scrypath.MeilisearchTest do
 
   test "create_index/3 remains Meilisearch-native and honors target index overrides" do
     assert {:ok,
-            %{live_index: "tenant_searchable_post", target_index: "tenant_searchable_post_v2", task: %{uid: 19, status: :enqueued}}} =
+            %{
+              live_index: "tenant_searchable_post",
+              target_index: "tenant_searchable_post_v2",
+              task: %{uid: 19, status: :enqueued}
+            }} =
              Scrypath.Meilisearch.create_index(SearchablePost, "id",
                index_prefix: "tenant",
                target_index: "tenant_searchable_post_v2",
@@ -374,22 +386,32 @@ defmodule Scrypath.MeilisearchTest do
 
   test "swap_indexes/2 keeps cutover under Scrypath.Meilisearch and uses the explicit target index" do
     assert {:ok,
-            %{live_index: "tenant_searchable_post", target_index: "tenant_searchable_post_v2", task: %{uid: 21, status: :enqueued}}} =
+            %{
+              live_index: "tenant_searchable_post",
+              target_index: "tenant_searchable_post_v2",
+              task: %{uid: 21, status: :enqueued}
+            }} =
              Scrypath.Meilisearch.swap_indexes(SearchablePost,
                index_prefix: "tenant",
                target_index: "tenant_searchable_post_v2",
                meilisearch_client: RecordingClient
              )
 
-    assert_received {:client_swap_indexes, {"tenant_searchable_post", "tenant_searchable_post_v2"}, config}
+    assert_received {:client_swap_indexes,
+                     {"tenant_searchable_post", "tenant_searchable_post_v2"}, config}
+
     assert config[:target_index] == "tenant_searchable_post_v2"
   end
 
   test "backend upsert preserves schema-configured document id fields" do
     documents = [%Document{id: "post-9", data: %{title: "Hello"}, source: :fields}]
 
     assert {:ok,
-            %{index: "tenant_custom_id_post", document_ids: ["post-9"], task: %{uid: 17, status: :enqueued}}} =
+            %{
+              index: "tenant_custom_id_post",
+              document_ids: ["post-9"],
+              task: %{uid: 17, status: :enqueued}
+            }} =
              Scrypath.Meilisearch.upsert_documents(CustomIdPost, documents,
                index_prefix: "tenant",
                meilisearch_client: RecordingClient
diff --git a/test/scrypath/oban/enqueue_test.exs b/test/scrypath/oban/enqueue_test.exs
diff --git a/test/scrypath/operator/status_test.exs b/test/scrypath/operator/status_test.exs
diff --git a/test/scrypath/telemetry_test.exs b/test/scrypath/telemetry_test.exs
diff --git a/test/support/docs/phoenix_examples_test.exs b/test/support/docs/phoenix_examples_test.exs
diff --git a/test/support/meilisearch_integration.ex b/test/support/meilisearch_integration.ex

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "0.1.0"`
	`2`	`+ ".": "0.2.0"`
`3`	`3`	`}`