test: fix failing misc tests and improve coverage (wraft#171)

Author: Sad-lie

config/config.exs

@@ -16,7 +16,7 @@ config :wraft_doc, WraftDocWeb.Endpoint,
   pubsub_server: WraftDoc.PubSub,
   live_view: [signing_salt: "2B8BVDxqHCMKIa5cHoQ2lM0Ne7gUxvkb"]
 
-config :wraft_doc, :deployement, is_self_hosted: System.get_env("SELF_HOSTED", "true") == "true"
+config :wraft_doc, :deployment, is_self_hosted: System.get_env("SELF_HOSTED", "true") == "true"
 
 # Configure esbuild (the version is required)
 config :esbuild,

config/runtime.exs

@@ -12,6 +12,13 @@ if System.get_env("PHX_SERVER") && System.get_env("RELEASE_NAME") do
   config :wraft_doc, WraftDocWeb.Endpoint, server: true
 end
 
+# Ensure Sandbox pool is set for tests
+if config_env() == :test do
+  config :wraft_doc, WraftDoc.Repo,
+    pool: Ecto.Adapters.SQL.Sandbox,
+    ownership_timeout: 60_000
+end
+
 if config_env() == :prod do
   database_url =
     System.get_env("DATABASE_URL") ||
@@ -179,10 +186,12 @@ end
 config :wraft_doc, sender_email: "no-reply@#{System.get_env("WRAFT_HOSTNAME")}"
 
 # Configure Resend mail
-if api_key = System.get_env("RESEND_API_KEY") do
-  config :wraft_doc, WraftDocWeb.Mailer,
-    adapter: Resend.Swoosh.Adapter,
-    api_key: api_key
+if config_env() != :test do
+  if api_key = System.get_env("RESEND_API_KEY") do
+    config :wraft_doc, WraftDocWeb.Mailer,
+      adapter: Resend.Swoosh.Adapter,
+      api_key: api_key
+  end
 end
 
 # Configure SMTP

config/test.exs

@@ -8,22 +8,17 @@ config :wraft_doc, WraftDocWeb.Endpoint,
   secret_key_base: Map.fetch!(System.get_env(), "SECRET_KEY_BASE")
 
 # Print only warnings and errors during test
-config :logger, level: :warn
+config :logger, level: :warning
 
-# Configure your database
-config :wraft_doc, WraftDoc.Repo,
-  adapter: Ecto.Adapters.Postgres,
-  username: System.get_env("POSTGRES_USER") || "postgres",
-  password: System.get_env("POSTGRES_PASSWORD") || "postgres",
-  database: System.get_env("POSTGRES_DB") || "wraft_doc_test",
-  hostname: System.get_env("POSTGRES_HOST") || "localhost",
-  pool: Ecto.Adapters.SQL.Sandbox,
-  pool_size: 10
-
-config :wraft_doc, Oban, queues: false, plugins: false
+config :wraft_doc, Oban,
+  queues: false,
+  plugins: false,
+  testing: :disabled
 
 config :wraft_doc, WraftDocWeb.Mailer, adapter: Swoosh.Adapters.Test
 
+config :wraft_doc, WraftDoc.TypesenseServer, start: false
+
 config :wraft_doc, permissions_file: "test/mix/tasks/csv/test_permissions.csv"
 
 config :wraft_doc, :test_module, minio: ExAwsMock, razorpay: WraftDoc.Client.RazorpayMock
@@ -32,5 +27,7 @@ config :tesla, adapter: Tesla.Mock
 
 config :waffle, storage: Waffle.Storage.Local
 
+# Set is_self_hosted to false in test environment to enable payment routes
+config :wraft_doc, :deployment, is_self_hosted: false
+
 # Initialize plugs at runtime for faster test compilation
-config :phoenix, :plug_init_mode, :runtime

lib/wraft_doc/api_keys/api_key.ex

@@ -147,8 +147,10 @@ defmodule WraftDoc.ApiKeys.ApiKey do
   end
 
   defp generate_random_string(length) do
-    encoded = Base.url_encode64(:crypto.strong_rand_bytes(length), padding: false)
-    binary_part(encoded, 0, length)
+    length
+    |> :crypto.strong_rand_bytes()
+    |> Base.url_encode64(padding: false)
+    |> binary_part(0, length)
   end
 
   @doc """

lib/wraft_doc/documents/documents.ex

@@ -142,9 +142,6 @@ defmodule WraftDoc.Documents do
     end
   end
 
-  # @spec create_instance(ContentType.t(), State.t(), map) ::
-  #         %Instance{content_type: ContentType.t(), state: State.t()}
-  #         | {:error, Ecto.Changeset.t()}
   def create_instance(
         %{id: c_id, prefix: prefix, type: type, organisation_id: organisation_id} = c_type,
         _state,

priv/repo/data/minio/utils.ex lib/wraft_doc/minio/utils.expriv/repo/data/minio/utils.ex renamed to lib/wraft_doc/minio/utils.ex

@@ -12,7 +12,13 @@ defmodule WraftDoc.Minio.Utils do
   alias WraftDoc.Layouts.Layout
   alias WraftDoc.Repo
 
-  @ex_aws_module Application.compile_env(:wraft_doc, [:test_module, :minio], ExAws)
+  defp ex_aws_module do
+    if Mix.env() == :test do
+      Application.get_env(:wraft_doc, [:test_module, :minio], ExAws)
+    else
+      ExAws
+    end
+  end
 
   defmodule DownloadError do
     defexception message: "MinIO download error. File not found."
@@ -72,7 +78,7 @@ defmodule WraftDoc.Minio.Utils do
       source_path
       |> S3.Upload.stream_file()
       |> S3.upload(bucket, target_path)
-      |> @ex_aws_module.request()
+      |> ex_aws_module().request()
     end
   end
 
@@ -118,7 +124,7 @@ defmodule WraftDoc.Minio.Utils do
          [binary] <-
            bucket
            |> S3.download_file(file_path, :memory)
-           |> @ex_aws_module.stream!()
+           |> ex_aws_module().stream!()
            |> Enum.to_list() do
       binary
     else
@@ -132,7 +138,7 @@ defmodule WraftDoc.Minio.Utils do
   def list_files(bucket, prefix) do
     bucket
     |> S3.list_objects(prefix: prefix)
-    |> @ex_aws_module.stream!()
+    |> ex_aws_module().stream!()
     |> Stream.map(& &1.key)
     |> Enum.sort(:desc)
   end
@@ -141,7 +147,7 @@ defmodule WraftDoc.Minio.Utils do
   def create_bucket(bucket) do
     bucket
     |> S3.put_bucket("")
-    |> @ex_aws_module.request()
+    |> ex_aws_module().request()
   end
 
   # Copy files from source bucket to target bucket
@@ -152,7 +158,7 @@ defmodule WraftDoc.Minio.Utils do
     else
       target_bucket
       |> S3.put_object_copy(target_path, source_bucket, source_path)
-      |> @ex_aws_module.request()
+      |> ex_aws_module().request()
       |> case do
         {:ok, %{status_code: 200}} -> true
         {:error, _reason} -> false
@@ -169,7 +175,7 @@ defmodule WraftDoc.Minio.Utils do
   def file_exists?(bucket, file_path) do
     bucket
     |> S3.head_object(file_path)
-    |> @ex_aws_module.request()
+    |> ex_aws_module().request()
     |> case do
       {:ok, _} -> true
       {:error, _} -> false
@@ -180,7 +186,7 @@ defmodule WraftDoc.Minio.Utils do
   def bucket_exists?(bucket) do
     bucket
     |> S3.head_bucket()
-    |> @ex_aws_module.request()
+    |> ex_aws_module().request()
     |> case do
       {:ok, _} -> true
       {:error, _} -> false
@@ -191,7 +197,7 @@ defmodule WraftDoc.Minio.Utils do
   def list_all_objects(bucket) do
     bucket
     |> S3.list_objects()
-    |> @ex_aws_module.stream!()
+    |> ex_aws_module().stream!()
     |> Enum.map(& &1.key)
   end
 
@@ -202,15 +208,15 @@ defmodule WraftDoc.Minio.Utils do
     |> Enum.each(fn chunk ->
       bucket
       |> S3.delete_multiple_objects(chunk)
-      |> @ex_aws_module.request!()
+      |> ex_aws_module().request!()
     end)
   end
 
   # Delete a bucket
   def delete_bucket(bucket) do
     bucket
     |> S3.delete_bucket()
-    |> @ex_aws_module.request!()
+    |> ex_aws_module().request!()
   end
 
   # Delete a file
@@ -225,13 +231,13 @@ defmodule WraftDoc.Minio.Utils do
   defp delete_object(bucket, file_path) do
     bucket
     |> S3.delete_object(file_path)
-    |> @ex_aws_module.request()
+    |> ex_aws_module().request()
   end
 
   defp list_objects(bucket, file_path) do
     bucket
     |> S3.list_objects(prefix: file_path)
-    |> @ex_aws_module.request()
+    |> ex_aws_module().request()
   end
 
   ######### Revamp File Structure ##########

lib/wraft_doc/organisation/enterprise.ex

@@ -45,7 +45,7 @@ defmodule WraftDoc.Enterprise do
   ]
 
   # Moved to runtime configuration to avoid compile-time vs runtime mismatch
-  defp self_hosted_deployment?, do: Application.get_env(:wraft_doc, :deployement)[:is_self_hosted]
+  defp self_hosted_deployment?, do: Application.get_env(:wraft_doc, :deployment)[:is_self_hosted]
 
   @superadmin_role "superadmin"
   @editor_role "editor"
@@ -156,7 +156,7 @@ defmodule WraftDoc.Enterprise do
   def create_flow(_, _), do: {:error, :fake}
 
   @doc """
-  Funtion to align order of states under  a flow
+  Function to align order of states under  a flow
   ## Params
   * flow - Flow struct
   * params - a map with states key
@@ -288,7 +288,7 @@ defmodule WraftDoc.Enterprise do
   end
 
   @doc """
-  Create default states for a controlled fow
+  Create default states for a controlled flow
   """
   @spec create_default_states(User.t(), Flow.t(), boolean()) :: list
   def create_default_states(current_user, flow, true) do
@@ -1026,8 +1026,8 @@ defmodule WraftDoc.Enterprise do
   - `params` - A map of params to paginate list of organisation
 
   ## Examples
-  organisations=list_organisations(%{"page"=>1, "name"=> "ABC Enterprices"})
-  organisation.entries= [%Organisation{name: "ABC Enterprices"}]
+  organisations=list_organisations(%{"page"=>1, "name"=> "ABC Enterprises"})
+  organisation.entries= [%Organisation{name: "ABC Enterprises"}]
   """
 
   @spec list_organisations(map) :: Scrivener.Page.t()
@@ -1107,7 +1107,7 @@ defmodule WraftDoc.Enterprise do
   end
 
   @doc """
-  Update an uproval system
+  Update an approval system
   """
   @spec update_approval_system(User.t(), ApprovalSystem.t(), map) ::
           ApprovalSystem.t() | {:error, Ecto.Changeset.t()}
@@ -1866,7 +1866,7 @@ defmodule WraftDoc.Enterprise do
   end
 
   @doc """
-  Returns true if deployement mode is saas.
+  Returns true if deployment mode is saas.
   """
   @spec self_hosted? :: boolean()
   def self_hosted?, do: self_hosted_deployment?()

lib/wraft_doc/webhooks/event_trigger_behaviour.ex

@@ -0,0 +1,12 @@
+defmodule WraftDoc.Webhooks.EventTriggerBehaviour do
+  @moduledoc """
+  Behaviour for event triggers.
+  """
+
+  @callback trigger_document_created(WraftDoc.Documents.Instance.t()) :: :ok
+  @callback trigger_document_sent(WraftDoc.Documents.Instance.t()) :: :ok
+  @callback trigger_document_state_updated(WraftDoc.Documents.Instance.t(), map()) :: :ok
+  @callback trigger_document_approved(WraftDoc.Documents.Instance.t()) :: :ok
+  @callback trigger_document_rejected(WraftDoc.Documents.Instance.t()) :: :ok
+  @callback trigger_document_deleted(WraftDoc.Documents.Instance.t()) :: :ok
+end

lib/wraft_doc/workers/bulk_worker.ex

@@ -337,7 +337,7 @@ defmodule WraftDoc.Workers.BulkWorker do
       })
     end)
 
-    Logger.info("Pipeline completed succesfully.!")
+    Logger.info("Pipeline completed successfully.!")
     trigger
   end
 

lib/wraft_doc_web/controllers/block_controller.ex

@@ -282,7 +282,7 @@ defmodule WraftDocWeb.Api.V1.BlockController do
 
     with %Block{} = block <- Blocks.get_block(id, current_user),
          {:ok, %Block{}} <- Blocks.delete_block(block) do
-      Typesense.delete_document(block, "block")
+      Typesense.delete_document(block.id, "block")
       render(conn, "block.json", block: block)
     end
   end