@fantastic.dev/better-stripe 0.53.0 → 0.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (184) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +1 -1
  3. package/dist/client/connect/payoutAdoptionTestHelpers.d.ts +226 -34
  4. package/dist/client/connect/payoutAdoptionTestHelpers.d.ts.map +1 -1
  5. package/dist/client/connect/payoutExecutionTestHelpers.d.ts +97 -1
  6. package/dist/client/connect/payoutExecutionTestHelpers.d.ts.map +1 -1
  7. package/dist/client/connect/payoutLargeAdoptionTestHelpers.d.ts +226 -34
  8. package/dist/client/connect/payoutLargeAdoptionTestHelpers.d.ts.map +1 -1
  9. package/dist/client/connect/payoutSyncTestHelpers.d.ts +97 -1
  10. package/dist/client/connect/payoutSyncTestHelpers.d.ts.map +1 -1
  11. package/dist/client/index.d.ts +8 -0
  12. package/dist/client/index.d.ts.map +1 -1
  13. package/dist/client/index.js +1 -0
  14. package/dist/client/index.js.map +1 -1
  15. package/dist/client/usage/client.d.ts +2 -2
  16. package/dist/client/usage/client.d.ts.map +1 -1
  17. package/dist/client/usage/client.js +3 -3
  18. package/dist/client/usage/client.js.map +1 -1
  19. package/dist/client/usage/deliveryClient.d.ts +64 -0
  20. package/dist/client/usage/deliveryClient.d.ts.map +1 -0
  21. package/dist/client/usage/deliveryClient.js +60 -0
  22. package/dist/client/usage/deliveryClient.js.map +1 -0
  23. package/dist/client/usage/deliveryProtocol.d.ts +130 -0
  24. package/dist/client/usage/deliveryProtocol.d.ts.map +1 -0
  25. package/dist/client/usage/deliveryProtocol.js +21 -0
  26. package/dist/client/usage/deliveryProtocol.js.map +1 -0
  27. package/dist/client/usage/deliveryProvider.d.ts +32 -0
  28. package/dist/client/usage/deliveryProvider.d.ts.map +1 -0
  29. package/dist/client/usage/deliveryProvider.js +127 -0
  30. package/dist/client/usage/deliveryProvider.js.map +1 -0
  31. package/dist/client/usage/index.d.ts +8 -0
  32. package/dist/client/usage/index.d.ts.map +1 -1
  33. package/dist/client/usage/index.js +1 -0
  34. package/dist/client/usage/index.js.map +1 -1
  35. package/dist/client/usage/invoiceObservation.d.ts +38 -0
  36. package/dist/client/usage/invoiceObservation.d.ts.map +1 -0
  37. package/dist/client/usage/invoiceObservation.js +157 -0
  38. package/dist/client/usage/invoiceObservation.js.map +1 -0
  39. package/dist/client/usage/observationClient.d.ts +83 -0
  40. package/dist/client/usage/observationClient.d.ts.map +1 -0
  41. package/dist/client/usage/observationClient.js +157 -0
  42. package/dist/client/usage/observationClient.js.map +1 -0
  43. package/dist/client/usage/observationTypes.d.ts +63 -0
  44. package/dist/client/usage/observationTypes.d.ts.map +1 -0
  45. package/dist/client/usage/observationTypes.js +59 -0
  46. package/dist/client/usage/observationTypes.js.map +1 -0
  47. package/dist/client/usage/providerObservation.d.ts +4 -0
  48. package/dist/client/usage/providerObservation.d.ts.map +1 -0
  49. package/dist/client/usage/providerObservation.js +96 -0
  50. package/dist/client/usage/providerObservation.js.map +1 -0
  51. package/dist/client/usage/reconciliation.d.ts +12 -0
  52. package/dist/client/usage/reconciliation.d.ts.map +1 -0
  53. package/dist/client/usage/reconciliation.js +48 -0
  54. package/dist/client/usage/reconciliation.js.map +1 -0
  55. package/dist/client/usage/summary.d.ts +50 -0
  56. package/dist/client/usage/summary.d.ts.map +1 -0
  57. package/dist/client/usage/summary.js +110 -0
  58. package/dist/client/usage/summary.js.map +1 -0
  59. package/dist/client/webhooks/handler.d.ts.map +1 -1
  60. package/dist/client/webhooks/handler.js +2 -1
  61. package/dist/client/webhooks/handler.js.map +1 -1
  62. package/dist/client/webhooks/meterErrors.d.ts +5 -0
  63. package/dist/client/webhooks/meterErrors.d.ts.map +1 -0
  64. package/dist/client/webhooks/meterErrors.js +98 -0
  65. package/dist/client/webhooks/meterErrors.js.map +1 -0
  66. package/dist/client/webhooks/v2.d.ts.map +1 -1
  67. package/dist/client/webhooks/v2.js +5 -0
  68. package/dist/client/webhooks/v2.js.map +1 -1
  69. package/dist/component/_generated/api.d.ts +22 -0
  70. package/dist/component/_generated/api.d.ts.map +1 -1
  71. package/dist/component/_generated/api.js.map +1 -1
  72. package/dist/component/_generated/component.d.ts +265 -0
  73. package/dist/component/_generated/component.d.ts.map +1 -1
  74. package/dist/component/balanceFunding/internal/actions.d.ts +11 -11
  75. package/dist/component/balanceFunding/mutations.d.ts +27 -27
  76. package/dist/component/balanceFunding/stateHandlers.d.ts +8 -8
  77. package/dist/component/earnings/triggers.d.ts +206 -18
  78. package/dist/component/earnings/triggers.d.ts.map +1 -1
  79. package/dist/component/schema.d.ts +97 -1
  80. package/dist/component/schema.js +6 -0
  81. package/dist/component/schema.js.map +1 -1
  82. package/dist/component/usage/schema.d.ts +101 -1
  83. package/dist/component/usage/schema.d.ts.map +1 -1
  84. package/dist/component/usage/schema.js +11 -2
  85. package/dist/component/usage/schema.js.map +1 -1
  86. package/dist/component/usageDelivery/bridge.d.ts +25 -0
  87. package/dist/component/usageDelivery/bridge.d.ts.map +1 -0
  88. package/dist/component/usageDelivery/bridge.js +45 -0
  89. package/dist/component/usageDelivery/bridge.js.map +1 -0
  90. package/dist/component/usageDelivery/fields.d.ts +79 -0
  91. package/dist/component/usageDelivery/fields.d.ts.map +1 -0
  92. package/dist/component/usageDelivery/fields.js +39 -0
  93. package/dist/component/usageDelivery/fields.js.map +1 -0
  94. package/dist/component/usageDelivery/helpers.d.ts +84 -0
  95. package/dist/component/usageDelivery/helpers.d.ts.map +1 -0
  96. package/dist/component/usageDelivery/helpers.js +63 -0
  97. package/dist/component/usageDelivery/helpers.js.map +1 -0
  98. package/dist/component/usageDelivery/mutations.d.ts +97 -0
  99. package/dist/component/usageDelivery/mutations.d.ts.map +1 -0
  100. package/dist/component/usageDelivery/mutations.js +160 -0
  101. package/dist/component/usageDelivery/mutations.js.map +1 -0
  102. package/dist/component/usageDelivery/queries.d.ts +115 -0
  103. package/dist/component/usageDelivery/queries.d.ts.map +1 -0
  104. package/dist/component/usageDelivery/queries.js +22 -0
  105. package/dist/component/usageDelivery/queries.js.map +1 -0
  106. package/dist/component/usageDelivery/schema.d.ts +79 -0
  107. package/dist/component/usageDelivery/schema.d.ts.map +1 -0
  108. package/dist/component/usageDelivery/schema.js +30 -0
  109. package/dist/component/usageDelivery/schema.js.map +1 -0
  110. package/dist/component/usageDelivery/steps.d.ts +85 -0
  111. package/dist/component/usageDelivery/steps.d.ts.map +1 -0
  112. package/dist/component/usageDelivery/steps.js +161 -0
  113. package/dist/component/usageDelivery/steps.js.map +1 -0
  114. package/dist/component/usageDelivery/workflow.d.ts +15 -0
  115. package/dist/component/usageDelivery/workflow.d.ts.map +1 -0
  116. package/dist/component/usageDelivery/workflow.js +28 -0
  117. package/dist/component/usageDelivery/workflow.js.map +1 -0
  118. package/dist/component/usageObservations/helpers.d.ts +38 -0
  119. package/dist/component/usageObservations/helpers.d.ts.map +1 -0
  120. package/dist/component/usageObservations/helpers.js +80 -0
  121. package/dist/component/usageObservations/helpers.js.map +1 -0
  122. package/dist/component/usageObservations/history.d.ts +6 -0
  123. package/dist/component/usageObservations/history.d.ts.map +1 -0
  124. package/dist/component/usageObservations/history.js +29 -0
  125. package/dist/component/usageObservations/history.js.map +1 -0
  126. package/dist/component/usageObservations/mutations.d.ts +6 -0
  127. package/dist/component/usageObservations/mutations.d.ts.map +1 -0
  128. package/dist/component/usageObservations/mutations.js +39 -0
  129. package/dist/component/usageObservations/mutations.js.map +1 -0
  130. package/dist/component/usageObservations/queries.d.ts +78 -0
  131. package/dist/component/usageObservations/queries.d.ts.map +1 -0
  132. package/dist/component/usageObservations/queries.js +131 -0
  133. package/dist/component/usageObservations/queries.js.map +1 -0
  134. package/dist/component/usageObservations/schema.d.ts +72 -0
  135. package/dist/component/usageObservations/schema.d.ts.map +1 -0
  136. package/dist/component/usageObservations/schema.js +29 -0
  137. package/dist/component/usageObservations/schema.js.map +1 -0
  138. package/docs/README.md +5 -1
  139. package/docs/metering-setup.md +3 -1
  140. package/docs/usage-delivery.md +143 -0
  141. package/docs/usage-observations.md +152 -0
  142. package/package.json +4 -2
  143. package/src/client/index.ts +34 -0
  144. package/src/client/usage/client.ts +5 -2
  145. package/src/client/usage/deliveryClient.ts +130 -0
  146. package/src/client/usage/deliveryProtocol.ts +26 -0
  147. package/src/client/usage/deliveryProvider.test.ts +207 -0
  148. package/src/client/usage/deliveryProvider.ts +155 -0
  149. package/src/client/usage/index.ts +31 -0
  150. package/src/client/usage/invoiceObservation.test.ts +195 -0
  151. package/src/client/usage/invoiceObservation.ts +203 -0
  152. package/src/client/usage/observationClient.ts +233 -0
  153. package/src/client/usage/observationTypes.ts +101 -0
  154. package/src/client/usage/providerObservation.test.ts +207 -0
  155. package/src/client/usage/providerObservation.ts +124 -0
  156. package/src/client/usage/reconciliation.test.ts +117 -0
  157. package/src/client/usage/reconciliation.ts +86 -0
  158. package/src/client/usage/summary.test.ts +222 -0
  159. package/src/client/usage/summary.ts +188 -0
  160. package/src/client/webhooks/handler.ts +2 -1
  161. package/src/client/webhooks/meterErrors.test.ts +164 -0
  162. package/src/client/webhooks/meterErrors.ts +118 -0
  163. package/src/client/webhooks/v2.ts +5 -0
  164. package/src/component/_generated/api.ts +22 -0
  165. package/src/component/_generated/component.ts +437 -0
  166. package/src/component/schema.ts +12 -0
  167. package/src/component/usage/schema.ts +11 -2
  168. package/src/component/usageDelivery/bridge.ts +56 -0
  169. package/src/component/usageDelivery/concurrency.test.ts +62 -0
  170. package/src/component/usageDelivery/fields.ts +60 -0
  171. package/src/component/usageDelivery/helpers.ts +77 -0
  172. package/src/component/usageDelivery/mutations.ts +210 -0
  173. package/src/component/usageDelivery/queries.ts +25 -0
  174. package/src/component/usageDelivery/schema.ts +33 -0
  175. package/src/component/usageDelivery/steps.ts +209 -0
  176. package/src/component/usageDelivery/workflow.test.ts +402 -0
  177. package/src/component/usageDelivery/workflow.ts +36 -0
  178. package/src/component/usageObservations/helpers.ts +95 -0
  179. package/src/component/usageObservations/history.test.ts +87 -0
  180. package/src/component/usageObservations/history.ts +39 -0
  181. package/src/component/usageObservations/mutations.ts +39 -0
  182. package/src/component/usageObservations/queries.test.ts +162 -0
  183. package/src/component/usageObservations/queries.ts +145 -0
  184. package/src/component/usageObservations/schema.ts +40 -0
@@ -0,0 +1,60 @@
1
+ import { defineTable } from "convex/server";
2
+ import { v } from "convex/values";
3
+ export const reason = v.union(
4
+ v.literal("rate_limited"),
5
+ v.literal("provider_unavailable"),
6
+ v.literal("provider_outcome_unknown"),
7
+ v.literal("provider_rejected"),
8
+ v.literal("retry_exhausted"),
9
+ v.literal("delivery_window_expired"),
10
+ v.literal("scope_busy"),
11
+ v.literal("administrative_hold"),
12
+ );
13
+ export { usageDeliveryOutcomeValidator as outcome } from "../../client/usage/deliveryProtocol.js";
14
+ export const deliveryFields = {
15
+ historySequence: v.optional(v.number()),
16
+ provider: v.optional(v.string()),
17
+ workflowId: v.optional(v.string()),
18
+ definitionVersion: v.optional(v.literal(1)),
19
+ firstSendAt: v.optional(v.number()),
20
+ leaseUntil: v.optional(v.number()),
21
+ held: v.optional(v.boolean()),
22
+ reason: v.optional(reason),
23
+ receipt: v.optional(
24
+ v.object({ identifier: v.string(), created: v.number() }),
25
+ ),
26
+ };
27
+ export const locksTable = defineTable({
28
+ key: v.string(),
29
+ eventId: v.optional(v.id("usageEvents")),
30
+ leaseUntil: v.number(),
31
+ nextAttemptAt: v.number(),
32
+ }).index("by_key", ["key"]);
33
+
34
+ export const errorCode = v.union(
35
+ v.literal("meter_event_customer_not_found"),
36
+ v.literal("meter_event_no_customer_defined"),
37
+ v.literal("meter_event_dimension_count_too_high"),
38
+ v.literal("archived_meter"),
39
+ v.literal("timestamp_too_far_in_past"),
40
+ v.literal("timestamp_in_future"),
41
+ v.literal("meter_event_value_not_found"),
42
+ v.literal("meter_event_invalid_value"),
43
+ v.literal("no_meter"),
44
+ );
45
+ export const errorFields = {
46
+ scopeKey: v.string(),
47
+ eventId: v.id("usageEvents"),
48
+ providerEventId: v.string(),
49
+ code: errorCode,
50
+ observedAt: v.number(),
51
+ dedupe: v.string(),
52
+ };
53
+ export const errorDoc = v.object({
54
+ _id: v.id("usageDeliveryErrors"),
55
+ _creationTime: v.number(),
56
+ ...errorFields,
57
+ });
58
+ export const errorsTable = defineTable(errorFields)
59
+ .index("by_dedupe", ["dedupe"])
60
+ .index("by_event", ["eventId"]);
@@ -0,0 +1,77 @@
1
+ import type { QueryCtx } from "../_generated/server.js";
2
+ import type { Doc, Id } from "../_generated/dataModel.js";
3
+ import type {
4
+ UsageScope,
5
+ PreparedUsageRecord,
6
+ } from "../../client/usage/records.js";
7
+ import { scopeKey } from "../usage/helpers.js";
8
+ export async function read(
9
+ ctx: QueryCtx,
10
+ args: { scope: UsageScope; eventId: Id<"usageEvents"> },
11
+ ) {
12
+ const event = await ctx.db.get("usageEvents", args.eventId);
13
+ if (!event || event.scopeKey !== scopeKey(args.scope))
14
+ throw new Error("Usage delivery scope unavailable");
15
+ const outbox = await ctx.db
16
+ .query("usageOutbox")
17
+ .withIndex("by_event", (q) => q.eq("eventId", event._id))
18
+ .unique();
19
+ if (!outbox) throw new Error("Usage outbox unavailable");
20
+ return {
21
+ event,
22
+ outbox,
23
+ record: JSON.parse(event.recordJson) as PreparedUsageRecord,
24
+ };
25
+ }
26
+ export function statusOf(outbox: Doc<"usageOutbox">) {
27
+ return {
28
+ validationErrors: [] as Array<{
29
+ providerEventId: string;
30
+ code: import("convex/values").Infer<
31
+ typeof import("./fields.js").errorCode
32
+ >;
33
+ observedAt: number;
34
+ }>,
35
+ validationHistoryComplete: true,
36
+ eventId: outbox.eventId,
37
+ state: outbox.state,
38
+ attempts: outbox.attempts,
39
+ held: outbox.held ?? false,
40
+ reason: outbox.reason,
41
+ providerIdentifier: outbox.providerIdentifier,
42
+ receipt: outbox.receipt,
43
+ };
44
+ }
45
+ export function lockKeys(record: PreparedUsageRecord) {
46
+ const realm = JSON.stringify([
47
+ record.scope.stripeAccountId,
48
+ record.scope.livemode,
49
+ ]);
50
+ return {
51
+ realm,
52
+ customer: JSON.stringify([
53
+ realm,
54
+ record.binding.stripeCustomerId,
55
+ record.scope.meterId,
56
+ ]),
57
+ };
58
+ }
59
+
60
+ export async function currentStatus(ctx: QueryCtx, outbox: Doc<"usageOutbox">) {
61
+ const errors = await ctx.db
62
+ .query("usageDeliveryErrors")
63
+ .withIndex("by_event", (q) => q.eq("eventId", outbox.eventId))
64
+ .order("desc")
65
+ .take(21);
66
+ return {
67
+ ...statusOf(outbox),
68
+ validationErrors: errors
69
+ .slice(0, 20)
70
+ .map(({ providerEventId, code, observedAt }) => ({
71
+ providerEventId,
72
+ code,
73
+ observedAt,
74
+ })),
75
+ validationHistoryComplete: errors.length <= 20,
76
+ };
77
+ }
@@ -0,0 +1,210 @@
1
+ import { appendDeliveryHistory } from "../usageObservations/history.js";
2
+ import { errorCode } from "./fields.js";
3
+ import type { PreparedUsageRecord } from "../../client/usage/records.js";
4
+ import { mutation } from "../_generated/server.js";
5
+ import { anyApi, type FunctionReference } from "convex/server";
6
+ import type { WorkflowId } from "@convex-dev/workflow";
7
+ import { v } from "convex/values";
8
+ import { refFields, status } from "./schema.js";
9
+ import { read, currentStatus } from "./helpers.js";
10
+ import { executionWorkflow } from "../durableExecution/runtime.js";
11
+ import type { MutationCtx } from "../_generated/server.js";
12
+ import type { Doc } from "../_generated/dataModel.js";
13
+ const workflow = anyApi.usageDelivery.workflow.run as FunctionReference<
14
+ "mutation",
15
+ "internal"
16
+ >;
17
+ async function launch(
18
+ ctx: MutationCtx,
19
+ args: import("convex/values").Infer<typeof _refValidator>,
20
+ outbox: Doc<"usageOutbox">,
21
+ ) {
22
+ if (outbox.workflowId) {
23
+ const state = await executionWorkflow.status(
24
+ ctx,
25
+ outbox.workflowId as WorkflowId,
26
+ );
27
+ if (state.type === "inProgress") return;
28
+ if (state.type === "failed") {
29
+ const last = (
30
+ await executionWorkflow.listSteps(
31
+ ctx,
32
+ outbox.workflowId as WorkflowId,
33
+ { order: "desc", paginationOpts: { cursor: null, numItems: 1 } },
34
+ )
35
+ ).page[0];
36
+ if (last?.name === "save-receipt" && last.runResult?.kind === "failed") {
37
+ await executionWorkflow.restart(ctx, outbox.workflowId as WorkflowId, {
38
+ from: last.stepNumber,
39
+ startAsync: true,
40
+ });
41
+ return;
42
+ }
43
+ }
44
+ }
45
+ const workflowId = await executionWorkflow.start(ctx, workflow, args, {
46
+ startAsync: true,
47
+ });
48
+ await ctx.db.patch("usageOutbox", outbox._id, { workflowId });
49
+ }
50
+ const _refValidator = v.object(refFields);
51
+ export const start = mutation({
52
+ args: { ...refFields, provider: v.string(), definitionVersion: v.literal(1) },
53
+ returns: status,
54
+ handler: async (ctx, args) => {
55
+ const { outbox } = await read(ctx, args);
56
+ if (!args.provider.startsWith("function://") || args.provider.length > 2048)
57
+ throw new Error("Internal provider handle required");
58
+ if (outbox.provider && outbox.provider !== args.provider)
59
+ throw new Error("Usage provider binding is immutable");
60
+ if (!outbox.provider)
61
+ await ctx.db.patch("usageOutbox", outbox._id, {
62
+ provider: args.provider,
63
+ definitionVersion: 1,
64
+ });
65
+ if (
66
+ !["provider_accepted", "rejected", "unknown", "held"].includes(
67
+ outbox.state,
68
+ )
69
+ )
70
+ await launch(ctx, { scope: args.scope, eventId: args.eventId }, outbox);
71
+ return await currentStatus(ctx, (await read(ctx, args)).outbox);
72
+ },
73
+ });
74
+ export const hold = mutation({
75
+ args: refFields,
76
+ returns: status,
77
+ handler: async (ctx, args) => {
78
+ const { outbox } = await read(ctx, args);
79
+ await ctx.db.patch("usageOutbox", outbox._id, {
80
+ held: true,
81
+ ...(outbox.state === "queued"
82
+ ? { state: "held" as const, reason: "administrative_hold" as const }
83
+ : {}),
84
+ });
85
+ if (!outbox.held)
86
+ await appendDeliveryHistory(
87
+ ctx,
88
+ args.eventId,
89
+ "held",
90
+ outbox.attempts,
91
+ `control:${(outbox.historySequence ?? 0) + 1}:held`,
92
+ );
93
+ return await currentStatus(ctx, (await read(ctx, args)).outbox);
94
+ },
95
+ });
96
+ export const resume = mutation({
97
+ args: refFields,
98
+ returns: status,
99
+ handler: async (ctx, args) => {
100
+ const { outbox } = await read(ctx, args);
101
+ if (
102
+ outbox.state === "unknown" ||
103
+ ["provider_accepted", "rejected"].includes(outbox.state) ||
104
+ outbox.reason === "delivery_window_expired"
105
+ ) {
106
+ if (outbox.held) {
107
+ await ctx.db.patch("usageOutbox", outbox._id, { held: false });
108
+ await appendDeliveryHistory(
109
+ ctx,
110
+ args.eventId,
111
+ "resumed",
112
+ outbox.attempts,
113
+ `control:${(outbox.historySequence ?? 0) + 1}:resumed`,
114
+ );
115
+ }
116
+ return await currentStatus(ctx, (await read(ctx, args)).outbox);
117
+ }
118
+ if (!outbox.provider)
119
+ throw new Error("Start delivery with a host provider first");
120
+ await ctx.db.patch("usageOutbox", outbox._id, {
121
+ held: false,
122
+ state: outbox.state === "sending" ? "sending" : "queued",
123
+ reason: undefined,
124
+ });
125
+ if (outbox.held || outbox.state === "held")
126
+ await appendDeliveryHistory(
127
+ ctx,
128
+ args.eventId,
129
+ "resumed",
130
+ outbox.attempts,
131
+ `control:${(outbox.historySequence ?? 0) + 1}:resumed`,
132
+ );
133
+ await launch(ctx, args, outbox);
134
+ return await currentStatus(ctx, (await read(ctx, args)).outbox);
135
+ },
136
+ });
137
+
138
+ /** Only a verified host webhook/provider action may submit native reports. */
139
+ export const recordErrorReport = mutation({
140
+ args: {
141
+ stripeAccountId: v.string(),
142
+ livemode: v.boolean(),
143
+ providerEventId: v.string(),
144
+ meterId: v.optional(v.string()),
145
+ samples: v.array(v.object({ identifier: v.string(), code: errorCode })),
146
+ truncated: v.boolean(),
147
+ },
148
+ returns: v.object({
149
+ matched: v.number(),
150
+ unattributed: v.number(),
151
+ truncated: v.boolean(),
152
+ }),
153
+ handler: async (ctx, args) => {
154
+ if (
155
+ args.samples.length > 100 ||
156
+ !/^evt_[a-zA-Z0-9_]+$/.test(args.providerEventId) ||
157
+ args.providerEventId.length > 100 ||
158
+ !/^acct_[a-zA-Z0-9]+$/.test(args.stripeAccountId)
159
+ )
160
+ throw new Error("Invalid usage error report");
161
+ let matched = 0,
162
+ unattributed = 0;
163
+ for (const sample of args.samples) {
164
+ if (sample.identifier.length > 100)
165
+ throw new Error("Invalid usage error identifier");
166
+ const outbox = await ctx.db
167
+ .query("usageOutbox")
168
+ .withIndex("by_provider_identifier", (q) =>
169
+ q.eq("providerIdentifier", sample.identifier),
170
+ )
171
+ .unique();
172
+ const event = outbox
173
+ ? await ctx.db.get("usageEvents", outbox.eventId)
174
+ : null;
175
+ const record = event
176
+ ? (JSON.parse(event.recordJson) as PreparedUsageRecord)
177
+ : null;
178
+ if (
179
+ !event ||
180
+ !record ||
181
+ record.scope.stripeAccountId !== args.stripeAccountId ||
182
+ record.scope.livemode !== args.livemode ||
183
+ (args.meterId !== undefined && record.scope.meterId !== args.meterId)
184
+ ) {
185
+ unattributed++;
186
+ continue;
187
+ }
188
+ const dedupe = JSON.stringify([
189
+ args.providerEventId,
190
+ event._id,
191
+ sample.code,
192
+ ]);
193
+ const prior = await ctx.db
194
+ .query("usageDeliveryErrors")
195
+ .withIndex("by_dedupe", (q) => q.eq("dedupe", dedupe))
196
+ .unique();
197
+ if (!prior)
198
+ await ctx.db.insert("usageDeliveryErrors", {
199
+ dedupe,
200
+ scopeKey: event.scopeKey,
201
+ eventId: event._id,
202
+ providerEventId: args.providerEventId,
203
+ code: sample.code,
204
+ observedAt: Math.floor(Date.now() / 1000),
205
+ });
206
+ matched++;
207
+ }
208
+ return { matched, unattributed, truncated: args.truncated };
209
+ },
210
+ });
@@ -0,0 +1,25 @@
1
+ import { query, internalQuery } from "../_generated/server.js";
2
+ import { refFields, status } from "./schema.js";
3
+ import { read, currentStatus } from "./helpers.js";
4
+ import { v } from "convex/values";
5
+ import { eventDoc, outboxDoc } from "../usage/schema.js";
6
+ export const get = query({
7
+ args: refFields,
8
+ returns: status,
9
+ handler: async (ctx, args) =>
10
+ currentStatus(ctx, (await read(ctx, args)).outbox),
11
+ });
12
+ const snapshotDefinition = {
13
+ args: refFields,
14
+ returns: v.object({ event: eventDoc, outbox: outboxDoc }),
15
+ handler: async (
16
+ ctx: import("../_generated/server.js").QueryCtx,
17
+ args: import("convex/values").Infer<typeof _refValidator>,
18
+ ) => {
19
+ const { event, outbox } = await read(ctx, args);
20
+ return { event, outbox };
21
+ },
22
+ };
23
+ const _refValidator = v.object(refFields);
24
+ export const saved = internalQuery(snapshotDefinition);
25
+ export const snapshot = query(snapshotDefinition);
@@ -0,0 +1,33 @@
1
+ import { v } from "convex/values";
2
+ import { scopeValidator, deliveryValidator } from "../usage/schema.js";
3
+ import { errorCode, reason } from "./fields.js";
4
+ export const refFields = {
5
+ scope: scopeValidator,
6
+ eventId: v.id("usageEvents"),
7
+ };
8
+ export const status = v.object({
9
+ validationErrors: v.array(
10
+ v.object({
11
+ providerEventId: v.string(),
12
+ code: errorCode,
13
+ observedAt: v.number(),
14
+ }),
15
+ ),
16
+ validationHistoryComplete: v.boolean(),
17
+ eventId: v.id("usageEvents"),
18
+ state: deliveryValidator,
19
+ attempts: v.number(),
20
+ held: v.boolean(),
21
+ reason: v.optional(reason),
22
+ providerIdentifier: v.string(),
23
+ receipt: v.optional(
24
+ v.object({ identifier: v.string(), created: v.number() }),
25
+ ),
26
+ });
27
+ export const request = {
28
+ ...refFields,
29
+ attempt: v.number(),
30
+ definitionVersion: v.literal(1),
31
+ apiVersion: v.string(),
32
+ identifier: v.string(),
33
+ };
@@ -0,0 +1,209 @@
1
+ import { appendDeliveryHistory } from "../usageObservations/history.js";
2
+ import { internalMutation } from "../_generated/server.js";
3
+ import { v } from "convex/values";
4
+ import { refFields, request, status } from "./schema.js";
5
+ import { outcome } from "./fields.js";
6
+ import { read, statusOf, lockKeys } from "./helpers.js";
7
+ export const claim = internalMutation({
8
+ args: refFields,
9
+ returns: v.union(
10
+ v.object({ kind: v.literal("ready"), request: v.object(request) }),
11
+ v.object({ kind: v.literal("wait"), delayMs: v.number() }),
12
+ v.object({ kind: v.literal("done") }),
13
+ ),
14
+ handler: async (ctx, args) => {
15
+ const { outbox, record } = await read(ctx, args),
16
+ now = Math.floor(Date.now() / 1000);
17
+ if (
18
+ outbox.held ||
19
+ ["provider_accepted", "rejected", "unknown", "held"].includes(
20
+ outbox.state,
21
+ )
22
+ )
23
+ return { kind: "done" as const };
24
+ if (
25
+ record.occurredAt < now - 35 * 86400 ||
26
+ record.occurredAt > now + 300 ||
27
+ (outbox.firstSendAt !== undefined &&
28
+ now - outbox.firstSendAt >= 23 * 3600)
29
+ ) {
30
+ await ctx.db.patch("usageOutbox", outbox._id, {
31
+ state: outbox.firstSendAt === undefined ? "held" : "unknown",
32
+ reason: "delivery_window_expired",
33
+ });
34
+ await appendDeliveryHistory(
35
+ ctx,
36
+ args.eventId,
37
+ "window_expired",
38
+ outbox.attempts,
39
+ `window:${outbox.attempts}`,
40
+ );
41
+ return { kind: "done" as const };
42
+ }
43
+ if (outbox.state === "sending") {
44
+ if ((outbox.leaseUntil ?? 0) > now)
45
+ return {
46
+ kind: "wait" as const,
47
+ delayMs: Math.min(
48
+ 60000,
49
+ Math.max(1000, ((outbox.leaseUntil ?? now) - now) * 1000),
50
+ ),
51
+ };
52
+ await ctx.db.patch("usageOutbox", outbox._id, {
53
+ state: "unknown",
54
+ reason: "provider_outcome_unknown",
55
+ });
56
+ await appendDeliveryHistory(
57
+ ctx,
58
+ args.eventId,
59
+ "unknown",
60
+ outbox.attempts,
61
+ `result:${outbox.attempts}:unknown`,
62
+ );
63
+ return { kind: "done" as const };
64
+ }
65
+ const keys = lockKeys(record);
66
+ const realm = await ctx.db
67
+ .query("usageDeliveryLocks")
68
+ .withIndex("by_key", (q) => q.eq("key", keys.realm))
69
+ .unique();
70
+ const customer = await ctx.db
71
+ .query("usageDeliveryLocks")
72
+ .withIndex("by_key", (q) => q.eq("key", keys.customer))
73
+ .unique();
74
+ const waitUntil = Math.max(
75
+ outbox.nextAttemptAt,
76
+ realm?.nextAttemptAt ?? 0,
77
+ customer?.leaseUntil ?? 0,
78
+ );
79
+ if (waitUntil > now)
80
+ return {
81
+ kind: "wait" as const,
82
+ delayMs: Math.min(60000, (waitUntil - now) * 1000),
83
+ };
84
+ const slot = { key: keys.realm, leaseUntil: 0, nextAttemptAt: now + 1 };
85
+ if (realm) await ctx.db.patch("usageDeliveryLocks", realm._id, slot);
86
+ else await ctx.db.insert("usageDeliveryLocks", slot);
87
+ const lock = {
88
+ key: keys.customer,
89
+ eventId: args.eventId,
90
+ leaseUntil: now + 900,
91
+ nextAttemptAt: 0,
92
+ };
93
+ if (customer) await ctx.db.patch("usageDeliveryLocks", customer._id, lock);
94
+ else await ctx.db.insert("usageDeliveryLocks", lock);
95
+ const attempt = outbox.attempts + 1;
96
+ await ctx.db.patch("usageOutbox", outbox._id, {
97
+ state: "sending",
98
+ attempts: attempt,
99
+ firstSendAt: outbox.firstSendAt ?? now,
100
+ leaseUntil: now + 900,
101
+ reason: undefined,
102
+ });
103
+ await appendDeliveryHistory(
104
+ ctx,
105
+ args.eventId,
106
+ "started",
107
+ attempt,
108
+ `started:${attempt}`,
109
+ );
110
+ return {
111
+ kind: "ready" as const,
112
+ request: {
113
+ ...args,
114
+ attempt,
115
+ definitionVersion: 1 as const,
116
+ apiVersion: record.binding.apiVersion,
117
+ identifier: outbox.providerIdentifier,
118
+ },
119
+ };
120
+ },
121
+ });
122
+ export const save = internalMutation({
123
+ args: { ...request, outcome },
124
+ returns: status,
125
+ handler: async (ctx, args) => {
126
+ const { outbox, record } = await read(ctx, args);
127
+ if (
128
+ outbox.attempts !== args.attempt ||
129
+ outbox.providerIdentifier !== args.identifier ||
130
+ record.binding.apiVersion !== args.apiVersion ||
131
+ outbox.definitionVersion !== args.definitionVersion
132
+ )
133
+ throw new Error("Stale usage delivery receipt");
134
+ if (outbox.receipt || outbox.state === "rejected") return statusOf(outbox);
135
+ const result = args.outcome,
136
+ now = Math.floor(Date.now() / 1000);
137
+ const update =
138
+ result.status === "accepted"
139
+ ? {
140
+ state: "provider_accepted" as const,
141
+ receipt: { identifier: args.identifier, created: result.created },
142
+ reason: undefined,
143
+ }
144
+ : result.status === "unknown"
145
+ ? {
146
+ state: "unknown" as const,
147
+ reason: "provider_outcome_unknown" as const,
148
+ }
149
+ : result.status === "rejected"
150
+ ? {
151
+ state: "rejected" as const,
152
+ reason: "provider_rejected" as const,
153
+ }
154
+ : result.status === "unavailable"
155
+ ? {
156
+ state: "held" as const,
157
+ reason: "provider_unavailable" as const,
158
+ }
159
+ : {
160
+ state: outbox.held ? ("held" as const) : ("queued" as const),
161
+ reason: "rate_limited" as const,
162
+ nextAttemptAt:
163
+ now + Math.min(60, 2 ** Math.min(outbox.attempts, 6)),
164
+ };
165
+ await ctx.db.patch("usageOutbox", outbox._id, update);
166
+ if (result.status !== "unknown") {
167
+ const key = lockKeys(record).customer;
168
+ const lock = await ctx.db
169
+ .query("usageDeliveryLocks")
170
+ .withIndex("by_key", (q) => q.eq("key", key))
171
+ .unique();
172
+ if (lock?.eventId === args.eventId)
173
+ await ctx.db.patch("usageDeliveryLocks", lock._id, {
174
+ leaseUntil: 0,
175
+ eventId: undefined,
176
+ });
177
+ }
178
+ await appendDeliveryHistory(
179
+ ctx,
180
+ args.eventId,
181
+ result.status,
182
+ args.attempt,
183
+ `result:${args.attempt}:${result.status}`,
184
+ result.status === "accepted" ? result.created : undefined,
185
+ );
186
+ return statusOf((await read(ctx, args)).outbox);
187
+ },
188
+ });
189
+ export const exhaust = internalMutation({
190
+ args: refFields,
191
+ returns: v.null(),
192
+ handler: async (ctx, args) => {
193
+ const { outbox } = await read(ctx, args);
194
+ if (outbox.state === "queued") {
195
+ await ctx.db.patch("usageOutbox", outbox._id, {
196
+ state: "held",
197
+ reason: "retry_exhausted",
198
+ });
199
+ await appendDeliveryHistory(
200
+ ctx,
201
+ args.eventId,
202
+ "retry_exhausted",
203
+ outbox.attempts,
204
+ `exhaust:${outbox.attempts}`,
205
+ );
206
+ }
207
+ return null;
208
+ },
209
+ });