Files
penpot/frontend/test/frontend_tests/data/repo_test.cljs
Andrey Antukh d67c7f1c8e Add retry mechanism for idenpotent get repo requests on frontend (#8792)
* ♻️ Handle fetch-error gracefully with toast instead of full-page error

Network-level failures (lost connectivity, DNS failure, etc.) on RPC
calls were propagating as :internal/:fetch-error to the global error
handler, which replaced the entire UI with a full-page error screen.

Now the :internal handler distinguishes :fetch-error from other internal
errors and shows a non-intrusive toast notification instead, allowing
the user to continue working.

*  Add automatic retry with backoff for idempotent RPC requests

Idempotent (GET) RPC requests are now automatically retried up to 3
times with exponential back-off (1s, 2s, 4s) when a transient error
occurs.  Retryable errors include: network-level failures
(:fetch-error), 502 Bad Gateway, 503 Service Unavailable, and browser
offline (status 0).

Mutation (POST) requests are never retried to avoid unintended
side-effects.  Non-transient errors (4xx client errors, auth errors,
validation errors) propagate immediately without retry.

* ♻️ Make retry helpers public with configurable parameters

Make retryable-error? and with-retry public functions, and replace
private constants with a default-retry-config map.  with-retry now
accepts an optional config map (:max-retries, :base-delay-ms) enabling
callers and tests to customize retry behavior.

*  Add tests for RPC retry mechanism

Comprehensive tests for the retry helpers in app.main.repo:
- retryable-error? predicate: covers all retryable types (fetch-error,
  bad-gateway, service-unavailable, offline) and non-retryable types
  (validation, authentication, authorization, plain errors)
- with-retry observable wrapper: verifies immediate success, recovery
  after transient failures, max-retries exhaustion, no retry for
  non-retryable errors, fetch-error retry, custom config, and mixed
  error scenarios

* ♻️ Introduce :network error type for fetch-level failures

Replace the awkward {:type :internal :code :fetch-error} combination
with a proper {:type :network} type in app.util.http/fetch.  This makes
the error taxonomy self-explanatory and removes the special-case branch
in the :internal handler.

Consequences:
- http.cljs: emit {:type :network} instead of {:type :internal :code :fetch-error}
- errors.cljs: add a dedicated ptk/handle-error :network method (toast);
  restore :internal handler to its original unconditional full-page error form
- repo.cljs: simplify retryable-types and retryable-error? — :network
  replaces the former :internal special-case, no code check needed
- repo_test.cljs: update tests to use {:type :network}

* 📚 Add comment explaining the use of bit-shift-left
2026-03-27 11:10:26 +01:00

218 lines
8.4 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 INC
(ns frontend-tests.data.repo-test
(:require
[app.main.repo :as repo]
[beicon.v2.core :as rx]
[cljs.test :as t :include-macros true]))
;; ---------------------------------------------------------------------------
;; retryable-error? tests (synchronous)
;; ---------------------------------------------------------------------------
(t/deftest retryable-error-network
(t/testing "network error (js/fetch failure) is retryable"
(let [err (ex-info "network" {:type :network})]
(t/is (true? (repo/retryable-error? err))))))
(t/deftest retryable-error-bad-gateway
(t/testing "502 bad-gateway is retryable"
(let [err (ex-info "bad gateway" {:type :bad-gateway})]
(t/is (true? (repo/retryable-error? err))))))
(t/deftest retryable-error-service-unavailable
(t/testing "503 service-unavailable is retryable"
(let [err (ex-info "service unavailable" {:type :service-unavailable})]
(t/is (true? (repo/retryable-error? err))))))
(t/deftest retryable-error-offline
(t/testing "offline (status 0) is retryable"
(let [err (ex-info "offline" {:type :offline})]
(t/is (true? (repo/retryable-error? err))))))
(t/deftest retryable-error-internal
(t/testing "internal error (genuine bug) is NOT retryable"
(let [err (ex-info "internal" {:type :internal :code :something})]
(t/is (not (repo/retryable-error? err))))))
(t/deftest retryable-error-validation
(t/testing "validation error is NOT retryable"
(let [err (ex-info "validation" {:type :validation :code :request-body-too-large})]
(t/is (not (repo/retryable-error? err))))))
(t/deftest retryable-error-authentication
(t/testing "authentication error is NOT retryable"
(let [err (ex-info "auth" {:type :authentication})]
(t/is (not (repo/retryable-error? err))))))
(t/deftest retryable-error-authorization
(t/testing "authorization/challenge error is NOT retryable"
(let [err (ex-info "auth" {:type :authorization :code :challenge-required})]
(t/is (not (repo/retryable-error? err))))))
(t/deftest retryable-error-no-ex-data
(t/testing "plain error without ex-data is NOT retryable"
(let [err (js/Error. "plain")]
(t/is (not (repo/retryable-error? err))))))
;; ---------------------------------------------------------------------------
;; with-retry tests (async, using zero-delay config for speed)
;; ---------------------------------------------------------------------------
(def ^:private fast-config
"Retry config with zero delay for fast tests."
{:max-retries 3 :base-delay-ms 0})
(t/deftest with-retry-succeeds-immediately
(t/testing "returns value when observable succeeds on first try"
(t/async done
(let [call-count (atom 0)
obs-fn (fn []
(swap! call-count inc)
(rx/of :ok))]
(->> (repo/with-retry obs-fn fast-config)
(rx/subs!
(fn [val]
(t/is (= :ok val))
(t/is (= 1 @call-count))
(done))
(fn [err]
(t/is false (str "unexpected error: " (ex-message err)))
(done))))))))
(t/deftest with-retry-retries-on-retryable-error
(t/testing "retries and eventually succeeds after transient failures"
(t/async done
(let [call-count (atom 0)
obs-fn (fn []
(let [n (swap! call-count inc)]
(if (< n 3)
;; First two calls fail with retryable error
(rx/throw (ex-info "bad gateway" {:type :bad-gateway}))
;; Third call succeeds
(rx/of :recovered))))]
(->> (repo/with-retry obs-fn fast-config)
(rx/subs!
(fn [val]
(t/is (= :recovered val))
(t/is (= 3 @call-count))
(done))
(fn [err]
(t/is false (str "unexpected error: " (ex-message err)))
(done))))))))
(t/deftest with-retry-exhausts-retries
(t/testing "propagates error after max retries exhausted"
(t/async done
(let [call-count (atom 0)
obs-fn (fn []
(swap! call-count inc)
(rx/throw (ex-info "offline" {:type :offline})))]
(->> (repo/with-retry obs-fn fast-config)
(rx/subs!
(fn [_val]
(t/is false "should not succeed")
(done))
(fn [err]
;; 1 initial + 3 retries = 4 total calls
(t/is (= 4 @call-count))
(t/is (= :offline (:type (ex-data err))))
(done))))))))
(t/deftest with-retry-no-retry-on-non-retryable
(t/testing "non-retryable errors propagate immediately without retry"
(t/async done
(let [call-count (atom 0)
obs-fn (fn []
(swap! call-count inc)
(rx/throw (ex-info "auth" {:type :authentication})))]
(->> (repo/with-retry obs-fn fast-config)
(rx/subs!
(fn [_val]
(t/is false "should not succeed")
(done))
(fn [err]
(t/is (= 1 @call-count))
(t/is (= :authentication (:type (ex-data err))))
(done))))))))
(t/deftest with-retry-network-error-retried
(t/testing "network error (js/fetch failure) is retried"
(t/async done
(let [call-count (atom 0)
obs-fn (fn []
(let [n (swap! call-count inc)]
(if (= n 1)
(rx/throw (ex-info "net" {:type :network}))
(rx/of :ok))))]
(->> (repo/with-retry obs-fn fast-config)
(rx/subs!
(fn [val]
(t/is (= :ok val))
(t/is (= 2 @call-count))
(done))
(fn [err]
(t/is false (str "unexpected error: " (ex-message err)))
(done))))))))
(t/deftest with-retry-internal-not-retried
(t/testing "internal error (genuine bug) is not retried"
(t/async done
(let [call-count (atom 0)
obs-fn (fn []
(swap! call-count inc)
(rx/throw (ex-info "bug" {:type :internal
:code :something})))]
(->> (repo/with-retry obs-fn fast-config)
(rx/subs!
(fn [_val]
(t/is false "should not succeed")
(done))
(fn [err]
(t/is (= 1 @call-count))
(t/is (= :internal (:type (ex-data err))))
(done))))))))
(t/deftest with-retry-respects-max-retries-config
(t/testing "respects custom max-retries setting"
(t/async done
(let [call-count (atom 0)
config {:max-retries 1 :base-delay-ms 0}
obs-fn (fn []
(swap! call-count inc)
(rx/throw (ex-info "offline" {:type :offline})))]
(->> (repo/with-retry obs-fn config)
(rx/subs!
(fn [_val]
(t/is false "should not succeed")
(done))
(fn [err]
;; 1 initial + 1 retry = 2 total
(t/is (= 2 @call-count))
(t/is (= :offline (:type (ex-data err))))
(done))))))))
(t/deftest with-retry-mixed-errors
(t/testing "retries retryable errors, then stops on non-retryable"
(t/async done
(let [call-count (atom 0)
obs-fn (fn []
(let [n (swap! call-count inc)]
(case n
1 (rx/throw (ex-info "gw" {:type :bad-gateway}))
2 (rx/throw (ex-info "auth" {:type :authentication}))
(rx/of :should-not-reach))))]
(->> (repo/with-retry obs-fn fast-config)
(rx/subs!
(fn [_val]
(t/is false "should not succeed")
(done))
(fn [err]
(t/is (= 2 @call-count))
(t/is (= :authentication (:type (ex-data err))))
(done))))))))