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 reverse proxy support in admin Table API by using route helpers (#13646)

Damian Legawiec31c7bcfee183
diff --git a/docs/developer/admin/tables.mdx b/docs/developer/admin/tables.mdx
index 17d3fee622..f6a7804ed2 100644
--- a/docs/developer/admin/tables.mdx
+++ b/docs/developer/admin/tables.mdx
@@ -180,8 +180,8 @@ All columns support the following options:
Options for select/status filters. Array of hashes with `value` and `label` keys.
</ParamField>
-<ParamField path="search_url" type="String">
- URL for autocomplete filter type.
+<ParamField path="search_url" type="String | Lambda">
+ URL for autocomplete filter type. Use a Lambda for dynamic paths: `search_url: ->(view_context) { view_context.spree.admin_taxons_select_options_path(format: :json) }`.
</ParamField>
### Custom Sort Options
@@ -301,7 +301,7 @@ Spree.admin.tables.products.add :taxons,
default: false,
ransack_attribute: 'taxons_id',
operators: [:in],
- search_url: '/admin/taxons/select_options.json',
+ search_url: ->(view_context) { view_context.spree.admin_taxons_select_options_path(format: :json) },
method: ->(product) { product.taxons.map(&:pretty_name).join(', ') }
```
@@ -412,7 +412,7 @@ Rails.application.config.after_initialize do
Spree.admin.tables.products.add_bulk_action :set_active,
label: 'admin.bulk_ops.products.title.set_active',
icon: 'circle-check',
- action_path: '/admin/products/bulk_status_update?status=active',
+ action_path: ->(view_context) { view_context.spree.bulk_status_update_admin_products_path(status: 'active') },
body: 'admin.bulk_ops.products.body.set_active',
position: 10,
if: -> { can?(:activate, Spree::Product) }
diff --git a/spree/admin/app/helpers/spree/admin/table_helper.rb b/spree/admin/app/helpers/spree/admin/table_helper.rb
index f7812f5ca0..3beae22eb4 100644
--- a/spree/admin/app/helpers/spree/admin/table_helper.rb
+++ b/spree/admin/app/helpers/spree/admin/table_helper.rb
@@ -230,7 +230,7 @@ module Spree
# @return [String] JSON string
def query_builder_fields_json(table)
query_builder = Spree::Admin::Table::QueryBuilder.new(table)
- query_builder.available_fields.to_json
+ query_builder.available_fields(self).to_json
end
# Build available operators JSON for Stimulus controller
diff --git a/spree/admin/app/models/spree/admin/table/column.rb b/spree/admin/app/models/spree/admin/table/column.rb
index ad6433c91e..8b3b90a5ea 100644
--- a/spree/admin/app/models/spree/admin/table/column.rb
+++ b/spree/admin/app/models/spree/admin/table/column.rb
@@ -42,7 +42,7 @@ module Spree
attribute :ransack_attribute, :string
attribute :operators, default: -> { [] }
attribute :value_options
- attribute :search_url, :string
+ attribute :search_url
attribute :sort_scope_asc
attribute :sort_scope_desc
diff --git a/spree/admin/app/models/spree/admin/table/query_builder.rb b/spree/admin/app/models/spree/admin/table/query_builder.rb
index e6e42f6752..1cf1e45be2 100644
--- a/spree/admin/app/models/spree/admin/table/query_builder.rb
+++ b/spree/admin/app/models/spree/admin/table/query_builder.rb
@@ -70,8 +70,9 @@ module Spree
end
# Get available fields for filtering based on table configuration
+ # @param view_context [ActionView::Base] optional view context for resolving dynamic URLs
# @return [Array<Hash>]
- def available_fields
+ def available_fields(view_context = nil)
@table.filterable_columns.map do |column|
{
key: column.ransack_attribute,
@@ -79,7 +80,7 @@ module Spree
type: column.filter_type.to_s,
operators: column.operators.map(&:to_s),
value_options: format_value_options(column.value_options),
- search_url: column.search_url
+ search_url: resolve_search_url(column.search_url, view_context)
}
end
end
@@ -92,6 +93,10 @@ module Spree
private
+ def resolve_search_url(search_url, view_context)
+ search_url.is_a?(Proc) ? search_url.call(view_context) : search_url
+ end
+
def format_value_options(options)
return nil if options.blank?
diff --git a/spree/admin/config/initializers/spree_admin_tables.rb b/spree/admin/config/initializers/spree_admin_tables.rb
index 5fa176ce6b..d42c91eed3 100644
--- a/spree/admin/config/initializers/spree_admin_tables.rb
+++ b/spree/admin/config/initializers/spree_admin_tables.rb
@@ -111,7 +111,7 @@ Rails.application.config.after_initialize do
position: 80,
ransack_attribute: 'taxons_id',
operators: %i[in],
- search_url: '/admin/taxons/select_options.json',
+ search_url: ->(view_context) { view_context.spree.admin_taxons_select_options_path(format: :json) },
method: ->(product) { product.taxons.pluck(:pretty_name).to_sentence if product.classification_count.positive? }
# Tags - displayed as comma-separated list, filtered via autocomplete
@@ -125,14 +125,14 @@ Rails.application.config.after_initialize do
position: 85,
ransack_attribute: 'tags_name',
operators: %i[in],
- search_url: '/admin/tags/select_options.json?taggable_type=Spree::Product',
+ search_url: ->(view_context) { view_context.spree.admin_tags_select_options_path(format: :json, taggable_type: 'Spree::Product') },
method: ->(product) { product.tag_list.to_sentence }
# Products bulk actions
Spree.admin.tables.products.add_bulk_action :set_active,
label: 'admin.bulk_ops.products.title.set_active',
icon: 'circle-check',
- action_path: '/admin/products/bulk_status_update?status=active',
+ action_path: ->(view_context) { view_context.spree.bulk_status_update_admin_products_path(status: 'active') },
body: 'admin.bulk_ops.products.body.set_active',
position: 10,
condition: -> { can?(:activate, Spree::Product) }
@@ -140,21 +140,21 @@ Rails.application.config.after_initialize do
Spree.admin.tables.products.add_bulk_action :set_draft,
label: 'admin.bulk_ops.products.title.set_draft',
icon: 'circle-dotted',
- action_path: '/admin/products/bulk_status_update?status=draft',
+ action_path: ->(view_context) { view_context.spree.bulk_status_update_admin_products_path(status: 'draft') },
body: 'admin.bulk_ops.products.body.set_draft',
position: 20
Spree.admin.tables.products.add_bulk_action :set_archived,
label: 'admin.bulk_ops.products.title.set_archived',
icon: 'archive',
- action_path: '/admin/products/bulk_status_update?status=archived',
+ action_path: ->(view_context) { view_context.spree.bulk_status_update_admin_products_path(status: 'archived') },
body: 'admin.bulk_ops.products.body.set_archived',
position: 30
Spree.admin.tables.products.add_bulk_action :add_to_taxons,
label: 'admin.bulk_ops.products.title.add_to_taxons',
icon: 'category-plus',
- action_path: '/admin/products/bulk_add_to_taxons',
+ action_path: ->(view_context) { view_context.spree.bulk_add_to_taxons_admin_products_path },
body: 'admin.bulk_ops.products.body.add_to_taxons',
form_partial: 'spree/admin/bulk_operations/forms/taxon_picker',
position: 40,
@@ -163,7 +163,7 @@ Rails.application.config.after_initialize do
Spree.admin.tables.products.add_bulk_action :remove_from_taxons,
label: 'admin.bulk_ops.products.title.remove_from_taxons',
icon: 'category-minus',
- action_path: '/admin/products/bulk_remove_from_taxons',
+ action_path: ->(view_context) { view_context.spree.bulk_remove_from_taxons_admin_products_path },
body: 'admin.bulk_ops.products.body.remove_from_taxons',
form_partial: 'spree/admin/bulk_operations/forms/taxon_picker',
position: 50,
@@ -172,7 +172,7 @@ Rails.application.config.after_initialize do
Spree.admin.tables.products.add_bulk_action :add_tags,
label: 'admin.bulk_ops.products.title.add_tags',
icon: 'tag-plus',
- action_path: '/admin/products/bulk_add_tags',
+ action_path: ->(view_context) { view_context.spree.bulk_add_tags_admin_products_path },
body: 'admin.bulk_ops.products.body.add_tags',
form_partial: 'spree/admin/bulk_operations/forms/tag_picker',
form_partial_locals: { allow_create: true },
@@ -182,7 +182,7 @@ Rails.application.config.after_initialize do
Spree.admin.tables.products.add_bulk_action :remove_tags,
label: 'admin.bulk_ops.products.title.remove_tags',
icon: 'tag-minus',
- action_path: '/admin/products/bulk_remove_tags',
+ action_path: ->(view_context) { view_context.spree.bulk_remove_tags_admin_products_path },
body: 'admin.bulk_ops.products.body.remove_tags',
form_partial: 'spree/admin/bulk_operations/forms/tag_picker',
form_partial_locals: { allow_create: false },
@@ -348,7 +348,7 @@ Rails.application.config.after_initialize do
position: 150,
ransack_attribute: 'promotions_id',
operators: %i[in],
- search_url: '/admin/promotions/select_options.json'
+ search_url: ->(view_context) { view_context.spree.select_options_admin_promotions_path(format: :json) }
# Register Checkouts table (draft orders)
Spree.admin.tables.register(:checkouts, model_class: Spree::Order, search_param: :multi_search, date_range_param: :created_at, new_resource: false)
@@ -462,7 +462,7 @@ Rails.application.config.after_initialize do
position: 30,
ransack_attribute: 'addresses_country_name',
operators: %i[eq],
- search_url: '/admin/countries/select_options.json',
+ search_url: ->(view_context) { view_context.spree.admin_countries_select_options_path(format: :json) },
partial: 'spree/admin/tables/columns/user_location'
# Number of orders
@@ -533,13 +533,13 @@ Rails.application.config.after_initialize do
position: 90,
ransack_attribute: 'tags_name',
operators: %i[in],
- search_url: '/admin/tags/select_options.json?taggable_type=Spree::User'
+ search_url: ->(view_context) { view_context.spree.admin_tags_select_options_path(format: :json, taggable_type: 'Spree::User') }
# Users bulk actions
Spree.admin.tables.users.add_bulk_action :add_tags,
label: 'admin.bulk_ops.users.title.add_tags',
icon: 'tag-plus',
- action_path: '/admin/users/bulk_add_tags',
+ action_path: ->(view_context) { view_context.spree.bulk_add_tags_admin_users_path },
body: 'admin.bulk_ops.users.body.add_tags',
form_partial: 'spree/admin/bulk_operations/forms/tag_picker',
form_partial_locals: { allow_create: true },
@@ -550,7 +550,7 @@ Rails.application.config.after_initialize do
Spree.admin.tables.users.add_bulk_action :remove_tags,
label: 'admin.bulk_ops.users.title.remove_tags',
icon: 'tag-minus',
- action_path: '/admin/users/bulk_remove_tags',
+ action_path: ->(view_context) { view_context.spree.bulk_remove_tags_admin_users_path },
body: 'admin.bulk_ops.users.body.remove_tags',
form_partial: 'spree/admin/bulk_operations/forms/tag_picker',
form_partial_locals: { allow_create: false },
@@ -1080,7 +1080,7 @@ Rails.application.config.after_initialize do
position: 70,
ransack_attribute: 'user_id',
operators: %i[eq],
- search_url: '/admin/users/select_options.json',
+ search_url: ->(view_context) { view_context.spree.admin_users_select_options_path(format: :json) },
method: ->(gc) { gc.user&.email }
Spree.admin.tables.gift_cards.add :created_at,
@@ -1125,7 +1125,7 @@ Rails.application.config.after_initialize do
position: 20,
ransack_attribute: 'stock_location_id',
operators: %i[eq],
- search_url: '/admin/stock_locations/select_options.json',
+ search_url: ->(view_context) { view_context.spree.admin_stock_locations_select_options_path(format: :json) },
partial: 'spree/admin/tables/columns/stock_item_location'
# Backorderable (inline editable checkbox)
@@ -1198,7 +1198,7 @@ Rails.application.config.after_initialize do
position: 20,
method: ->(post) { post.post_category_title },
ransack_attribute: 'post_category_id',
- search_url: '/admin/post_categories/select_options.json'
+ search_url: ->(view_context) { view_context.spree.select_options_admin_post_categories_path(format: :json) }
Spree.admin.tables.posts.add :author,
label: :author,
@@ -1210,7 +1210,7 @@ Rails.application.config.after_initialize do
position: 30,
method: ->(post) { post.author_name },
ransack_attribute: 'author_id',
- search_url: '/admin/admin_users/select_options.json'
+ search_url: ->(view_context) { view_context.spree.select_options_admin_admin_users_path(format: :json) }
Spree.admin.tables.posts.add :published_at,
label: :published_at,
diff --git a/spree/admin/spec/helpers/spree/admin/table_helper_spec.rb b/spree/admin/spec/helpers/spree/admin/table_helper_spec.rb
index f6d7bbb212..81e386897b 100644
--- a/spree/admin/spec/helpers/spree/admin/table_helper_spec.rb
+++ b/spree/admin/spec/helpers/spree/admin/table_helper_spec.rb
@@ -543,6 +543,28 @@ RSpec.describe Spree::Admin::TableHelper, type: :helper do
parsed = JSON.parse(result)
expect(parsed).to be_an(Array)
end
+
+ it 'resolves lambda search_url using view context' do
+ table.add(:taxons, label: 'Taxons', type: :association, filter_type: :autocomplete,
+ search_url: ->(view_context) { '/resolved/taxons/select_options.json' })
+
+ result = helper.query_builder_fields_json(table)
+ parsed = JSON.parse(result)
+ taxon_field = parsed.find { |f| f['key'] == 'taxons' }
+
+ expect(taxon_field['search_url']).to eq('/resolved/taxons/select_options.json')
+ end
+
+ it 'passes string search_url through unchanged' do
+ table.add(:taxons, label: 'Taxons', type: :association, filter_type: :autocomplete,
+ search_url: '/admin/taxons/select_options.json')
+
+ result = helper.query_builder_fields_json(table)
+ parsed = JSON.parse(result)
+ taxon_field = parsed.find { |f| f['key'] == 'taxons' }
+
+ expect(taxon_field['search_url']).to eq('/admin/taxons/select_options.json')
+ end
end
describe '#query_builder_operators_json' do
@@ -609,6 +631,19 @@ RSpec.describe Spree::Admin::TableHelper, type: :helper do
expect(result).to include('data-confirm="Are you sure?"')
end
+
+ it 'resolves lambda action_path with view context' do
+ action = Spree::Admin::Table::BulkAction.new(
+ key: :activate,
+ label: 'Activate',
+ icon: 'check',
+ action_path: ->(view_context) { '/resolved/products/bulk_status_update?status=active' }
+ )
+
+ result = helper.render_bulk_action(action, table: table)
+
+ expect(result).to include('data-url="/resolved/products/bulk_status_update?status=active"')
+ end
end
describe '#render_bulk_actions_panel' do
diff --git a/spree/admin/spec/models/spree/admin/table/bulk_action_spec.rb b/spree/admin/spec/models/spree/admin/table/bulk_action_spec.rb
index 734d9cbdc2..88bf7442ee 100644
--- a/spree/admin/spec/models/spree/admin/table/bulk_action_spec.rb
+++ b/spree/admin/spec/models/spree/admin/table/bulk_action_spec.rb
@@ -43,13 +43,21 @@ RSpec.describe Spree::Admin::Table::BulkAction do
action = described_class.new(key: :delete, if: condition)
expect(action.condition).to eq(condition)
end
+
+ it 'accepts a lambda for action_path' do
+ path_lambda = ->(view_context) { '/resolved/path' }
+ action = described_class.new(key: :activate, action_path: path_lambda)
+
+ expect(action.action_path).to eq(path_lambda)
+ expect(action.action_path.call(nil)).to eq('/resolved/path')
+ end
end
describe 'validations' do
it 'is invalid when key is missing' do
action = described_class.new
expect(action).not_to be_valid
- expect(action.errors[:key]).to include("can't be blank")
+ expect(action.errors[:key]).to be_present
end
it 'is valid with just a key' do
@@ -60,7 +68,7 @@ RSpec.describe Spree::Admin::Table::BulkAction do
it 'is invalid when method is not in allowed list' do
action = described_class.new(key: :delete, method: :invalid)
expect(action).not_to be_valid
- expect(action.errors[:method]).to include('is not included in the list')
+ expect(action.errors[:method]).to be_present
end
it 'accepts all valid methods' do
diff --git a/spree/admin/spec/models/spree/admin/table/column_spec.rb b/spree/admin/spec/models/spree/admin/table/column_spec.rb
index 8021515d1a..62c71a7291 100644
--- a/spree/admin/spec/models/spree/admin/table/column_spec.rb
+++ b/spree/admin/spec/models/spree/admin/table/column_spec.rb
@@ -267,6 +267,25 @@ RSpec.describe Spree::Admin::Table::Column do
end
end
+ describe '#search_url' do
+ it 'accepts a string value' do
+ column = described_class.new(key: 'taxon', label: :taxon, search_url: '/admin/taxons/select_options.json')
+ expect(column.search_url).to eq('/admin/taxons/select_options.json')
+ end
+
+ it 'accepts a lambda value' do
+ url_lambda = ->(view_context) { '/resolved/path' }
+ column = described_class.new(key: 'taxon', label: :taxon, search_url: url_lambda)
+ expect(column.search_url).to eq(url_lambda)
+ expect(column.search_url.call(nil)).to eq('/resolved/path')
+ end
+
+ it 'defaults to nil' do
+ column = described_class.new(key: 'name', label: :name)
+ expect(column.search_url).to be_nil
+ end
+ end
+
describe '#deep_clone' do
it 'creates a deep copy' do
original = described_class.new(key: 'name', label: 'Original', default: true, position: 10)
diff --git a/spree/admin/spec/models/spree/admin/table/query_builder_spec.rb b/spree/admin/spec/models/spree/admin/table/query_builder_spec.rb
index 193b8ed5ba..588773ba24 100644
--- a/spree/admin/spec/models/spree/admin/table/query_builder_spec.rb
+++ b/spree/admin/spec/models/spree/admin/table/query_builder_spec.rb
@@ -179,6 +179,33 @@ RSpec.describe Spree::Admin::Table::QueryBuilder do
expect(status_field[:value_options].map { |o| o[:value] }).to include('one', 'two', 'three')
end
+
+ it 'returns string search_url as-is' do
+ table.add(:taxons, label: 'Taxons', type: :association, filter_type: :autocomplete, search_url: '/admin/taxons/select_options.json')
+
+ fields = query_builder.available_fields
+ taxon_field = fields.find { |f| f[:key] == 'taxons' }
+
+ expect(taxon_field[:search_url]).to eq('/admin/taxons/select_options.json')
+ end
+
+ it 'resolves lambda search_url with view_context' do
+ table.add(:taxons, label: 'Taxons', type: :association, filter_type: :autocomplete,
+ search_url: ->(view_context) { "#{view_context.prefix}/taxons/select_options.json" })
+
+ view_context = double('view_context', prefix: '/custom')
+ fields = query_builder.available_fields(view_context)
+ taxon_field = fields.find { |f| f[:key] == 'taxons' }
+
+ expect(taxon_field[:search_url]).to eq('/custom/taxons/select_options.json')
+ end
+
+ it 'returns nil search_url when column has no search_url' do
+ fields = query_builder.available_fields
+ name_field = fields.find { |f| f[:key] == 'name' }
+
+ expect(name_field[:search_url]).to be_nil
+ end
end
describe '#available_operators' do