add metric registry change suggestions (#4460)

* Start implementing Metric Registry Change Suggestions

* Abstract some components in registry change suggestions liveview

* Metric Registry Change Suggestions liveview working

* Change type of metric registry submitter form

* Wire Metric Registry Change Undo. Fix filters on index page

* Dirty hack for metric registry event handling. Improve sorting of suggestions

* Do not call MailJet functions outside tests where mailjet is tested

* Fix typo in html id

Co-authored-by: Tsvetozar Penov <tsvetozar.penov@gmail.com>

---------

Co-authored-by: Tsvetozar Penov <tsvetozar.penov@gmail.com>

config/dev.exs

@@ -6,6 +6,7 @@ import Config
 # The watchers configuration can be used to run external
 # watchers to your application. For example, we use it
 # with brunch.io to recompile .js and .css sources.
+config :phoenix_live_view, debug_heex_annotations: true
 config :sanbase, Sanbase, url: {:system, "SANBASE_URL", "https://app-stage.santiment.net"}
 
 config :sanbase, SanbaseWeb.Endpoint,

config/test.exs

@@ -51,6 +51,10 @@ config :sanbase, Sanbase.EventBus.KafkaExporterSubscriber,
   can_send_after_interval: 0,
   kafka_flush_timeout: 0
 
+config :sanbase, Sanbase.EventBus.MetricRegistrySubscriber,
+  metric_registry_change_handler:
+    {Sanbase.EventBus.MetricRegistrySubscriber, :on_metric_registry_change_test_env}
+
 config :sanbase, Sanbase.ExternalServices.RateLimiting.Server,
   implementation_module: Sanbase.ExternalServices.RateLimiting.TestServer
 

lib/sanbase/billing/plan/standard_access_checker/standard_access_checker.ex

@@ -195,15 +195,18 @@ defmodule Sanbase.Billing.Plan.StandardAccessChecker do
   def refresh_stored_terms() do
     Logger.info("Refreshing stored terms in the #{__MODULE__}")
 
-    for {fun, args} <- @functions do
-      data = compute(fun, args)
+    result =
+      for {fun, args} <- @functions do
+        data = compute(fun, args)
 
-      if :not_implemented == data,
-        do: raise("Function #{fun} is not implemented in module #{__MODULE__}")
+        if :not_implemented == data,
+          do: raise("Function #{fun} is not implemented in module #{__MODULE__}")
 
-      :ok = :persistent_term.put(key(fun, args), data)
-      {{fun, args}, :ok}
-    end
+        result = :persistent_term.put(key(fun, args), data)
+        {{fun, args}, result}
+      end
+
+    Enum.all?(result, &match?({_, :ok}, &1))
   end
 
   # Private functions

lib/sanbase/clickhouse/metric/registry/registry.ex

@@ -103,15 +103,18 @@ defmodule Sanbase.Clickhouse.MetricAdapter.Registry do
     Sanbase.Cache.clear(registry_cache_key(remove_hard_deprecated: true))
     Sanbase.Cache.clear(registry_cache_key(remove_hard_deprecated: false))
 
-    for {fun, args} <- @functions do
-      data = compute(fun, args)
+    result =
+      for {fun, args} <- @functions do
+        data = compute(fun, args)
 
-      if :not_implemented == data,
-        do: raise("Function #{fun} is not implemented in module #{__MODULE__}")
+        if :not_implemented == data,
+          do: raise("Function #{fun} is not implemented in module #{__MODULE__}")
 
-      :ok = :persistent_term.put(key(fun, args), data)
-      {{fun, args}, :ok}
-    end
+        result = :persistent_term.put(key(fun, args), data)
+        {{fun, args}, result}
+      end
+
+    Enum.all?(result, &match?({_, :ok}, &1))
   end
 
   # Private functions

lib/sanbase/event_bus/metric_registry_subscriber.ex

@@ -4,6 +4,8 @@ defmodule Sanbase.EventBus.MetricRegistrySubscriber do
   """
   use GenServer
 
+  alias Sanbase.Utils.Config
+
   require Logger
 
   def topics(), do: ["metric_registry_events"]
@@ -41,8 +43,24 @@ defmodule Sanbase.EventBus.MetricRegistrySubscriber do
     {:noreply, state}
   end
 
+  def on_metric_registry_change(_event_type, _metric) do
+    # Do not change the order here
+    true = Sanbase.Clickhouse.MetricAdapter.Registry.refresh_stored_terms()
+    true = Sanbase.Metric.Helper.refresh_stored_terms()
+    true = Sanbase.Billing.Plan.StandardAccessChecker.refresh_stored_terms()
+
+    :ok
+  end
+
+  def on_metric_registry_change_test_env(event_type, metric) do
+    # In test env this is the handler in order to avoid Ecto DBConnection
+    # ownership errors
+    Logger.warning("Metric Registry Change - Event Type: #{event_type}, Metric: #{metric}")
+    :ok
+  end
+
   defp handle_event(
-         %{data: %{event_type: event_type}} = event,
+         %{data: %{event_type: event_type, metric: metric}} = event,
          event_shadow,
          state
        )
@@ -52,10 +70,15 @@ defmodule Sanbase.EventBus.MetricRegistrySubscriber do
               :delete_metric_registry
             ] do
     Logger.info("Start refreshing stored terms from #{__MODULE__}")
-    # Do not change the order here
-    Sanbase.Clickhouse.MetricAdapter.Registry.refresh_stored_terms()
-    Sanbase.Metric.Helper.refresh_stored_terms()
-    Sanbase.Billing.Plan.StandardAccessChecker.refresh_stored_terms()
+
+    {mod, fun} =
+      Config.module_get(
+        __MODULE__,
+        :metric_registry_change_handler,
+        {__MODULE__, :on_metric_registry_change}
+      )
+
+    :ok = apply(mod, fun, [event_type, metric])
 
     Task.Supervisor.async_nolink(Sanbase.TaskSupervisor, fn ->
       Sanbase.Notifications.Handler.handle_metric_registry_event(event)

lib/sanbase/event_bus/user_events_subscriber.ex

@@ -54,6 +54,7 @@ defmodule Sanbase.EventBus.UserEventsSubscriber do
        ) do
     email = Sanbase.Accounts.get_user!(user_id).email
     if email, do: Sanbase.Email.MailjetApi.client().subscribe(:monthly_newsletter, email)
+
     EventBus.mark_as_completed({__MODULE__, event_shadow})
     state
   end
@@ -64,7 +65,8 @@ defmodule Sanbase.EventBus.UserEventsSubscriber do
          state
        ) do
     email = Sanbase.Accounts.get_user!(user_id).email
-    Sanbase.Email.MailjetApi.client().unsubscribe(:monthly_newsletter, email)
+    if email, do: Sanbase.Email.MailjetApi.client().unsubscribe(:monthly_newsletter, email)
+
     EventBus.mark_as_completed({__MODULE__, event_shadow})
     state
   end
@@ -95,8 +97,7 @@ defmodule Sanbase.EventBus.UserEventsSubscriber do
          state
        ) do
     email = Sanbase.Accounts.get_user!(user_id).email
-
-    Sanbase.Email.MailjetApi.client().subscribe(:metric_updates, email)
+    if email, do: Sanbase.Email.MailjetApi.client().subscribe(:metric_updates, email)
     EventBus.mark_as_completed({__MODULE__, event_shadow})
     state
   end
@@ -107,7 +108,8 @@ defmodule Sanbase.EventBus.UserEventsSubscriber do
          state
        ) do
     email = Sanbase.Accounts.get_user!(user_id).email
-    Sanbase.Email.MailjetApi.client().unsubscribe(:metric_updates, email)
+    if email, do: Sanbase.Email.MailjetApi.client().unsubscribe(:metric_updates, email)
+
     EventBus.mark_as_completed({__MODULE__, event_shadow})
     state
   end

lib/sanbase/ex_audit/patch.ex

@@ -0,0 +1,35 @@
+defmodule Sanbase.ExAudit.Patch do
+  def format_patch(%{patch: patch}) when is_map(patch) do
+    changes =
+      patch
+      |> Enum.map(fn {field, change} ->
+        safe_field = Phoenix.HTML.html_escape(to_string(field))
+        safe_change = Phoenix.HTML.html_escape(format_change_value(change))
+
+        content = PhoenixHTMLHelpers.Tag.content_tag(:strong, safe_field)
+        PhoenixHTMLHelpers.Tag.content_tag(:li, [content, ": ", safe_change])
+      end)
+
+    PhoenixHTMLHelpers.Tag.content_tag(:ul, changes, class: "list-disc list-inside")
+  end
+
+  def format_patch(_), do: Phoenix.HTML.raw("")
+
+  defp format_change_value({:changed, {:primitive_change, old_val, new_val}}) do
+    old = inspect(old_val)
+    new = inspect(new_val)
+    "#{old} → #{new}"
+  end
+
+  defp format_change_value({:changed, nested}) when is_map(nested) do
+    nested_changes =
+      nested
+      |> Enum.map_join(", ", fn {k, v} ->
+        "#{to_string(k)}: #{format_change_value(v)}"
+      end)
+
+    "{#{nested_changes}}"
+  end
+
+  defp format_change_value(other), do: inspect(other)
+end

lib/sanbase/metric/helper.ex

@@ -93,15 +93,18 @@ defmodule Sanbase.Metric.Helper do
   def refresh_stored_terms() do
     Logger.info("Refreshing stored terms in the #{__MODULE__}")
 
-    for {fun, args} <- @functions do
-      data = compute(fun, args)
+    result =
+      for {fun, args} <- @functions do
+        data = compute(fun, args)
 
-      if :not_implemented == data,
-        do: raise("Function #{fun} is not implemented in module #{__MODULE__}")
+        if :not_implemented == data,
+          do: raise("Function #{fun} is not implemented in module #{__MODULE__}")
 
-      :ok = :persistent_term.put(key(fun, args), data)
-      {{fun, args}, :ok}
-    end
+        result = :persistent_term.put(key(fun, args), data)
+        {{fun, args}, result}
+      end
+
+    Enum.all?(result, &match?({_, :ok}, &1))
   end
 
   # Private functions