Remove unused storage callbacks

Author: magnetised

packages/sync-service/lib/electric/shape_cache/crashing_file_storage.ex

@@ -10,8 +10,6 @@ defmodule Electric.ShapeCache.CrashingFileStorage do
   defdelegate for_shape(shape_handle, opts), to: PureFileStorage
   defdelegate start_link(opts), to: PureFileStorage
   defdelegate get_all_stored_shape_handles(opts), to: PureFileStorage
-  defdelegate get_stored_shapes(opts, shape_handles), to: PureFileStorage
-  defdelegate metadata_backup_dir(opts), to: PureFileStorage
   defdelegate get_total_disk_usage(opts), to: PureFileStorage
   defdelegate fetch_latest_offset(opts), to: PureFileStorage
   defdelegate fetch_pg_snapshot(opts), to: PureFileStorage

packages/sync-service/lib/electric/shape_cache/in_memory_storage.ex

@@ -130,12 +130,6 @@ defmodule Electric.ShapeCache.InMemoryStorage do
   @impl Electric.ShapeCache.Storage
   def get_all_stored_shape_handles(_opts), do: {:ok, MapSet.new()}
 
-  @impl Electric.ShapeCache.Storage
-  def get_stored_shapes(_opts, _shape_handles), do: %{}
-
-  @impl Electric.ShapeCache.Storage
-  def metadata_backup_dir(_opts), do: nil
-
   @impl Electric.ShapeCache.Storage
   def get_total_disk_usage(_opts), do: 0
 

packages/sync-service/lib/electric/shape_cache/pure_file_storage.ex

@@ -38,7 +38,6 @@ defmodule Electric.ShapeCache.PureFileStorage do
   alias Electric.ShapeCache.PureFileStorage.Snapshot
   alias Electric.ShapeCache.PureFileStorage.WriteLoop
   alias Electric.ShapeCache.Storage
-  alias Electric.Shapes.Shape
 
   import LogOffset
   import Electric.ShapeCache.PureFileStorage.SharedRecords
@@ -94,9 +93,6 @@ defmodule Electric.ShapeCache.PureFileStorage do
 
   @clean_cache_keys storage_meta_keys() -- @read_path_keys
 
-  # Directory for storing metadata
-  @metadata_storage_dir ".meta"
-
   def shared_opts(opts) do
     stack_id = Keyword.fetch!(opts, :stack_id)
     storage_dir = Keyword.get(opts, :storage_dir, "./shapes")
@@ -207,37 +203,6 @@ defmodule Electric.ShapeCache.PureFileStorage do
     end
   end
 
-  def get_stored_shapes(stack_opts, shape_handles) do
-    Task.Supervisor.async_stream(
-      stack_task_supervisor(stack_opts.stack_id),
-      shape_handles,
-      fn handle ->
-        shape_opts = for_shape(handle, stack_opts)
-
-        case read_shape_definition(shape_opts) do
-          {:ok, shape} ->
-            {handle, {:ok, shape}}
-
-          _ ->
-            Logger.warning(
-              "Failed to read shape definition for shape #{handle}, removing it from disk"
-            )
-
-            cleanup!(shape_opts)
-            {handle, {:error, :failed_to_recover_shape}}
-        end
-      end,
-      timeout: :infinity,
-      ordered: false
-    )
-    |> Enum.map(fn {:ok, res} -> res end)
-    |> Map.new()
-  end
-
-  def metadata_backup_dir(%{base_path: base_path}) do
-    Path.join([base_path, @metadata_storage_dir, "backups"])
-  end
-
   def drop_all_ets_entries(stack_id) do
     try do
       :ets.delete_all_objects(stack_ets(stack_id))
@@ -525,7 +490,7 @@ defmodule Electric.ShapeCache.PureFileStorage do
   def init_writer!(shape_opts, shape_definition) do
     table = :ets.new(:in_memory_storage, [:ordered_set, :protected])
 
-    {initial_acc, suffix} = initialise_filesystem!(shape_opts, shape_definition)
+    {initial_acc, suffix} = initialise_filesystem!(shape_opts)
 
     register_with_stack(
       shape_opts,
@@ -571,7 +536,7 @@ defmodule Electric.ShapeCache.PureFileStorage do
     writer_state(state, writer_acc: WriteLoop.flush_and_close_all(acc, state))
   end
 
-  defp initialise_filesystem!(%__MODULE__{} = opts, shape_definition) do
+  def initialise_filesystem!(%__MODULE__{} = opts) do
     on_disk_version = read_metadata!(opts, :version)
     new? = is_nil(on_disk_version)
 
@@ -587,7 +552,6 @@ defmodule Electric.ShapeCache.PureFileStorage do
 
     if initialize? do
       create_directories!(opts)
-      write_shape_definition!(opts, shape_definition)
     end
 
     suffix =
@@ -749,24 +713,6 @@ defmodule Electric.ShapeCache.PureFileStorage do
     :ets.update_element(stack_ets, handle, updates)
   end
 
-  defp write_shape_definition!(%__MODULE__{} = opts, shape_definition) do
-    write!(
-      shape_metadata_path(opts, "shape_definition.json"),
-      Jason.encode!(shape_definition),
-      [:raw]
-    )
-  end
-
-  defp read_shape_definition(%__MODULE__{} = opts) do
-    path = shape_metadata_path(opts, "shape_definition.json")
-
-    with {:ok, contents} <- File.open(path, [:read, :raw, :read_ahead], &IO.binread(&1, :eof)),
-         {:ok, decoded} <- Jason.decode(if(is_binary(contents), do: contents, else: "")),
-         {:ok, rebuilt} <- Shape.from_json_safe(decoded) do
-      {:ok, rebuilt}
-    end
-  end
-
   defp last_snapshot_chunk(%__MODULE__{} = opts),
     do: read_cached_metadata(opts, :last_snapshot_chunk)
 

packages/sync-service/lib/electric/shape_cache/storage.ex

@@ -53,13 +53,6 @@ defmodule Electric.ShapeCache.Storage do
   @callback get_all_stored_shape_handles(compiled_opts()) ::
               {:ok, MapSet.t(shape_handle())} | {:error, term()}
 
-  @doc "Retrieve stored shapes for given shape handles"
-  @callback get_stored_shapes(compiled_opts(), Enumerable.t(shape_handle())) ::
-              %{shape_handle() => {:ok, shape_def :: Shape.t()} | {:error, term()}}
-
-  @doc "Get the directory where metadata backups are stored."
-  @callback metadata_backup_dir(compiled_opts()) :: String.t() | nil
-
   @doc "Get the total disk usage for all shapes"
   @callback get_total_disk_usage(compiled_opts()) :: non_neg_integer()
 
@@ -260,16 +253,6 @@ defmodule Electric.ShapeCache.Storage do
     mod.get_all_stored_shape_handles(opts)
   end
 
-  @impl __MODULE__
-  def get_stored_shapes({mod, opts}, shape_handles) do
-    mod.get_stored_shapes(opts, shape_handles)
-  end
-
-  @impl __MODULE__
-  def metadata_backup_dir({mod, opts}) do
-    mod.metadata_backup_dir(opts)
-  end
-
   @impl __MODULE__
   def get_total_disk_usage({mod, opts}) do
     mod.get_total_disk_usage(opts)

packages/sync-service/test/electric/shape_cache/storage_implementations_test.exs

@@ -1187,46 +1187,6 @@ defmodule Electric.ShapeCache.StorageImplimentationsTest do
       end
     end
 
-    describe "#{module_name}.get_stored_shapes/1" do
-      @describetag skip_initialise: true
-      setup :start_storage
-
-      test "retrieves no shapes if no shapes persisted", %{storage_base: storage_base} do
-        assert %{} = Storage.get_stored_shapes(storage_base, [])
-      end
-
-      test "retrieves stored shapes", %{storage: opts, storage_base: storage_base} do
-        _writer = Storage.init_writer!(opts, @shape)
-        invalid_handle = "invalid-handle"
-
-        assert %{@shape_handle => {:ok, parsed}, ^invalid_handle => {:error, _}} =
-                 Storage.get_stored_shapes(storage_base, [@shape_handle, invalid_handle])
-
-        assert @shape == parsed
-      end
-
-      test "restores shape snapshot started flag", %{storage: opts, storage_base: storage_base} do
-        _writer = Storage.init_writer!(opts, @shape)
-        :ok = Storage.mark_snapshot_as_started(opts)
-
-        assert %{@shape_handle => {:ok, parsed}} =
-                 Storage.get_stored_shapes(storage_base, [@shape_handle])
-
-        assert @shape == parsed
-      end
-    end
-
-    describe "#{module_name}.metadata_backup_dir/1" do
-      @describetag skip_initialise: true
-      setup :start_storage
-
-      test "returns metadata backup directory", %{storage_base: storage_base} do
-        assert dir = Storage.metadata_backup_dir(storage_base)
-        assert is_binary(dir)
-        assert Path.type(dir) == :absolute
-      end
-    end
-
     describe "#{module_name}.cleanup!/1" do
       setup :start_storage
 
@@ -1299,7 +1259,6 @@ defmodule Electric.ShapeCache.StorageImplimentationsTest do
 
         Storage.cleanup_all!(storage_base)
         assert Storage.get_total_disk_usage(storage_base) == 0
-        refute File.dir?(Storage.metadata_backup_dir(storage_base))
       end
 
       test "should handle entire base directory already missing", %{storage_base: storage_base} do

packages/sync-service/test/support/test_storage.ex

@@ -77,18 +77,6 @@ defmodule Support.TestStorage do
     Storage.get_all_stored_shape_handles(storage)
   end
 
-  @impl Electric.ShapeCache.Storage
-  def get_stored_shapes({parent, _init, storage}, shape_handles) do
-    send(parent, {__MODULE__, :get_stored_shapes, shape_handles})
-    Storage.get_stored_shapes(storage, shape_handles)
-  end
-
-  @impl Electric.ShapeCache.Storage
-  def metadata_backup_dir({parent, _init, storage}) do
-    send(parent, {__MODULE__, :metadata_backup_dir})
-    Storage.metadata_backup_dir(storage)
-  end
-
   @impl Electric.ShapeCache.Storage
   def get_total_disk_usage({parent, _init, storage}) do
     send(parent, {__MODULE__, :get_total_disk_usage})