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(core): address collections PR review feedback

Łukasz Adamczykde154516578c
diff --git a/packages/admin-sdk/src/types/generated/Collection.ts b/packages/admin-sdk/src/types/generated/Collection.ts
index 2ea2c7e5b0..fb3e7ae8f5 100644
--- a/packages/admin-sdk/src/types/generated/Collection.ts
+++ b/packages/admin-sdk/src/types/generated/Collection.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 9a2bdbea2ae8cc853148d221195b7faa
+// Typelizer digest bd42483ac12630d71f35fa8a428425c1
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {CustomField, CollectionRule} from '@/types'
@@ -9,7 +9,6 @@ interface Collection {
permalink: string;
position: number;
sort_order: string;
- hide_from_nav: boolean;
meta_title: string | null;
meta_description: string | null;
meta_keywords: string | null;
diff --git a/packages/sdk/src/types/generated/Collection.ts b/packages/sdk/src/types/generated/Collection.ts
index ede6b15de4..cf580639d0 100644
--- a/packages/sdk/src/types/generated/Collection.ts
+++ b/packages/sdk/src/types/generated/Collection.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 0b52db62d44a37e8b6230314390fd2e6
+// Typelizer digest 0b9f33a1c89939e25130e731369b0f80
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {CustomField} from '@/types'
@@ -9,7 +9,6 @@ interface Collection {
permalink: string;
position: number;
sort_order: string;
- hide_from_nav: boolean;
meta_title: string | null;
meta_description: string | null;
meta_keywords: string | null;
diff --git a/packages/sdk/src/zod/generated/Collection.ts b/packages/sdk/src/zod/generated/Collection.ts
index 354176da3e..2efa89d5b7 100644
--- a/packages/sdk/src/zod/generated/Collection.ts
+++ b/packages/sdk/src/zod/generated/Collection.ts
@@ -8,7 +8,6 @@ export const CollectionSchema = z.object({
permalink: z.string(),
position: z.number(),
sort_order: z.string(),
- hide_from_nav: z.boolean(),
meta_title: z.string().nullable(),
meta_description: z.string().nullable(),
meta_keywords: z.string().nullable(),
diff --git a/spree/api/app/controllers/spree/api/v3/admin/collections_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/collections_controller.rb
index 523cba39a4..bcdfa4a993 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/collections_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/collections_controller.rb
@@ -34,7 +34,7 @@ module Spree
params.permit(
:name, :description, :permalink, :position,
:meta_title, :meta_description, :meta_keywords,
- :hide_from_nav, :image, :square_image,
+ :image, :square_image,
:automatic, :rules_match_policy, :sort_order,
rules: [:id, :type, :value, :match_policy],
# Inline custom field values keyed by definition id (see
diff --git a/spree/api/app/serializers/spree/api/v3/collection_serializer.rb b/spree/api/app/serializers/spree/api/v3/collection_serializer.rb
index 1e52160930..358644ac5d 100644
--- a/spree/api/app/serializers/spree/api/v3/collection_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/collection_serializer.rb
@@ -6,13 +6,13 @@ module Spree
# back-office state exposed only by the Admin serializer.
class CollectionSerializer < BaseSerializer
typelize name: :string, permalink: :string, position: :number,
- sort_order: :string, hide_from_nav: :boolean,
+ sort_order: :string,
meta_title: [:string, nullable: true], meta_description: [:string, nullable: true], meta_keywords: [:string, nullable: true],
description: :string, description_html: :string,
image_url: [:string, nullable: true], square_image_url: [:string, nullable: true],
products_count: :number
- attributes :name, :permalink, :position, :sort_order, :hide_from_nav,
+ attributes :name, :permalink, :position, :sort_order,
:meta_title, :meta_description, :meta_keywords, :products_count
attribute :description do |collection|
diff --git a/spree/api/spec/integration/spree/api/v3/admin/collections_spec.rb b/spree/api/spec/integration/spree/api/v3/admin/collections_spec.rb
index b710fa5837..d2c1002179 100644
--- a/spree/api/spec/integration/spree/api/v3/admin/collections_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/admin/collections_spec.rb
@@ -59,7 +59,6 @@ RSpec.describe 'Admin Collections API', type: :request, swagger_doc: 'api-refere
meta_title: { type: :string },
meta_description: { type: :string },
meta_keywords: { type: :string },
- hide_from_nav: { type: :boolean, example: false },
rules: {
type: :array,
description: 'Full desired rule set. Entries with an id update, id-less entries create, omitted rules are removed.',
@@ -166,7 +165,6 @@ RSpec.describe 'Admin Collections API', type: :request, swagger_doc: 'api-refere
meta_title: { type: :string },
meta_description: { type: :string },
meta_keywords: { type: :string },
- hide_from_nav: { type: :boolean },
sort_order: { type: :string },
automatic: { type: :boolean },
rules_match_policy: { type: :string, enum: %w[all any] },
diff --git a/spree/core/app/models/spree/collection.rb b/spree/core/app/models/spree/collection.rb
index ce2b8fab56..07c8b46502 100644
--- a/spree/core/app/models/spree/collection.rb
+++ b/spree/core/app/models/spree/collection.rb
@@ -25,7 +25,11 @@ module Spree
include Spree::TranslatableResource
include Spree::TranslatableResourceSlug
include Spree::Metafields
- include Spree::Metadata
+
+ # Single consolidated metadata JSON column (drops public_metadata; see
+ # docs/plans/decisions.md 2026-03-16 "Consolidate metadata"). Write-only
+ # developer escape hatch — never exposed in the Store API.
+ attribute :metadata, default: -> { {} }
#
# Slug / permalink — FriendlyId with history (mirrors Spree::Category; flat, no hierarchy).
@@ -78,7 +82,6 @@ module Spree
validates :permalink, uniqueness: { scope: :store_id, case_sensitive: false, allow_blank: true }
validates :rules_match_policy, inclusion: { in: RULES_MATCH_POLICIES }, presence: true
validates :sort_order, inclusion: { in: SORT_ORDERS }, presence: true
- validates :hide_from_nav, inclusion: { in: [true, false] }
before_validation :set_permalink, if: :name
@@ -91,7 +94,7 @@ module Spree
#
# Automatic (rule-based) membership
#
- after_commit :regenerate_products, on: [:update], if: -> { automatic? && saved_change_to_rules_match_policy? }
+ after_commit :regenerate_products, on: [:update], if: -> { automatic? && (saved_change_to_automatic? || saved_change_to_rules_match_policy?) }
attribute :marked_for_regenerate_products, :boolean, default: true
def manual?
diff --git a/spree/core/app/services/spree/collections/regenerate_products.rb b/spree/core/app/services/spree/collections/regenerate_products.rb
index 3255544ac9..4bb4bd8876 100644
--- a/spree/core/app/services/spree/collections/regenerate_products.rb
+++ b/spree/core/app/services/spree/collections/regenerate_products.rb
@@ -34,13 +34,14 @@ module Spree
end
Spree::ProductCollection.insert_all(records_to_insert)
-
- # expire product cache + reindex
- products = Spree::Product.where(id: (previous_products_ids + product_ids_to_insert).uniq)
- products.touch_all
- products.each(&:enqueue_search_index)
end
+ # Expire cache + reindex the union of previous and new members, so products
+ # dropped when the match set empties also refresh their stale collection_ids.
+ products = Spree::Product.where(id: (previous_products_ids + product_ids_to_insert).uniq)
+ products.touch_all
+ products.each(&:enqueue_search_index)
+
# counter caches — bulk insert/delete bypass the ProductCollection counter_cache callbacks
Spree::Collection.reset_counters(collection.id, :product_collections)
all_product_ids = (previous_products_ids + product_ids_to_insert).uniq
diff --git a/spree/core/app/services/spree/products/auto_match_collections.rb b/spree/core/app/services/spree/products/auto_match_collections.rb
index a16ab86225..dd289dfdc9 100644
--- a/spree/core/app/services/spree/products/auto_match_collections.rb
+++ b/spree/core/app/services/spree/products/auto_match_collections.rb
@@ -49,6 +49,7 @@ module Spree
affected_ids = all_affected.pluck(:id)
Spree::Collection.where(id: affected_ids).touch_all
product.touch
+ product.enqueue_search_index
# counter caches — bulk insert/delete bypass the counter_cache callbacks
affected_ids.each { |id| Spree::Collection.reset_counters(id, :product_collections) }
diff --git a/spree/core/db/migrate/20260708160054_create_spree_collections.rb b/spree/core/db/migrate/20260708160054_create_spree_collections.rb
index cb10f899b5..d0e0a5407a 100644
--- a/spree/core/db/migrate/20260708160054_create_spree_collections.rb
+++ b/spree/core/db/migrate/20260708160054_create_spree_collections.rb
@@ -6,7 +6,6 @@ class CreateSpreeCollections < ActiveRecord::Migration[7.2]
t.boolean :automatic, null: false, default: false
t.string :rules_match_policy, null: false, default: 'all'
t.string :sort_order, null: false, default: 'manual'
- t.boolean :hide_from_nav, null: false, default: false
t.integer :position
t.integer :products_count, null: false, default: 0
t.references :store, null: false, index: true
@@ -15,11 +14,9 @@ class CreateSpreeCollections < ActiveRecord::Migration[7.2]
t.string :meta_keywords
if t.respond_to?(:jsonb)
- t.jsonb :public_metadata
- t.jsonb :private_metadata
+ t.jsonb :metadata
else
- t.json :public_metadata
- t.json :private_metadata
+ t.json :metadata
end
t.timestamps
diff --git a/spree/core/lib/tasks/categories_and_collections.rake b/spree/core/lib/tasks/categories_and_collections.rake
index f1858efc6d..9c665a5cb2 100644
--- a/spree/core/lib/tasks/categories_and_collections.rake
+++ b/spree/core/lib/tasks/categories_and_collections.rake
@@ -47,14 +47,12 @@ namespace :spree do
automatic: true,
rules_match_policy: category.rules_match_policy,
sort_order: category.sort_order,
- hide_from_nav: category.hide_from_nav,
position: category.position,
store_id: store_id,
meta_title: category[:meta_title],
meta_description: category[:meta_description],
meta_keywords: category[:meta_keywords],
- public_metadata: category.public_metadata,
- private_metadata: category.private_metadata
+ metadata: category.metadata
)
# Membership is copied verbatim below, so don't rebuild it from the rules.
collection.marked_for_regenerate_products = false
diff --git a/spree/core/spec/models/spree/collection_spec.rb b/spree/core/spec/models/spree/collection_spec.rb
index 0f3453a6e3..2c6be078d5 100644
--- a/spree/core/spec/models/spree/collection_spec.rb
+++ b/spree/core/spec/models/spree/collection_spec.rb
@@ -3,7 +3,13 @@ require 'spec_helper'
RSpec.describe Spree::Collection, type: :model do
let(:store) { @default_store }
- it_behaves_like 'metadata'
+ describe 'metadata' do
+ it 'defaults to an empty hash and round-trips a JSON value' do
+ collection = create(:collection, metadata: { erp_id: '123' })
+ expect(create(:collection).metadata).to eq({})
+ expect(collection.reload.metadata).to eq({ 'erp_id' => '123' })
+ end
+ end
describe 'permalink generation' do
it 'derives a url-safe permalink from the name' do