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.

Simplified the email template backend

Damian Legawiecf9460bbd66d1
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 2c102b365a..d7b6fe18cb 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
@@ -41,6 +41,23 @@ module Spree
Spree.api.admin_email_template_serializer
end
+ # Renders the template as it stands after a workflow ran, or why the
+ # workflow refused.
+ def render_email_template_result(result, status: :ok)
+ return render_stale_draft if result.error&.value == :stale
+ return render_template_problems(result.value) if result.error&.value == :invalid_template
+ return render_result_error(result) unless result.success?
+
+ render json: serialize_email_template(reload: true), status: status
+ end
+
+ # Every published version of the template in the requested language.
+ def email_template_revisions
+ Spree::EmailTemplateRevision.where(
+ email_template: current_store.email_templates.for_key(email_template.key, language)
+ )
+ end
+
# An unsaved subject and body are previewed only when sent, so an
# empty body still previews as empty. `branding` previews unsaved
# colors and font.
diff --git a/spree/api/app/controllers/spree/api/v3/admin/email_templates/drafts_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/email_templates/drafts_controller.rb
index 410d6bcf29..0ec2ebed5b 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/email_templates/drafts_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/email_templates/drafts_controller.rb
@@ -20,10 +20,7 @@ module Spree
store: current_store, key: email_template.key, locale: language, actor: current_actor,
attributes: params.permit(:subject, :body, :lock_version, :rebase).to_h.symbolize_keys
)
- return render_stale_draft if result.error&.value == :stale
- return render_result_error(result) unless result.success?
-
- render json: serialize_email_template(reload: true)
+ render_email_template_result(result)
end
# DELETE /api/v3/admin/email_templates/:email_template_id/draft
@@ -33,9 +30,7 @@ module Spree
result = Spree.email_template_discard_draft_workflow.call(
store: current_store, key: email_template.key, locale: language, lock_version: params[:lock_version].presence
)
- return render_stale_draft if result.error&.value == :stale
-
- render json: serialize_email_template(reload: true)
+ render_email_template_result(result)
end
end
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 fd3d4d60af..ec48e69c54 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
@@ -18,11 +18,7 @@ module Spree
store: current_store, key: email_template.key, locale: language, actor: current_actor,
lock_version: params[:lock_version].presence
)
- return render_stale_draft if result.error&.value == :stale
- return render_template_problems(result.value) if result.error&.value == :invalid_template
- return render_result_error(result) unless result.success?
-
- render json: serialize_email_template(reload: true), status: :created
+ render_email_template_result(result, status: :created)
end
end
end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/email_templates/restorations_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/email_templates/restorations_controller.rb
index 9f604ba38b..7add11c8ab 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/email_templates/restorations_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/email_templates/restorations_controller.rb
@@ -12,17 +12,12 @@ module Spree
def create
authorize! :update, Spree::EmailTemplate
- revision = Spree::EmailTemplateRevision.where(
- email_template: current_store.email_templates.for_key(email_template.key, language)
- ).find_by_prefix_id!(params[:revision_id])
+ revision = email_template_revisions.find_by_prefix_id!(params[:revision_id])
result = Spree.email_template_restore_revision_workflow.call(
revision: revision, actor: current_actor, lock_version: params[:lock_version]
)
- return render_stale_draft if result.error&.value == :stale
- return render_result_error(result) unless result.success?
-
- render json: serialize_email_template(reload: true), status: :created
+ render_email_template_result(result, status: :created)
end
end
end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/email_templates/revisions_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/email_templates/revisions_controller.rb
index 2bb77e73bb..47dadea03d 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/email_templates/revisions_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/email_templates/revisions_controller.rb
@@ -19,9 +19,7 @@ module Spree
end
def scope
- Spree::EmailTemplateRevision.where(
- email_template: current_store.email_templates.for_key(email_template.key, language)
- ).order(created_at: :desc)
+ email_template_revisions.order(created_at: :desc)
end
def collection_includes
diff --git a/spree/api/app/controllers/spree/api/v3/admin/email_templates_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/email_templates_controller.rb
index e38f0dc6bc..d2c0b4a891 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/email_templates_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/email_templates_controller.rb
@@ -37,10 +37,7 @@ module Spree
store: current_store, key: email_template.key, locale: language, actor: current_actor,
lock_version: params[:lock_version].presence
)
- return render_stale_draft if result.error&.value == :stale
- return render_result_error(result) unless result.success?
-
- render json: serialize_email_template(reload: true)
+ render_email_template_result(result)
end
end
end
diff --git a/spree/core/app/models/concerns/spree/email_template_identity.rb b/spree/core/app/models/concerns/spree/email_template_identity.rb
index ab3ab506e1..45440a5c75 100644
--- a/spree/core/app/models/concerns/spree/email_template_identity.rb
+++ b/spree/core/app/models/concerns/spree/email_template_identity.rb
@@ -13,7 +13,7 @@ module Spree
included do
include Spree::SingleStoreResource
- normalizes :locale, with: ->(locale) { locale.to_s.strip.presence || ANY_LOCALE }
+ normalizes :locale, with: ->(locale) { locale.to_s.strip.presence || ANY_LOCALE }, apply_to_nil: true
validates :key, presence: true, uniqueness: { scope: spree_base_uniqueness_scope + [:store_id, :locale] }
validates :locale, format: { with: LOCALE_FORMAT }
diff --git a/spree/core/app/models/spree/email_templates/entry.rb b/spree/core/app/models/spree/email_templates/entry.rb
index f552aed0cf..f2ba81f431 100644
--- a/spree/core/app/models/spree/email_templates/entry.rb
+++ b/spree/core/app/models/spree/email_templates/entry.rb
@@ -59,7 +59,7 @@ module Spree
# @return [Spree::Emails::Template, nil] the template file Spree or the app ships
def default
- @default ||= Spree::Emails::TemplateResolver.new(Spree::BaseMailer.view_paths.paths.map(&:path)).find_default(key)
+ @default ||= Spree::Emails::TemplateResolver.for_mailers.find_default(key)
end
# What customers receive now.
diff --git a/spree/core/app/services/spree/email_templates/preview.rb b/spree/core/app/services/spree/email_templates/preview.rb
index 841c22c891..a375c2859b 100644
--- a/spree/core/app/services/spree/email_templates/preview.rb
+++ b/spree/core/app/services/spree/email_templates/preview.rb
@@ -55,8 +55,8 @@ module Spree
@email ||= if definition.email?
definition
else
- Spree.editable_email_templates[@email_key.to_s].then { |named| named&.email? ? named : nil } ||
- Spree.editable_email_templates.emails.first
+ emails = Spree.editable_email_templates.emails
+ emails.find { |candidate| candidate.key == @email_key } || emails.first
end
end
@@ -67,9 +67,7 @@ module Spree
end
def resolver
- @resolver ||= Spree::Emails::TemplateResolver.new(
- Spree::BaseMailer.view_paths.paths.map(&:path), store: @store, locale: language, drafts: drafts
- )
+ @resolver ||= Spree::Emails::TemplateResolver.for_mailers(store: @store, locale: language, drafts: drafts)
end
def drafts
diff --git a/spree/core/app/services/spree/emails/renderer.rb b/spree/core/app/services/spree/emails/renderer.rb
index 2d2a37d9e0..81c17a7f79 100644
--- a/spree/core/app/services/spree/emails/renderer.rb
+++ b/spree/core/app/services/spree/emails/renderer.rb
@@ -84,7 +84,6 @@ module Spree
MRML.to_html(render_liquid(layout.body, assigns.merge('content_for_layout' => body.html_safe)))
end
-
# The subject is plain text for a mail header, so it is not HTML-escaped.
def subject_for(template, assigns)
render_liquid(template.subject.to_s, assigns, escape: false).squish
diff --git a/spree/core/app/services/spree/emails/template_resolver.rb b/spree/core/app/services/spree/emails/template_resolver.rb
index dfcbb93fc7..413546f7fd 100644
--- a/spree/core/app/services/spree/emails/template_resolver.rb
+++ b/spree/core/app/services/spree/emails/template_resolver.rb
@@ -16,6 +16,12 @@ module Spree
class InvalidKey < ArgumentError; end
+ # @param options [Hash] see {#initialize}
+ # @return [Spree::Emails::TemplateResolver] searching the directories Spree's mailers render from
+ def self.for_mailers(**options)
+ new(Spree::BaseMailer.view_paths.paths.map(&:path), **options)
+ end
+
# @param view_paths [Array<String, Pathname>] directories to search, highest precedence first
# @param store [Spree::Store, nil] the store whose published templates apply
# @param locale [String, Symbol, nil] the email's language
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 c089d2510c..a7db67d021 100644
--- a/spree/core/app/workflows/spree/email_templates/discard_draft.rb
+++ b/spree/core/app/workflows/spree/email_templates/discard_draft.rb
@@ -5,7 +5,7 @@ module Spree
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.presence || Spree::EmailTemplate::ANY_LOCALE)
+ draft = store.email_template_drafts.find_by(key: key, locale: locale)
return success(nil) unless draft
return failure(nil, :stale) if !lock_version.nil? && lock_version.to_i != draft.lock_version
diff --git a/spree/core/app/workflows/spree/email_templates/publish.rb b/spree/core/app/workflows/spree/email_templates/publish.rb
index e1b9e0ce2c..d0fedff9b1 100644
--- a/spree/core/app/workflows/spree/email_templates/publish.rb
+++ b/spree/core/app/workflows/spree/email_templates/publish.rb
@@ -30,7 +30,7 @@ module Spree
private
def draft
- @draft ||= store.email_template_drafts.find_by(key: key, locale: locale.presence || Spree::EmailTemplate::ANY_LOCALE)
+ @draft ||= store.email_template_drafts.find_by(key: key, locale: locale)
end
def template
diff --git a/spree/core/app/workflows/spree/email_templates/revert.rb b/spree/core/app/workflows/spree/email_templates/revert.rb
index 6eaf3f21e4..fe2decdeb6 100644
--- a/spree/core/app/workflows/spree/email_templates/revert.rb
+++ b/spree/core/app/workflows/spree/email_templates/revert.rb
@@ -8,9 +8,8 @@ module Spree
class Revert < Spree::Workflow
def perform(store:, key:, locale: Spree::EmailTemplate::ANY_LOCALE, actor: nil, lock_version: nil)
super
- locale_value = locale.presence || Spree::EmailTemplate::ANY_LOCALE
- template = store.email_templates.find_by(key: key, locale: locale_value)
- draft = store.email_template_drafts.find_by(key: key, locale: locale_value)
+ 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
ApplicationRecord.transaction do
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 71a76e7cdb..221977ff3c 100644
--- a/spree/core/app/workflows/spree/email_templates/save_draft.rb
+++ b/spree/core/app/workflows/spree/email_templates/save_draft.rb
@@ -22,7 +22,7 @@ module Spree
private
def draft
- @draft ||= store.email_template_drafts.find_or_initialize_by(key: key, locale: locale.presence || Spree::EmailTemplate::ANY_LOCALE)
+ @draft ||= store.email_template_drafts.find_or_initialize_by(key: key, locale: locale)
end
def ensure_editable
@@ -60,7 +60,7 @@ module Spree
end
def default
- @default ||= Spree::Emails::TemplateResolver.new(Spree::BaseMailer.view_paths.paths.map(&:path)).find_default(key)
+ @default ||= Spree::Emails::TemplateResolver.for_mailers.find_default(key)
end
end
end