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
Give reporting validation failures stable error codes
Damian Legawiec732dbc63b4fe
diff --git a/packages/dashboard-core/src/locales/ar.json b/packages/dashboard-core/src/locales/ar.jsonindex 1a0650b983..2b587310fa 100644--- a/packages/dashboard-core/src/locales/ar.json+++ b/packages/dashboard-core/src/locales/ar.json@@ -1412,6 +1412,7 @@"empty": "لا يمكن أن يكون فارغًا","equal_to": "يجب أن يساوي {{count}}","exclusion": "محجوز",+ "forbidden_reporting_member": "يشير هذا التقرير إلى بيانات غير مسموح لك بقراءتها.","greater_than": "يجب أن يكون أكبر من {{count}}","greater_than_or_equal_to": "يجب أن يكون أكبر من أو يساوي {{count}}","inclusion": "غير مدرج في القائمة",@@ -1425,6 +1426,7 @@"present": "يجب أن يكون فارغًا","product_not_in_store": "يجب أن تنتمي جميعها إلى هذا المتجر","required": "يجب أن يكون موجودًا",+ "seeded_report_read_only": "هذا تقرير مدمج ولا يمكن تغييره. احفظ نسخة بدلاً من ذلك.","taken": "مستخدم بالفعل","too_long": "طويل جدًا (الحد الأقصى {{count}} حرفًا)","too_short": "قصير جدًا (الحد الأدنى {{count}} حرفًا)",diff --git a/packages/dashboard-core/src/locales/de.json b/packages/dashboard-core/src/locales/de.jsonindex a15b962865..b593a3af6c 100644--- a/packages/dashboard-core/src/locales/de.json+++ b/packages/dashboard-core/src/locales/de.json@@ -1412,6 +1412,7 @@"empty": "darf nicht leer sein","equal_to": "muss genau {{count}} sein","exclusion": "ist reserviert",+ "forbidden_reporting_member": "Dieser Bericht verweist auf Daten, die Sie nicht lesen dürfen.","greater_than": "muss größer als {{count}} sein","greater_than_or_equal_to": "muss größer oder gleich {{count}} sein","inclusion": "ist nicht in der Liste enthalten",@@ -1425,6 +1426,7 @@"present": "muss leer sein","product_not_in_store": "müssen alle zu diesem Shop gehören","required": "muss vorhanden sein",+ "seeded_report_read_only": "Dies ist ein integrierter Bericht und kann nicht geändert werden. Speichern Sie stattdessen eine Kopie.","taken": "ist bereits vergeben","too_long": "ist zu lang (maximal {{count}} Zeichen)","too_short": "ist zu kurz (mindestens {{count}} Zeichen)",diff --git a/packages/dashboard-core/src/locales/en.json b/packages/dashboard-core/src/locales/en.jsonindex bfff45224d..ee03fa138a 100644--- a/packages/dashboard-core/src/locales/en.json+++ b/packages/dashboard-core/src/locales/en.json@@ -1414,6 +1414,7 @@"empty": "can't be empty","equal_to": "must be equal to {{count}}","exclusion": "is reserved",+ "forbidden_reporting_member": "This report references data you are not allowed to read.","greater_than": "must be greater than {{count}}","greater_than_or_equal_to": "must be greater than or equal to {{count}}","inclusion": "is not included in the list",@@ -1427,6 +1428,7 @@"present": "must be blank","product_not_in_store": "must all belong to this store","required": "must exist",+ "seeded_report_read_only": "This is a built-in report and cannot be changed. Save a copy instead.","taken": "has already been taken","too_long": "is too long (maximum is {{count}} characters)","too_short": "is too short (minimum is {{count}} characters)",diff --git a/packages/dashboard-core/src/locales/fr.json b/packages/dashboard-core/src/locales/fr.jsonindex 6b6e59d356..e5801f7c1a 100644--- a/packages/dashboard-core/src/locales/fr.json+++ b/packages/dashboard-core/src/locales/fr.json@@ -1412,6 +1412,7 @@"empty": "ne peut pas être vide","equal_to": "doit être égal à {{count}}","exclusion": "est réservé",+ "forbidden_reporting_member": "Ce rapport référence des données que vous n’êtes pas autorisé à lire.","greater_than": "doit être supérieur à {{count}}","greater_than_or_equal_to": "doit être supérieur ou égal à {{count}}","inclusion": "ne fait pas partie de la liste",@@ -1425,6 +1426,7 @@"present": "doit être vide","product_not_in_store": "doivent tous appartenir à cette boutique","required": "doit exister",+ "seeded_report_read_only": "Ce rapport est intégré et ne peut pas être modifié. Enregistrez plutôt une copie.","taken": "est déjà utilisé","too_long": "est trop long ({{count}} caractères maximum)","too_short": "est trop court ({{count}} caractères minimum)",diff --git a/packages/dashboard-core/src/locales/pl.json b/packages/dashboard-core/src/locales/pl.jsonindex 6c275b59c2..9551465400 100644--- a/packages/dashboard-core/src/locales/pl.json+++ b/packages/dashboard-core/src/locales/pl.json@@ -1429,6 +1429,7 @@"empty": "nie może być puste","equal_to": "musi być równe {{count}}","exclusion": "jest zarezerwowane",+ "forbidden_reporting_member": "Ten raport odwołuje się do danych, których nie możesz odczytać.","greater_than": "musi być większe niż {{count}}","greater_than_or_equal_to": "musi być większe lub równe {{count}}","inclusion": "nie znajduje się na liście",@@ -1442,6 +1443,7 @@"present": "musi być puste","product_not_in_store": "wszystkie muszą należeć do tego sklepu","required": "musi istnieć",+ "seeded_report_read_only": "To raport wbudowany i nie można go zmienić. Zapisz zamiast tego kopię.","taken": "jest już zajęte","too_long": "jest za długie (maksymalnie {{count}} znaków)","too_short": "jest za krótkie (minimalnie {{count}} znaków)",diff --git a/packages/dashboard-core/src/locales/zh-CN.json b/packages/dashboard-core/src/locales/zh-CN.jsonindex d6903aeb78..187e6b7904 100644--- a/packages/dashboard-core/src/locales/zh-CN.json+++ b/packages/dashboard-core/src/locales/zh-CN.json@@ -1412,6 +1412,7 @@"empty": "不能为空","equal_to": "必须等于 {{count}}","exclusion": "已被保留",+ "forbidden_reporting_member": "此报表引用了您无权读取的数据。","greater_than": "必须大于 {{count}}","greater_than_or_equal_to": "必须大于或等于 {{count}}","inclusion": "不在列表中",@@ -1425,6 +1426,7 @@"present": "必须为空","product_not_in_store": "必须全部属于本店","required": "必须存在",+ "seeded_report_read_only": "这是内置报表,无法修改。请改为保存副本。","taken": "已被占用","too_long": "太长(最多 {{count}} 个字符)","too_short": "太短(最少 {{count}} 个字符)",diff --git a/spree/core/app/models/spree/exports/report.rb b/spree/core/app/models/spree/exports/report.rbindex 1413f6d060..7ab185c87b 100644--- a/spree/core/app/models/spree/exports/report.rb+++ b/spree/core/app/models/spree/exports/report.rb@@ -79,7 +79,7 @@ module Spreedef query_must_compile_and_be_readableerrors.add(:base, :forbidden_reporting_member) if reporting_query.unreadable_subjects(current_ability).any?rescue Spree::Reporting::UnknownMember, Spree::Reporting::InvalidQuery => e- errors.add(:search_params, e.message)+ errors.add(:search_params, :invalid_reporting_query, message: e.message)rescue JSON::ParserErrorerrors.add(:search_params, :invalid)enddiff --git a/spree/core/app/models/spree/saved_report.rb b/spree/core/app/models/spree/saved_report.rbindex 03070cbe35..7619ac43fa 100644--- a/spree/core/app/models/spree/saved_report.rb+++ b/spree/core/app/models/spree/saved_report.rb@@ -44,7 +44,7 @@ module Spreereporting_queryrescue Spree::Reporting::UnknownMember, Spree::Reporting::InvalidQuery => e- errors.add(:query, e.message)+ errors.add(:query, :invalid_reporting_query, message: e.message)enddef seeded_reports_are_read_onlydiff --git a/spree/core/spec/models/spree/exports/report_spec.rb b/spree/core/spec/models/spree/exports/report_spec.rbindex 7cd5d72a46..4c6488c411 100644--- a/spree/core/spec/models/spree/exports/report_spec.rb+++ b/spree/core/spec/models/spree/exports/report_spec.rb@@ -27,7 +27,7 @@ RSpec.describe Spree::Exports::Report, type: :model doit 'refuses search_params that are not an object' doexport = described_class.new(store: store, user: admin, search_params: '[]')expect(export).not_to be_valid- expect(export.errors[:search_params]).to be_present+ expect(export.errors.details[:search_params]).to include(hash_including(error: :invalid_reporting_query))endit 'refuses at create a query that does not compile' do@@ -43,7 +43,7 @@ RSpec.describe Spree::Exports::Report, type: :model dosearch_params: { query: { 'metrics' => %w[net_revenue], 'dimensions' => %w[product] } })expect(export).not_to be_valid- expect(export.errors[:base]).to be_present+ expect(export.errors.details[:base]).to include(hash_including(error: :forbidden_reporting_member))endit 'gates on the reports scope and anchors on saved reports' dodiff --git a/spree/core/spec/models/spree/saved_report_spec.rb b/spree/core/spec/models/spree/saved_report_spec.rbindex 2ab9a53496..7c5c5b182e 100644--- a/spree/core/spec/models/spree/saved_report_spec.rb+++ b/spree/core/spec/models/spree/saved_report_spec.rb@@ -13,6 +13,9 @@ RSpec.describe Spree::SavedReport, type: :model doit 'refuses a query the registry cannot compile' doreport = described_class.new(store: store, name: 'Broken', query: { 'metrics' => %w[revenues] })expect(report).not_to be_valid+ expect(report.errors.details[:query]).to include(hash_including(error: :invalid_reporting_query))+ # The compiler's own sentence is the useful part — it names the members+ # that would have worked — so it rides along as the message.expect(report.errors[:query].first).to include('net_revenue')report = described_class.new(store: store, name: 'Broken', query: { 'metrics' => %w[gross_revenue], 'dimensions' => %w[category] })@@ -31,7 +34,7 @@ RSpec.describe Spree::SavedReport, type: :model doreport.name = 'Renamed'expect(report).not_to be_valid- expect(report.errors[:base]).to be_present+ expect(report.errors.details[:base]).to include(hash_including(error: :seeded_report_read_only))expect { report.reload.destroy! }.to change(described_class, :count).by(-1)end