Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Fix import purge on cleaner failure (#6547)

EmmS21fb0f0a251d99
diff --git a/lib/oban_error_reporter.ex b/lib/oban_error_reporter.ex
index aa33973eb2..dda722ef6c 100644
--- a/lib/oban_error_reporter.ex
+++ b/lib/oban_error_reporter.ex
@@ -25,7 +25,6 @@ defmodule ObanErrorReporter do
|> Map.take([:id, :args, :meta, :queue, :worker])
|> Map.merge(measure)
- on_job_exception(job)
capture_error(meta, extra)
end
@@ -39,35 +38,6 @@ defmodule ObanErrorReporter do
capture_error(meta, extra)
end
- defp on_job_exception(%Oban.Job{
- queue: "analytics_imports",
- args: %{"import_id" => import_id},
- state: "executing",
- attempt: attempt,
- max_attempts: max_attempts
- })
- when attempt >= max_attempts do
- site_import = Plausible.Repo.get(Plausible.Imported.SiteImport, import_id)
-
- if site_import do
- Plausible.Workers.ImportAnalytics.import_fail(site_import, [])
- end
- end
-
- defp on_job_exception(%Oban.Job{
- queue: "analytics_imports",
- args: %{"import_id" => import_id},
- state: "executing"
- }) do
- site_import = Plausible.Repo.get(Plausible.Imported.SiteImport, import_id)
-
- if site_import do
- Plausible.Workers.ImportAnalytics.import_fail_transient(site_import)
- end
- end
-
- defp on_job_exception(_job), do: :ignore
-
# Logs the error and sends it to Sentry
defp capture_error(meta, extra) do
Logger.error(
diff --git a/lib/plausible/application.ex b/lib/plausible/application.ex
index fde540325d..f8daa8b72e 100644
--- a/lib/plausible/application.ex
+++ b/lib/plausible/application.ex
@@ -222,6 +222,7 @@ defmodule Plausible.Application do
setup_request_logging()
setup_sentry()
+ Plausible.Workers.ImportAnalytics.install_exception_handler()
setup_opentelemetry()
Plausible.Ingestion.Persistor.TelemetryHandler.install()
diff --git a/lib/workers/import_analytics.ex b/lib/workers/import_analytics.ex
index 6bcc0ec6e3..36a3ef2823 100644
--- a/lib/workers/import_analytics.ex
+++ b/lib/workers/import_analytics.ex
@@ -4,6 +4,7 @@ defmodule Plausible.Workers.ImportAnalytics do
"""
use Plausible.Repo
+ require Logger
use Oban.Worker,
queue: :analytics_imports,
@@ -14,6 +15,8 @@ defmodule Plausible.Workers.ImportAnalytics do
alias Plausible.Imported.Importer
alias Plausible.Imported.SiteImport
+ @worker inspect(__MODULE__)
+
@impl Oban.Worker
def perform(%Oban.Job{
args: %{"import_id" => import_id} = args
@@ -52,6 +55,50 @@ defmodule Plausible.Workers.ImportAnalytics do
300
end
+ def install_exception_handler() do
+ :ok =
+ :telemetry.attach(
+ "import-analytics-exceptions",
+ [:oban, :job, :exception],
+ &__MODULE__.handle_event/4,
+ %{}
+ )
+ end
+
+ @doc false
+ def handle_event(_event, _measurements, meta, _config) do
+ on_job_exception(meta)
+ catch
+ kind, reason ->
+ Logger.error(Exception.format(kind, reason, __STACKTRACE__))
+ end
+
+ defp on_job_exception(%{
+ job: %Oban.Job{
+ worker: @worker,
+ args: %{"import_id" => import_id}
+ },
+ state: :discard
+ }) do
+ if site_import = Repo.get(SiteImport, import_id) do
+ import_fail(site_import, [])
+ end
+ end
+
+ defp on_job_exception(%{
+ job: %Oban.Job{
+ worker: @worker,
+ args: %{"import_id" => import_id}
+ },
+ state: :failure
+ }) do
+ if site_import = Repo.get(SiteImport, import_id) do
+ import_fail_transient(site_import)
+ end
+ end
+
+ defp on_job_exception(_meta), do: :ignore
+
def import_complete(site_import) do
site_import = Repo.preload(site_import, [:imported_by, site: :team])
diff --git a/test/workers/import_analytics_test.exs b/test/workers/import_analytics_test.exs
index 4af13ff2b8..98f2d5cf54 100644
--- a/test/workers/import_analytics_test.exs
+++ b/test/workers/import_analytics_test.exs
@@ -324,4 +324,97 @@ defmodule Plausible.Workers.ImportAnalyticsTest do
end)
end
end
+
+ describe "job exceptions" do
+ setup do
+ user = new_user()
+ site = new_site(owner: user)
+
+ {:ok, site: site, user: user}
+ end
+
+ test "purges imported stats when the import job crashes and will retry", %{
+ site: site,
+ user: user
+ } do
+ {:ok, job} = new_crashing_import(site, user, max_attempts: 3)
+ query = imported_visitors_query(site, job.args.import_id)
+
+ assert %{failure: 1} = Oban.drain_queue(queue: :analytics_imports)
+
+ assert await_clickhouse_count(query, 0)
+ assert_no_emails_delivered()
+ end
+
+ test "marks the import failed when the import job crashes on its last attempt", %{
+ site: site,
+ user: user
+ } do
+ {:ok, job} = new_crashing_import(site, user, max_attempts: 1)
+
+ assert %{discard: 1} = Oban.drain_queue(queue: :analytics_imports)
+
+ assert Repo.get!(SiteImport, job.args.import_id).status == SiteImport.failed()
+ assert_email_delivered_with(to: [user])
+ end
+
+ @tag :tmp_dir
+ test "keeps the import when the cleaner job crashes and will retry", %{
+ site: site,
+ user: user,
+ tmp_dir: tmp_dir
+ } do
+ site_import = insert(:site_import, site: site, imported_by: user)
+ query = imported_visitors_query(site, site_import.id)
+
+ insert_crashing_cleaner(site_import, tmp_dir, max_attempts: 20)
+
+ assert %{failure: 1} = Oban.drain_queue(queue: :analytics_imports)
+
+ assert await_clickhouse_count(query, 1)
+ assert Repo.reload!(site_import).status == SiteImport.completed()
+ assert_no_emails_delivered()
+ end
+
+ @tag :tmp_dir
+ test "keeps the import when the cleaner job crashes on its last attempt", %{
+ site: site,
+ user: user,
+ tmp_dir: tmp_dir
+ } do
+ site_import = insert(:site_import, site: site, imported_by: user)
+ query = imported_visitors_query(site, site_import.id)
+
+ insert_crashing_cleaner(site_import, tmp_dir, max_attempts: 1)
+
+ assert %{discard: 1} = Oban.drain_queue(queue: :analytics_imports)
+
+ assert await_clickhouse_count(query, 1)
+ assert Repo.reload!(site_import).status == SiteImport.completed()
+ assert_no_emails_delivered()
+ end
+ end
+
+ defp new_crashing_import(site, user, job_opts) do
+ Plausible.Imported.NoopImporter.new_import(site, user,
+ start_date: Date.utc_today() |> Date.shift(day: -7),
+ end_date: Date.utc_today(),
+ crash: true,
+ job_opts: job_opts
+ )
+ end
+
+ defp imported_visitors_query(site, import_id) do
+ populate_stats(site, import_id, [build(:imported_visitors)])
+ query = from(v in Plausible.Imported.Visitor, where: v.import_id == ^import_id)
+ assert await_clickhouse_count(query, 1)
+ query
+ end
+
+ # Deleting a directory with File.rm!/1 raises, like the permission errors in #6515.
+ defp insert_crashing_cleaner(site_import, dir, job_opts) do
+ %{"import_id" => site_import.id, "paths" => [dir]}
+ |> Plausible.Workers.LocalImportAnalyticsCleaner.new(job_opts)
+ |> Oban.insert!()
+ end
end