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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Add error pages to the storefront (#12689)
Damian Kaczmarczyk8e0f8ad916e4
diff --git a/admin/app/controllers/spree/admin/errors_controller.rb b/admin/app/controllers/spree/admin/errors_controller.rbindex 1182704050..99ba7a763b 100644--- a/admin/app/controllers/spree/admin/errors_controller.rb+++ b/admin/app/controllers/spree/admin/errors_controller.rb@@ -1,10 +1,24 @@module Spreemodule Admin- class ErrorsController < BaseController+ class ErrorsController < Spree::Admin::BaseControllerskip_before_action :authorize_admin- def forbidden- render status: 403+ def show+ render "spree/admin/errors/#{status_code}", status: status_code+ end++ private++ def status_code+ # Extract a 3‑digit code from params or path, default to “500”+ code_str = params[:code].presence ||+ request.path.match(%r{/(\d{3})$})&.[](1) ||+ '500'+ code = code_str.to_i++ # Only allow valid 4xx/5xx error codes, fallback to 500+ valid_errors = Rack::Utils::HTTP_STATUS_CODES.keys.select { |c| c >= 400 }+ valid_errors.include?(code) ? code : 500endendenddiff --git a/admin/app/views/spree/admin/errors/403.html.erb b/admin/app/views/spree/admin/errors/403.html.erbnew file mode 100644index 0000000000..76dae43600--- /dev/null+++ b/admin/app/views/spree/admin/errors/403.html.erb@@ -0,0 +1,14 @@+<%= content_for :title do %>+ <%= Spree.t(:forbidden) %>+<% end %>++<div class="page-container py-12">+ <div class="not-found-page text-center pt-5">+ <h1 class="display-4 text-primary">403</h1>+ <p class="display-5"><%= Spree.t(:forbidden) %></p>+ <p class="display-6"><%= Spree.t(:forbidden_message) %></p>+ <%= link_to Spree.t("admin.back_to_dashboard"),+ spree.admin_dashboard_path,+ class: "btn btn-primary" %>+ </div>+</div>diff --git a/admin/app/views/spree/admin/errors/404.html.erb b/admin/app/views/spree/admin/errors/404.html.erbnew file mode 100644index 0000000000..41d08d6033--- /dev/null+++ b/admin/app/views/spree/admin/errors/404.html.erb@@ -0,0 +1,14 @@+<%= content_for :title do %>+ <%= Spree.t(:page_not_found) %>+<% end %>++<div class="page-container py-12">+ <div class="not-found-page text-center pt-5">+ <h1 class="display-4 text-primary">404</h1>+ <p class="display-5"><%= Spree.t(:page_not_found) %></p>+ <p class="display-6"><%= Spree.t(:page_not_found_message) %></p>+ <%= link_to Spree.t("admin.back_to_dashboard"),+ spree.admin_dashboard_path,+ class: "btn btn-primary" %>+ </div>+</div>diff --git a/admin/app/views/spree/admin/errors/422.html.erb b/admin/app/views/spree/admin/errors/422.html.erbnew file mode 100644index 0000000000..d9d6895ab6--- /dev/null+++ b/admin/app/views/spree/admin/errors/422.html.erb@@ -0,0 +1,14 @@+<%= content_for :title do %>+ <%= Spree.t(:forbidden) %>+<% end %>++<div class="page-container py-12">+ <div class="not-found-page text-center pt-5">+ <h1 class="display-4 text-primary">422</h1>+ <p class="display-5"><%= Spree.t(:unprocessable_entity) %></p>+ <p class="display-6"><%= Spree.t(:unprocessable_entity_message) %></p>+ <%= link_to Spree.t("admin.back_to_dashboard"),+ spree.admin_dashboard_path,+ class: "btn btn-primary" %>+ </div>+</div>diff --git a/admin/app/views/spree/admin/errors/500.html.erb b/admin/app/views/spree/admin/errors/500.html.erbnew file mode 100644index 0000000000..4106e9645e--- /dev/null+++ b/admin/app/views/spree/admin/errors/500.html.erb@@ -0,0 +1,14 @@+<%= content_for :title do %>+ <%= Spree.t(:internal_server_error) %>+<% end %>++<div class="page-container py-12">+ <div class="not-found-page text-center pt-5">+ <h1 class="display-4 text-primary">500</h1>+ <p class="display-5"><%= Spree.t(:internal_server_error) %></p>+ <p class="display-6"><%= Spree.t(:internal_server_error_message) %></p>+ <%= link_to Spree.t("admin.back_to_dashboard"),+ spree.admin_dashboard_path,+ class: "btn btn-primary" %>+ </div>+</div>diff --git a/admin/app/views/spree/admin/errors/503.html.erb b/admin/app/views/spree/admin/errors/503.html.erbnew file mode 100644index 0000000000..2c3c529998--- /dev/null+++ b/admin/app/views/spree/admin/errors/503.html.erb@@ -0,0 +1,14 @@+<%= content_for :title do %>+ <%= Spree.t(:service_unavailable) %>+<% end %>++<div class="page-container py-12">+ <div class="not-found-page text-center pt-5">+ <h1 class="display-4 text-primary">503</h1>+ <p class="display-5"><%= Spree.t(:service_unavailable) %></p>+ <p class="display-6"><%= Spree.t(:service_unavailable_message) %></p>+ <%= link_to Spree.t("admin.back_to_dashboard"),+ spree.admin_dashboard_path,+ class: "btn btn-primary" %>+ </div>+</div>diff --git a/admin/app/views/spree/admin/errors/forbidden.html.erb b/admin/app/views/spree/admin/errors/forbidden.html.erbdeleted file mode 100644index 59803b8135..0000000000--- a/admin/app/views/spree/admin/errors/forbidden.html.erb+++ /dev/null@@ -1,13 +0,0 @@-<%= content_for :title do %>- <%= Spree.t(:forbidden) %>-<% end %>--<%= content_for :page_title do %>- <%= Spree.t(:forbidden) %>-<% end %>--<p class="text-danger">- <%= Spree.t(:forbidden_message) %>-</p>--<%= link_to Spree.t('admin.back_to_dashboard'), spree.admin_dashboard_path, class: 'btn btn-primary' %>\ No newline at end of filediff --git a/admin/config/routes.rb b/admin/config/routes.rbindex 25c9aaefca..72ceb5d003 100644--- a/admin/config/routes.rb+++ b/admin/config/routes.rb@@ -262,7 +262,11 @@ Spree::Core::Engine.add_routes doresources :webhooks_subscribers# errors- get '/forbidden', to: 'errors#forbidden', as: :forbidden+ get '/forbidden', to: 'errors#show', code: 403, as: :forbidden+ if Rails.env.test?+ get '/errors', to: 'errors#show'+ get '/errors/:path', to: 'errors#show', as: :pathed_errors+ end# dashboardresource :dashboard, controller: 'dashboard'diff --git a/admin/spec/requests/spree/admin/errors_spec.rb b/admin/spec/requests/spree/admin/errors_spec.rbnew file mode 100644index 0000000000..12e1c81820--- /dev/null+++ b/admin/spec/requests/spree/admin/errors_spec.rb@@ -0,0 +1,78 @@+require 'spec_helper'++describe 'Errors', type: :request do+ context 'with code parameter' do+ it 'renders 404 template for code 404' do+ get '/admin/errors?code=404'++ expect(response.status).to eq(404)+ expect(response).to render_template('spree/admin/errors/404')+ end++ it 'renders 500 template for code 500' do+ get '/admin/errors?code=500'++ expect(response.status).to eq(500)+ expect(response).to render_template('spree/admin/errors/500')+ end++ it 'renders 403 template for code 403' do+ get '/admin/errors?code=403'++ expect(response.status).to eq(403)+ expect(response).to render_template('spree/admin/errors/403')+ end++ it 'renders 422 template for code 422' do+ get '/admin/errors?code=422'++ expect(response.status).to eq(422)+ expect(response).to render_template('spree/admin/errors/422')+ end++ it 'renders 503 template for code 503' do+ get '/admin/errors?code=503'++ expect(response.status).to eq(503)+ expect(response).to render_template('spree/admin/errors/503')+ end+ end++ context 'with path-based code' do+ it 'extracts code from path and renders correct template' do+ get '/admin/errors/403'++ expect(response).to render_template('spree/admin/errors/403')+ expect(response.status).to eq(403)+ end+ end++ context 'with invalid code' do+ it 'falls back to 500 for non-HTTP status code' do+ get '/admin/errors/999'++ expect(response).to render_template('spree/admin/errors/500')+ expect(response.status).to eq(500)+ end++ it 'falls back to 500 for non-error HTTP status code' do+ get '/admin/errors/200'+ expect(response).to render_template('spree/admin/errors/500')+ expect(response.status).to eq(500)+ end++ it 'falls back to 500 for non-numeric code' do+ get '/admin/errors/error'+ expect(response).to render_template('spree/admin/errors/500')+ expect(response.status).to eq(500)+ end+ end++ context 'without any code' do+ it 'defaults to 500 when no code is provided' do+ get '/admin/errors'+ expect(response).to render_template('spree/admin/errors/500')+ expect(response.status).to eq(500)+ end+ end+enddiff --git a/core/config/locales/en.yml b/core/config/locales/en.ymlindex 899ab9676a..016c172039 100644--- a/core/config/locales/en.yml+++ b/core/config/locales/en.yml@@ -1192,6 +1192,8 @@ en:intercept_email_address: Intercept Email Addressintercept_email_instructions: Override email recipient and replace with this address.internal_name: Internal Name+ internal_server_error: Internal Server Error+ internal_server_error_message: The server encountered an internal error and was unable to complete your request.internationalization: Internationalizationinvalid_credit_card: Invalid credit card.invalid_exchange_variant: Invalid exchange variant.@@ -1537,6 +1539,7 @@ en:buy_buttons:display_name: Add To Cartpage_not_found: Sorry! Page you are looking can’t be found.+ page_not_found_message: This page just doesn't exist.page_sections:announcement_bar:default_text: Welcome to my Store!@@ -1913,6 +1916,8 @@ en:seo_title: SEO Titleserver: Serverserver_error: The server returned an error+ service_unavailable: Service Unavailable+ service_unavailable_message: The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.settings: Settingsship: Shipship_address: Ship Address@@ -2249,6 +2254,8 @@ en:metric: metricmetric_system: Metric systemunlock: Unlock+ unprocessable_entity: Unprocessable Entity+ unprocessable_entity_message: Your request could not be processed. Please check the form for errors and try again.unrecognized_card_type: Unrecognized card typeunshippable_items: Unshippable Itemsupdate: Updatediff --git a/storefront/app/controllers/spree/errors_controller.rb b/storefront/app/controllers/spree/errors_controller.rbnew file mode 100644index 0000000000..6dbd975733--- /dev/null+++ b/storefront/app/controllers/spree/errors_controller.rb@@ -0,0 +1,21 @@+module Spree+ class ErrorsController < StoreController+ def show+ render "spree/errors/#{status_code}", status: status_code+ end++ private++ def status_code+ # Extract a 3‑digit code from params or path, default to “500”+ code_str = params[:code].presence ||+ request.path.match(%r{/(\d{3})$})&.[](1) ||+ '500'+ code = code_str.to_i++ # Only allow valid 4xx/5xx error codes, fallback to 500+ valid_errors = Rack::Utils::HTTP_STATUS_CODES.keys.select { |c| c >= 400 }+ valid_errors.include?(code) ? code : 500+ end+ end+enddiff --git a/storefront/app/controllers/spree/store_controller.rb b/storefront/app/controllers/spree/store_controller.rbindex e9ddd2de97..49fad2880f 100644--- a/storefront/app/controllers/spree/store_controller.rb+++ b/storefront/app/controllers/spree/store_controller.rb@@ -40,7 +40,7 @@ module Spreedef render_404_if_store_not_existsreturn if current_store.present?- render 'errors/404', layout: 'application', status: :not_found+ render 'spree/errors/404', layout: 'application', status: :not_foundenddef current_taxondiff --git a/storefront/app/views/spree/errors/403.html.erb b/storefront/app/views/spree/errors/403.html.erbnew file mode 100644index 0000000000..515f31d2a9--- /dev/null+++ b/storefront/app/views/spree/errors/403.html.erb@@ -0,0 +1,7 @@+<div class="w-full">+ <div class="flex flex-col items-center justify-center py-6 gap-4">+ <h2 class="text-4xl font-bold"><%= Spree.t(:forbidden) %></h2>+ <p><%= Spree.t(:forbidden_message) %></p>+ <%= link_to Spree.t(:back), :back, class: "btn btn-primary" %>+ </div>+</div>diff --git a/storefront/app/views/spree/errors/403.json.erb b/storefront/app/views/spree/errors/403.json.erbnew file mode 100644index 0000000000..683bf150d3--- /dev/null+++ b/storefront/app/views/spree/errors/403.json.erb@@ -0,0 +1 @@+{"status":403,"error":"<%= Spree.t(:forbidden) %>"}diff --git a/storefront/app/views/spree/errors/404.html.erb b/storefront/app/views/spree/errors/404.html.erbnew file mode 100644index 0000000000..7e08cdc760--- /dev/null+++ b/storefront/app/views/spree/errors/404.html.erb@@ -0,0 +1,7 @@+<div class="w-full">+ <div class="flex flex-col items-center justify-center py-6 gap-4">+ <h2 class="text-4xl font-bold"><%= Spree.t(:page_not_found) %></h2>+ <p><%= Spree.t(:page_not_found_message) %></p>+ <%= link_to Spree.t(:back), :back, class: "btn btn-primary" %>+ </div>+</div>diff --git a/storefront/app/views/spree/errors/404.json.erb b/storefront/app/views/spree/errors/404.json.erbnew file mode 100644index 0000000000..ddeaa06293--- /dev/null+++ b/storefront/app/views/spree/errors/404.json.erb@@ -0,0 +1 @@+{"status":404,"error":"<%= Spree.t(:page_not_found) %>"}diff --git a/storefront/app/views/spree/errors/422.html.erb b/storefront/app/views/spree/errors/422.html.erbnew file mode 100644index 0000000000..27e7c3785a--- /dev/null+++ b/storefront/app/views/spree/errors/422.html.erb@@ -0,0 +1,7 @@+<div class="w-full">+ <div class="flex flex-col items-center justify-center py-6 gap-4">+ <h2 class="text-4xl font-bold"><%= Spree.t(:unprocessable_entity) %></h2>+ <p><%= Spree.t(:unprocessable_entity_message) %></p>+ <%= link_to Spree.t(:back), :back, class: "btn btn-primary" %>+ </div>+</div>diff --git a/storefront/app/views/spree/errors/422.json.erb b/storefront/app/views/spree/errors/422.json.erbnew file mode 100644index 0000000000..f40097c964--- /dev/null+++ b/storefront/app/views/spree/errors/422.json.erb@@ -0,0 +1 @@+{"status":422,"error":"<%= Spree.t(:unprocessable_entity) %>"}diff --git a/storefront/app/views/spree/errors/500.html.erb b/storefront/app/views/spree/errors/500.html.erbnew file mode 100644index 0000000000..b4d52045b7--- /dev/null+++ b/storefront/app/views/spree/errors/500.html.erb@@ -0,0 +1,7 @@+<div class="w-full">+ <div class="flex flex-col items-center justify-center py-6 gap-4">+ <h2 class="text-4xl font-bold"><%= Spree.t(:internal_server_error) %></h2>+ <p><%= Spree.t(:internal_server_error_message) %></p>+ <%= link_to Spree.t(:back), :back, class: "btn btn-primary" %>+ </div>+</div>diff --git a/storefront/app/views/spree/errors/500.json.erb b/storefront/app/views/spree/errors/500.json.erbnew file mode 100644index 0000000000..4076889e32--- /dev/null+++ b/storefront/app/views/spree/errors/500.json.erb@@ -0,0 +1 @@+{"status":500,"error":"<%= Spree.t(:internal_server_error) %>"}diff --git a/storefront/app/views/spree/errors/503.html.erb b/storefront/app/views/spree/errors/503.html.erbnew file mode 100644index 0000000000..bb33d5c983--- /dev/null+++ b/storefront/app/views/spree/errors/503.html.erb@@ -0,0 +1,7 @@+<div class="w-full">+ <div class="flex flex-col items-center justify-center py-6 gap-4">+ <h2 class="text-4xl font-bold"><%= Spree.t(:service_unavailable) %></h2>+ <p><%= Spree.t(:service_unavailable_message) %></p>+ <%= link_to Spree.t(:back), :back, class: "btn btn-primary" %>+ </div>+</div>diff --git a/storefront/app/views/spree/errors/503.json.erb b/storefront/app/views/spree/errors/503.json.erbnew file mode 100644index 0000000000..e33beb5eff--- /dev/null+++ b/storefront/app/views/spree/errors/503.json.erb@@ -0,0 +1 @@+{"status":503,"error":"<%= Spree.t(:service_unavailable) %>"}diff --git a/storefront/config/routes.rb b/storefront/config/routes.rbindex 192e7647c2..b0852ab197 100644--- a/storefront/config/routes.rb+++ b/storefront/config/routes.rb@@ -89,6 +89,12 @@ Spree::Core::Engine.add_routes doroot to: 'home#index'end+ get '/forbidden', to: 'errors#show', code: 403, as: :forbidden+ if Rails.env.test?+ get '/errors', to: 'errors#show'+ get '/errors/:path', to: 'errors#show', as: :pathed_errors+ end+get 'robots.txt' => 'seo#robots'get 'sitemap' => 'seo#sitemap'get 'sitemap.xml.gz' => 'seo#sitemap'diff --git a/storefront/spec/requests/errors_spec.rb b/storefront/spec/requests/errors_spec.rbnew file mode 100644index 0000000000..6901c0dde5--- /dev/null+++ b/storefront/spec/requests/errors_spec.rb@@ -0,0 +1,79 @@+require 'spec_helper'++describe 'Errors', type: :request do+ context 'with code parameter' do+ it 'renders 404 template for code 404' do+ get '/errors?code=404'++ expect(response.status).to eq(404)+ expect(response).to render_template('spree/errors/404')+ end++ it 'renders 500 template for code 500' do+ get '/errors?code=500'++ expect(response.status).to eq(500)+ expect(response).to render_template('spree/errors/500')+ end++ it 'renders 403 template for code 403' do+ get '/errors?code=403'++ expect(response.status).to eq(403)+ expect(response).to render_template('spree/errors/403')+ end++ it 'renders 422 template for code 422' do+ get '/errors?code=422'++ expect(response.status).to eq(422)+ expect(response).to render_template('spree/errors/422')+ end++ it 'renders 503 template for code 503' do+ get '/errors?code=503'++ expect(response.status).to eq(503)+ expect(response).to render_template('spree/errors/503')+ end+ end++ context 'with path-based code' do+ it 'extracts code from path and renders correct template' do+ get '/errors/403'++ expect(response).to render_template('spree/errors/403')+ expect(response.status).to eq(403)+ end+ end++ context 'with invalid code' do+ it 'falls back to 500 for non-HTTP status code' do+ get '/errors/999'++ expect(response).to render_template('spree/errors/500')+ expect(response.status).to eq(500)+ end++ it 'falls back to 500 for non-error HTTP status code' do+ get '/errors/200'++ expect(response).to render_template('spree/errors/500')+ expect(response.status).to eq(500)+ end++ it 'falls back to 500 for non-numeric code' do+ get '/errors/error'+ expect(response).to render_template('spree/errors/500')+ expect(response.status).to eq(500)+ end+ end++ context 'without any code' do+ it 'defaults to 500 when no code is provided' do+ get '/errors'+ expect(response).to render_template('spree/errors/500')+ expect(response.status).to eq(500)+ end+ end+end