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.

Fixed second-round email template review findings

Damian Legawiec2b20a6983bc7
diff --git a/spree/api/app/controllers/concerns/spree/api/v3/admin/email_template_lookup.rb b/spree/api/app/controllers/concerns/spree/api/v3/admin/email_template_lookup.rb
index d7b6fe18cb..184fa26228 100644
--- a/spree/api/app/controllers/concerns/spree/api/v3/admin/email_template_lookup.rb
+++ b/spree/api/app/controllers/concerns/spree/api/v3/admin/email_template_lookup.rb
@@ -72,8 +72,8 @@ module Spree
# Samples show a real record of the store (the latest order, a
# company), so previewing one needs permission to read it.
def authorize_sample_data!
- sample = build_preview.email.sample_class
- missing = Array(sample.try(:required_permissions)).reject { |key| holds_permission?(key) }
+ missing = sample_classes.flat_map { |sample| Array(sample.try(:required_permissions)) }.uniq.
+ reject { |key| holds_permission?(key) }
return if missing.empty?
render_error(
@@ -84,6 +84,16 @@ module Spree
)
end
+ # A preview shows one email; publishing the layout or a partial
+ # renders every email, so it needs what all of their samples need.
+ def sample_classes
+ if action_name == 'create' && controller_name == 'publications' && !email_template.definition.email?
+ Spree.editable_email_templates.emails.map(&:sample_class)
+ else
+ [build_preview.email.sample_class]
+ end
+ end
+
def build_preview
Spree::EmailTemplates::Preview.new(store: current_store, key: email_template.key, strict: true, **preview_arguments)
end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/email_templates/publications_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/email_templates/publications_controller.rb
index ec48e69c54..7e46922d45 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/email_templates/publications_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/email_templates/publications_controller.rb
@@ -6,6 +6,8 @@ module Spree
class PublicationsController < Admin::BaseController
include Spree::Api::V3::Admin::EmailTemplateLookup
+ before_action :authorize_sample_data!
+
# POST /api/v3/admin/email_templates/:email_template_id/publication
#
# Makes the draft live. A draft that does not render with sample data
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/email_templates/publications_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/email_templates/publications_controller_spec.rb
index e8f7cd000c..eb0d282f4c 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/email_templates/publications_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/email_templates/publications_controller_spec.rb
@@ -42,6 +42,21 @@ RSpec.describe Spree::Api::V3::Admin::EmailTemplates::PublicationsController, ty
expect(response).to have_http_status(:conflict)
end
+ context 'when publishing the layout without permission to read the records its emails show' do
+ let(:headers) { { 'x-spree-api-key' => create(:api_key, :secret, store: store, scopes: %w[write_email_templates]).plaintext_token } }
+
+ before { allow(Spree::TestingSupport::EmailTemplateSample).to receive(:required_permissions).and_return(%w[read_orders]) }
+
+ it 'is refused, since the check renders every email with real records' do
+ create(:email_template_draft, store: store, key: 'layouts/spree/base_mailer',
+ body: File.read(Spree::Core::Engine.root.join('app/views/layouts/spree/base_mailer.liquid')))
+
+ post :create, params: { email_template_id: 'layouts.spree.base_mailer' }, as: :json
+
+ expect(response).to have_http_status(:forbidden)
+ end
+ end
+
it 'refuses when there is no draft' do
post :create, params: { email_template_id: id }, as: :json
diff --git a/spree/core/app/mailers/spree/base_mailer.rb b/spree/core/app/mailers/spree/base_mailer.rb
index 1b40d26045..54916dbbdf 100644
--- a/spree/core/app/mailers/spree/base_mailer.rb
+++ b/spree/core/app/mailers/spree/base_mailer.rb
@@ -140,7 +140,7 @@ module Spree
resolver = email_resolver(template)
email_renderer(resolver).render(find_email_template(resolver, template), assigns)
rescue Liquid::Error, MRML::Error => e
- raise unless resolver&.store
+ raise unless resolver&.stored_templates_used?
Rails.error.report(e, context: { email_template: template, store_id: current_store&.id })
fallback = email_resolver
diff --git a/spree/core/app/services/spree/email_templates/check.rb b/spree/core/app/services/spree/email_templates/check.rb
index bedeebe4b3..89faeef974 100644
--- a/spree/core/app/services/spree/email_templates/check.rb
+++ b/spree/core/app/services/spree/email_templates/check.rb
@@ -39,11 +39,11 @@ module Spree
email_key: email_key, strict: true).call
nil
rescue Spree::EmailTemplates::NoSampleRecord
- syntax_problem(email_key)
+ syntax_problem(email_key)&.merge(locale: locale)
rescue Liquid::Error => e
- { email: email_key, message: e.message, line: e.line_number }
+ { email: email_key, locale: locale, message: e.message, line: e.line_number }
rescue MRML::Error => e
- { email: email_key, message: e.message, line: nil }
+ { email: email_key, locale: locale, message: e.message, line: nil }
end
def syntax_problem(email_key)
diff --git a/spree/core/app/services/spree/emails/file_system.rb b/spree/core/app/services/spree/emails/file_system.rb
index 1ff51d83b1..66f5785738 100644
--- a/spree/core/app/services/spree/emails/file_system.rb
+++ b/spree/core/app/services/spree/emails/file_system.rb
@@ -15,8 +15,8 @@ module Spree
raise Liquid::FileSystemError, "No such email partial: #{name}" unless partial
partial.body
- rescue Spree::Emails::TemplateResolver::InvalidKey => e
- raise Liquid::FileSystemError, e.message
+ rescue Spree::Emails::TemplateResolver::InvalidKey
+ raise Liquid::FileSystemError, 'Invalid email partial name'
end
end
end
diff --git a/spree/core/app/services/spree/emails/renderer.rb b/spree/core/app/services/spree/emails/renderer.rb
index 81c17a7f79..ee5e85d599 100644
--- a/spree/core/app/services/spree/emails/renderer.rb
+++ b/spree/core/app/services/spree/emails/renderer.rb
@@ -23,6 +23,9 @@ module Spree
def environment
@environment ||= Liquid::Environment.build(error_mode: :strict) do |environment|
environment.register_filter(Spree::Emails::Filters)
+ # `include` takes a variable as the partial name, which would echo
+ # data back in its error message; `render` only takes a fixed name.
+ environment.tags.delete('include')
environment.register_tag('capture', Spree::Core::Emails::EscapedOutput::Capture)
environment.register_tag('cycle', Spree::Core::Emails::EscapedOutput::Cycle)
end
diff --git a/spree/core/app/services/spree/emails/template_resolver.rb b/spree/core/app/services/spree/emails/template_resolver.rb
index 413546f7fd..807432a42d 100644
--- a/spree/core/app/services/spree/emails/template_resolver.rb
+++ b/spree/core/app/services/spree/emails/template_resolver.rb
@@ -69,6 +69,11 @@ module Spree
@drafts[name] || stored(name) || partial_file(name)
end
+ # @return [Boolean] whether a store's published template answered any lookup so far
+ def stored_templates_used?
+ @stored.values.any?
+ end
+
private
attr_reader :view_paths
diff --git a/spree/core/app/workflows/spree/email_templates/discard_draft.rb b/spree/core/app/workflows/spree/email_templates/discard_draft.rb
index a7db67d021..92984603e9 100644
--- a/spree/core/app/workflows/spree/email_templates/discard_draft.rb
+++ b/spree/core/app/workflows/spree/email_templates/discard_draft.rb
@@ -1,13 +1,14 @@
module Spree
module EmailTemplates
# Throws away the draft of one template and language. Given the
- # `lock_version` the draft was seen at, a draft saved since is kept.
+ # `lock_version` the draft was seen at, a draft saved or published since
+ # is reported as a conflict.
class DiscardDraft < Spree::Workflow
def perform(store:, key:, locale: Spree::EmailTemplate::ANY_LOCALE, lock_version: nil)
super
draft = store.email_template_drafts.find_by(key: key, locale: locale)
+ return failure(nil, :stale) if !lock_version.nil? && lock_version.to_i != draft&.lock_version
return success(nil) unless draft
- return failure(nil, :stale) if !lock_version.nil? && lock_version.to_i != draft.lock_version
draft.destroy!
success(nil)
diff --git a/spree/core/app/workflows/spree/email_templates/revert.rb b/spree/core/app/workflows/spree/email_templates/revert.rb
index fe2decdeb6..becb3d4312 100644
--- a/spree/core/app/workflows/spree/email_templates/revert.rb
+++ b/spree/core/app/workflows/spree/email_templates/revert.rb
@@ -4,17 +4,21 @@ module Spree
# published version is marked reverted, so the file answers again, and
# any draft is discarded. The row and its revisions stay, so the history
# can still be restored. Given the `lock_version` the draft was seen at,
- # a draft saved since is not thrown away.
+ # a draft saved or published since is not thrown away.
class Revert < Spree::Workflow
def perform(store:, key:, locale: Spree::EmailTemplate::ANY_LOCALE, actor: nil, lock_version: nil)
super
template = store.email_templates.find_by(key: key, locale: locale)
draft = store.email_template_drafts.find_by(key: key, locale: locale)
- return failure(nil, :stale) if draft && !lock_version.nil? && lock_version.to_i != draft.lock_version
+ return failure(nil, :stale) if !lock_version.nil? && lock_version.to_i != draft&.lock_version
- ApplicationRecord.transaction do
- draft&.destroy!
- template&.update!(status: :reverted, reverted_at: Time.current, reverted_by: actor) if template&.published?
+ begin
+ ApplicationRecord.transaction do
+ draft&.destroy!
+ template&.update!(status: :reverted, reverted_at: Time.current, reverted_by: actor) if template&.published?
+ end
+ rescue ActiveRecord::StaleObjectError
+ return failure(nil, :stale)
end
template&.publish_event('email_template.reverted') if template&.reverted?
diff --git a/spree/core/app/workflows/spree/email_templates/save_draft.rb b/spree/core/app/workflows/spree/email_templates/save_draft.rb
index 221977ff3c..1f5af1bea9 100644
--- a/spree/core/app/workflows/spree/email_templates/save_draft.rb
+++ b/spree/core/app/workflows/spree/email_templates/save_draft.rb
@@ -31,7 +31,10 @@ module Spree
def ensure_current
expected = attributes[:lock_version]
- failure(nil, :stale) if draft.persisted? && !expected.nil? && expected.to_i != draft.lock_version
+ return if expected.nil?
+
+ # A draft that is gone was published or discarded since it was loaded.
+ failure(nil, :stale) if draft.new_record? || expected.to_i != draft.lock_version
end
def save
diff --git a/spree/core/spec/mailers/spree/admin_user_mailer_spec.rb b/spree/core/spec/mailers/spree/admin_user_mailer_spec.rb
index 6991026a68..4737faa068 100644
--- a/spree/core/spec/mailers/spree/admin_user_mailer_spec.rb
+++ b/spree/core/spec/mailers/spree/admin_user_mailer_spec.rb
@@ -60,6 +60,22 @@ describe Spree::AdminUserMailer, type: :mailer do
end
end
+ context "when Spree's own template fails, with no store version" do
+ include_context 'with an editable email template'
+
+ it 'raises once, without reporting a store template failure' do
+ allow(Spree::Emails::Template).to receive(:new).and_wrap_original do |original, **arguments|
+ template = original.call(**arguments)
+ allow(template).to receive(:body).and_return('<mj-section><mj-column><mj-text>{{ 1 | divided_by: 0 }}</mj-text></mj-column></mj-section>') if arguments[:key] == editable_key
+ template
+ end
+ allow(Rails.error).to receive(:report)
+
+ expect { described_class.password_reset_email(admin_user, token, store).message }.to raise_error(Liquid::ZeroDivisionError)
+ expect(Rails.error).not_to have_received(:report)
+ end
+ end
+
context 'when the admin has a dashboard language set' do
around do |example|
previous = I18n.available_locales
diff --git a/spree/core/spec/services/spree/emails/renderer_spec.rb b/spree/core/spec/services/spree/emails/renderer_spec.rb
index b22d45d645..a10afcb158 100644
--- a/spree/core/spec/services/spree/emails/renderer_spec.rb
+++ b/spree/core/spec/services/spree/emails/renderer_spec.rb
@@ -128,6 +128,11 @@ describe Spree::Emails::Renderer do
expect { render(section("{% render '../../etc/passwd' %}")) }.to raise_error(Liquid::FileSystemError)
end
+ it 'has no include tag, whose variable partial name would echo data back in its error' do
+ expect { render(section('{% include order.email %}'), { order: { email: '[email protected]' } }) }.
+ to raise_error(Liquid::SyntaxError) { |error| expect(error.message).not_to include('[email protected]') }
+ end
+
it 'fails a runaway template instead of rendering it' do
expect { render(section('{% for i in (1..10000000) %}{{ i }}{% endfor %}')) }.to raise_error(Liquid::MemoryError)
end
diff --git a/spree/core/spec/workflows/spree/email_templates/revert_spec.rb b/spree/core/spec/workflows/spree/email_templates/revert_spec.rb
index ec3a7f5cc4..9e8af1f257 100644
--- a/spree/core/spec/workflows/spree/email_templates/revert_spec.rb
+++ b/spree/core/spec/workflows/spree/email_templates/revert_spec.rb
@@ -29,4 +29,11 @@ describe Spree::EmailTemplates::Revert do
expect(result.error.value).to eq(:stale)
expect(template.reload).to be_published
end
+
+ it 'refuses when the draft the admin saw was published or discarded since' do
+ store.email_template_drafts.destroy_all
+
+ expect(described_class.new.call(store: store, key: editable_key, actor: admin, lock_version: 0).error.value).to eq(:stale)
+ expect(template.reload).to be_published
+ end
end
diff --git a/spree/core/spec/workflows/spree/email_templates/save_draft_spec.rb b/spree/core/spec/workflows/spree/email_templates/save_draft_spec.rb
index a973fb3986..3de1fe3863 100644
--- a/spree/core/spec/workflows/spree/email_templates/save_draft_spec.rb
+++ b/spree/core/spec/workflows/spree/email_templates/save_draft_spec.rb
@@ -63,6 +63,10 @@ describe Spree::EmailTemplates::SaveDraft do
expect(draft.reload.body).to eq('second')
end
+ it 'refuses a save from a copy whose draft was published or discarded since' do
+ expect(save({ body: 'mine', lock_version: 3 }).error.value).to eq(:stale)
+ end
+
it 'refuses a template merchants may not edit' do
result = described_class.new.call(store: store, key: 'spree/webhook_mailer/endpoint_disabled', attributes: { body: 'x' })