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: seller panel sidebar stayed empty on a cold start

Claude291238dfc0b0
diff --git a/.changeset/seller-panel-cold-start-permissions.md b/.changeset/seller-panel-cold-start-permissions.md
new file mode 100644
index 0000000000..823c12dd37
--- /dev/null
+++ b/.changeset/seller-panel-cold-start-permissions.md
@@ -0,0 +1,6 @@
+---
+"@spree/dashboard-core": patch
+"@spree/seller-dashboard": patch
+---
+
+Fixed the seller panel opening with an empty sidebar when a seller returned with a live session but no remembered seller, for example after the browser cleared site storage. The panel now loads the seller's permissions once it knows which seller is active.
diff --git a/packages/dashboard-core/src/providers/permission-provider.tsx b/packages/dashboard-core/src/providers/permission-provider.tsx
index f3e3d40882..a50bdbf327 100644
--- a/packages/dashboard-core/src/providers/permission-provider.tsx
+++ b/packages/dashboard-core/src/providers/permission-provider.tsx
@@ -121,7 +121,13 @@ export function PermissionProvider({ children }: { children: ReactNode }) {
// forever. Depend on the tenant id (a string) and rebuild the key inside.
const tenantId = useTenantId()
const refresh = useCallback(async () => {
- await queryClient.invalidateQueries({ queryKey: [PERMISSIONS_RESOURCE, tenantId] })
+ const permissionsKey = [PERMISSIONS_RESOURCE, tenantId]
+ // A refresh asks for the rules as they stand now. A first fetch still in
+ // flight was sent before — in the seller panel, before any seller was
+ // chosen — and with nothing cached TanStack hands that same fetch back
+ // rather than starting another, so it is cancelled first.
+ await queryClient.cancelQueries({ queryKey: permissionsKey })
+ await queryClient.invalidateQueries({ queryKey: permissionsKey })
}, [queryClient, tenantId])
const permissions = useMemo(
diff --git a/packages/dashboard/e2e/global-setup.ts b/packages/dashboard/e2e/global-setup.ts
index ab74c033e3..371e8eb5f4 100644
--- a/packages/dashboard/e2e/global-setup.ts
+++ b/packages/dashboard/e2e/global-setup.ts
@@ -25,6 +25,7 @@ import {
FIXTURE_LEDGER_OWED_AMOUNT,
FIXTURE_LEDGER_PAYOUT_AMOUNT,
FIXTURE_LEDGER_SELLER,
+ FIXTURE_PANEL_SELLER,
FIXTURE_PROMO_CUSTOMER_EMAIL,
FIXTURE_PROMO_CUSTOMER_FIRST_NAME,
FIXTURE_PROMO_CUSTOMER_FULL_NAME,
@@ -33,6 +34,9 @@ import {
FIXTURE_PROMO_SKU,
FIXTURE_PROMO_TAXON,
FIXTURE_PROMO_TAXON_PERMALINK,
+ FIXTURE_SELLER_PASSWORD,
+ FIXTURE_SELLER_USER_EMAIL,
+ FIXTURE_SELLER_WRITER_EMAIL,
FIXTURE_SUPPLIER,
FIXTURE_TRANSFER_DESTINATION,
FIXTURE_TRANSFER_PRODUCT,
@@ -129,6 +133,15 @@ const BOOTSTRAP_RUBY = [
`ledger_seller.seller_payouts.where(amount: ${FIXTURE_LEDGER_OWED_AMOUNT}).first_or_create!(store: s, currency: s.default_currency, provider: Spree::PayoutProvider::System.provider_key, status: 'pending')`,
`ledger_order = s.orders.where(seller: ledger_seller).first || Spree::Order.create!(store: s, seller: ledger_seller, currency: s.default_currency, email: '[email protected]', status: 'placed', completed_at: Time.current)`,
`ledger_seller.seller_transfers.first_or_create!(store: s, order: ledger_order, payout: ledger_payout, amount: ${FIXTURE_LEDGER_PAYOUT_AMOUNT}, currency: s.default_currency, kind: 'earning', provider: Spree::PayoutProvider::System.provider_key, status: 'completed')`,
+ // Seller panel accounts. One runs the ledger seller, whose sale and payouts
+ // give the read-only panel screens something to show; the other runs a
+ // seller of its own that the specs editing a profile, policy or team may
+ // change freely. One seller each, so neither lands on the seller picker.
+ `seller_user = Spree.admin_user_class.where(email: '${FIXTURE_SELLER_USER_EMAIL}').first_or_create! { |u| u.password = '${FIXTURE_SELLER_PASSWORD}'; u.password_confirmation = '${FIXTURE_SELLER_PASSWORD}'; u.first_name = 'Lee'; u.last_name = 'Ledger' }`,
+ 'ledger_seller.add_user(seller_user)',
+ `panel_seller = s.sellers.where(name: '${FIXTURE_PANEL_SELLER}').first_or_create!`,
+ `seller_writer = Spree.admin_user_class.where(email: '${FIXTURE_SELLER_WRITER_EMAIL}').first_or_create! { |u| u.password = '${FIXTURE_SELLER_PASSWORD}'; u.password_confirmation = '${FIXTURE_SELLER_PASSWORD}'; u.first_name = 'Pat'; u.last_name = 'Panel' }`,
+ 'panel_seller.add_user(seller_writer)',
// Inventory operations: a second warehouse to transfer into, a stocked
// product to send, and a supplier to order from. A transfer cannot be
// created from its own screens without two warehouses.
diff --git a/packages/dashboard/e2e/helpers.ts b/packages/dashboard/e2e/helpers.ts
index 1db552e1df..67473bf05c 100644
--- a/packages/dashboard/e2e/helpers.ts
+++ b/packages/dashboard/e2e/helpers.ts
@@ -178,6 +178,21 @@ export const FIXTURE_LEDGER_PAYOUT_AMOUNT = '120.0'
*/
export const FIXTURE_LEDGER_OWED_AMOUNT = '75.0'
+/**
+ * Seller panel accounts. `FIXTURE_SELLER_USER_EMAIL` runs the ledger seller, so
+ * the panel's read-only screens have a sale and payouts to show;
+ * `FIXTURE_SELLER_WRITER_EMAIL` runs `FIXTURE_PANEL_SELLER`, which the specs
+ * that edit a profile, policy or team may change without moving what another
+ * spec reads.
+ */
+export const FIXTURE_SELLER_USER_EMAIL = '[email protected]'
+export const FIXTURE_SELLER_WRITER_EMAIL = '[email protected]'
+export const FIXTURE_SELLER_PASSWORD = 'spree123'
+export const FIXTURE_PANEL_SELLER = 'E2E Panel Seller'
+
+/** The marketplace seller panel, its own app on its own origin (see playwright.config.ts). */
+export const SELLER_PANEL = `http://localhost:${process.env.E2E_SELLER_VITE_PORT || '5175'}`
+
export const FIXTURE_PROMO_CUSTOMER_EMAIL = '[email protected]'
export const FIXTURE_PROMO_CUSTOMER_FIRST_NAME = 'Promo'
export const FIXTURE_PROMO_CUSTOMER_FULL_NAME = 'Promo Customer'
@@ -242,6 +257,28 @@ export async function login(page: Page): Promise<E2ELoginSession> {
return { ...creds, accessToken }
}
+/**
+ * The seller panel's counterpart to `login`: signs in through the Seller API,
+ * then opens the panel and waits until it has settled on the seller's own
+ * home — the same single-use refresh-cookie race `login` guards against.
+ *
+ * @returns The seller panel URL of the seller's home, e.g. `.../sel_x`.
+ */
+export async function sellerLogin(
+ page: Page,
+ email: string = FIXTURE_SELLER_USER_EMAIL,
+): Promise<string> {
+ const res = await page.request.post(`${SELLER_PANEL}/api/v3/seller/auth/login`, {
+ data: { email, password: FIXTURE_SELLER_PASSWORD },
+ })
+ if (!res.ok()) {
+ throw new Error(`Seller API login failed with ${res.status()}: ${await res.text()}`)
+ }
+ await page.goto(SELLER_PANEL)
+ await expect(page).toHaveURL(/\/sel_[^/]+$/, { timeout: 20_000 })
+ return page.url()
+}
+
/**
* Navigate to a resource index page and wait for it to settle. Every new
* spec needs the same shape: visit the URL, wait for the page's primary
diff --git a/packages/dashboard/e2e/seller-panel-home.spec.ts b/packages/dashboard/e2e/seller-panel-home.spec.ts
new file mode 100644
index 0000000000..977e3b4ce0
--- /dev/null
+++ b/packages/dashboard/e2e/seller-panel-home.spec.ts
@@ -0,0 +1,83 @@
+import { expect, test } from '@playwright/test'
+import {
+ FIXTURE_LEDGER_SELLER,
+ FIXTURE_SELLER_PASSWORD,
+ FIXTURE_SELLER_USER_EMAIL,
+ SELLER_PANEL,
+ sellerLogin,
+} from './helpers'
+
+test.describe('seller panel — signing in', () => {
+ test('signs in with the form and lands on the seller home', async ({ page }) => {
+ await page.goto(`${SELLER_PANEL}/login`)
+ await page.getByLabel(/^email$/i).fill(FIXTURE_SELLER_USER_EMAIL)
+ await page.getByLabel(/^password$/i).fill(FIXTURE_SELLER_PASSWORD)
+ await page.getByRole('button', { name: /^sign in$/i }).click()
+
+ await expect(page).toHaveURL(/\/sel_[^/]+$/, { timeout: 20_000 })
+ await expect(
+ page.getByRole('heading', { name: `Hello, ${FIXTURE_LEDGER_SELLER}` }),
+ ).toBeVisible()
+ })
+
+ test('refuses a wrong password', async ({ page }) => {
+ await page.goto(`${SELLER_PANEL}/login`)
+ await page.getByLabel(/^email$/i).fill(FIXTURE_SELLER_USER_EMAIL)
+ await page.getByLabel(/^password$/i).fill('not-the-password')
+ await page.getByRole('button', { name: /^sign in$/i }).click()
+
+ await expect(page.getByText(/did not match a seller account/i)).toBeVisible({
+ timeout: 15_000,
+ })
+ await expect(page).toHaveURL(/\/login/)
+ })
+
+ test('sends a password reset link', async ({ page }) => {
+ await page.goto(`${SELLER_PANEL}/login`)
+ await page.getByRole('link', { name: /forgot your password/i }).click()
+
+ await page.getByLabel(/^email$/i).fill(FIXTURE_SELLER_USER_EMAIL)
+ await page.getByRole('button', { name: /send reset link/i }).click()
+
+ await expect(page.getByRole('heading', { name: /check your email/i })).toBeVisible({
+ timeout: 15_000,
+ })
+ })
+
+ test('signs out back to the sign-in page', async ({ page }) => {
+ await sellerLogin(page)
+
+ await page.getByRole('button', { name: /user menu/i }).click()
+ await page.getByRole('menuitem', { name: /sign out|log out/i }).click()
+
+ await expect(page).toHaveURL(/\/login/, { timeout: 15_000 })
+ // The session is gone, not just the page: going back in asks again.
+ await page.goto(SELLER_PANEL)
+ await expect(page).toHaveURL(/\/login/, { timeout: 15_000 })
+ })
+})
+
+test.describe('seller panel — home', () => {
+ // `sellerLogin` opens the panel with a session but no remembered seller —
+ // the cold start where the sidebar used to stay empty, because permissions
+ // were fetched before a seller was chosen and never again.
+ test('shows where the seller stands, and each section is a click away', async ({ page }) => {
+ await sellerLogin(page)
+
+ await expect(page.getByText(/^status$/i)).toBeVisible()
+ await expect(page.getByText(/^approved$/i).first()).toBeVisible()
+ await expect(page.getByText(/^team members$/i)).toBeVisible()
+
+ for (const [link, heading] of [
+ [/^products$/i, /^products$/i],
+ [/^orders$/i, /^orders$/i],
+ [/^earnings$/i, /^earnings$/i],
+ [/^payouts$/i, /^payouts$/i],
+ ] as const) {
+ await page.getByRole('link', { name: link }).first().click()
+ await expect(page.getByRole('heading', { name: heading, level: 1 })).toBeVisible({
+ timeout: 15_000,
+ })
+ }
+ })
+})