Files
accounted/extensions/general/shopify/__tests__/api-client.test.ts
T
Mattsson c187fabf92 feat(shopify): Shopify order/refund feed into the transactions inbox (#1474)
* feat(shopify): Shopify order/refund feed into the transactions inbox

New extensions/general/shopify feed extension, modeled on the WooCommerce
feed: connect a Shopify store with Dev Dashboard custom-app client
credentials (client credentials grant, ~24h tokens, never stored), then a
nightly cron + manual sync imports paid orders and refunds via the GraphQL
Admin API (pinned 2026-07) into the transactions inbox on clearing account
1584. Feed-only: nothing auto-books. Zero PII fields are queried, keeping
the app outside Shopify's protected customer data program.

- shopify_connections migration (RLS, revoke-never-delete, encrypted
  client id/secret) + shopify_sync capability and bank_sync-mirrored
  backfill
- frozen external_id scheme shopify_{shop_domain}_order|refund_{id},
  scoped on the shop domain so reconnects never re-import
- cursor sync on updated_at windows with 24h overlap, lock-date drop at
  map time, ingest-failure cursor floor, deadline stop-and-resume,
  revoked-credential flip
- /import card + settings panel, sv/en i18n, cron 03:15 in vercel.json +
  regenerated Docker crontabs, logo, events, panel registry
- 65 unit tests + pg-real RLS test; extensions.schema.json enum also
  gains the missing stripe entry (pre-existing drift)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(shopify): review findings from PR 1474

- token exchange: a 429 that survives every retry is throttling, not a
  credential failure; stop remapping retryable 4xx to 401 so sustained
  throttling can no longer flip the connection to revoked and delete the
  stored credentials (CodeRabbit critical)
- order sync: advance a scanned-through watermark (run start, capped by
  the failure floor) after a fully-listed window, so empty first runs and
  quiet stores rotate to the back of the cron's oldest-first selection
  instead of permanently occupying the 50-connection batch (CodeRabbit
  major, starvation)
- add handler-level tests for the orders cron route (auth 401, disabled
  503, unconfigured no-op, query failure, capability skip, happy path,
  per-connection failure isolation, revoked marking)
- add 401 tests for /sync, /transaction-sync and /disconnect; pin the
  cursor floor rule with a two-order page; stub the encryption key via
  vi.stubEnv
- note in the panel description (sv/en) that orders can mix VAT rates and
  must be split at booking (Swedish review advisory)
- DECISIONS.md: wrap underscore identifiers in backticks (MD037)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-09 12:44:08 +02:00

187 lines
6.6 KiB
TypeScript

import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
import {
normalizeShopDomain,
exchangeAccessToken,
shopifyGraphQL,
listOrdersPage,
isRevokedCredentialsError,
ShopifyApiError,
SHOPIFY_API_VERSION,
SHOPIFY_PAGE_SIZE,
type ShopifyCredentials,
type ShopifySession,
} from '../lib/api-client'
const CREDS: ShopifyCredentials = {
shopDomain: 'minbutik.myshopify.com',
clientId: 'client-id',
clientSecret: 'client-secret',
}
const SESSION: ShopifySession = {
shopDomain: 'minbutik.myshopify.com',
accessToken: 'token-1',
}
function jsonResponse(body: unknown, status = 200): Response {
return new Response(JSON.stringify(body), {
status,
headers: { 'Content-Type': 'application/json' },
})
}
const fetchMock = vi.fn()
beforeEach(() => {
vi.clearAllMocks()
vi.stubGlobal('fetch', fetchMock)
})
afterEach(() => {
vi.unstubAllGlobals()
})
describe('normalizeShopDomain', () => {
it('accepts the full myshopify.com domain in any casing, with or without scheme', () => {
expect(normalizeShopDomain('minbutik.myshopify.com')).toBe('minbutik.myshopify.com')
expect(normalizeShopDomain(' MinButik.MyShopify.com ')).toBe('minbutik.myshopify.com')
expect(normalizeShopDomain('https://minbutik.myshopify.com')).toBe('minbutik.myshopify.com')
expect(normalizeShopDomain('https://minbutik.myshopify.com/admin')).toBe(
'minbutik.myshopify.com',
)
})
it('expands a bare store handle', () => {
expect(normalizeShopDomain('minbutik')).toBe('minbutik.myshopify.com')
})
it('accepts a pasted admin URL', () => {
expect(normalizeShopDomain('https://admin.shopify.com/store/minbutik')).toBe(
'minbutik.myshopify.com',
)
expect(normalizeShopDomain('admin.shopify.com/store/minbutik/settings/apps')).toBe(
'minbutik.myshopify.com',
)
})
it('rejects anything that is not a myshopify.com host (SSRF guard)', () => {
expect(normalizeShopDomain('minbutik.se')).toBeNull()
expect(normalizeShopDomain('192.168.1.1')).toBeNull()
expect(normalizeShopDomain('https://evil.example.com/x.myshopify.com')).toBeNull()
expect(normalizeShopDomain('sub.domain.myshopify.com')).toBeNull()
expect(normalizeShopDomain('')).toBeNull()
// A bare word expands to <word>.myshopify.com, which is Shopify-owned:
// safe by construction, never a private host.
expect(normalizeShopDomain('localhost')).toBe('localhost.myshopify.com')
})
})
describe('exchangeAccessToken', () => {
it('POSTs the client credentials grant and returns the token', async () => {
fetchMock.mockResolvedValueOnce(
jsonResponse({ access_token: 'token-1', expires_in: 86399 }),
)
await expect(exchangeAccessToken(CREDS)).resolves.toBe('token-1')
const [url, init] = fetchMock.mock.calls[0]
expect(url).toBe('https://minbutik.myshopify.com/admin/oauth/access_token')
expect(JSON.parse((init as RequestInit).body as string)).toEqual({
client_id: 'client-id',
client_secret: 'client-secret',
grant_type: 'client_credentials',
})
})
it('classifies a non-retryable 4xx as revoked credentials', async () => {
fetchMock.mockResolvedValueOnce(
jsonResponse({ error: 'invalid_client' }, 400),
)
const error = await exchangeAccessToken(CREDS).catch((e) => e)
expect(error).toBeInstanceOf(ShopifyApiError)
expect(isRevokedCredentialsError(error)).toBe(true)
expect((error as ShopifyApiError).code).toBe('invalid_client')
})
it('does NOT classify sustained throttling (429) as revoked credentials', async () => {
// A persistent 429 that survives every retry is still throttling.
// Classifying it as revoked would delete the stored credentials and force
// the merchant to reconnect over a rate limit.
fetchMock.mockResolvedValue(jsonResponse({}, 429))
const error = await exchangeAccessToken(CREDS).catch((e) => e)
expect(error).toBeInstanceOf(ShopifyApiError)
expect((error as ShopifyApiError).status).toBe(429)
expect(isRevokedCredentialsError(error)).toBe(false)
}, 15_000)
})
describe('shopifyGraphQL', () => {
it('sends the token header against the pinned API version and returns data', async () => {
fetchMock.mockResolvedValueOnce(jsonResponse({ data: { shop: { name: 'Butiken' } } }))
const data = await shopifyGraphQL<{ shop: { name: string } }>(SESSION, 'query { shop { name } }')
expect(data.shop.name).toBe('Butiken')
const [url, init] = fetchMock.mock.calls[0]
expect(url).toBe(
`https://minbutik.myshopify.com/admin/api/${SHOPIFY_API_VERSION}/graphql.json`,
)
expect((init as RequestInit).headers).toMatchObject({
'X-Shopify-Access-Token': 'token-1',
})
})
it('retries a THROTTLED response before surfacing data', async () => {
fetchMock
.mockResolvedValueOnce(
jsonResponse({ errors: [{ message: 'Throttled', extensions: { code: 'THROTTLED' } }] }),
)
.mockResolvedValueOnce(jsonResponse({ data: { ok: true } }))
await expect(shopifyGraphQL(SESSION, 'query { ok }')).resolves.toEqual({ ok: true })
expect(fetchMock).toHaveBeenCalledTimes(2)
}, 15_000)
it('classifies ACCESS_DENIED as revoked (missing scope)', async () => {
fetchMock.mockResolvedValueOnce(
jsonResponse({
errors: [{ message: 'Access denied', extensions: { code: 'ACCESS_DENIED' } }],
}),
)
const error = await shopifyGraphQL(SESSION, 'query { orders }').catch((e) => e)
expect(isRevokedCredentialsError(error)).toBe(true)
})
it('classifies HTTP 401 as revoked without retrying', async () => {
fetchMock.mockResolvedValueOnce(jsonResponse({}, 401))
const error = await shopifyGraphQL(SESSION, 'query { ok }').catch((e) => e)
expect(isRevokedCredentialsError(error)).toBe(true)
expect(fetchMock).toHaveBeenCalledTimes(1)
})
})
describe('listOrdersPage', () => {
it('passes the window filter and cursor and unwraps the connection', async () => {
fetchMock.mockResolvedValueOnce(
jsonResponse({
data: {
orders: {
pageInfo: { hasNextPage: true, endCursor: 'cursor-2' },
nodes: [{ legacyResourceId: '1042', name: '#1042' }],
},
},
}),
)
const page = await listOrdersPage(SESSION, {
updatedAtMin: '2026-05-01T00:00:00.000Z',
after: 'cursor-1',
})
expect(page.hasNextPage).toBe(true)
expect(page.endCursor).toBe('cursor-2')
expect(page.orders).toHaveLength(1)
const body = JSON.parse((fetchMock.mock.calls[0][1] as RequestInit).body as string)
expect(body.variables).toEqual({
first: SHOPIFY_PAGE_SIZE,
after: 'cursor-1',
query: "updated_at:>='2026-05-01T00:00:00.000Z'",
})
})
})