Fix the target type for the Nebulex.Event.CacheEntryEvent

Author: cabol

lib/nebulex/event/cache_entry_event.ex

@@ -25,12 +25,18 @@ defmodule Nebulex.Event.CacheEntryEvent do
   @typedoc """
   Type for the event target.
 
-  The event target can be a key or a query (for `delete_all` command).
-  If the target is a key, it will come in the shape of `{:key, deleted_key}`
-  tuple. On the other hand, if the target is a query, it will come in the shape
-  of a `{:query, {:in, deleted_keys}}` tuple, or a `{:query, {:q, query}}` tuple.
+  The event can target a single key, a list of keys, or a query.
+
+    * A single key: `{:key, key}`. A command writing or deleting a single key
+      will use this target. E.g., `put`, `put_new`, `replace`, `delete`, etc.
+    * A list of keys: `{:in, [key1, key2, ...]}`. A command writing or deleting
+      multiple keys will use this target. E.g., `put_all`, `put_new_all`, and
+      `delete_all`.
+    * A query: `{:q, query}`. A command deleting entries matching a query will
+      use this target. E.g., `delete_all`.
+
   """
-  @type target() :: {:key, any()} | {:query, {:in, [keys :: any()]} | {:q, query :: any()}}
+  @type target() :: {:key, key :: any()} | {:in, [key :: any()]} | {:q, query :: any()}
 
   @typedoc """
   Type for a cache entry event.

lib/nebulex/telemetry/cache_entry_handler.ex

@@ -106,7 +106,7 @@ defmodule Nebulex.Telemetry.CacheEntryHandler do
 
   defp do_handle(:put_all, [entries, :put_new | _], {:ok, true}, event_attrs, config) do
     [
-      target: {:keys, Enum.map(entries, &elem(&1, 0))},
+      target: {:in, Enum.map(entries, &elem(&1, 0))},
       command: :put_new_all
     ]
     |> Kernel.++(event_attrs)
@@ -116,7 +116,7 @@ defmodule Nebulex.Telemetry.CacheEntryHandler do
 
   defp do_handle(:put_all, [entries | _], {:ok, true}, event_attrs, config) do
     [
-      target: {:keys, Enum.map(entries, &elem(&1, 0))},
+      target: {:in, Enum.map(entries, &elem(&1, 0))},
       command: :put_all
     ]
     |> Kernel.++(event_attrs)
@@ -184,7 +184,7 @@ defmodule Nebulex.Telemetry.CacheEntryHandler do
        )
        when count > 0 do
     [
-      target: {:query, query},
+      target: query,
       command: :delete_all
     ]
     |> Kernel.++(event_attrs)

test/shared/cache/observable_test.exs

@@ -60,7 +60,7 @@ defmodule Nebulex.Cache.ObservableTest do
         assert_receive ^deleted
 
         entries = [foo: :bar, bar: :foo]
-        inserted_all = %{event | target: {:keys, Keyword.keys(entries)}, command: :put_all}
+        inserted_all = %{event | target: {:in, Keyword.keys(entries)}, command: :put_all}
 
         assert cache.put_all(entries) == :ok
         assert_receive ^inserted_all
@@ -74,7 +74,7 @@ defmodule Nebulex.Cache.ObservableTest do
 
         inserted_new_all = %{
           inserted_all
-          | target: {:keys, Keyword.keys(entries)},
+          | target: {:in, Keyword.keys(entries)},
             command: :put_new_all
         }
 
@@ -84,7 +84,7 @@ defmodule Nebulex.Cache.ObservableTest do
         deleted_all = %{
           event
           | type: :deleted,
-            target: {:query, {:in, [:foo, :bar]}},
+            target: {:in, [:foo, :bar]},
             command: :delete_all
         }
 
@@ -187,7 +187,7 @@ defmodule Nebulex.Cache.ObservableTest do
         deleted_all = %{
           event
           | type: :deleted,
-            target: {:query, {:q, nil}},
+            target: {:q, nil},
             command: :delete_all
         }