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: Hide custom payment source from provider picker (#14810)
Damian Legawiecf15404d95b6c
diff --git a/packages/dashboard/e2e/payment-methods.spec.ts b/packages/dashboard/e2e/payment-methods.spec.tsindex 2973e1b229..a95c7f0774 100644--- a/packages/dashboard/e2e/payment-methods.spec.ts+++ b/packages/dashboard/e2e/payment-methods.spec.ts@@ -42,6 +42,32 @@ test.describe('payment methods', () => {await expect(page.getByText(/dummy secret key/i)).toHaveCount(0)})+ // Runs before create/edit so Check is still in the picker. Custom payment+ // source is hidden from the UI and store credit is seeded — Check is the+ // spare installable provider for this lifecycle test.+ test('deletes a payment method', async ({ page }) => {+ const creds = await login(page)+ await gotoIndex(page, PAYMENT_METHODS_PATH(creds.store_id), CTA)++ const name = `E2E Delete PM ${Date.now()}`++ await page.getByRole('button', { name: /add payment method/i }).click()+ await selectProvider(page, 'Check')+ await page.locator('#name').fill(name)+ await page.getByRole('button', { name: /create payment method/i }).click()+ await expect(rowButton(page, name)).toBeVisible({ timeout: 15_000 })++ await openRowMenu(page, name)+ await page.getByRole('menuitem', { name: /^delete$/i }).click()+ await expect(page.getByRole('heading', { name: /delete payment method\?/i })).toBeVisible()+ await page+ .getByRole('dialog')+ .getByRole('button', { name: /^delete$/i })+ .click()++ await expect(rowButton(page, name)).toHaveCount(0, { timeout: 15_000 })+ })+test('creates a new payment method (Bogus provider)', async ({ page }) => {const creds = await login(page)await gotoIndex(page, PAYMENT_METHODS_PATH(creds.store_id), CTA)@@ -81,28 +107,4 @@ test.describe('payment methods', () => {await expect(rowButton(page, updated)).toBeVisible({ timeout: 15_000 })})-- test('deletes a payment method', async ({ page }) => {- const creds = await login(page)- await gotoIndex(page, PAYMENT_METHODS_PATH(creds.store_id), CTA)-- const name = `E2E Delete PM ${Date.now()}`-- await page.getByRole('button', { name: /add payment method/i }).click()- await selectProvider(page, 'Custom Payment Source Method')- await page.locator('#name').fill(name)- await page.getByRole('button', { name: /create payment method/i }).click()- await expect(rowButton(page, name)).toBeVisible({ timeout: 15_000 })-- // Delete now lives on the row-action kebab.- await openRowMenu(page, name)- await page.getByRole('menuitem', { name: /^delete$/i }).click()- await expect(page.getByRole('heading', { name: /delete payment method\?/i })).toBeVisible()- await page- .getByRole('dialog')- .getByRole('button', { name: /^delete$/i })- .click()-- await expect(rowButton(page, name)).toHaveCount(0, { timeout: 15_000 })- })})diff --git a/packages/dashboard/src/hooks/use-payment-methods.ts b/packages/dashboard/src/hooks/use-payment-methods.tsindex ce6f1bebc7..31842b6a14 100644--- a/packages/dashboard/src/hooks/use-payment-methods.ts+++ b/packages/dashboard/src/hooks/use-payment-methods.ts@@ -12,6 +12,7 @@ import {} from '@spree/dashboard-core'import { useQuery, useQueryClient } from '@tanstack/react-query'import i18n from 'i18next'+import { filterPaymentMethodProviderTypes } from '../schemas/payment-method'export function usePaymentMethodTypes() {// Store-scoped because the server filters out providers already installed@@ -19,7 +20,10 @@ export function usePaymentMethodTypes() {// that +useResourceMutation+ expands to +['payment-methods', storeId, 'types']+.return useQuery({queryKey: useResourceKey('payment-methods', 'types'),- queryFn: () => adminClient.paymentMethods.types(),+ queryFn: async () => {+ const response = await adminClient.paymentMethods.types()+ return { ...response, data: filterPaymentMethodProviderTypes(response.data) }+ },staleTime: Infinity,})}diff --git a/packages/dashboard/src/schemas/payment-method.test.ts b/packages/dashboard/src/schemas/payment-method.test.tsnew file mode 100644index 0000000000..094bb74c4b--- /dev/null+++ b/packages/dashboard/src/schemas/payment-method.test.ts@@ -0,0 +1,18 @@+import { describe, expect, it } from 'vitest'+import { filterPaymentMethodProviderTypes } from './payment-method'++describe('filterPaymentMethodProviderTypes', () => {+ it('removes custom payment source from the provider picker list', () => {+ const types = [+ { type: 'stripe', label: 'Stripe', preference_schema: [] },+ {+ type: 'custom_payment_source_method',+ label: 'Custom Payment Source Method',+ preference_schema: [],+ },+ { type: 'check', label: 'Check', preference_schema: [] },+ ]++ expect(filterPaymentMethodProviderTypes(types).map((t) => t.type)).toEqual(['stripe', 'check'])+ })+})diff --git a/packages/dashboard/src/schemas/payment-method.ts b/packages/dashboard/src/schemas/payment-method.tsindex ad21ed4ff8..cbacb339b2 100644--- a/packages/dashboard/src/schemas/payment-method.ts+++ b/packages/dashboard/src/schemas/payment-method.ts@@ -38,6 +38,14 @@ export const PAYMENT_METHOD_CREATE_DEFAULTS: PaymentMethodFormValues = {type: '',}+/** Wire `type` values that must not appear in the add-payment-method provider picker. */+export const PAYMENT_METHOD_TYPES_HIDDEN_FROM_PICKER = ['custom_payment_source_method'] as const++export function filterPaymentMethodProviderTypes<T extends { type: string }>(types: T[]): T[] {+ const hidden = new Set<string>(PAYMENT_METHOD_TYPES_HIDDEN_FROM_PICKER)+ return types.filter((entry) => !hidden.has(entry.type))+}+export function paymentMethodValuesToCreateParams(v: PaymentMethodFormValues,preferences: Record<string, unknown>,