mirror of
https://github.com/penpot/penpot.git
synced 2026-10-29 22:10:34 +00:00
d3ca9a0b83
* 🎉 Move backend jobs to the unified job table substrate Replace the generic 'task' table with a unified 'job' table as the durable substrate for all backend jobs, and migrate every producer and consumer to it. The legacy 'task' table stops receiving writes but stays dormant (still cleaned by tasks-gc); upload-session chunking and the other post-branch upstream changes are preserved. New 0154 migration creates the 'job' table: dispatch and lifecycle columns (name, queue, priority, scheduled_at, retries, status, timestamps, props) plus optional user-facing ledger columns (profile_id, target, progress, error, result, resource_id, expires_at). No modified_at trigger: the application updates it on every write for lease and orphan detection. Partial indexes cover the dispatcher claim query, orphan scanning, and per-profile listing. New app.jobs public API: submit!/invoke!, heartbeats and progress reporting, a precompiled job-def registry (name, schema, handler, decoder, validator), an ephemeral request/response mode, and a management API for external workers. The dispatcher claims new/retry rows (FOR UPDATE SKIP LOCKED) with a plain JSON redis payload and marks lease-expired running rows as orphaned; the runner executes per-queue with the same retry conventions. New jobs GC (daily): deletes expired rows and retains internal terminal rows per :jobs-retention, touching referenced storage objects so storage-gc-touched reclaims them. Job resources live in a dedicated job-resource bucket with a reclaim branch in storage-gc-touched. All production call-sites (sendmail, delete-object, demo-purge, file-gc, offload, webhooks, quotes, nitrate bulk delete, snapshots, telemetry) and the ten cron tasks now submit through app.jobs; cron is a pure scheduler and the legacy worker registry, task-table inserts, and per-namespace handlers are removed. Includes migrations, dispatcher, runner, jobs, request/response, jobs GC, management API, and cron test suites. AI-assisted-by: glm-5.3-flash AI-assisted-by: muse-spark-1.3-contributor AI-assisted-by: kimi-k3 AI-assisted-by: mimo-v2.5 * ✨ Address review comments on jobs substrate Resolves the four open review threads on the jobs PR. Orphaned jobs are now marked aborted, a system-side terminal state with no retry: the dispatcher sweep stores the end event with outcome aborted in a single bulk insert in the same transaction, records the terminal outcome next to the orphaned counter, and reports an error log; orphans keep alerting through the log and the counter, with no user notification. The aborted state is terminal everywhere: the status CHECK, the sweep, the lifecycle writers, the jobs GC retention, the backlog gauges and the user status mapping, with tests covering each transition. The claim comment, the 2.20 doc version and the legacy task table notes are corrected, and objects-gc heartbeats per chunk. AI-assisted-by: muse-spark-1.3-contributor
194 lines
8.0 KiB
Clojure
194 lines
8.0 KiB
Clojure
;; This Source Code Form is subject to the terms of the Mozilla Public
|
|
;; License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
;; file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
;;
|
|
;; Copyright (c) KALEIDOS SUBSIDIARY SL
|
|
|
|
(ns backend-tests.loggers-webhooks-test
|
|
(:require
|
|
[app.common.time :as ct]
|
|
[app.common.transit :as transit]
|
|
[app.common.uuid :as uuid]
|
|
[app.db :as db]
|
|
[app.http :as http]
|
|
[app.jobs :as jobs]
|
|
[app.storage :as sto]
|
|
[backend-tests.helpers :as th]
|
|
[clojure.test :as t]
|
|
[mockery.core :refer [with-mocks]]))
|
|
|
|
(t/use-fixtures :once th/state-init)
|
|
(t/use-fixtures :each th/database-reset)
|
|
|
|
(t/deftest process-event-handler-with-no-webhooks
|
|
(with-mocks [submit-mock {:target 'app.jobs/submit :return nil}]
|
|
(let [prof (th/create-profile* 1 {:is-active true})
|
|
res (th/run-task! :process-webhook-event
|
|
{:event-blob
|
|
(transit/encode-str
|
|
{:type "command"
|
|
:name "create-project"
|
|
:props {:team-id (:default-team-id prof)}})})]
|
|
|
|
(t/is (= 0 (:call-count @submit-mock)))
|
|
(t/is (nil? res)))))
|
|
|
|
(t/deftest process-event-handler
|
|
(with-mocks [submit-mock {:target 'app.jobs/submit :return nil}]
|
|
(let [prof (th/create-profile* 1 {:is-active true})
|
|
whk (th/create-webhook* {:team-id (:default-team-id prof)})
|
|
res (th/run-task! :process-webhook-event
|
|
{:event-blob
|
|
(transit/encode-str
|
|
{:type "command"
|
|
:name "create-project"
|
|
:props {:team-id (:default-team-id prof)}})})]
|
|
|
|
(t/is (= 1 (:call-count @submit-mock)))
|
|
(t/is (nil? res)))))
|
|
|
|
(t/deftest process-event-submits-consumed-config-subset
|
|
(with-mocks [submit-mock {:target 'app.jobs/submit :return nil}]
|
|
(let [prof (th/create-profile* 1 {:is-active true})
|
|
whk (th/create-webhook* {:team-id (:default-team-id prof)})]
|
|
(th/run-task! :process-webhook-event
|
|
{:event-blob
|
|
(transit/encode-str
|
|
{:type "command"
|
|
:name "create-project"
|
|
:props {:team-id (:default-team-id prof)}})})
|
|
(t/is (= 1 (:call-count @submit-mock)))
|
|
(let [options (second (:call-args @submit-mock))
|
|
config (get-in options [::jobs/params :config])]
|
|
(t/is (= #{:id :uri :mtype} (set (keys config))))
|
|
(t/is (= (:id whk) (:id config)))
|
|
(t/is (= (:uri whk) (:uri config)))
|
|
(t/is (= (:mtype whk) (:mtype config)))))))
|
|
|
|
(t/deftest run-webhook-handler-1
|
|
(with-mocks [http-mock {:target 'app.http.client/req :return {:status 200}}]
|
|
(let [prof (th/create-profile* 1 {:is-active true})
|
|
whk (th/create-webhook* {:team-id (:default-team-id prof)})
|
|
evt {:type "command"
|
|
:name "create-project"
|
|
:props {:team-id (:default-team-id prof)}}
|
|
res (th/run-task! :run-webhook
|
|
{:event (transit/encode-str evt)
|
|
:config whk})]
|
|
|
|
(t/is (= 1 (:call-count @http-mock)))
|
|
|
|
(let [rows (th/db-exec! ["select * from webhook_delivery where webhook_id=?"
|
|
(:id whk)])]
|
|
(t/is (= 1 (count rows)))
|
|
(t/is (nil? (-> rows first :error-code))))
|
|
|
|
;; Refresh webhook
|
|
(let [whk' (th/db-get :webhook {:id (:id whk)})]
|
|
(t/is (nil? (:error-code whk')))))))
|
|
|
|
(t/deftest run-webhook-handler-2
|
|
(with-mocks [http-mock {:target 'app.http.client/req :return {:status 400}}]
|
|
(let [prof (th/create-profile* 1 {:is-active true})
|
|
whk (th/create-webhook* {:team-id (:default-team-id prof)})
|
|
evt {:type "command"
|
|
:name "create-project"
|
|
:props {:team-id (:default-team-id prof)}}
|
|
res (th/run-task! :run-webhook
|
|
{:event (transit/encode-str evt)
|
|
:config whk})]
|
|
|
|
(t/is (= 1 (:call-count @http-mock)))
|
|
|
|
(let [rows (th/db-query :webhook-delivery {:webhook-id (:id whk)})]
|
|
(t/is (= 1 (count rows)))
|
|
(t/is (= "unexpected-status:400" (-> rows first :error-code))))
|
|
|
|
;; Refresh webhook
|
|
(let [whk' (th/db-get :webhook {:id (:id whk)})]
|
|
(t/is (= "unexpected-status:400" (:error-code whk')))
|
|
(t/is (= 1 (:error-count whk'))))
|
|
|
|
|
|
;; RUN 2 times more
|
|
|
|
(th/run-task! :run-webhook
|
|
{:event (transit/encode-str evt)
|
|
:config whk})
|
|
|
|
(th/run-task! :run-webhook
|
|
{:event (transit/encode-str evt)
|
|
:config whk})
|
|
|
|
|
|
(let [rows (th/db-query :webhook-delivery {:webhook-id (:id whk)})]
|
|
(t/is (= 3 (count rows)))
|
|
(t/is (= "unexpected-status:400" (-> rows first :error-code))))
|
|
|
|
;; Refresh webhook
|
|
(let [whk' (th/db-get :webhook {:id (:id whk)})]
|
|
(t/is (= "unexpected-status:400" (:error-code whk')))
|
|
(t/is (= 3 (:error-count whk')))
|
|
(t/is (false? (:is-active whk')))))))
|
|
|
|
(t/deftest webhook-json-round-trip-preserves-uuid-types
|
|
"Integration test: drives process-webhook-event through the real pipeline
|
|
(submit → decode → handler) to verify uuid types survive: the JSON hop
|
|
carries only the opaque transit blob, and the handler decodes the typed
|
|
event from it."
|
|
(with-mocks [http-mock {:target 'app.http.client/req :return {:status 200}}]
|
|
(let [prof (th/create-profile* 1 {:is-active true})
|
|
whk (th/create-webhook* {:team-id (:default-team-id prof)})
|
|
evt {:type "command"
|
|
:name "create-project"
|
|
:props {:team-id (:default-team-id prof)}}]
|
|
|
|
;; Submit the job through the real pipeline (this creates a job row)
|
|
(th/run-task! :process-webhook-event
|
|
{:event-blob (transit/encode-str evt)})
|
|
|
|
;; Now run the pending jobs (simulates dispatcher + runner)
|
|
;; This will decode the params from JSON and invoke the handler
|
|
(th/run-pending-jobs)
|
|
|
|
;; The handler should have been invoked and created a webhook_delivery row
|
|
;; If uuid types were lost, the lookup would fail with a type error
|
|
(let [rows (th/db-query :webhook-delivery {:webhook-id (:id whk)})]
|
|
(t/is (= 1 (count rows)))
|
|
(t/is (nil? (-> rows first :error-code))))
|
|
|
|
;; Refresh webhook
|
|
(let [whk' (th/db-get :webhook {:id (:id whk)})]
|
|
(t/is (nil? (:error-code whk')))))))
|
|
|
|
(t/deftest webhook-transit-round-trip-preserves-uuid-types
|
|
"The run-webhook event travels as the original transit blob inside the
|
|
JSON job props, so transit deliveries keep instant/UUID types (no wire
|
|
change vs the legacy worker), whatever shape the event has."
|
|
(with-mocks [http-mock {:target 'app.http.client/req :return {:status 200}}]
|
|
(let [prof (th/create-profile* 1 {:is-active true})
|
|
whk (th/create-webhook* {:team-id (:default-team-id prof)
|
|
:mtype "application/transit+json"})
|
|
evt {:type "command"
|
|
:name "create-project"
|
|
:created-at (ct/now)
|
|
:tracked-at (ct/now)
|
|
:props {:team-id (:default-team-id prof)
|
|
:comment-id (uuid/next)}}]
|
|
|
|
;; through the real pipeline: process submits run-webhook, the
|
|
;; runner decodes it from JSON and delivers it
|
|
(th/run-task! :process-webhook-event
|
|
{:event-blob (transit/encode-str evt)})
|
|
(th/run-pending-jobs)
|
|
|
|
(t/is (= 1 (:call-count @http-mock)))
|
|
(let [req (second (:call-args @http-mock))
|
|
event (transit/decode-str (:body req))]
|
|
(t/is (= "application/transit+json" (get-in req [:headers "content-type"])))
|
|
(t/is (uuid? (get-in event [:props :team-id])))
|
|
(t/is (uuid? (get-in event [:props :comment-id])))
|
|
(t/is (inst? (:created-at event)))
|
|
(t/is (inst? (:tracked-at event)))))))
|
|
|