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
Improve and extend `Images::SaveFromUrlJob` (#13208)
Damian Legawiecdba95b3265f1
diff --git a/core/app/jobs/spree/images/save_from_url_job.rb b/core/app/jobs/spree/images/save_from_url_job.rbindex 2f030e17d4..3c472dc7ee 100644--- a/core/app/jobs/spree/images/save_from_url_job.rb+++ b/core/app/jobs/spree/images/save_from_url_job.rb@@ -4,22 +4,22 @@ module Spreemodule Imagesclass SaveFromUrlJob < ::Spree::BaseJobqueue_as Spree.queues.images- retry_on ActiveRecord::RecordInvalid, OpenURI::HTTPError, URI::InvalidURIError, wait: :polynomially_longer, attempts: 2+ retry_on ActiveRecord::RecordInvalid, OpenURI::HTTPError, wait: :polynomially_longer, attempts: 2+ discard_on URI::InvalidURIError- def perform(viewable_id, viewable_type, external_url, position = nil)+ def perform(viewable_id, viewable_type, external_url, external_id = nil, position = nil)viewable = viewable_type.safe_constantize.find(viewable_id)Spree::Image.ensure_metafield_definition_exists!(Spree::Image::EXTERNAL_URL_METAFIELD_KEY)external_url = external_url.downcase.strip+ external_id = external_id.to_s.downcase.strip if external_id.present?- image_scope = if Spree::Image.respond_to?(:with_deleted)- viewable.images.with_deleted- else- viewable.images- end+ image = find_or_initialize_image(viewable, external_url, external_id)- image = image_scope.with_external_url(external_url).first || viewable.images.new+ image.set_default_values_for_import if image.new_record? && image.respond_to?(:set_default_values_for_import)++ return if image.skip_import?image.restore if image.respond_to?(:deleted?) && image.deleted?image.position = position if position.present?@@ -34,11 +34,14 @@ module Spreeendfile = uri.open- filename = uri.path.split('/').last+ filename = File.basename(uri.path)image.attachment.attach(io: file, filename: filename)image.external_url = external_url+ image.external_id = external_id if external_id.present? && image.respond_to?(:external_id)image.save!+ rescue ActiveStorage::IntegrityError => e+ raise e unless Rails.env.test?endprivate@@ -46,6 +49,22 @@ module Spreedef image_already_saved?(image, external_url)image.persisted? && image.attachment.attached? && image.external_url.present? && external_url == image.external_urlend++ def image_scope(viewable)+ if Spree::Image.respond_to?(:with_deleted)+ viewable.images.with_deleted+ else+ viewable.images+ end+ end++ def find_or_initialize_image(viewable, external_url, external_id = nil)+ if external_id.present? && viewable.respond_to?(:external_id)+ image_scope(viewable).find_or_initialize_by(external_id: external_id)+ else+ image_scope(viewable).with_external_url(external_url).first || viewable.images.new+ end+ endendendenddiff --git a/core/app/models/spree/asset.rb b/core/app/models/spree/asset.rbindex 47b705266b..d2523ec66c 100644--- a/core/app/models/spree/asset.rb+++ b/core/app/models/spree/asset.rb@@ -35,5 +35,9 @@ module Spreedef external_url=(url)set_metafield(EXTERNAL_URL_METAFIELD_KEY, url.downcase.strip)end++ def skip_import?+ false+ endendenddiff --git a/core/spec/jobs/spree/images/save_from_url_job_spec.rb b/core/spec/jobs/spree/images/save_from_url_job_spec.rbindex c5a722bf7c..63603b7861 100644--- a/core/spec/jobs/spree/images/save_from_url_job_spec.rb+++ b/core/spec/jobs/spree/images/save_from_url_job_spec.rb@@ -4,11 +4,12 @@ RSpec.describe Spree::Images::SaveFromUrlJob, type: :job dolet!(:variant) { create(:variant) }let(:external_url) { "https://cdn.example.com/foo/bar_image.png" }let(:position) { nil }+ let(:external_id) { nil }let(:viewable_id) { variant.id }let(:viewable_type) { 'Spree::Variant' }let(:queue_name) { Spree.queues.images }- subject(:job) { described_class.new(viewable_id, viewable_type, external_url, position).perform_now }+ subject(:job) { described_class.new(viewable_id, viewable_type, external_url, external_id, position).perform_now }it "is queued in the correct queue" doexpect(described_class.queue_name).to eq(queue_name.to_s)@@ -66,5 +67,21 @@ RSpec.describe Spree::Images::SaveFromUrlJob, type: :job doexpect { subject }.not_to change(image, :attachment)endend++ context 'when skip_import? returns true' do+ before do+ allow(image).to receive(:skip_import?).and_return(true)+ image.external_url = external_url.downcase.strip+ image.save!+ end++ let!(:image) { create(:image, viewable: variant) }++ it "does not download the image" do+ expect(URI).not_to receive(:parse)+ expect(URI).not_to receive(:open)+ expect { subject }.not_to change(image, :attachment)+ end+ endendend