From 9545dd3858506ef19f8d97d17e5e963563dd6ad4 Mon Sep 17 00:00:00 2001 From: "liuxiaohe.io" Date: Tue, 12 May 2026 22:21:14 +0800 Subject: [PATCH] Add fake payment API --- README.md | 13 +++++ bun.lockb | Bin 67071 -> 68519 bytes lib/db/db-client.ts | 104 ++++++++++++++++++++++++++++++++-- lib/db/schema.ts | 27 +++++++++ routes/payments/cancel.ts | 27 +++++++++ routes/payments/complete.ts | 27 +++++++++ routes/payments/get.ts | 25 ++++++++ routes/payments/list.ts | 24 ++++++++ routes/payments/send.ts | 26 +++++++++ tests/routes/payments.test.ts | 72 +++++++++++++++++++++++ 10 files changed, 341 insertions(+), 4 deletions(-) create mode 100644 routes/payments/cancel.ts create mode 100644 routes/payments/complete.ts create mode 100644 routes/payments/get.ts create mode 100644 routes/payments/list.ts create mode 100644 routes/payments/send.ts create mode 100644 tests/routes/payments.test.ts diff --git a/README.md b/README.md index 824427a..cfa5aae 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,16 @@ This is a template project with best-practice modules: - Winterspec for defining the API - bun testing - Zustand store with zod definition for database state + +## Payment API + +The fake payment lifecycle supports the core bounty-payment flow: + +- `POST /payments/send` creates a pending payment record. Include an optional + `idempotency_key` to make retries return the original payment instead of + creating duplicates. +- `GET /payments/list` returns payments, with optional `recipient`, `status`, + and `repository` query filters. +- `GET /payments/get?payment_id=` returns a single payment. +- `POST /payments/complete` marks a payment as completed. +- `POST /payments/cancel` marks a payment as canceled. diff --git a/bun.lockb b/bun.lockb index 557d79cc3b88accaaa0f1f96a19cff1aa0a4aa86..0c63394b12417524c4e11be672b37bb2a08fea50 100755 GIT binary patch delta 3272 zcmZ{mO>7fa5XWuf6vy5qcKn$HIP)H%ARe@T3bt$D_ z3Z*Sn35?Woqx1_(Kjg%LI;Ew!tyKC&59QiJZ=9+e7pW5czc-ugTH09p**kCN&CHvb z_nsf0_g;J7JCk;=x|nJA!~++%cX}S*n$`6H-3|C?F_3V($gPamxbUf=Lj4HoiXtTs zxuYXgHl6TXX z`XIa(>e(xg8Kwrj#zshMVB5lvZaxJVi}yxkmPeHsgERF*@P5WDAvX^k8p!i9UiQJQQtO(F=RQIQVmRJ}%8I7q(fAZ-t8 zVjW>qEgZQNQQ_E2YO0ntMjC|UhzPeJzblamdZ9Z+bxkQ!qntE&N0RlZ^cS^9WXLgh z%$_7YCiP;rxMCc)S0+}AbCfbIaj6@(&o|;rr4^;p5-f$dC<$KFOd=->=a$W2Boy*S zZRu=UvLN%+Bz-iAHCE)eyV;6OZ(i0Fjnr(Gv>64mTWo;`g*~X*S~}Ju@>XaWuhKGv zmRVLciR`Wk$S7+$e`~CEDX+0KMf(^wSxt^DH-?_H%}I)NRFYOxX=|;h@@uVG<+Z`( z8cORnJvGHO<;>|Rvla?EE@hjQ!urkiE+(*&)_^68c5mglimmnzF zr$}WL94)CGj+R7@JDfbrJUPEv(UP`)B}=;Fo8tPFVlo`{Wu7{neB?WwEENZkr_L4g zYQ^-PUO*Yt+qs zt@c>EN$;`k!5+B>d$8~AyCV&|w$nmSC*%&EN$13lO%KTPb`jn2C_S>gx3!EFsct^Y zle?VZRC?s5ak)Zrsf!ujYUUx@%g5Fed=>Os8?V?KsTC9DY${|kw1|WLQE!0nq8M(5 zK84QI^I?|ni}1KO0Q%Tw4d0@D93EdL{rrmWA>EYXobi5}qG1=b0oxnhE|l$pVHY&j zKF2PU?Si3-LbwO{;xPXc404dTt8qP+2dlFf;4ETe8I~UYEoejhUtsGH{}=G!BGhPM zh}%;p2iZ(nvxlsvQnO3PUqM`uSw*x|)-1O;(6Z27YLsQ&&0%=WadfNA8uQU8T2Rkb ztsh;I7@G%T%m;End~N~{P0pp94 z6YvrE0DMT3rJZd*;ps;pf)eq3555K8fji(E`lr-#@)Dj1Tm&=VJh%X+!MorvI04=S zuYM@oW-vOHUjZ1 z-iu%THoowgzaxwF@Mg~Eg(#9s9k=#)=kQRvaO<+i|4^h2pMU=<^)IN=uCWI!pE7^_ zqlc#UADuebzePVhb@0ICzNZf#eDT0uI(@&hMrzXa`(yE5vM+AwJo+< zu}|t_M9!jYoW{OPA9kROHDGnH?M&&*vS8to?&!i9oNnl%WB=dxCGjRRzq#jpIrn_$ zJLi1oUi;AY=)7&RRV}#O)=+RvyBu#SI5;~yHs+)lvrjRd0<2%t6h+Z!mu~0~b}P!b zie~|b9KcojNObIvBxc@?7pK_bR-+Jb0>O3ri#_^oi`!x}bu+%*|wRlE^b<)G5;_>iU z*6^NDbQ>rW`O2s&pEvl3^}FzF#Hxj#o=7S?cL(S&G%_tf$~6AI&)1DQG(ErSd>U zbavC={7WbE53lyOZ2nTUdydO2v4UKgMg%AKf_>&ZHwD7(zVdL57ciYr2W^=@G|UN7wy z>*Z;8!~9V$@zGnsb;I;P&0Qm+-!AqKhGlAVznP>;r6Fnto9pu7O^c>`-wbl zIZq3;a$g;-R$r-BCI(2cNYFYoTP~qy8!rTJ>~SIS)?93}l%O3g+#VApO17J{3Yn+g z=rC!tBOvb7Vn?=g4swK?kNb||p#Y7BBC1QY{7jRB{tER{u+x{>bF@>owrq-YM)MF7 z%$gKs2ig#kD)QzH8B8srVI!L9)n&scMpO~)syFmzY0gi^+eOZ;k*!SCa@TDJnmp@< zSTE^{3I}rciLUGfTJDll6BiYQt_V9bR%)Z6w<^jrh{}a6_;{4Bro!Cu?XcCI8L=L1 zJWpH7)AVku<(_Wt>qz$?rMt6ppO1K>N8YwVy6Q6MWDigC#hz$pT-$r)aEWCXbd=XLs7QjkQgQ+mp0lpV9?G!r}$>bYc|=J z4M%)``uI?M&=(a~+#|Ld*~T=?SH&f?8EBQcgl$0M^F{iKZD$(he5Pg-+nH*oE8C-% zwLrhsB9W)1^0f6l%^cvqo*uCJS{jghi!bFI+wsp>`OGYK$1nM zyLqZRB3G3;JbBUim$Mu2KDz<<*N?~F1Nho^K&6K_Ymr`0+FM=(eV(s@<;)i88?-Im zM9-#M4*iVfCGZRQ75oN%2Y-Nj;0Le>?t+g%5?lozgHOPx;4|XJz!CT;M@D6wvya(O~6W{}I4jjc6&V@}C!;traeINn$gXh2jdUC;EwgnQd zp3(+7KnQfwk%dmrK}gSo7r-ERimorb=;7tz=FY90?xDXgTvC<)0V`owod5s; diff --git a/lib/db/db-client.ts b/lib/db/db-client.ts index e525e65..90ed9ed 100644 --- a/lib/db/db-client.ts +++ b/lib/db/db-client.ts @@ -1,9 +1,14 @@ -import { createStore, type StoreApi } from "zustand/vanilla" +import { type HoistedStoreApi, hoist } from "zustand-hoist" import { immer } from "zustand/middleware/immer" -import { hoist, type HoistedStoreApi } from "zustand-hoist" +import { type StoreApi, createStore } from "zustand/vanilla" -import { databaseSchema, type DatabaseSchema, type Thing } from "./schema.ts" import { combine } from "zustand/middleware" +import { + type Payment, + type PaymentStatus, + type Thing, + databaseSchema, +} from "./schema.ts" export const createDatabase = () => { return hoist(createStore(initializer)) @@ -11,7 +16,25 @@ export const createDatabase = () => { export type DbClient = ReturnType -const initializer = combine(databaseSchema.parse({}), (set) => ({ +type PaymentInput = Omit< + Payment, + | "payment_id" + | "status" + | "created_at" + | "updated_at" + | "completed_at" + | "canceled_at" + | "failed_at" +> + +const statusTimestampField = { + completed: "completed_at", + canceled: "canceled_at", + failed: "failed_at", + pending: undefined, +} as const satisfies Record + +const initializer = combine(databaseSchema.parse({}), (set, get) => ({ addThing: (thing: Omit) => { set((state) => ({ things: [ @@ -21,4 +44,77 @@ const initializer = combine(databaseSchema.parse({}), (set) => ({ idCounter: state.idCounter + 1, })) }, + addPayment: (payment: PaymentInput): Payment => { + const existingPayment = payment.idempotency_key + ? get().payments.find( + (storedPayment) => + storedPayment.idempotency_key === payment.idempotency_key, + ) + : undefined + + if (existingPayment) { + return existingPayment + } + + const now = new Date().toISOString() + const newPayment: Payment = { + ...payment, + payment_id: get().idCounter.toString(), + status: "pending", + created_at: now, + updated_at: now, + } + + set((state) => ({ + payments: [...state.payments, newPayment], + idCounter: state.idCounter + 1, + })) + + return newPayment + }, + getPayment: (payment_id: string): Payment | undefined => { + return get().payments.find((payment) => payment.payment_id === payment_id) + }, + listPayments: ( + filters: Partial>, + ): Payment[] => { + return get().payments.filter((payment) => { + if (filters.recipient && payment.recipient !== filters.recipient) { + return false + } + if (filters.status && payment.status !== filters.status) { + return false + } + if (filters.repository && payment.repository !== filters.repository) { + return false + } + return true + }) + }, + updatePaymentStatus: ( + payment_id: string, + status: Exclude, + ): Payment | undefined => { + const now = new Date().toISOString() + let updatedPayment: Payment | undefined + + set((state) => ({ + payments: state.payments.map((payment) => { + if (payment.payment_id !== payment_id) { + return payment + } + + const timestampField = statusTimestampField[status] + updatedPayment = { + ...payment, + status, + updated_at: now, + ...(timestampField ? { [timestampField]: now } : {}), + } + return updatedPayment + }), + })) + + return updatedPayment + }, })) diff --git a/lib/db/schema.ts b/lib/db/schema.ts index 8377516..67044b6 100644 --- a/lib/db/schema.ts +++ b/lib/db/schema.ts @@ -9,8 +9,35 @@ export const thingSchema = z.object({ }) export type Thing = z.infer +export const paymentStatusSchema = z.enum([ + "pending", + "completed", + "canceled", + "failed", +]) +export type PaymentStatus = z.infer + +export const paymentSchema = z.object({ + payment_id: z.string(), + recipient: z.string(), + amount: z.number().positive(), + currency: z.string(), + status: paymentStatusSchema, + bounty_id: z.string().optional(), + issue_number: z.number().int().positive().optional(), + repository: z.string().optional(), + idempotency_key: z.string().optional(), + created_at: z.string(), + updated_at: z.string(), + completed_at: z.string().optional(), + canceled_at: z.string().optional(), + failed_at: z.string().optional(), +}) +export type Payment = z.infer + export const databaseSchema = z.object({ idCounter: z.number().default(0), things: z.array(thingSchema).default([]), + payments: z.array(paymentSchema).default([]), }) export type DatabaseSchema = z.infer diff --git a/routes/payments/cancel.ts b/routes/payments/cancel.ts new file mode 100644 index 0000000..6e622ec --- /dev/null +++ b/routes/payments/cancel.ts @@ -0,0 +1,27 @@ +import { paymentSchema } from "lib/db/schema" +import { withRouteSpec } from "lib/middleware/with-winter-spec" +import { z } from "zod" + +export default withRouteSpec({ + methods: ["POST"], + jsonBody: z.object({ + payment_id: z.string(), + }), + jsonResponse: z.union([ + z.object({ + payment: paymentSchema, + }), + z.object({ + error: z.string(), + }), + ]), +})(async (req, ctx) => { + const { payment_id } = await req.json() + const payment = ctx.db.updatePaymentStatus(payment_id, "canceled") + + if (!payment) { + return ctx.json({ error: "Payment not found" }, { status: 404 }) + } + + return ctx.json({ payment }) +}) diff --git a/routes/payments/complete.ts b/routes/payments/complete.ts new file mode 100644 index 0000000..1af6be4 --- /dev/null +++ b/routes/payments/complete.ts @@ -0,0 +1,27 @@ +import { paymentSchema } from "lib/db/schema" +import { withRouteSpec } from "lib/middleware/with-winter-spec" +import { z } from "zod" + +export default withRouteSpec({ + methods: ["POST"], + jsonBody: z.object({ + payment_id: z.string(), + }), + jsonResponse: z.union([ + z.object({ + payment: paymentSchema, + }), + z.object({ + error: z.string(), + }), + ]), +})(async (req, ctx) => { + const { payment_id } = await req.json() + const payment = ctx.db.updatePaymentStatus(payment_id, "completed") + + if (!payment) { + return ctx.json({ error: "Payment not found" }, { status: 404 }) + } + + return ctx.json({ payment }) +}) diff --git a/routes/payments/get.ts b/routes/payments/get.ts new file mode 100644 index 0000000..2f898b5 --- /dev/null +++ b/routes/payments/get.ts @@ -0,0 +1,25 @@ +import { paymentSchema } from "lib/db/schema" +import { withRouteSpec } from "lib/middleware/with-winter-spec" +import { z } from "zod" + +export default withRouteSpec({ + methods: ["GET"], + jsonResponse: z.union([ + z.object({ + payment: paymentSchema, + }), + z.object({ + error: z.string(), + }), + ]), +})((req, ctx) => { + const url = new URL(req.url) + const paymentId = url.searchParams.get("payment_id") + const payment = paymentId ? ctx.db.getPayment(paymentId) : undefined + + if (!payment) { + return ctx.json({ error: "Payment not found" }, { status: 404 }) + } + + return ctx.json({ payment }) +}) diff --git a/routes/payments/list.ts b/routes/payments/list.ts new file mode 100644 index 0000000..28e8540 --- /dev/null +++ b/routes/payments/list.ts @@ -0,0 +1,24 @@ +import { paymentSchema, paymentStatusSchema } from "lib/db/schema" +import { withRouteSpec } from "lib/middleware/with-winter-spec" +import { z } from "zod" + +export default withRouteSpec({ + methods: ["GET"], + jsonResponse: z.object({ + payments: z.array(paymentSchema), + }), +})((req, ctx) => { + const url = new URL(req.url) + const statusParam = url.searchParams.get("status") + const status = statusParam + ? paymentStatusSchema.parse(statusParam) + : undefined + + const payments = ctx.db.listPayments({ + recipient: url.searchParams.get("recipient") ?? undefined, + repository: url.searchParams.get("repository") ?? undefined, + status, + }) + + return ctx.json({ payments }) +}) diff --git a/routes/payments/send.ts b/routes/payments/send.ts new file mode 100644 index 0000000..28f4bc5 --- /dev/null +++ b/routes/payments/send.ts @@ -0,0 +1,26 @@ +import { paymentSchema } from "lib/db/schema" +import { withRouteSpec } from "lib/middleware/with-winter-spec" +import { z } from "zod" + +const paymentRequestSchema = z.object({ + recipient: z.string().min(1), + amount: z.number().positive(), + currency: z.string().min(1).default("USD"), + repository: z.string().optional(), + issue_number: z.number().int().positive().optional(), + bounty_id: z.string().optional(), + idempotency_key: z.string().optional(), +}) + +export default withRouteSpec({ + methods: ["POST"], + jsonBody: paymentRequestSchema, + jsonResponse: z.object({ + payment: paymentSchema, + }), +})(async (req, ctx) => { + const paymentRequest = await req.json() + const payment = ctx.db.addPayment(paymentRequest) + + return ctx.json({ payment }) +}) diff --git a/tests/routes/payments.test.ts b/tests/routes/payments.test.ts new file mode 100644 index 0000000..08aa968 --- /dev/null +++ b/tests/routes/payments.test.ts @@ -0,0 +1,72 @@ +import { expect, test } from "bun:test" +import { getTestServer } from "tests/fixtures/get-test-server" + +test("send payment is idempotent and queryable", async () => { + const { axios } = await getTestServer() + + const paymentRequest = { + recipient: "richboyneedcash", + amount: 10, + currency: "USD", + repository: "tscircuit/fake-algora", + issue_number: 1, + bounty_id: "fake-algora-1", + idempotency_key: "issue-1-richboyneedcash", + } + + const firstResponse = await axios.post("/payments/send", paymentRequest) + const replayResponse = await axios.post("/payments/send", paymentRequest) + + expect(replayResponse.data.payment.payment_id).toBe( + firstResponse.data.payment.payment_id, + ) + + const { data: listData } = await axios.get( + "/payments/list?recipient=richboyneedcash&status=pending", + ) + expect(listData.payments).toHaveLength(1) + expect(listData.payments[0]).toMatchObject({ + recipient: "richboyneedcash", + amount: 10, + currency: "USD", + repository: "tscircuit/fake-algora", + issue_number: 1, + status: "pending", + }) +}) + +test("payment lifecycle can be completed or canceled", async () => { + const { axios } = await getTestServer() + + const { data: sentData } = await axios.post("/payments/send", { + recipient: "first-contributor", + amount: 15, + currency: "USD", + repository: "tscircuit/fake-algora", + issue_number: 1, + }) + + const paymentId = sentData.payment.payment_id + + const { data: getData } = await axios.get( + `/payments/get?payment_id=${paymentId}`, + ) + expect(getData.payment.status).toBe("pending") + + const { data: completeData } = await axios.post("/payments/complete", { + payment_id: paymentId, + }) + expect(completeData.payment.status).toBe("completed") + expect(completeData.payment.completed_at).toBeString() + + const { data: cancelSentData } = await axios.post("/payments/send", { + recipient: "second-contributor", + amount: 20, + currency: "USD", + }) + const { data: cancelData } = await axios.post("/payments/cancel", { + payment_id: cancelSentData.payment.payment_id, + }) + expect(cancelData.payment.status).toBe("canceled") + expect(cancelData.payment.canceled_at).toBeString() +})