Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .changeset/browser-purchase-revisions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
"@sapiom/core": minor
"@sapiom/fetch": patch
"@sapiom/axios": patch
"@sapiom/node-http": patch
"@sapiom/mcp": patch
---

Add versioned browser purchase updates with stable idempotency keys. Polling returns `needs_revision` with actionable reasons, and HTTP adapters block that policy decision even in failureMode open. Updates require the backend browser revision release and do not edit the merchant's cart.

HTTP adapters stop on either the revision status or the revise action, including Fetch's on-demand transaction creation after an HTTP 402, before further authorization or retry.
160 changes: 159 additions & 1 deletion packages/axios/src/failureMode.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@
import axios, { AxiosInstance } from "axios";
import MockAdapter from "axios-mock-adapter";
import { withSapiom } from "./axios";
import { SapiomClient, TransactionAPI } from "@sapiom/core";
import {
SapiomClient,
TransactionAPI,
TransactionRevisionRequiredError,
} from "@sapiom/core";

describe("Axios failureMode", () => {
let axiosInstance: AxiosInstance;
Expand All @@ -21,6 +25,7 @@ describe("Axios failureMode", () => {
create: jest.fn(),
get: jest.fn(),
reauthorizeWithPayment: jest.fn(),
complete: jest.fn().mockResolvedValue({}),
list: jest.fn(),
isAuthorized: jest.fn(),
isCompleted: jest.fn(),
Expand All @@ -37,6 +42,159 @@ describe("Axios failureMode", () => {
mockAxios.restore();
});

it.each(["open", "closed"] as const)(
"does not reauthorize an existing payment revision in failureMode %s",
async (failureMode) => {
const revision = {
id: "tx-revise",
status: "authorized",
requiresPayment: false,
nextAction: { type: "revise", actor: "agent", reasons: [] },
};
mockTransactionAPI.create.mockResolvedValue({
id: revision.id,
status: "authorized",
} as any);
mockTransactionAPI.get.mockResolvedValue(revision as any);
mockTransactionAPI.reauthorizeWithPayment.mockResolvedValue({
id: revision.id,
status: "authorized",
payment: { authorizationPayload: { x402Version: 1 } },
} as any);
mockAxios.onGet("/test").reply(402, {
x402Version: 1,
accepts: [
{
scheme: "exact",
network: "base",
maxAmountRequired: "1000000",
resource: "https://api.example.com/test",
payTo: "0x123",
asset: "0xUSDC",
},
],
});
const client = withSapiom(axiosInstance, {
sapiomClient: mockSapiomClient,
failureMode,
});

await expect(client.get("/test")).rejects.toMatchObject({
name: "TransactionRevisionRequiredError",
transaction: revision,
});
expect(mockAxios.history.get).toHaveLength(1);
expect(mockTransactionAPI.reauthorizeWithPayment).not.toHaveBeenCalled();
expect(mockTransactionAPI.complete).not.toHaveBeenCalled();
},
);

it.each([
["open", false, "needs_revision"],
["open", true, "needs_revision"],
["closed", false, "needs_revision"],
["closed", true, "needs_revision"],
["open", false, "authorized"],
["open", true, "authorized"],
["closed", false, "authorized"],
["closed", true, "authorized"],
] as const)(
"leaves a payment revision open (%s, polled: %s, status: %s)",
async (failureMode, pending, status) => {
const revision = {
id: "tx-revise",
status,
...(status === "authorized" && {
nextAction: { type: "revise", actor: "agent", reasons: [] },
}),
};
mockTransactionAPI.create.mockResolvedValue({
id: "tx-revise",
status: "authorized",
} as any);
mockTransactionAPI.reauthorizeWithPayment.mockResolvedValue(
pending
? ({ id: "tx-revise", status: "pending" } as any)
: (revision as any),
);
mockTransactionAPI.get
.mockResolvedValueOnce({
id: "tx-revise",
status: "authorized",
requiresPayment: false,
} as any)
.mockResolvedValue(revision as any);
const paymentRequired = {
x402Version: 1,
accepts: [
{
scheme: "exact",
network: "base",
maxAmountRequired: "1000000",
resource: "https://api.example.com/test",
payTo: "0x123",
asset: "0xUSDC",
},
],
};
mockAxios.onGet("/test").reply(402, paymentRequired);
const client = withSapiom(axiosInstance, {
sapiomClient: mockSapiomClient,
failureMode,
polling: { pollInterval: 1 },
});
await expect(client.get("/test")).rejects.toBeInstanceOf(
TransactionRevisionRequiredError,
);
expect(mockAxios.history.get).toHaveLength(1);
expect(mockTransactionAPI.reauthorizeWithPayment).toHaveBeenCalledTimes(
1,
);
expect(mockTransactionAPI.complete).not.toHaveBeenCalled();
},
);

it.each([
["open", "needs_revision"],
["closed", "needs_revision"],
["open", "authorized"],
["closed", "authorized"],
] as const)(
"blocks revision decisions in failureMode %s with status %s",
async (failureMode, status) => {
for (const mode of ["create", "existing", "poll"] as const) {
const transaction = {
id: "tx-revise",
status,
...(status === "authorized" && {
nextAction: { type: "revise", actor: "agent", reasons: [] },
}),
};
mockTransactionAPI.create.mockResolvedValue(
mode === "poll"
? ({ id: "tx-revise", status: "pending" } as any)
: (transaction as any),
);
mockTransactionAPI.get.mockResolvedValue(transaction as any);
mockAxios.onGet("/test").reply(200);
const client = withSapiom(axiosInstance, {
sapiomClient: mockSapiomClient,
failureMode,
polling: { pollInterval: 1 },
});
await expect(
client.get("/test", {
headers:
mode === "existing"
? { "X-Sapiom-Transaction-Id": "tx-revise" }
: {},
}),
).rejects.toBeInstanceOf(TransactionRevisionRequiredError);
expect(mockAxios.history.get).toHaveLength(0);
}
},
);

describe('failureMode: "open" (default)', () => {
it("should allow request when Sapiom API returns 500", async () => {
mockAxios.onGet("/test").reply(200, { data: "success" });
Expand Down
34 changes: 33 additions & 1 deletion packages/axios/src/interceptors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
SapiomClient,
TransactionPoller,
TransactionStatus,
TransactionRevisionRequiredError,
captureUserCallSite,
extractX402Response,
extractResourceFromError,
Expand Down Expand Up @@ -303,11 +304,18 @@ export function addAuthorizationInterceptor(
return axiosConfig;
}

if (
transaction.status === TransactionStatus.NEEDS_REVISION ||
transaction.nextAction?.type === "revise"
)
throw new TransactionRevisionRequiredError(transaction);

switch (transaction.status) {
case TransactionStatus.AUTHORIZED:
return axiosConfig;

case TransactionStatus.PENDING:
case TransactionStatus.WAITING_APPROVAL:
case TransactionStatus.PREPARING: {
let authResult;
try {
Expand All @@ -323,6 +331,11 @@ export function addAuthorizationInterceptor(
return axiosConfig;
}

if (authResult.status === "needs_revision")
throw new TransactionRevisionRequiredError(
authResult.transaction,
);

if (authResult.status === "authorized") {
return axiosConfig;
} else if (authResult.status === "denied") {
Expand Down Expand Up @@ -472,6 +485,12 @@ export function addAuthorizationInterceptor(
return axiosConfig;
}

if (
transaction.status === TransactionStatus.NEEDS_REVISION ||
transaction.nextAction?.type === "revise"
)
throw new TransactionRevisionRequiredError(transaction);

if (
transaction.status === TransactionStatus.DENIED ||
transaction.status === TransactionStatus.CANCELLED
Expand Down Expand Up @@ -504,6 +523,9 @@ export function addAuthorizationInterceptor(
return axiosConfig;
}

if (result.status === "needs_revision")
throw new TransactionRevisionRequiredError(result.transaction);

if (result.status === "authorized") {
setHeader(
axiosConfig.headers,
Expand Down Expand Up @@ -616,7 +638,8 @@ export function addPaymentInterceptor(

if (
!transaction.requiresPayment &&
transaction.status === TransactionStatus.AUTHORIZED
transaction.status === TransactionStatus.AUTHORIZED &&
transaction.nextAction?.type !== "revise"
) {
transaction =
await config.sapiomClient.transactions.reauthorizeWithPayment(
Expand Down Expand Up @@ -684,6 +707,12 @@ export function addPaymentInterceptor(
}
}

if (
transaction.status === TransactionStatus.NEEDS_REVISION ||
transaction.nextAction?.type === "revise"
)
throw new TransactionRevisionRequiredError(transaction);

if (
transaction.status === TransactionStatus.DENIED ||
transaction.status === TransactionStatus.CANCELLED
Expand All @@ -708,6 +737,9 @@ export function addPaymentInterceptor(
return Promise.reject(error);
}

if (result.status === "needs_revision")
throw new TransactionRevisionRequiredError(result.transaction);

if (result.status !== "authorized") {
// Clear payment handling flag so completion interceptor fires
(originalConfig as any).__sapiomPaymentHandling = false;
Expand Down
Loading
Loading