Removed metadata from variant

Author: JustShah

api/app/controllers/spree/api/base_controller.rb

@@ -12,8 +12,7 @@ class BaseController < ActionController::Base
         :ReturnAuthorization,
         :Shipment,
         :StockLocation,
-        :StockMovement,
-        :Variant
+        :StockMovement
       ]
 
       self.responder = Spree::Api::Responders::AppResponder

api/app/controllers/spree/api/line_items_controller.rb

@@ -15,9 +15,10 @@ def create
           @line_item = @order.contents.add(
             variant,
             params[:line_item][:quantity] || 1,
-            options: line_item_params[:options].to_h
+            options: line_item_params[:options].to_h,
+            **extract_metadata
           )
-          set_metadata(@line_item)
+
           respond_with(@line_item, status: 201, default_template: :show)
         rescue ActiveRecord::RecordInvalid => error
           invalid_resource!(error.record)
@@ -27,7 +28,6 @@ def create
       def update
         @line_item = find_line_item
         if @order.contents.update_cart(line_items_attributes)
-          set_metadata(@line_item)
           @line_item.reload
           respond_with(@line_item, default_template: :show)
         else
@@ -43,14 +43,6 @@ def destroy
 
       private
 
-      def set_metadata(line_item)
-       line_item.update(customer_metadata: line_item_params[:customer_metadata])
-
-       if can?(:admin, Spree::LineItem)
-         line_item.update(admin_metadata: line_item_params[:admin_metadata])
-       end
-      end
-
       def load_order
         @order ||= Spree::Order.includes(:line_items).find_by!(number: order_id)
         authorize! :update, @order, order_token
@@ -66,10 +58,21 @@ def line_items_attributes
         { line_items_attributes: {
             id: params[:id],
             quantity: params[:line_item][:quantity],
-            options: line_item_params[:options] || {}
+            options: line_item_params[:options] || {},
+            **extract_metadata
         } }
       end
 
+      def extract_metadata
+        metadata = { customer_metadata: line_item_params[:customer_metadata] }
+
+        if @current_user_roles&.include?("admin")
+          metadata[:admin_metadata] = line_item_params[:admin_metadata]
+        end
+
+        metadata
+      end
+
       def line_item_params
         params.require(:line_item).permit(permitted_line_item_attributes)
       end

api/app/helpers/spree/api/api_helpers.rb

@@ -45,7 +45,8 @@ module ApiHelpers
         shipment: Spree::Shipment,
         stock_location: Spree::StockLocation,
         stock_movement: Spree::StockMovement,
-        user: Spree::LegacyUser
+        user: Spree::LegacyUser,
+        line_item: Spree::LineItem
       }
 
       ATTRIBUTES.each do |attribute|
@@ -79,7 +80,7 @@ def required_fields_for(model)
       def variant_attributes
         preference_attributes = Spree::Api::Config.variant_attributes
         if @current_user_roles&.include?("admin")
-          preference_attributes + [:cost_price] + [:admin_metadata]
+          preference_attributes + [:cost_price]
         else
           preference_attributes
         end

api/lib/spree/api_configuration.rb

@@ -14,7 +14,7 @@ class ApiConfiguration < Preferences::Configuration
 
     preference :variant_attributes, :array, default: [
       :id, :name, :sku, :weight, :height, :width, :depth, :is_master,
-      :slug, :description, :track_inventory, :customer_metadata
+      :slug, :description, :track_inventory
     ]
 
     preference :image_attributes, :array, default: [

api/spec/requests/spree/api/variants_spec.rb

@@ -216,22 +216,6 @@ module Spree::Api
                                                         :option_type_id])
       end
 
-      it "can see a single variant with customer metadata" do
-        subject
-
-        expect(json_response).to have_attributes(show_attributes)
-        expect(json_response["stock_items"]).to be_present
-
-        option_values = json_response["option_values"]
-
-        expect(json_response).to have_key('customer_metadata')
-        expect(json_response).not_to have_key('admin_metadata')
-        expect(option_values.first).to have_attributes([:name,
-                                                        :presentation,
-                                                        :option_type_name,
-                                                        :option_type_id])
-      end
-
       it "can see a single variant with images" do
         variant.images.create!(attachment: image("blank.jpg"))
 
@@ -331,18 +315,6 @@ module Spree::Api
         expect(variant.product.variants.count).to eq(1)
       end
 
-      it "can create a new variant with metadata" do
-        post spree.api_product_variants_path(product), params: { variant: { sku: "12345", customer_metadata: { 'type' => 'limited edition' }, admin_metadata: { 'in_demand' => 'true' } } }
-
-        expect(json_response).to have_attributes(new_attributes)
-        expect(response.status).to eq(201)
-        expect(json_response["sku"]).to eq("12345")
-        expect(json_response["admin_metadata"]).to eq({ 'in_demand' => 'true' })
-        expect(json_response["customer_metadata"]).to eq({ 'type' => 'limited edition' })
-
-        expect(variant.product.variants.count).to eq(1)
-      end
-
       it "creates new variants with nested option values" do
         option_values = create_list(:option_value, 2)
         expect do

core/app/models/spree/simple_order_contents.rb

@@ -85,8 +85,11 @@ def add_to_line_item(variant, quantity, options = {})
         adjustments: []
       )
 
+      permitted_attributes = Spree::PermittedAttributes.line_item_attributes.dup
+      permitted_attributes << { admin_metadata: {} } if options[:admin_metadata].present?
+
       line_item.quantity += quantity.to_i
-      line_item.options = ActionController::Parameters.new(options).permit(PermittedAttributes.line_item_attributes).to_h
+      line_item.options = ActionController::Parameters.new(options).permit(permitted_attributes).to_h
 
       line_item.target_shipment = options[:shipment]
       line_item.save!

core/app/models/spree/variant.rb

@@ -19,7 +19,6 @@ class Variant < Spree::Base
     acts_as_list scope: :product
 
     include Spree::SoftDeletable
-    include Metadata
 
     after_discard do
       stock_items.discard_all

core/db/migrate/20250129061658_add_metadata_to_spree_resources.rb

@@ -13,7 +13,6 @@ def change
       spree_customer_returns
       spree_stock_locations
       spree_store_credit_events
-      spree_variants
       spree_users
       spree_return_authorizations
     ].each do |table_name|

core/lib/spree/permitted_attributes.rb

@@ -143,7 +143,7 @@ module PermittedAttributes
       :position, :track_inventory,
       :product_id, :product, :price,
       :weight, :height, :width, :depth, :sku, :cost_currency,
-      :tax_category_id, :shipping_category_id, customer_metadata: {},
+      :tax_category_id, :shipping_category_id,
       option_value_ids: [],
       options: [:name, :value]
     ]

core/spec/models/spree/variant_spec.rb

@@ -1083,26 +1083,4 @@
     expect { variant.option_values << variant.option_values.first }
       .to raise_error ActiveRecord::RecordNotUnique
   end
-
-  describe "metadata fields" do
-    subject { described_class.new }
-
-    it "responds to customer_metadata" do
-      expect(subject).to respond_to(:customer_metadata)
-    end
-
-    it "responds to admin_metadata" do
-      expect(subject).to respond_to(:admin_metadata)
-    end
-
-    it "can store data in customer_metadata" do
-      subject.customer_metadata = { "variant_type" => "veg" }
-      expect(subject.customer_metadata["variant_type"]).to eq("veg")
-    end
-
-    it "can store data in admin_metadata" do
-      subject.admin_metadata = { "variant_details" => "veg" }
-      expect(subject.admin_metadata["variant_details"]).to eq("veg")
-    end
-  end
 end