Commit bb47e34
fix: use generated workspace API response types (#15281)
## Summary
Use the generated Comfy Cloud ingest contract as the source of truth for
workspace and billing API response types, including the `TEAM`
subscription tier.
## Root cause
`workspaceApi.ts` locally overrode generated `@comfyorg/ingest-types`
responses and sourced `SubscriptionTier` from the Registry contract.
Those frontend-owned copies had drifted from the ingest API: Registry
omitted `TEAM`, billing fields that ingest requires were made optional
or normalized, and undocumented `scheduled_plan_slug` / `change_at`
fields were added only on the frontend. The preview request also added a
`billing_cycle` field that the ingest contract does not define and the
server does not read. That let frontend behavior compile against a
contract the server did not define.
## Changes
- Import workspace, billing plan, billing status, plan, and subscription
tier response types directly from `@comfyorg/ingest-types`.
- Remove frontend-only billing status overrides, seat normalization, and
scheduled plan field mapping.
- Map generated `TEAM` tiers into existing team billing policy and
subscription display behavior.
- Remove `billing_cycle` only from preview-subscribe requests; the
actual subscribe request still sends it as required by the server
contract.
- Update billing fixtures and behavioral coverage to match the generated
response/request contracts.
## AS IS
- Workspace billing responses were reshaped by frontend-owned response
types.
- `SubscriptionTier` came from the Registry schema, so the
server-defined `TEAM` value was absent.
- Undocumented scheduled plan fields and a preview-only `billing_cycle`
were treated as ingest API fields.
## TO BE
- Workspace API consumers use the generated ingest contract directly.
- `TEAM` is represented and handled according to the server contract.
- Frontend code no longer invents or normalizes server state or request
fields outside that contract.
## Behavior and regression assessment
The network endpoints and subscription flow are unchanged. `TEAM`
handling is the only intentional policy correction: inconsistent
payloads where a non-team workspace reports a `TEAM` tier now resolve to
the existing team policy state instead of falling through an impossible
TypeScript branch. Removing preview `billing_cycle` is behavior-neutral
because the server derives cadence from `plan_slug` and does not read
that field. Removing scheduled plan fields is behavior-neutral for the
current backend, which does not define or emit them.
## Verification
- `pnpm test:unit src/platform/workspace/api/workspaceApi.test.ts
src/platform/workspace/composables/useSubscriptionCheckout.test.ts
src/platform/workspace/composables/useWorkspaceBilling.test.ts` — 219
passed
- `pnpm typecheck` — passed
- ESLint — passed for changed files
- oxfmt check — passed for changed files
- `pnpm knip --cache` — passed via pre-push hook
## Screenshots
N/A — API contract alignment with no intended visible UI change.
---------
Co-authored-by: Amp <amp@ampcode.com>1 parent 848cd39 commit bb47e34
16 files changed
Lines changed: 97 additions & 76 deletions
File tree
- browser_tests
- fixtures/data
- tests
- dialogs
- src
- composables/billing
- platform
- cloud/subscription/composables
- workspace
- api
- components
- composables
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
16 | 19 | | |
17 | 20 | | |
18 | 21 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
53 | | - | |
| 53 | + | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
57 | 66 | | |
58 | 67 | | |
59 | 68 | | |
| |||
112 | 121 | | |
113 | 122 | | |
114 | 123 | | |
115 | | - | |
| 124 | + | |
116 | 125 | | |
117 | 126 | | |
118 | 127 | | |
119 | 128 | | |
120 | 129 | | |
121 | | - | |
122 | | - | |
123 | | - | |
124 | | - | |
125 | | - | |
126 | | - | |
| 130 | + | |
127 | 131 | | |
128 | 132 | | |
129 | 133 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
| 56 | + | |
56 | 57 | | |
57 | 58 | | |
58 | 59 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
63 | 63 | | |
64 | 64 | | |
65 | 65 | | |
| 66 | + | |
66 | 67 | | |
67 | 68 | | |
68 | 69 | | |
| |||
71 | 72 | | |
72 | 73 | | |
73 | 74 | | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
74 | 78 | | |
75 | 79 | | |
76 | 80 | | |
77 | 81 | | |
78 | 82 | | |
79 | 83 | | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
80 | 87 | | |
81 | 88 | | |
82 | 89 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
49 | 49 | | |
50 | 50 | | |
51 | 51 | | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
52 | 55 | | |
53 | 56 | | |
54 | 57 | | |
| |||
57 | 60 | | |
58 | 61 | | |
59 | 62 | | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
60 | 66 | | |
61 | 67 | | |
62 | 68 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
22 | 23 | | |
23 | 24 | | |
24 | 25 | | |
| |||
190 | 191 | | |
191 | 192 | | |
192 | 193 | | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
193 | 197 | | |
194 | 198 | | |
195 | 199 | | |
| |||
Lines changed: 17 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
114 | 131 | | |
Lines changed: 1 addition & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| |||
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
44 | | - | |
45 | | - | |
46 | 44 | | |
47 | 45 | | |
48 | 46 | | |
| |||
Lines changed: 4 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
21 | 24 | | |
22 | 25 | | |
23 | 26 | | |
| |||
62 | 65 | | |
63 | 66 | | |
64 | 67 | | |
| 68 | + | |
65 | 69 | | |
66 | | - | |
67 | | - | |
68 | 70 | | |
69 | 71 | | |
70 | 72 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
439 | 439 | | |
440 | 440 | | |
441 | 441 | | |
442 | | - | |
| 442 | + | |
443 | 443 | | |
444 | 444 | | |
445 | 445 | | |
446 | | - | |
| 446 | + | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
447 | 452 | | |
448 | 453 | | |
449 | 454 | | |
450 | | - | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
451 | 459 | | |
452 | 460 | | |
453 | 461 | | |
| |||
0 commit comments