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: list tests left records that broke other end-to-end specs

Damian Legawiec9e0ebfdf687c
diff --git a/packages/dashboard/e2e/customers-list.spec.ts b/packages/dashboard/e2e/customers-list.spec.ts
index f2bd97b81e..01f45a827d 100644
--- a/packages/dashboard/e2e/customers-list.spec.ts
+++ b/packages/dashboard/e2e/customers-list.spec.ts
@@ -2,11 +2,12 @@ import { expect, type Page, test } from '@playwright/test'
import {
addListFilter,
addTextFilter,
- adminRequest,
+ deleteSeededRecords,
type E2ELoginSession,
gotoIndex,
login,
searchList,
+ seedRecord,
sortList,
} from './helpers'
@@ -34,8 +35,8 @@ async function seedCustomers(page: Page, session: E2ELoginSession) {
last_name: lastName,
accepts_email_marketing: false,
}
- await adminRequest(page, session, 'post', '/customers', subscriber)
- await adminRequest(page, session, 'post', '/customers', other)
+ await seedRecord(page, session, '/customers', subscriber)
+ await seedRecord(page, session, '/customers', other)
return { lastName, subscriber, other }
}
@@ -43,6 +44,8 @@ async function seedCustomers(page: Page, session: E2ELoginSession) {
const row = (page: Page, email: string) => page.getByRole('row').filter({ hasText: email })
test.describe('customers list', () => {
+ test.afterEach(({ page }) => deleteSeededRecords(page))
+
test('searches by name and by email', async ({ page }) => {
const session = await login(page)
const { lastName, subscriber, other } = await seedCustomers(page, session)
diff --git a/packages/dashboard/e2e/helpers.ts b/packages/dashboard/e2e/helpers.ts
index 7d7eec05bc..20d03c0c23 100644
--- a/packages/dashboard/e2e/helpers.ts
+++ b/packages/dashboard/e2e/helpers.ts
@@ -675,3 +675,28 @@ export async function switchAdminLocale(page: Page, locale: string): Promise<()
})
}
}
+
+// Records a list test seeded, deleted after the test so later specs in the
+// shard see the store they expect (the products index's first page, the
+// payment-method picker's providers).
+let seededRecords: { path: string; session: E2ELoginSession }[] = []
+
+/** Creates a record through the Admin API and deletes it after the test. */
+export async function seedRecord<T extends { id: string } = { id: string }>(
+ page: Page,
+ session: E2ELoginSession,
+ path: string,
+ data: object,
+): Promise<T> {
+ const record = await adminRequest<T>(page, session, 'post', path, data)
+ seededRecords.push({ path: `${path}/${record.id}`, session })
+ return record
+}
+
+/** Deletes what {@link seedRecord} created; call from `test.afterEach`. */
+export async function deleteSeededRecords(page: Page) {
+ for (const { path, session } of seededRecords.reverse()) {
+ await adminRequest(page, session, 'delete', path).catch(() => undefined)
+ }
+ seededRecords = []
+}
diff --git a/packages/dashboard/e2e/list-filters.spec.ts b/packages/dashboard/e2e/list-filters.spec.ts
index 79bd1f30eb..e8d14eea01 100644
--- a/packages/dashboard/e2e/list-filters.spec.ts
+++ b/packages/dashboard/e2e/list-filters.spec.ts
@@ -1,5 +1,12 @@
import { expect, type Page, test } from '@playwright/test'
-import { addListFilter, adminRequest, login, narrowQuickFilter, searchList } from './helpers'
+import {
+ addListFilter,
+ deleteSeededRecords,
+ login,
+ narrowQuickFilter,
+ searchList,
+ seedRecord,
+} from './helpers'
// Searches and filters the API used to ignore, so each list came back whole
// while the control said it was narrowed. Each test narrows a list of its own
@@ -8,6 +15,8 @@ import { addListFilter, adminRequest, login, narrowQuickFilter, searchList } fro
const stamp = () => `${Date.now()}`
const row = (page: Page, text: string) => page.getByRole('row').filter({ hasText: text })
+test.afterEach(({ page }) => deleteSeededRecords(page))
+
async function openList(page: Page, path: string, search: RegExp) {
await page.goto(path)
await expect(page.getByPlaceholder(search)).toBeVisible({ timeout: 15_000 })
@@ -20,7 +29,7 @@ test.describe('list filters', () => {
const kept = `https://shop-${id}.example.com`
const other = `https://admin-${id}.example.com`
for (const origin of [kept, other]) {
- await adminRequest(page, session, 'post', '/allowed_origins', { origin })
+ await seedRecord(page, session, '/allowed_origins', { origin })
}
await openList(page, `/${session.store_id}/settings/allowed-origins`, /search by origin/i)
@@ -35,12 +44,12 @@ test.describe('list filters', () => {
const id = stamp()
const active = `E2E Active ${id}`
const inactive = `E2E Inactive ${id}`
- await adminRequest(page, session, 'post', '/payment_methods', {
+ await seedRecord(page, session, '/payment_methods', {
type: 'check',
name: active,
active: true,
})
- await adminRequest(page, session, 'post', '/payment_methods', {
+ await seedRecord(page, session, '/payment_methods', {
type: 'check',
name: inactive,
active: false,
@@ -59,7 +68,7 @@ test.describe('list filters', () => {
test('filters sellers by status', async ({ page }) => {
const session = await login(page)
const name = `E2E Filter Seller ${stamp()}`
- await adminRequest(page, session, 'post', '/sellers', {
+ await seedRecord(page, session, '/sellers', {
name,
contact_email: `filter-seller-${Date.now()}@example.com`,
})
@@ -79,12 +88,12 @@ test.describe('list filters', () => {
const id = stamp()
const swatch = `e2e-swatch-${id}`
const buttons = `e2e-buttons-${id}`
- await adminRequest(page, session, 'post', '/option_types', {
+ await seedRecord(page, session, '/option_types', {
name: swatch,
label: swatch,
kind: 'color_swatch',
})
- await adminRequest(page, session, 'post', '/option_types', {
+ await seedRecord(page, session, '/option_types', {
name: buttons,
label: buttons,
kind: 'buttons',
@@ -109,7 +118,7 @@ test.describe('list filters', () => {
[number, 'number'],
[text, 'short_text'],
]) {
- await adminRequest(page, session, 'post', '/custom_field_definitions', {
+ await seedRecord(page, session, '/custom_field_definitions', {
namespace: 'e2e',
key,
field_type: fieldType,
diff --git a/packages/dashboard/e2e/products-list.spec.ts b/packages/dashboard/e2e/products-list.spec.ts
index e3e2ae7b60..2572de18f4 100644
--- a/packages/dashboard/e2e/products-list.spec.ts
+++ b/packages/dashboard/e2e/products-list.spec.ts
@@ -3,12 +3,14 @@ import {
addRecordFilter,
addTextFilter,
adminRequest,
+ deleteSeededRecords,
type E2ELoginSession,
FIXTURE_PROMO_TAXON,
gotoIndex,
login,
narrowQuickFilter,
searchList,
+ seedRecord,
sortList,
} from './helpers'
@@ -29,7 +31,7 @@ async function seedProducts(page: Page, session: E2ELoginSession) {
`/categories?q[name_eq]=${encodeURIComponent(FIXTURE_PROMO_TAXON)}`,
)
const create = (name: string, status: string, amount: number, extra: object = {}) =>
- adminRequest<{ id: string; default_variant_id: string }>(page, session, 'post', '/products', {
+ seedRecord<{ id: string; default_variant_id: string }>(page, session, '/products', {
name,
status,
prices: [{ amount, currency: 'USD' }],
@@ -57,6 +59,8 @@ async function seedProducts(page: Page, session: E2ELoginSession) {
const row = (page: Page, name: string) => page.getByRole('row').filter({ hasText: name })
test.describe('products list', () => {
+ test.afterEach(({ page }) => deleteSeededRecords(page))
+
test('searches by name and by SKU', async ({ page }) => {
const session = await login(page)
const { stamp, cheap, pricey, draft } = await seedProducts(page, session)