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
Fix: first draft save could overwrite another admin's draft, and previews dropped the subject
Damian Legawiec819008632d7d
diff --git a/packages/admin-sdk/src/params.ts b/packages/admin-sdk/src/params.tsindex 4ae634e3f3..ff393f5021 100644--- a/packages/admin-sdk/src/params.ts+++ b/packages/admin-sdk/src/params.ts@@ -3161,8 +3161,12 @@ export type EmailTemplateVersionParams = EmailTemplateLanguageParams & {export interface EmailTemplateDraftParams extends EmailTemplateLanguageParams {subject?: string | nullbody?: string- /** The `lock_version` the draft was loaded with. A save from an older copy is refused with 409. */- lock_version?: number+ /**+ * The `lock_version` the draft was loaded with, or `null` when there was no+ * draft; a save from an older copy is refused with 409. Omit it to save+ * without checking.+ */+ lock_version?: number | null/** Marks the draft as based on Spree's current default, after reviewing what changed in it. */rebase?: boolean}@@ -3188,6 +3192,6 @@ export interface EmailTemplatePreviewParams extends EmailTemplateLanguageParams}export interface EmailTemplateRestoreParams extends EmailTemplateLanguageParams {- /** The open draft's `lock_version`, when there is one. */- lock_version?: number+ /** The open draft's `lock_version`, or `null` when there is none; checked as when saving. */+ lock_version?: number | null}diff --git a/packages/dashboard/src/hooks/use-email-templates.ts b/packages/dashboard/src/hooks/use-email-templates.tsindex 922d3def18..443aa7c6b6 100644--- a/packages/dashboard/src/hooks/use-email-templates.ts+++ b/packages/dashboard/src/hooks/use-email-templates.ts@@ -95,7 +95,7 @@ export function useRestoreEmailTemplateRevision(id: string) {return useResourceMutation<EmailTemplate,Error,- { revisionId: string; language: string; lock_version?: number }+ { revisionId: string; language: string; lock_version?: number | null }>({mutationFn: ({ revisionId, ...params }) =>adminClient.emailTemplates.revisions.restore(id, revisionId, params),diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/$templateId.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/$templateId.tsxindex e18c6387d2..17265622ec 100644--- a/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/$templateId.tsx+++ b/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/$templateId.tsx@@ -237,7 +237,8 @@ function EmailTemplateEditor({language,body: version.body,...(isEmail ? { subject: version.subject } : {}),- lock_version: 'lockVersion' in extra ? extra.lockVersion : lockVersion,+ // null says this editor saw no draft, so one someone saved since is not overwritten.+ lock_version: ('lockVersion' in extra ? extra.lockVersion : lockVersion) ?? null,rebase: extra.rebase,})// Keep what is being typed: only the saved copy moves on.@@ -319,7 +320,7 @@ function EmailTemplateEditor({},() =>// Restored into this language's draft, even from the shared version's history.- restore.mutateAsync({ revisionId, language, lock_version: lockVersion }),+ restore.mutateAsync({ revisionId, language, lock_version: lockVersion ?? null }),)if (restored) setHistoryOpen(false)}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.rbindex 04c1121752..8318d18bad 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@@ -21,7 +21,8 @@ module Spree).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], locale: language+ revision: revision, actor: current_actor, locale: language,+ draft_version: params.key?(:lock_version) ? { lock_version: params[:lock_version] } : {})render_email_template_result(result, status: :created)enddiff --git a/spree/core/app/services/spree/email_templates/preview.rb b/spree/core/app/services/spree/email_templates/preview.rbindex a375c2859b..ccfe6f9d2c 100644--- a/spree/core/app/services/spree/email_templates/preview.rb+++ b/spree/core/app/services/spree/email_templates/preview.rb@@ -73,7 +73,9 @@ module Spreedef draftsreturn {} if @body.nil?- { @key => Spree::Emails::Template.new(key: @key, subject: @subject, body: @body) }+ # A body sent alone keeps the subject customers currently get.+ subject = @subject.nil? ? Spree::Emails::TemplateResolver.for_mailers(store: @store, locale: language).find(@key)&.subject : @subject+ { @key => Spree::Emails::Template.new(key: @key, subject: subject, body: @body) }enddef languagediff --git a/spree/core/app/workflows/spree/email_templates/restore_revision.rb b/spree/core/app/workflows/spree/email_templates/restore_revision.rbindex 63f24d27f6..3464efbf43 100644--- a/spree/core/app/workflows/spree/email_templates/restore_revision.rb+++ b/spree/core/app/workflows/spree/email_templates/restore_revision.rb@@ -4,13 +4,14 @@ module Spree# published like any other change. A revision of the version for every# language can be restored into one language's draft (`locale`).class RestoreRevision < Spree::Workflow- def perform(revision:, actor: nil, lock_version: nil, locale: nil)+ # @param draft_version [Hash] `{ lock_version: }` to check the draft as saving does; empty checks nothing+ def perform(revision:, actor: nil, locale: nil, draft_version: {})supertemplate = revision.email_templateSpree.email_template_save_draft_workflow.call(store: template.store, key: template.key, locale: locale.presence || template.locale, actor: actor,- attributes: { subject: revision.subject, body: revision.body, lock_version: lock_version }+ attributes: { subject: revision.subject, body: revision.body, **draft_version.slice(:lock_version) })endenddiff --git a/spree/core/app/workflows/spree/email_templates/save_draft.rb b/spree/core/app/workflows/spree/email_templates/save_draft.rbindex 445198a6b5..fc72508b39 100644--- a/spree/core/app/workflows/spree/email_templates/save_draft.rb+++ b/spree/core/app/workflows/spree/email_templates/save_draft.rb@@ -29,12 +29,18 @@ module Spreefailure(nil, :not_editable) unless Spree.editable_email_templates.include?(key)end+ # Without `lock_version` nothing is checked. `nil` says the caller saw no+ # draft, so one saved since is refused rather than overwritten.def ensure_current- expected = attributes[:lock_version]- return if expected.nil?+ return unless attributes.key?(:lock_version)- # 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+ expected = attributes[:lock_version]+ if expected.nil?+ failure(nil, :stale) if draft.persisted?+ elsif draft.new_record? || expected.to_i != draft.lock_version+ # A draft that is gone was published or discarded since it was loaded.+ failure(nil, :stale)+ endenddef savediff --git a/spree/core/spec/services/spree/email_templates/preview_spec.rb b/spree/core/spec/services/spree/email_templates/preview_spec.rbindex 50054ab789..fe816f5c9a 100644--- a/spree/core/spec/services/spree/email_templates/preview_spec.rb+++ b/spree/core/spec/services/spree/email_templates/preview_spec.rb@@ -23,4 +23,11 @@ describe Spree::EmailTemplates::Preview doexpect(email.html).to include('LAYOUT DRAFT')end++ it 'keeps the current subject when only a body is sent' do+ email = described_class.new(store: store, key: editable_key,+ body: '<mj-section><mj-column><mj-text>Body only</mj-text></mj-column></mj-section>').call++ expect(email.subject).to be_present+ endenddiff --git a/spree/core/spec/workflows/spree/email_templates/save_draft_spec.rb b/spree/core/spec/workflows/spree/email_templates/save_draft_spec.rbindex d8efdbf607..44bf5ea11b 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@@ -75,6 +75,13 @@ describe Spree::EmailTemplates::SaveDraft doexpect(save({ body: 'mine', lock_version: 3 }).error.value).to eq(:stale)end+ it 'refuses a first save when someone else started a draft since the caller saw none' do+ save({ body: 'theirs' })++ expect(save({ body: 'mine', lock_version: nil }).error.value).to eq(:stale)+ expect(store.email_template_drafts.sole.body).to eq('theirs')+ end+it 'refuses a template merchants may not edit' doresult = described_class.new.call(store: store, key: 'spree/webhook_mailer/endpoint_disabled', attributes: { body: 'x' })