feat(zettle): sync paid purchases into webshop_orders (#2445)
Community PR #2416 by @olofpinzke, adopted and finished by maintainers (rebased so every commit is signed). Why the problem occurred: no Zettle integration; POS sales only reached the books as bank descriptors while Woo/Shopify already had order underlag via webshop_orders. The contributor's version also failed at the database (platform CHECKs listed only woocommerce/shopify), which the mocked unit tests never saw. What was simplified: reused the Orders/book/invoice path instead of a new inbox; Finance API payouts/fees deferred. Sales the one-account, revenue-per-rate model cannot book (split tender, gift cards, tips) import unbookable with a "bokför manuellt" title instead of guessing accounts. Reset parity uses the rename-and-wrap pattern instead of re-issuing the reset body. Why this solution: per-purchase rows give the radunderlag BFL verifikat need and the bulk-book path exists; daily kassarapport aggregation and Finance API fees/payouts are the follow-up (DECISIONS.md). Skeptic-refuted paths fixed before merge: concurrent refresh-token rotation (sync claim), cron offset paging (candidate snapshot), platform CHECKs, writer-role gate, migration-reset parity, white-label return origin re-validated at callback, VAT net from product rows. Not live until ZETTLE_CLIENT_ID / ZETTLE_CLIENT_SECRET / ZETTLE_CREDENTIALS_ENCRYPTION_KEY are set on Vercel and a Zettle developer app is registered with the callback redirect URI. Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WtYqzKPoTSRHskYYdf7MwB
This commit is contained in:
Mattsson
co-authored by
Claude Fable 5.1
Claude Fable 5.1
parent
500806f001
commit
6ea92f3152
@@ -0,0 +1,117 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
|
||||
// Each test re-imports the route after vi.resetModules(); the cold import
|
||||
// exceeds the 5 s default under a loaded CI shard.
|
||||
vi.setConfig({ testTimeout: 30_000 })
|
||||
|
||||
const verifyCronSecret = vi.fn((..._args: unknown[]) => null as unknown)
|
||||
vi.mock('@/lib/auth/cron', () => ({
|
||||
verifyCronSecret: (...args: unknown[]) => verifyCronSecret(...args),
|
||||
}))
|
||||
|
||||
const registryGet = vi.fn()
|
||||
vi.mock('@/lib/extensions/loader', () => ({ loadExtensions: vi.fn() }))
|
||||
vi.mock('@/lib/extensions/registry', () => ({
|
||||
extensionRegistry: { get: (...args: unknown[]) => registryGet(...args) },
|
||||
}))
|
||||
|
||||
const rangeResult = vi.fn()
|
||||
vi.mock('@/lib/supabase/service-client', () => ({
|
||||
createServiceRoleClient: vi.fn(() => ({
|
||||
from: () => ({
|
||||
select: () => ({
|
||||
eq: () => ({
|
||||
eq: () => ({
|
||||
order: () => ({
|
||||
range: (...args: unknown[]) => rangeResult(...args),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
})),
|
||||
}))
|
||||
|
||||
const isZettleConfigured = vi.fn((..._args: unknown[]) => true)
|
||||
vi.mock('@/extensions/general/zettle/lib/credentials', () => ({
|
||||
isZettleConfigured: (...args: unknown[]) => isZettleConfigured(...args),
|
||||
}))
|
||||
|
||||
const syncZettlePurchases = vi.fn()
|
||||
vi.mock('@/extensions/general/zettle/lib/order-sync', () => ({
|
||||
syncZettlePurchases: (...args: unknown[]) => syncZettlePurchases(...args),
|
||||
}))
|
||||
|
||||
const hasCapability = vi.fn()
|
||||
vi.mock('@/lib/entitlements/has-capability', () => ({
|
||||
hasCapability: (...args: unknown[]) => hasCapability(...args),
|
||||
}))
|
||||
|
||||
const CONNECTION = { id: 'conn-1', company_id: 'company-1' }
|
||||
|
||||
async function callRoute() {
|
||||
const { GET } = await import('../route')
|
||||
return GET(new Request('https://example.test/api/extensions/zettle/orders/cron'))
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks()
|
||||
vi.resetModules()
|
||||
verifyCronSecret.mockReturnValue(null)
|
||||
registryGet.mockReturnValue({ id: 'zettle' })
|
||||
isZettleConfigured.mockReturnValue(true)
|
||||
hasCapability.mockResolvedValue(true)
|
||||
rangeResult.mockResolvedValue({ data: [CONNECTION], error: null })
|
||||
syncZettlePurchases.mockResolvedValue({
|
||||
fetched: 2,
|
||||
refundsFetched: 0,
|
||||
inserted: 2,
|
||||
updated: 0,
|
||||
unchanged: 0,
|
||||
frozenFlagged: 0,
|
||||
crossMarked: 0,
|
||||
errors: 0,
|
||||
})
|
||||
process.env.NEXT_PUBLIC_SUPABASE_URL = 'https://project.supabase.co'
|
||||
process.env.SUPABASE_SERVICE_ROLE_KEY = 'service-key'
|
||||
})
|
||||
|
||||
describe('GET /api/extensions/zettle/orders/cron', () => {
|
||||
it('returns 503 when the extension is disabled', async () => {
|
||||
registryGet.mockReturnValue(null)
|
||||
const res = await callRoute()
|
||||
expect(res.status).toBe(503)
|
||||
expect(syncZettlePurchases).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('syncs entitled active connections', async () => {
|
||||
const res = await callRoute()
|
||||
expect(res.status).toBe(200)
|
||||
expect(syncZettlePurchases).toHaveBeenCalled()
|
||||
const body = await res.json()
|
||||
expect(body.processed).toBe(1)
|
||||
expect(body.inserted).toBe(2)
|
||||
})
|
||||
|
||||
it('pages past a front of non-entitled connections so entitled ones still sync', async () => {
|
||||
// Old limit(50) before hasCapability starved eligible rows behind 50 skips.
|
||||
const notEntitled = Array.from({ length: 50 }, (_, i) => ({
|
||||
id: `skip-${i}`,
|
||||
company_id: `co-skip-${i}`,
|
||||
}))
|
||||
const entitled = { id: 'conn-entitled', company_id: 'company-entitled' }
|
||||
rangeResult.mockResolvedValue({ data: [...notEntitled, entitled], error: null })
|
||||
hasCapability.mockImplementation(async (_sb: unknown, companyId: string) => {
|
||||
return companyId === 'company-entitled'
|
||||
})
|
||||
|
||||
const res = await callRoute()
|
||||
expect(res.status).toBe(200)
|
||||
const body = await res.json()
|
||||
expect(body.processed).toBe(1)
|
||||
expect(syncZettlePurchases).toHaveBeenCalledTimes(1)
|
||||
expect(syncZettlePurchases.mock.calls[0][1]).toMatchObject(entitled)
|
||||
// Skips must not touch last_order_synced_at (purchase recovery cursor).
|
||||
expect(rangeResult).toHaveBeenCalledWith(0, 99)
|
||||
})
|
||||
})
|
||||
@@ -0,0 +1,156 @@
|
||||
import { createServiceRoleClient } from '@/lib/supabase/service-client'
|
||||
import { NextResponse } from 'next/server'
|
||||
import { withCronContext } from '@/lib/api/with-cron-context'
|
||||
import { errorResponse, errorResponseFromCode } from '@/lib/errors/get-structured-error'
|
||||
import { hasCapability } from '@/lib/entitlements/has-capability'
|
||||
import { CAPABILITY } from '@/lib/entitlements/keys'
|
||||
import { loadExtensions } from '@/lib/extensions/loader'
|
||||
import { extensionRegistry } from '@/lib/extensions/registry'
|
||||
import { isZettleConfigured } from '@/extensions/general/zettle/lib/credentials'
|
||||
import { syncZettlePurchases } from '@/extensions/general/zettle/lib/order-sync'
|
||||
import type { ZettleConnection } from '@/extensions/general/zettle/types'
|
||||
|
||||
export const maxDuration = 300
|
||||
|
||||
/** Cap of entitled connections synced per cron invocation. */
|
||||
const MAX_SYNCED = 50
|
||||
/** Page size when scanning candidates ordered by purchase cursor. */
|
||||
const CANDIDATE_PAGE_SIZE = 100
|
||||
/** Hard stop so a flood of non-entitled rows cannot burn the whole budget scanning. */
|
||||
const MAX_CANDIDATES_SCANNED = 2000
|
||||
|
||||
/**
|
||||
* GET /api/extensions/zettle/orders/cron
|
||||
* Nightly purchase sync for connections that opted in (transaction_sync_enabled):
|
||||
* upserts each connected org's paid purchases and refunds into webshop_orders.
|
||||
*
|
||||
* Candidates are paged by last_order_synced_at. Entitlement skips do not advance
|
||||
* that cursor (it controls purchase recovery) and do not consume the sync cap,
|
||||
* so a front of non-entitled rows cannot starve eligible connections behind them.
|
||||
*/
|
||||
export const GET = withCronContext('cron.zettle_order_sync', async (_request, ctx) => {
|
||||
loadExtensions()
|
||||
if (!extensionRegistry.get('zettle')) {
|
||||
ctx.log.warn('zettle extension is not enabled; cron refused')
|
||||
return NextResponse.json(
|
||||
{ error: 'Zettle extension is not enabled', code: 'EXTENSION_DISABLED' },
|
||||
{ status: 503 },
|
||||
)
|
||||
}
|
||||
|
||||
const supabaseUrl = process.env.NEXT_PUBLIC_SUPABASE_URL
|
||||
const supabaseServiceKey = process.env.SUPABASE_SERVICE_ROLE_KEY
|
||||
|
||||
if (!supabaseUrl || !supabaseServiceKey) {
|
||||
return errorResponseFromCode('INTERNAL_ERROR', ctx.log, {
|
||||
requestId: ctx.requestId,
|
||||
details: { reason: 'Missing Supabase configuration' },
|
||||
})
|
||||
}
|
||||
if (!isZettleConfigured()) {
|
||||
return NextResponse.json({ message: 'Zettle not configured', processed: 0 })
|
||||
}
|
||||
|
||||
const supabase = createServiceRoleClient(supabaseUrl, supabaseServiceKey)
|
||||
|
||||
const startTime = Date.now()
|
||||
const TIME_BUDGET_MS = 240_000
|
||||
const deadlineMs = startTime + TIME_BUDGET_MS
|
||||
|
||||
const results: Array<{
|
||||
connectionId: string
|
||||
inserted: number
|
||||
updated: number
|
||||
status: 'synced' | 'revoked' | 'locked' | 'error'
|
||||
}> = []
|
||||
|
||||
// Snapshot the candidate list BEFORE syncing any of it. Each sync moves its
|
||||
// row's last_order_synced_at to "now" (to the tail of this ordering), so
|
||||
// paging with a live offset would re-fetch already-synced rows on page 2
|
||||
// and never reach the eligible rows that slid into the gap.
|
||||
const candidates: ZettleConnection[] = []
|
||||
for (let offset = 0; offset < MAX_CANDIDATES_SCANNED; offset += CANDIDATE_PAGE_SIZE) {
|
||||
const { data: page, error: connError } = await supabase
|
||||
.from('zettle_connections')
|
||||
.select('*')
|
||||
.eq('status', 'active')
|
||||
.eq('transaction_sync_enabled', true)
|
||||
.order('last_order_synced_at', { ascending: true, nullsFirst: true })
|
||||
.range(offset, offset + CANDIDATE_PAGE_SIZE - 1)
|
||||
|
||||
if (connError) {
|
||||
ctx.log.error('failed to fetch zettle connections', connError, {
|
||||
message: connError.message,
|
||||
code: connError.code,
|
||||
})
|
||||
return errorResponse(connError, ctx.log, { requestId: ctx.requestId })
|
||||
}
|
||||
|
||||
if (!page || page.length === 0) break
|
||||
candidates.push(...(page as ZettleConnection[]))
|
||||
if (page.length < CANDIDATE_PAGE_SIZE) break
|
||||
}
|
||||
|
||||
let scanned = 0
|
||||
for (const connection of candidates) {
|
||||
if (results.length >= MAX_SYNCED) break
|
||||
if (Date.now() >= deadlineMs) {
|
||||
ctx.log.info('time budget reached', { processedSoFar: results.length, scanned })
|
||||
break
|
||||
}
|
||||
scanned += 1
|
||||
|
||||
if (!(await hasCapability(supabase, connection.company_id, CAPABILITY.zettle_sync))) {
|
||||
ctx.log.info('skip: capability not entitled', { companyId: connection.company_id })
|
||||
continue
|
||||
}
|
||||
|
||||
try {
|
||||
const summary = await syncZettlePurchases(supabase, connection, ctx.log, deadlineMs)
|
||||
if (summary.locked) {
|
||||
// A manual sync holds the claim; it will advance the cursor itself.
|
||||
results.push({ connectionId: connection.id, inserted: 0, updated: 0, status: 'locked' })
|
||||
continue
|
||||
}
|
||||
if (summary.deadlineReached) {
|
||||
ctx.log.info('connection stopped early on time budget; remaining rows resume next run', {
|
||||
connectionId: connection.id,
|
||||
})
|
||||
}
|
||||
results.push({
|
||||
connectionId: connection.id,
|
||||
inserted: summary.inserted,
|
||||
updated: summary.updated,
|
||||
status: summary.revoked ? 'revoked' : 'synced',
|
||||
})
|
||||
} catch (error) {
|
||||
ctx.log.error('zettle purchase sync failed for connection', error as Error, {
|
||||
connectionId: connection.id,
|
||||
companyId: connection.company_id,
|
||||
})
|
||||
results.push({
|
||||
connectionId: connection.id,
|
||||
inserted: 0,
|
||||
updated: 0,
|
||||
status: 'error',
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
if (candidates.length === 0) {
|
||||
return NextResponse.json({
|
||||
message: 'No connections with transaction sync enabled',
|
||||
processed: 0,
|
||||
})
|
||||
}
|
||||
|
||||
const totalInserted = results.reduce((acc, r) => acc + r.inserted, 0)
|
||||
ctx.log.info('zettle purchase sync summary', {
|
||||
processed: results.length,
|
||||
scanned,
|
||||
totalInserted,
|
||||
failed: results.filter((r) => r.status === 'error').length,
|
||||
})
|
||||
|
||||
return NextResponse.json({ processed: results.length, inserted: totalInserted, results })
|
||||
})
|
||||
Reference in New Issue
Block a user