Merge pull request #79 from WTTJ/feat/add-conditional-deploy-to-replicas

feat: added "if" option to replica for conditional deployment

Author: Jordan-Kowal

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v0.8.3 - 2024-10-18
+
+New `if` option for replicas which decides if they should be updated or not.
+
+- **If not provided**, the replica will be updated (so no impact on existing configurations)
+- Must be `nil|true|false` or the name (atom) of a arity-0 func which returns a boolean
+- If provided, the replica will be updated only if the value is `true` or the function returns `true`
+
+Useful for Algolia's A/B testing which requires replicas and only deploy them in production.
+
 ## v0.8.2 - 2024-09-16
 
 - Upgrading all dependencies

CONTRIBUTING.md

@@ -25,6 +25,7 @@ Then run `mix test` to run the tests.
 ## CI/CD
 
 We use CircleCI to:
+
 - Run the code_analysis (format/credo)
 - Check for vulnerabilities
 - Run the tests

lib/algoliax/exceptions.ex

@@ -31,6 +31,19 @@ defmodule Algoliax.MissingIndexNameError do
   end
 end
 
+defmodule Algoliax.InvalidReplicaConfigurationError do
+  @moduledoc "Raise when a replica has an invalid configuration"
+
+  defexception [:message]
+
+  @impl true
+  def exception(%{index_name: index_name, error: error}) do
+    %__MODULE__{
+      message: "Invalid configuration for replica #{index_name}: #{error}"
+    }
+  end
+end
+
 defmodule Algoliax.AlgoliaApiError do
   @moduledoc "Raise Algolia API error"
 

lib/algoliax/resources/index.ex

@@ -24,27 +24,28 @@ defmodule Algoliax.Resources.Index do
   end
 
   def replicas_names(module, settings, replica_index) do
-    settings
-    |> replicas_settings()
+    module
+    |> replicas_settings(settings)
     |> Enum.map(fn replica_settings ->
       index_name(module, replica_settings)
       |> Enum.at(replica_index)
     end)
   end
 
-  def replicas_settings(settings) do
-    replicas = Keyword.get(settings, :replicas, [])
-
-    Enum.map(replicas, fn replica ->
+  def replicas_settings(module, settings) do
+    settings
+    |> Keyword.get(:replicas, [])
+    |> Enum.filter(fn replica -> should_be_updated?(module, replica) end)
+    |> Enum.map(fn replica ->
       case Keyword.get(replica, :inherit, true) do
         true ->
           replica_algolia_settings = algolia_settings(replica)
-          primary_algolia_setttings = algolia_settings(settings)
+          primary_algolia_settings = algolia_settings(settings)
 
           Keyword.put(
             replica,
             :algolia,
-            Keyword.merge(primary_algolia_setttings, replica_algolia_settings)
+            Keyword.merge(primary_algolia_settings, replica_algolia_settings)
           )
 
         false ->
@@ -53,6 +54,43 @@ defmodule Algoliax.Resources.Index do
     end)
   end
 
+  defp should_be_updated?(module, replica) do
+    index_name = Keyword.get(replica, :index_name, nil)
+
+    error_message =
+      "`if` must be `nil|true|false` or be the name of a 0-arity func which returns a boolean."
+
+    value = Keyword.get(replica, :if, nil)
+
+    cond do
+      # No config, defaults to true
+      is_nil(value) ->
+        true
+
+      # Boolean, use this value
+      value == true || value == false ->
+        value
+
+      # Name of a 0-arity func
+      is_atom(value) ->
+        if module.__info__(:functions) |> Keyword.get(value) == 0 do
+          apply(module, value, []) == true
+        else
+          raise Algoliax.InvalidReplicaConfigurationError, %{
+            index_name: index_name,
+            error: error_message
+          }
+        end
+
+      # Any other value, raise an error
+      true ->
+        raise Algoliax.InvalidReplicaConfigurationError, %{
+          index_name: index_name,
+          error: error_message
+        }
+    end
+  end
+
   def get_settings(module, settings) do
     index_name(module, settings)
     |> Enum.map(fn index_name ->
@@ -80,8 +118,8 @@ defmodule Algoliax.Resources.Index do
   end
 
   def configure_replicas(module, settings) do
-    settings
-    |> replicas_settings()
+    module
+    |> replicas_settings(settings)
     |> Enum.map(fn replica_settings ->
       configure_index(module, replica_settings)
     end)

mix.exs

@@ -2,7 +2,7 @@ defmodule Algoliax.MixProject do
   use Mix.Project
 
   @source_url "https://github.com/WTTJ/algoliax"
-  @version "0.8.2"
+  @version "0.8.3"
 
   def project do
     [

test/algoliax/replica_test.exs

@@ -3,6 +3,7 @@ defmodule AlgoliaxTest.ReplicaTest do
 
   alias Algoliax.Schemas.PeopleWithReplicas
   alias Algoliax.Schemas.PeopleWithReplicasMultipleIndexes
+  alias Algoliax.Schemas.PeopleWithInvalidReplicas
 
   setup do
     Algoliax.SettingsStore.set_settings(:algoliax_people_replicas, %{})
@@ -76,7 +77,11 @@ defmodule AlgoliaxTest.ReplicaTest do
         body: %{
           "searchableAttributes" => ["full_name"],
           "attributesForFaceting" => ["age"],
-          "replicas" => ["algoliax_people_replicas_asc_en", "algoliax_people_replicas_desc_en"]
+          "replicas" => [
+            "algoliax_people_replicas_asc_en",
+            "algoliax_people_replicas_desc_en",
+            "algoliax_people_replicas_not_skipped_en"
+          ]
         }
       })
 
@@ -85,7 +90,11 @@ defmodule AlgoliaxTest.ReplicaTest do
         body: %{
           "searchableAttributes" => ["full_name"],
           "attributesForFaceting" => ["age"],
-          "replicas" => ["algoliax_people_replicas_asc_fr", "algoliax_people_replicas_desc_fr"]
+          "replicas" => [
+            "algoliax_people_replicas_asc_fr",
+            "algoliax_people_replicas_desc_fr",
+            "algoliax_people_replicas_not_skipped_fr"
+          ]
         }
       })
 
@@ -124,6 +133,24 @@ defmodule AlgoliaxTest.ReplicaTest do
           "ranking" => ["desc(age)"]
         }
       })
+
+      assert_request("PUT", %{
+        path: ~r/algoliax_people_replicas_not_skipped_en/,
+        body: %{
+          "searchableAttributes" => ["age"],
+          "attributesForFaceting" => ["age"],
+          "ranking" => ["asc(age)"]
+        }
+      })
+
+      assert_request("PUT", %{
+        path: ~r/algoliax_people_replicas_not_skipped_fr/,
+        body: %{
+          "searchableAttributes" => ["age"],
+          "attributesForFaceting" => ["age"],
+          "ranking" => ["asc(age)"]
+        }
+      })
     end
 
     test "save_object/1" do
@@ -524,5 +551,15 @@ defmodule AlgoliaxTest.ReplicaTest do
         body: %{"facetQuery" => "2"}
       })
     end
+
+    test "should raise error on invalid replica config" do
+      assert_raise(
+        Algoliax.InvalidReplicaConfigurationError,
+        "Invalid configuration for replica algoliax_people_replicas_asc: `if` must be `nil|true|false` or be the name of a 0-arity func which returns a boolean.",
+        fn ->
+          PeopleWithInvalidReplicas.configure_index()
+        end
+      )
+    end
   end
 end

test/support/schemas/people_with_invalid_replicas.ex

@@ -0,0 +1,36 @@
+defmodule Algoliax.Schemas.PeopleWithInvalidReplicas do
+  @moduledoc false
+
+  use Algoliax.Indexer,
+    index_name: :algoliax_people_replicas,
+    object_id: :reference,
+    algolia: [
+      attributes_for_faceting: ["age"],
+      searchable_attributes: ["full_name"],
+      custom_ranking: ["desc(update_at)"]
+    ],
+    replicas: [
+      [
+        index_name: :algoliax_people_replicas_asc,
+        inherit: true,
+        algolia: [
+          searchable_attributes: ["age"],
+          ranking: ["asc(age)"]
+        ],
+        if: :ok
+      ]
+    ]
+
+  defstruct reference: nil, last_name: nil, first_name: nil, age: nil
+
+  def build_object(people) do
+    %{
+      first_name: people.first_name,
+      last_name: people.last_name,
+      age: people.age,
+      updated_at: ~U[2019-01-01 00:00:00Z] |> DateTime.to_unix(),
+      full_name: Map.get(people, :first_name, "") <> " " <> Map.get(people, :last_name, ""),
+      nickname: Map.get(people, :first_name, "") |> String.downcase()
+    }
+  end
+end

test/support/schemas/people_with_replicas_multiple_indexes.ex

@@ -21,7 +21,41 @@ defmodule Algoliax.Schemas.PeopleWithReplicasMultipleIndexes do
       [
         index_name: [:algoliax_people_replicas_desc_en, :algoliax_people_replicas_desc_fr],
         inherit: false,
-        algolia: [ranking: ["desc(age)"]]
+        algolia: [ranking: ["desc(age)"]],
+        if: true
+      ],
+      [
+        index_name: [:algoliax_people_replicas_skipped_en, :algoliax_people_replicas_skipped_fr],
+        inherit: true,
+        algolia: [
+          searchable_attributes: ["age"],
+          ranking: ["asc(age)"]
+        ],
+        if: :do_not_deploy
+      ],
+      [
+        index_name: [
+          :algoliax_people_replicas_skipped_too_en,
+          :algoliax_people_replicas_skipped_too_fr
+        ],
+        inherit: true,
+        algolia: [
+          searchable_attributes: ["age"],
+          ranking: ["asc(age)"]
+        ],
+        if: false
+      ],
+      [
+        index_name: [
+          :algoliax_people_replicas_not_skipped_en,
+          :algoliax_people_replicas_not_skipped_fr
+        ],
+        inherit: true,
+        algolia: [
+          searchable_attributes: ["age"],
+          ranking: ["asc(age)"]
+        ],
+        if: :do_deploy
       ]
     ]
 
@@ -37,4 +71,7 @@ defmodule Algoliax.Schemas.PeopleWithReplicasMultipleIndexes do
       nickname: Map.get(people, :first_name, "") |> String.downcase()
     }
   end
+
+  def do_not_deploy, do: false
+  def do_deploy, do: true
 end