Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Fix: setup screen claiming setup is unavailable when rate limited; release 6.0.0.beta4 (#14746)

Damian Legawiec8bf7b0721985
diff --git a/packages/dashboard-core/CHANGELOG.md b/packages/dashboard-core/CHANGELOG.md
index e47b6bb5c0..9e61e345e8 100644
--- a/packages/dashboard-core/CHANGELOG.md
+++ b/packages/dashboard-core/CHANGELOG.md
@@ -1,5 +1,7 @@
# @spree/dashboard-core
+## 1.0.0-beta.8
+
## 1.0.0-beta.7
### Patch Changes
diff --git a/packages/dashboard-core/package.json b/packages/dashboard-core/package.json
index ac24432ec3..e16fb636b2 100644
--- a/packages/dashboard-core/package.json
+++ b/packages/dashboard-core/package.json
@@ -1,7 +1,7 @@
{
"name": "@spree/dashboard-core",
"license": "MIT",
- "version": "1.0.0-beta.7",
+ "version": "1.0.0-beta.8",
"description": "Spree Dashboard framework — registries (table, nav, slot, settings-nav), providers (auth, permission, store), admin SDK client, generic infra hooks, and the defineDashboardPlugin extension API. Developer Preview.",
"author": "Vendo Connect Inc.",
"homepage": "https://spreecommerce.org",
diff --git a/packages/dashboard-ui/CHANGELOG.md b/packages/dashboard-ui/CHANGELOG.md
index bc5d3fb6eb..b72b79fa35 100644
--- a/packages/dashboard-ui/CHANGELOG.md
+++ b/packages/dashboard-ui/CHANGELOG.md
@@ -1,5 +1,7 @@
# @spree/dashboard-ui
+## 1.0.0-beta.8
+
## 1.0.0-beta.7
### Patch Changes
diff --git a/packages/dashboard-ui/package.json b/packages/dashboard-ui/package.json
index dca481ec8b..bf4cfd5d9f 100644
--- a/packages/dashboard-ui/package.json
+++ b/packages/dashboard-ui/package.json
@@ -1,7 +1,7 @@
{
"name": "@spree/dashboard-ui",
"license": "MIT",
- "version": "1.0.0-beta.7",
+ "version": "1.0.0-beta.8",
"description": "Spree Dashboard design system — shadcn primitives, headless composed components, and design tokens. Source-only package; consumers compile via their own Vite/Tailwind setup. Developer Preview.",
"author": "Vendo Connect Inc.",
"homepage": "https://spreecommerce.org",
diff --git a/packages/dashboard/CHANGELOG.md b/packages/dashboard/CHANGELOG.md
index b5292c4666..b80cc47a12 100644
--- a/packages/dashboard/CHANGELOG.md
+++ b/packages/dashboard/CHANGELOG.md
@@ -1,5 +1,15 @@
# @spree/dashboard
+## 1.0.0-beta.8
+
+### Patch Changes
+
+- [#14746](https://github.com/spree/spree/pull/14746) [`3ad9173`](https://github.com/spree/spree/commit/3ad917373f1fc309d10db464dee746b7264a9818) Thanks [@damianlegawiec](https://github.com/damianlegawiec)! - The setup screen no longer says an installation is already set up when it simply could not check. A rate-limited check shows "Too many attempts" and a failed one shows "Couldn't check setup", each with a retry button; "Setup is not available" now appears only when the server confirms setup is done. The setup status is also no longer re-checked every time the browser tab regains focus.
+
+- Updated dependencies []:
+
## 1.0.0-beta.7
### Patch Changes
diff --git a/packages/dashboard/package.json b/packages/dashboard/package.json
index b465013de4..54a43a0e92 100644
--- a/packages/dashboard/package.json
+++ b/packages/dashboard/package.json
@@ -1,7 +1,7 @@
{
"name": "@spree/dashboard",
"license": "MIT",
- "version": "1.0.0-beta.7",
+ "version": "1.0.0-beta.8",
"description": "Spree Dashboard app shell — the next-gen React admin for Spree Commerce. Routes, resource hooks, schemas, locales, and the <Dashboard /> component. Source-only package; hosts compile it via @spree/dashboard/vite. Developer Preview.",
"author": "Vendo Connect Inc.",
"homepage": "https://spreecommerce.org",
diff --git a/packages/dashboard/src/locales/ar.json b/packages/dashboard/src/locales/ar.json
index 8fbf9a0a91..fdd460fe16 100644
--- a/packages/dashboard/src/locales/ar.json
+++ b/packages/dashboard/src/locales/ar.json
@@ -5116,7 +5116,11 @@
"subtitle": "أنشئ حساب المسؤول وأخبرنا عن متجرك. كل شيء هنا يمكن تغييره لاحقًا.",
"title": "إعداد Spree",
"welcome_description": "أكمل قائمة المهام أدناه لفتح {{store}} أمام العملاء.",
- "welcome_title": "مرحبًا، متجرك جاهز الآن!"
+ "welcome_title": "مرحبًا، متجرك جاهز الآن!",
+ "rate_limited_title": "محاولات كثيرة جدًا",
+ "rate_limited_message": "تم التحقق من الإعداد مرات كثيرة في وقت قصير. انتظر دقيقة ثم حاول مرة أخرى.",
+ "check_failed_title": "تعذّر التحقق من الإعداد",
+ "check_failed_message": "تعذّر الوصول إلى الخادم للتحقق مما إذا كان هذا التثبيت يحتاج إلى إعداد. تأكد من أنه يعمل، ثم حاول مرة أخرى."
},
"staff": {
"actions": {
diff --git a/packages/dashboard/src/locales/de.json b/packages/dashboard/src/locales/de.json
index 652da6fa52..393a964edd 100644
--- a/packages/dashboard/src/locales/de.json
+++ b/packages/dashboard/src/locales/de.json
@@ -5083,7 +5083,11 @@
"subtitle": "Erstellen Sie Ihr Administratorkonto und beschreiben Sie Ihren Shop. Alles hier lässt sich später ändern.",
"title": "Spree einrichten",
"welcome_description": "Arbeiten Sie die folgende Checkliste ab, um {{store}} zu eröffnen.",
- "welcome_title": "Willkommen, Ihr Shop ist startklar!"
+ "welcome_title": "Willkommen, Ihr Shop ist startklar!",
+ "rate_limited_title": "Zu viele Versuche",
+ "rate_limited_message": "Die Einrichtung wurde in kurzer Zeit zu oft abgefragt. Warte eine Minute und versuche es dann erneut.",
+ "check_failed_title": "Einrichtung konnte nicht geprüft werden",
+ "check_failed_message": "Der Server war nicht erreichbar, um zu prüfen, ob diese Installation eingerichtet werden muss. Stelle sicher, dass er läuft, und versuche es erneut."
},
"staff": {
"actions": {
diff --git a/packages/dashboard/src/locales/en.json b/packages/dashboard/src/locales/en.json
index 3f23b84cf9..407c0a9fb2 100644
--- a/packages/dashboard/src/locales/en.json
+++ b/packages/dashboard/src/locales/en.json
@@ -5083,7 +5083,11 @@
"subtitle": "Create your admin account and tell us about your store. Everything here can be changed later.",
"title": "Set up Spree",
"welcome_description": "Work through the checklist below to open {{store}} for business.",
- "welcome_title": "Welcome, your store is now ready!"
+ "welcome_title": "Welcome, your store is now ready!",
+ "rate_limited_title": "Too many attempts",
+ "rate_limited_message": "Setup was checked too many times in a short period. Wait a minute, then try again.",
+ "check_failed_title": "Couldn't check setup",
+ "check_failed_message": "The server couldn't be reached to check whether this installation needs setup. Make sure it is running, then try again."
},
"staff": {
"actions": {
diff --git a/packages/dashboard/src/locales/es.json b/packages/dashboard/src/locales/es.json
index df04c2d871..7c5e4c241e 100644
--- a/packages/dashboard/src/locales/es.json
+++ b/packages/dashboard/src/locales/es.json
@@ -5695,7 +5695,11 @@
"subtitle": "Creá tu cuenta de administrador y contanos sobre tu tienda. Todo esto se puede cambiar después.",
"title": "Configurar Spree",
"welcome_description": "Avanzá por la lista de control de abajo para abrir {{store}} al público.",
- "welcome_title": "¡Bienvenido, tu tienda ya está lista!"
+ "welcome_title": "¡Bienvenido, tu tienda ya está lista!",
+ "rate_limited_title": "Demasiados intentos",
+ "rate_limited_message": "La configuración se ha consultado demasiadas veces en poco tiempo. Espera un minuto y vuelve a intentarlo.",
+ "check_failed_title": "No se pudo comprobar la configuración",
+ "check_failed_message": "No se pudo contactar con el servidor para comprobar si esta instalación necesita configurarse. Asegúrate de que está en marcha y vuelve a intentarlo."
},
"tax_rates": {
"add_cta": "Agregar tasa de impuesto",
diff --git a/packages/dashboard/src/locales/fr.json b/packages/dashboard/src/locales/fr.json
index f13adfe1a1..39edaa4e3c 100644
--- a/packages/dashboard/src/locales/fr.json
+++ b/packages/dashboard/src/locales/fr.json
@@ -5083,7 +5083,11 @@
"subtitle": "Créez votre compte administrateur et présentez votre boutique. Tout ceci est modifiable par la suite.",
"title": "Configurer Spree",
"welcome_description": "Suivez la liste ci-dessous pour ouvrir {{store}}.",
- "welcome_title": "Bienvenue, votre boutique est prête !"
+ "welcome_title": "Bienvenue, votre boutique est prête !",
+ "rate_limited_title": "Trop de tentatives",
+ "rate_limited_message": "La configuration a été vérifiée trop souvent en peu de temps. Patientez une minute, puis réessayez.",
+ "check_failed_title": "Impossible de vérifier la configuration",
+ "check_failed_message": "Le serveur est injoignable pour vérifier si cette installation doit être configurée. Vérifiez qu'il est démarré, puis réessayez."
},
"staff": {
"actions": {
diff --git a/packages/dashboard/src/locales/pl.json b/packages/dashboard/src/locales/pl.json
index 86067ba555..b10e30988e 100644
--- a/packages/dashboard/src/locales/pl.json
+++ b/packages/dashboard/src/locales/pl.json
@@ -5147,7 +5147,11 @@
"subtitle": "Utwórz konto administratora i opisz swój sklep. Wszystko tutaj możesz później zmienić.",
"title": "Skonfiguruj Spree",
"welcome_description": "Przejdź przez poniższą listę, aby otworzyć sklep {{store}}.",
- "welcome_title": "Witamy, Twój sklep jest gotowy!"
+ "welcome_title": "Witamy, Twój sklep jest gotowy!",
+ "rate_limited_title": "Zbyt wiele prób",
+ "rate_limited_message": "Konfiguracja była sprawdzana zbyt często w krótkim czasie. Odczekaj minutę i spróbuj ponownie.",
+ "check_failed_title": "Nie udało się sprawdzić konfiguracji",
+ "check_failed_message": "Nie udało się połączyć z serwerem, aby sprawdzić, czy ta instalacja wymaga konfiguracji. Upewnij się, że działa, i spróbuj ponownie."
},
"staff": {
"actions": {
diff --git a/packages/dashboard/src/locales/zh-CN.json b/packages/dashboard/src/locales/zh-CN.json
index 0ce0f0e667..88c6559bcd 100644
--- a/packages/dashboard/src/locales/zh-CN.json
+++ b/packages/dashboard/src/locales/zh-CN.json
@@ -5072,7 +5072,11 @@
"subtitle": "创建您的管理员账户并介绍您的商店。此处的所有设置之后均可更改。",
"title": "设置 Spree",
"welcome_description": "完成下方清单即可让 {{store}} 正式开业。",
- "welcome_title": "欢迎,您的商店已就绪!"
+ "welcome_title": "欢迎,您的商店已就绪!",
+ "rate_limited_title": "尝试次数过多",
+ "rate_limited_message": "短时间内检查设置的次数过多。请等待一分钟后重试。",
+ "check_failed_title": "无法检查设置",
+ "check_failed_message": "无法连接服务器以检查此安装是否需要设置。请确认服务器正在运行,然后重试。"
},
"staff": {
"actions": {
diff --git a/packages/dashboard/src/routes/login.tsx b/packages/dashboard/src/routes/login.tsx
index a03ddea7aa..16eec9e625 100644
--- a/packages/dashboard/src/routes/login.tsx
+++ b/packages/dashboard/src/routes/login.tsx
@@ -69,6 +69,7 @@ function SetupRequiredNotice() {
gcTime: 0,
staleTime: 0,
refetchOnMount: 'always',
+ refetchOnWindowFocus: false,
})
if (!status.data?.setup_required) return null
diff --git a/packages/dashboard/src/routes/setup.tsx b/packages/dashboard/src/routes/setup.tsx
index 94afce5e4e..3804bc765e 100644
--- a/packages/dashboard/src/routes/setup.tsx
+++ b/packages/dashboard/src/routes/setup.tsx
@@ -73,13 +73,32 @@ function SetupLoader({
gcTime: 0,
staleTime: 0,
refetchOnMount: 'always',
+ // Fresh on every visit, but not on every tab switch — each refetch spends
+ // the per-caller request budget this unauthenticated endpoint sits under.
+ refetchOnWindowFocus: false,
})
if (status.isPending) {
return <div className="py-12 text-center text-muted-foreground">{t('admin.setup.loading')}</div>
}
- if (status.isError || !status.data?.setup_required) {
+ // Only a definite answer from the server means setup is closed. A failed
+ // check (rate limited, backend down) must not tell a new merchant their
+ // installation is already set up.
+ if (status.isError) {
+ const rateLimited = (status.error as SpreeError).status === 429
+ return (
+ <SetupUnavailable
+ title={t(rateLimited ? 'admin.setup.rate_limited_title' : 'admin.setup.check_failed_title')}
+ message={t(
+ rateLimited ? 'admin.setup.rate_limited_message' : 'admin.setup.check_failed_message',
+ )}
+ onRetry={() => status.refetch()}
+ />
+ )
+ }
+
+ if (!status.data?.setup_required) {
return (
<SetupUnavailable
title={t('admin.setup.not_available_title')}
@@ -284,13 +303,28 @@ function SetupForm({
)
}
-function SetupUnavailable({ title, message }: { title: string; message: string }) {
+function SetupUnavailable({
+ title,
+ message,
+ onRetry,
+}: {
+ title: string
+ message: string
+ onRetry?: () => void
+}) {
const { t } = useTranslation()
return (
<div className="flex flex-col gap-2">
<h1 className="text-2xl font-bold">{title}</h1>
<p className="text-sm text-muted-foreground">{message}</p>
+ {onRetry && (
+ <div>
+ <Button type="button" variant="outline" size="sm" onClick={onRetry}>
+ {t('admin.common.retry')}
+ </Button>
+ </div>
+ )}
<p className="text-sm text-muted-foreground">
<Link to="/login" className="link">
{t('admin.setup.back_to_login')}
diff --git a/packages/seller-dashboard/CHANGELOG.md b/packages/seller-dashboard/CHANGELOG.md
index 57b5e08a40..c25ac33642 100644
--- a/packages/seller-dashboard/CHANGELOG.md
+++ b/packages/seller-dashboard/CHANGELOG.md
@@ -1,5 +1,15 @@
# @spree/seller-dashboard
+## 1.0.0-beta.8
+
+### Patch Changes
+
+- [#14746](https://github.com/spree/spree/pull/14746) [`3ad9173`](https://github.com/spree/spree/commit/3ad917373f1fc309d10db464dee746b7264a9818) Thanks [@damianlegawiec](https://github.com/damianlegawiec)! - The setup screen no longer says an installation is already set up when it simply could not check. A rate-limited check shows "Too many attempts" and a failed one shows "Couldn't check setup", each with a retry button; "Setup is not available" now appears only when the server confirms setup is done. The setup status is also no longer re-checked every time the browser tab regains focus.
+
+- Updated dependencies []:
+
## 1.0.0-beta.7
### Patch Changes
diff --git a/packages/seller-dashboard/package.json b/packages/seller-dashboard/package.json
index 3e7d19e174..e0619b0c5c 100644
--- a/packages/seller-dashboard/package.json
+++ b/packages/seller-dashboard/package.json
@@ -1,6 +1,6 @@
{
"name": "@spree/seller-dashboard",
- "version": "1.0.0-beta.7",
+ "version": "1.0.0-beta.8",
"license": "MIT",
"type": "module",
"description": "Spree marketplace seller panel — the seller-facing counterpart to the admin dashboard.",
diff --git a/spree/api/app/controllers/spree/api/v3/admin/setup_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/setup_controller.rb
index ddf0407e24..85741c90c9 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/setup_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/setup_controller.rb
@@ -14,10 +14,14 @@ module Spree
skip_scope_check!
skip_before_action :authenticate_admin!, only: [:show, :countries, :create]
+ # Only create checks the setup token, so only create needs the strict
+ # login budget against guessing. The status and countries reads stay
+ # on the general per-caller limit: sharing the login budget with them
+ # let an ordinary first visit and one reload lock the setup screen.
rate_limit to: Spree::Api::Config[:rate_limit_login],
within: Spree::Api::Config[:rate_limit_window].seconds,
store: Rails.cache,
- only: [:show, :countries, :create],
+ only: :create,
with: -> { render_rate_limited(limit: Spree::Api::Config[:rate_limit_login]) }
# GET /api/v3/admin/auth/setup
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/setup_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/setup_controller_spec.rb
index 70c91ba141..c20dd9db75 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/setup_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/setup_controller_spec.rb
@@ -74,6 +74,28 @@ RSpec.describe Spree::Api::V3::Admin::SetupController, type: :controller do
end
end
+ describe 'rate limiting' do
+ before do
+ allow(Rails.cache).to receive(:increment).and_return(Spree::Api::Config[:rate_limit_login] + 1)
+ end
+
+ it 'keeps the status and countries reads off the login budget' do
+ get :show
+ expect(response).to have_http_status(:ok)
+
+ get :countries
+ expect(response).not_to have_http_status(:too_many_requests)
+ end
+
+ it 'holds token submissions to the login budget' do
+ post :create, params: { setup_token: 'guess' }
+
+ expect(response).to have_http_status(:too_many_requests)
+ expect(json_response[:error][:code]).to eq('rate_limit_exceeded')
+ expect(response.headers['X-RateLimit-Limit']).to eq(Spree::Api::Config[:rate_limit_login].to_s)
+ end
+ end
+
describe 'POST #create' do
# Read fresh, not through the memoized @default_store: the shared object
# reloads in an after(:each) that runs inside the previous example's
diff --git a/spree/core/lib/spree/core/version.rb b/spree/core/lib/spree/core/version.rb
index 47448475f2..aa174577b9 100644
--- a/spree/core/lib/spree/core/version.rb
+++ b/spree/core/lib/spree/core/version.rb
@@ -1,5 +1,5 @@
module Spree
- VERSION = '6.0.0.beta3'.freeze
+ VERSION = '6.0.0.beta4'.freeze
def self.version
VERSION