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
Build reporting filter predicates with Arel
Damian Legawiec5a151d651724
diff --git a/spree/core/lib/spree/reporting/adapters/live.rb b/spree/core/lib/spree/reporting/adapters/live.rbindex c6b2b142e6..1ef3a824a9 100644--- a/spree/core/lib/spree/reporting/adapters/live.rb+++ b/spree/core/lib/spree/reporting/adapters/live.rb@@ -119,21 +119,28 @@ module Spreedef apply_filters(scope, base, range)query.filters.each do |filter|dimension = filter[:dimension]- predicate = ["#{qualified_column(dimension)} IN (?)", filter[:values]]+ predicate = in_predicate(qualified_column(dimension), filter[:values])if dimension.joins.blank?- scope = scope.where(*predicate)+ scope = scope.where(predicate)else# Bounded like the outer query (store, currency, range) so the# planner starts from the same indexed slice.- table = scope.klass.table_name- ids = join_for(base_relation(base, range), dimension, base).where(*predicate).select("#{table}.id")- scope = scope.where("#{table}.id IN (#{ids.to_sql})")+ table = scope.klass.arel_table+ ids = join_for(base_relation(base, range), dimension, base).where(predicate).select(table[:id])+ scope = scope.where(table[:id].in(ids.arel))endendscopeend+ # `column IN (values)` as an Arel node. The column is a validated+ # identifier (see #qualified_column) and the values bind as parameters,+ # so no request data reaches the statement as text.+ def in_predicate(column, values)+ Arel::Nodes::SqlLiteral.new(column).in(values)+ end+# Dimension joins are declared from the dimension's own base. Reaching# an :orders dimension (e.g. the ship address) from the :line_items# base goes through the order association.@@ -180,8 +187,7 @@ module Spreeenddef apply_key_filter(scope, keys)- dim = query.dimensions.first- scope.where("#{dimension_expression(dim)} IN (?)", keys)+ scope.where(in_predicate(dimension_expression(query.dimensions.first), keys))end# ---- SQL expressions ----@@ -213,11 +219,28 @@ module Spreequalified_column(dimension)end+ # A registered dimension's column, as a SQL identifier. Registered+ # vocabulary is developer-authored, never request data, but this is+ # the point where it becomes SQL — so the resolved fragment must look+ # like `table.column` and nothing else. Anything richer is a+ # registration bug and raises rather than reaching the database.def qualified_column(dimension)- return resolve_sql(dimension.column) if dimension.column.is_a?(String)+ resolved = if dimension.column.is_a?(String)+ resolve_sql(dimension.column)+ else+ table = dimension.base == :orders ? Spree::Order.table_name : Spree::LineItem.table_name+ "#{table}.#{dimension.column}"+ end++ identifier!(resolved, dimension.name)+ end++ IDENTIFIER = /\A[a-z_][a-z0-9_]*(\.[a-z_][a-z0-9_]*)?\z/i++ def identifier!(fragment, name)+ return fragment if IDENTIFIER.match?(fragment)- table = dimension.base == :orders ? Spree::Order.table_name : Spree::LineItem.table_name- "#{table}.#{dimension.column}"+ raise InvalidQuery, "dimension #{name} resolved to an unusable column expression"end# Time buckets come back as Date on PostgreSQL and String elsewhere —