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.

Fix promotion rule/action editor commit timing (V-3575) (#14547)

Damian Legawiec097850e189d4
diff --git a/packages/dashboard/e2e/promotions.spec.ts b/packages/dashboard/e2e/promotions.spec.ts
index 62ecb030e8..b14e043f60 100644
--- a/packages/dashboard/e2e/promotions.spec.ts
+++ b/packages/dashboard/e2e/promotions.spec.ts
@@ -44,9 +44,10 @@ async function cancelEditor(page: Page) {
}
async function saveEditor(page: Page) {
+ // Zero-config rule/action editors label the confirm button "Add"; the rest use "Save".
await page
.getByRole('dialog')
- .getByRole('button', { name: /^save$/i })
+ .getByRole('button', { name: /^(save|add)$/i })
.click()
}
@@ -83,17 +84,15 @@ test.describe('promotions', () => {
await startNewPromotion(page, creds.store_id, name)
- // No-preference rule + action: pick the type to append the draft, then
- // cancel to close the editor (Save is disabled when there's nothing to
- // configure).
+ // No-preference rule + action: confirm in the editor so the row is appended.
await pickRule(page, /^first order$/i)
await expect(page.getByRole('heading', { name: /^first order$/i })).toBeVisible({
timeout: 5_000,
})
- await cancelEditor(page)
+ await saveEditor(page)
await pickAction(page, /^free shipping$/i)
- await cancelEditor(page)
+ await saveEditor(page)
await submitCreate(page, name)
@@ -107,6 +106,25 @@ test.describe('promotions', () => {
await expect(rowButton(page, name)).toBeVisible({ timeout: 15_000 })
})
+ test('cancelling a rule or action editor does not add a row', async ({ page }) => {
+ const creds = await login(page)
+ await gotoIndex(page, PROMOTIONS_PATH(creds.store_id), CTA)
+
+ const name = `E2E Promo Cancel ${Date.now()}`
+ await startNewPromotion(page, creds.store_id, name)
+
+ await pickRule(page, /^first order$/i)
+ await expect(page.getByRole('heading', { name: /^first order$/i })).toBeVisible({
+ timeout: 5_000,
+ })
+ await cancelEditor(page)
+ await expect(page.getByText(/^first order$/i)).toHaveCount(0)
+
+ await pickAction(page, /^free shipping$/i)
+ await cancelEditor(page)
+ await expect(page.getByText(/^free shipping$/i)).toHaveCount(0)
+ })
+
test('removes a rule and an action while editing', async ({ page }) => {
const creds = await login(page)
await gotoIndex(page, PROMOTIONS_PATH(creds.store_id), CTA)
@@ -116,10 +134,10 @@ test.describe('promotions', () => {
await startNewPromotion(page, creds.store_id, name)
await pickRule(page, /^first order$/i)
- await cancelEditor(page)
+ await saveEditor(page)
await pickAction(page, /^free shipping$/i)
- await cancelEditor(page)
+ await saveEditor(page)
await submitCreate(page, name)
diff --git a/packages/dashboard/src/components/spree/promotion-editors/promotion-form.tsx b/packages/dashboard/src/components/spree/promotion-editors/promotion-form.tsx
index f61ac70ecf..26d534ef95 100644
--- a/packages/dashboard/src/components/spree/promotion-editors/promotion-form.tsx
+++ b/packages/dashboard/src/components/spree/promotion-editors/promotion-form.tsx
@@ -623,6 +623,17 @@ function ScheduleCard({ form }: { form: UseFormReturn<PromotionFormValues> }) {
type RulesArray = ReturnType<typeof useFieldArray<PromotionFormValues, 'rules', '_key'>>
type ActionsArray = ReturnType<typeof useFieldArray<PromotionFormValues, 'actions', '_key'>>
+/** Draft held in the editor until Save — nothing is appended to the form on pick. */
+type RuleEditorState =
+ | { mode: 'new'; draft: PromotionRuleFormDraft }
+ | { mode: 'edit'; index: number }
+ | null
+
+type ActionEditorState =
+ | { mode: 'new'; draft: PromotionActionFormDraft }
+ | { mode: 'edit'; index: number }
+ | null
+
function RulesCard({
form,
rulesArray,
@@ -637,7 +648,7 @@ function RulesCard({
const { data: typesData } = usePromotionRuleTypes()
const { defaultCurrency } = useStore()
const [pickerOpen, setPickerOpen] = useState(false)
- const [editingIndex, setEditingIndex] = useState<number | null>(null)
+ const [editorState, setEditorState] = useState<RuleEditorState>(null)
const types = typesData?.data ?? []
// Use `watch` for the row drafts — `rulesArray.fields` is RHF's
@@ -701,7 +712,7 @@ function RulesCard({
<RuleRow
key={field._key}
draft={(watchedRules[index] ?? field) as unknown as PromotionRuleFormDraft}
- onEdit={() => setEditingIndex(index)}
+ onEdit={() => setEditorState({ mode: 'edit', index })}
onRemove={() => rulesArray.remove(index)}
/>
))
@@ -723,22 +734,30 @@ function RulesCard({
onOpenChange={(o) => !o && setPickerOpen(false)}
onPicked={(type) => {
const draft = ruleDraftFromType(type, { currency: defaultCurrency })
- rulesArray.append(draft)
setPickerOpen(false)
- setEditingIndex(rulesArray.fields.length)
+ setEditorState({ mode: 'new', draft })
}}
/>
)}
- {editingIndex !== null && rulesArray.fields[editingIndex] && (
+ {editorState && (
<RuleEditSheet
draft={
- (watchedRules[editingIndex] ??
- rulesArray.fields[editingIndex]) as unknown as PromotionRuleFormDraft
+ editorState.mode === 'new'
+ ? editorState.draft
+ : ((watchedRules[editorState.index] ??
+ rulesArray.fields[editorState.index]) as unknown as PromotionRuleFormDraft)
}
open
- onOpenChange={(o) => !o && setEditingIndex(null)}
- onSave={(next) => rulesArray.update(editingIndex, next)}
+ onOpenChange={(o) => !o && setEditorState(null)}
+ onSave={(next) => {
+ if (editorState.mode === 'new') {
+ rulesArray.append(next)
+ } else {
+ rulesArray.update(editorState.index, next)
+ }
+ setEditorState(null)
+ }}
/>
)}
</CardContent>
@@ -1026,7 +1045,7 @@ function DefaultRuleEditor({ draft, onSave, onClose }: PromotionRuleEditorContex
onSave={handleSave}
onCancel={onClose}
pending={false}
- saveDisabled={!hasPreferences}
+ saveLabel={hasPreferences ? undefined : t('admin.actions.add')}
>
{hasPreferences ? (
<PreferencesForm schema={draft.preference_schema} values={values} onChange={setValues} />
@@ -1055,7 +1074,7 @@ function ActionsCard({
const { data: typesData } = usePromotionActionTypes()
const { defaultCurrency } = useStore()
const [pickerOpen, setPickerOpen] = useState(false)
- const [editingIndex, setEditingIndex] = useState<number | null>(null)
+ const [editorState, setEditorState] = useState<ActionEditorState>(null)
const types = typesData?.data ?? []
// See `RulesCard` — read row drafts from `watch` so unregistered
@@ -1082,7 +1101,7 @@ function ActionsCard({
<ActionRow
key={field._key}
draft={(watchedActions[index] ?? field) as unknown as PromotionActionFormDraft}
- onEdit={() => setEditingIndex(index)}
+ onEdit={() => setEditorState({ mode: 'edit', index })}
onRemove={() => actionsArray.remove(index)}
/>
))
@@ -1102,22 +1121,30 @@ function ActionsCard({
onOpenChange={(o) => !o && setPickerOpen(false)}
onPicked={(type) => {
const draft = actionDraftFromType(type, { currency: defaultCurrency })
- actionsArray.append(draft)
setPickerOpen(false)
- setEditingIndex(actionsArray.fields.length)
+ setEditorState({ mode: 'new', draft })
}}
/>
)}
- {editingIndex !== null && actionsArray.fields[editingIndex] && (
+ {editorState && (
<ActionEditSheet
draft={
- (watchedActions[editingIndex] ??
- actionsArray.fields[editingIndex]) as unknown as PromotionActionFormDraft
+ editorState.mode === 'new'
+ ? editorState.draft
+ : ((watchedActions[editorState.index] ??
+ actionsArray.fields[editorState.index]) as unknown as PromotionActionFormDraft)
}
open
- onOpenChange={(o) => !o && setEditingIndex(null)}
- onSave={(next) => actionsArray.update(editingIndex, next)}
+ onOpenChange={(o) => !o && setEditorState(null)}
+ onSave={(next) => {
+ if (editorState.mode === 'new') {
+ actionsArray.append(next)
+ } else {
+ actionsArray.update(editorState.index, next)
+ }
+ setEditorState(null)
+ }}
/>
)}
</CardContent>
@@ -1284,7 +1311,7 @@ function DefaultActionEditor({ draft, onSave, onClose }: PromotionActionEditorCo
onSave={handleSave}
onCancel={onClose}
pending={false}
- saveDisabled={!hasPreferences}
+ saveLabel={hasPreferences ? undefined : t('admin.actions.add')}
>
{hasPreferences ? (
<PreferencesForm schema={draft.preference_schema} values={values} onChange={setValues} />