@dizzlkheinz/ynab-mcpb 0.15.1 → 0.16.1
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.
- package/CHANGELOG.md +36 -0
- package/CLAUDE.md +113 -18
- package/README.md +19 -4
- package/dist/bundle/index.cjs +53 -52
- package/dist/server/YNABMCPServer.d.ts +2 -6
- package/dist/server/YNABMCPServer.js +5 -1
- package/dist/server/resources.d.ts +17 -13
- package/dist/server/resources.js +237 -48
- package/dist/tools/reconcileAdapter.d.ts +1 -0
- package/dist/tools/reconcileAdapter.js +1 -0
- package/dist/tools/reconciliation/csvParser.d.ts +3 -0
- package/dist/tools/reconciliation/csvParser.js +58 -19
- package/dist/tools/reconciliation/executor.js +47 -1
- package/dist/tools/reconciliation/index.js +82 -42
- package/dist/tools/reconciliation/reportFormatter.d.ts +1 -0
- package/dist/tools/reconciliation/reportFormatter.js +49 -36
- package/dist/tools/transactionTools.js +5 -0
- package/docs/reference/API.md +144 -0
- package/docs/technical/reconciliation-system-architecture.md +2251 -0
- package/package.json +1 -1
- package/src/server/YNABMCPServer.ts +7 -0
- package/src/server/__tests__/resources.template.test.ts +198 -0
- package/src/server/__tests__/resources.test.ts +10 -2
- package/src/server/resources.ts +307 -62
- package/src/tools/__tests__/transactionTools.test.ts +90 -17
- package/src/tools/reconcileAdapter.ts +2 -0
- package/src/tools/reconciliation/__tests__/reportFormatter.test.ts +23 -23
- package/src/tools/reconciliation/csvParser.ts +84 -18
- package/src/tools/reconciliation/executor.ts +58 -1
- package/src/tools/reconciliation/index.ts +105 -55
- package/src/tools/reconciliation/reportFormatter.ts +55 -37
- package/src/tools/transactionTools.ts +10 -0
- package/.dxtignore +0 -57
- package/CODEREVIEW_RESPONSE.md +0 -128
- package/SCHEMA_IMPROVEMENT_SUMMARY.md +0 -120
- package/TESTING_NOTES.md +0 -217
- package/accountactivity-merged.csv +0 -149
- package/bundle-analysis.html +0 -13110
- package/docs/plans/2025-11-20-reloadable-config-token-validation.md +0 -93
- package/docs/plans/2025-11-21-fix-transaction-cached-property.md +0 -362
- package/docs/plans/2025-11-21-reconciliation-error-handling.md +0 -90
- package/docs/plans/2025-11-21-v014-hardening.md +0 -153
- package/docs/plans/reconciliation-v2-redesign.md +0 -1571
- package/fix-types.sh +0 -17
- package/test-csv-sample.csv +0 -28
- package/test-exports/sample_bank_statement.csv +0 -7
- package/test-reconcile-autodetect.js +0 -40
- package/test-reconcile-tool.js +0 -152
- package/test-reconcile-with-csv.cjs +0 -89
- package/test-statement.csv +0 -8
- package/test_debug.js +0 -47
- package/test_mcp_tools.mjs +0 -75
- package/test_simple.mjs +0 -16
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
# Reloadable Config & Token Validation Implementation Plan
|
|
2
|
-
|
|
3
|
-
> **For Claude:** REQUIRED SUB-SKILL: Use superpowers:executing-plans to implement this plan task-by-task.
|
|
4
|
-
|
|
5
|
-
**Goal:** Make config parsing reloadable for env-mutation tests/CI, harden token validation against malformed responses, and confirm integration runs with a valid YNAB token.
|
|
6
|
-
|
|
7
|
-
**Architecture:** Parse env vars on-demand via `loadConfig()` (with a backward-compatible `config` singleton), inject per-server config instances instead of module globals, and wrap YNAB token validation failures (including non-JSON responses) into `AuthenticationError` with clear messaging.
|
|
8
|
-
|
|
9
|
-
**Tech Stack:** Node + TypeScript, Zod, dotenv, Vitest, YNAB SDK, esbuild.
|
|
10
|
-
|
|
11
|
-
### Task 1: Reloadable config loader
|
|
12
|
-
|
|
13
|
-
**Files:**
|
|
14
|
-
- Modify: `src/server/config.ts`
|
|
15
|
-
- Modify: `src/server/__tests__/config.test.ts`
|
|
16
|
-
|
|
17
|
-
**Step 1: Write failing test**
|
|
18
|
-
Add a test that calls `loadConfig()` twice after mutating `process.env.YNAB_ACCESS_TOKEN` (without re-importing the module) and expects the second call to return the updated token.
|
|
19
|
-
|
|
20
|
-
**Step 2: Run test to verify failure**
|
|
21
|
-
Run `npx vitest run src/server/__tests__/config.test.ts` and confirm the new test fails because the loader is still tied to initial state.
|
|
22
|
-
|
|
23
|
-
**Step 3: Implement reloadable loader**
|
|
24
|
-
Keep the Zod schema and explicit `config` singleton, but ensure `loadConfig()` re-parses `process.env` on every call (optionally allowing an env override for tests) and throws `ValidationError` on failure; keep `import 'dotenv/config'` so `.env` is loaded for Node execution.
|
|
25
|
-
|
|
26
|
-
**Step 4: Re-run targeted test**
|
|
27
|
-
Re-run `npx vitest run src/server/__tests__/config.test.ts` to confirm the reloadable behavior passes.
|
|
28
|
-
|
|
29
|
-
### Task 2: Inject per-instance config into YNABMCPServer
|
|
30
|
-
|
|
31
|
-
**Files:**
|
|
32
|
-
- Modify: `src/server/YNABMCPServer.ts`
|
|
33
|
-
- Modify: `src/server/__tests__/YNABMCPServer.test.ts`
|
|
34
|
-
- Modify: `src/server/__tests__/server-startup.integration.test.ts`
|
|
35
|
-
|
|
36
|
-
**Step 1: Add/adjust tests**
|
|
37
|
-
Add coverage that changing `process.env.YNAB_ACCESS_TOKEN` before constructing a new `YNABMCPServer` produces a server wired to the new token (no module cache reset), and update expectations to align with `ValidationError` from `loadConfig()` where appropriate.
|
|
38
|
-
|
|
39
|
-
**Step 2: Run tests to see failures**
|
|
40
|
-
Run `npx vitest run src/server/__tests__/YNABMCPServer.test.ts src/server/__tests__/server-startup.integration.test.ts`.
|
|
41
|
-
|
|
42
|
-
**Step 3: Apply code changes**
|
|
43
|
-
Ensure the constructor stores `const configInstance = loadConfig()` and uses it for YNAB API creation, token validation, and tool execution auth; remove any lingering usage of the `config` singleton for runtime behavior.
|
|
44
|
-
|
|
45
|
-
**Step 4: Re-run the affected tests**
|
|
46
|
-
Re-run the same Vitest targets to verify per-instance config wiring passes.
|
|
47
|
-
|
|
48
|
-
### Task 3: Token validation resilience
|
|
49
|
-
|
|
50
|
-
**Files:**
|
|
51
|
-
- Modify: `src/server/YNABMCPServer.ts`
|
|
52
|
-
- Modify: `src/server/__tests__/server-startup.integration.test.ts`
|
|
53
|
-
|
|
54
|
-
**Step 1: Write failing test**
|
|
55
|
-
Mock `ynab.API().user.getUser` to reject with a `SyntaxError`/HTML-shaped error and expect `validateToken()` to reject with `AuthenticationError("Unexpected response from YNAB during token validation")` instead of surfacing the raw syntax failure.
|
|
56
|
-
|
|
57
|
-
**Step 2: Run test to confirm failure**
|
|
58
|
-
Run `npx vitest run src/server/__tests__/server-startup.integration.test.ts`.
|
|
59
|
-
|
|
60
|
-
**Step 3: Implement graceful handling**
|
|
61
|
-
Wrap token validation to catch non-JSON/SyntaxError cases (or responses lacking expected shape) and throw `AuthenticationError` with the clear message while preserving existing 401/403 mapping.
|
|
62
|
-
|
|
63
|
-
**Step 4: Re-run validation tests**
|
|
64
|
-
Re-run the targeted integration test to ensure the new mapping passes.
|
|
65
|
-
|
|
66
|
-
### Task 4: Test alignment & runner portability
|
|
67
|
-
|
|
68
|
-
**Files:**
|
|
69
|
-
- Modify: `src/server/__tests__/config.test.ts`
|
|
70
|
-
- Modify: `scripts/run-throttled-integration-tests.js`
|
|
71
|
-
|
|
72
|
-
**Step 1: Align config test patterns**
|
|
73
|
-
Update any assertions relying on module-level parsing side effects to use `vi.resetModules()` + `loadConfig()` explicitly for reload checks; keep singleton expectations where intentional.
|
|
74
|
-
|
|
75
|
-
**Step 2: Harden integration runner on Windows**
|
|
76
|
-
Change the throttled runner to spawn Vitest via a platform-portable path (e.g., `node` + resolved `vitest` bin) to avoid `spawn EINVAL` with `.cmd` on Windows.
|
|
77
|
-
|
|
78
|
-
**Step 3: Run quick smoke**
|
|
79
|
-
Run `node scripts/run-throttled-integration-tests.js --help` or kick a single file to ensure the wrapper executes without path errors.
|
|
80
|
-
|
|
81
|
-
### Task 5: Full verification
|
|
82
|
-
|
|
83
|
-
**Files/Commands:**
|
|
84
|
-
- Commands: `npm test`, `npm run test:integration:core` (with `YNAB_ACCESS_TOKEN` set), optionally `npm run test:integration:domain`.
|
|
85
|
-
|
|
86
|
-
**Step 1: Run unit suite**
|
|
87
|
-
Execute `npm test` to ensure unit coverage stays green.
|
|
88
|
-
|
|
89
|
-
**Step 2: Run core integrations with real token**
|
|
90
|
-
Execute `npm run test:integration:core` using a known-good `YNAB_ACCESS_TOKEN`; capture any regressions.
|
|
91
|
-
|
|
92
|
-
**Step 3: Optional extended coverage**
|
|
93
|
-
If time permits, run `npm run test:integration:domain` for broader confidence; note any skips or rate-limit impacts.
|
|
@@ -1,362 +0,0 @@
|
|
|
1
|
-
# Fix Missing `cached` Property in Large Transaction Responses
|
|
2
|
-
|
|
3
|
-
> **For Claude:** REQUIRED SUB-SKILL: Use superpowers:executing-plans to implement this plan task-by-task.
|
|
4
|
-
|
|
5
|
-
**Goal:** Fix GitHub Action test failure by adding the missing `cached` property to large transaction list responses.
|
|
6
|
-
|
|
7
|
-
**Architecture:** The `handleListTransactions` function in `transactionTools.ts` has two response paths: normal (lines 815+) and large response (lines 788-812). The large response path is missing the `cached` and `cache_info` properties that the normal path includes, causing test assertion failures when transaction data exceeds 90KB.
|
|
8
|
-
|
|
9
|
-
**Tech Stack:** TypeScript, Vitest, YNAB API integration tests
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## Background
|
|
14
|
-
|
|
15
|
-
**Current Issue:**
|
|
16
|
-
- GitHub Action failing: `src/tools/__tests__/accountTools.delta.integration.test.ts:94`
|
|
17
|
-
- Error: `expected undefined to be false // Object.is equality`
|
|
18
|
-
- Test code: `expect(firstPayload.cached).toBe(false);`
|
|
19
|
-
|
|
20
|
-
**Root Cause:**
|
|
21
|
-
File `src/tools/transactionTools.ts` has two response code paths:
|
|
22
|
-
1. **Large response path** (lines 788-812): When transactions > 90KB, returns preview + summary
|
|
23
|
-
2. **Normal path** (lines 815+): Returns full transaction list
|
|
24
|
-
|
|
25
|
-
The large response path returns an object WITHOUT the `cached` property.
|
|
26
|
-
The normal path returns an object WITH `cached: cacheHit` and `cache_info`.
|
|
27
|
-
|
|
28
|
-
**Test accounts with many transactions trigger the large response path, causing `cached` to be undefined.**
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
## Task 1: Add Unit Test Coverage for Large Response Path
|
|
33
|
-
|
|
34
|
-
**Files:**
|
|
35
|
-
- Read: `src/tools/__tests__/transactionTools.test.ts`
|
|
36
|
-
- Modify: `src/tools/__tests__/transactionTools.test.ts` (add test after existing tests)
|
|
37
|
-
|
|
38
|
-
**Step 1: Read the existing test file to understand patterns**
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
cat src/tools/__tests__/transactionTools.test.ts | head -100
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
Expected: See test structure, mocking patterns, imports
|
|
45
|
-
|
|
46
|
-
**Step 2: Write failing test for large response cached property**
|
|
47
|
-
|
|
48
|
-
Add this test to `src/tools/__tests__/transactionTools.test.ts` in the appropriate describe block:
|
|
49
|
-
|
|
50
|
-
```typescript
|
|
51
|
-
it('should include cached property in large response path', async () => {
|
|
52
|
-
// Create large transaction list (> 90KB)
|
|
53
|
-
const largeTransactionList: ynab.TransactionDetail[] = [];
|
|
54
|
-
for (let i = 0; i < 5000; i++) {
|
|
55
|
-
largeTransactionList.push({
|
|
56
|
-
id: `transaction-${i}`,
|
|
57
|
-
date: '2025-01-01',
|
|
58
|
-
amount: -10000,
|
|
59
|
-
memo: 'Test transaction with long memo to increase size '.repeat(10),
|
|
60
|
-
cleared: 'cleared',
|
|
61
|
-
approved: true,
|
|
62
|
-
flag_color: null,
|
|
63
|
-
account_id: 'test-account',
|
|
64
|
-
payee_id: null,
|
|
65
|
-
category_id: null,
|
|
66
|
-
transfer_account_id: null,
|
|
67
|
-
transfer_transaction_id: null,
|
|
68
|
-
matched_transaction_id: null,
|
|
69
|
-
import_id: null,
|
|
70
|
-
import_payee_name: null,
|
|
71
|
-
import_payee_name_original: null,
|
|
72
|
-
debt_transaction_type: null,
|
|
73
|
-
deleted: false,
|
|
74
|
-
account_name: 'Test Account',
|
|
75
|
-
payee_name: 'Test Payee',
|
|
76
|
-
category_name: 'Test Category',
|
|
77
|
-
subtransactions: [],
|
|
78
|
-
} as ynab.TransactionDetail);
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
const mockDeltaFetcher = {
|
|
82
|
-
fetchTransactionsByAccount: vi.fn().mockResolvedValue({
|
|
83
|
-
data: largeTransactionList,
|
|
84
|
-
wasCached: false,
|
|
85
|
-
usedDelta: false,
|
|
86
|
-
}),
|
|
87
|
-
} as unknown as DeltaFetcher;
|
|
88
|
-
|
|
89
|
-
const result = await handleListTransactions(mockYnabAPI, mockDeltaFetcher, {
|
|
90
|
-
budget_id: 'test-budget',
|
|
91
|
-
account_id: 'test-account',
|
|
92
|
-
});
|
|
93
|
-
|
|
94
|
-
const content = result.content?.[0];
|
|
95
|
-
expect(content).toBeDefined();
|
|
96
|
-
expect(content?.type).toBe('text');
|
|
97
|
-
|
|
98
|
-
const parsedResponse = JSON.parse(content!.text);
|
|
99
|
-
|
|
100
|
-
// Should have cached property even in large response path
|
|
101
|
-
expect(parsedResponse.cached).toBeDefined();
|
|
102
|
-
expect(parsedResponse.cached).toBe(false);
|
|
103
|
-
expect(parsedResponse.cache_info).toBeDefined();
|
|
104
|
-
});
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
**Step 3: Run the test to verify it fails**
|
|
108
|
-
|
|
109
|
-
```bash
|
|
110
|
-
npm run test:unit -- src/tools/__tests__/transactionTools.test.ts -t "should include cached property in large response path"
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
Expected: FAIL with error about `cached` being undefined
|
|
114
|
-
|
|
115
|
-
**Step 4: Commit the failing test**
|
|
116
|
-
|
|
117
|
-
```bash
|
|
118
|
-
git add src/tools/__tests__/transactionTools.test.ts
|
|
119
|
-
git commit -m "test: add failing test for cached property in large transaction responses"
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
---
|
|
123
|
-
|
|
124
|
-
## Task 2: Fix Large Response Path to Include Cached Property
|
|
125
|
-
|
|
126
|
-
**Files:**
|
|
127
|
-
- Modify: `src/tools/transactionTools.ts:788-812`
|
|
128
|
-
|
|
129
|
-
**Step 1: Read the current large response code**
|
|
130
|
-
|
|
131
|
-
```bash
|
|
132
|
-
cat src/tools/transactionTools.ts | sed -n '788,812p'
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
Expected: See the current implementation missing `cached` and `cache_info`
|
|
136
|
-
|
|
137
|
-
**Step 2: Add cached properties to large response**
|
|
138
|
-
|
|
139
|
-
In `src/tools/transactionTools.ts`, replace lines 788-812 with:
|
|
140
|
-
|
|
141
|
-
```typescript
|
|
142
|
-
if (estimatedSize > sizeLimit) {
|
|
143
|
-
// Return summary and suggest export
|
|
144
|
-
const preview = transactions.slice(0, 50);
|
|
145
|
-
return {
|
|
146
|
-
content: [
|
|
147
|
-
{
|
|
148
|
-
type: 'text',
|
|
149
|
-
text: responseFormatter.format({
|
|
150
|
-
message: `Found ${transactions.length} transactions (${Math.round(estimatedSize / 1024)}KB). Too large to display all.`,
|
|
151
|
-
suggestion: "Use 'export_transactions' tool to save all transactions to a file.",
|
|
152
|
-
showing: `First ${preview.length} transactions:`,
|
|
153
|
-
total_count: transactions.length,
|
|
154
|
-
estimated_size_kb: Math.round(estimatedSize / 1024),
|
|
155
|
-
cached: cacheHit,
|
|
156
|
-
cache_info: cacheHit
|
|
157
|
-
? `Data retrieved from cache for improved performance${usedDelta ? ' (delta merge applied)' : ''}`
|
|
158
|
-
: 'Fresh data retrieved from YNAB API',
|
|
159
|
-
preview_transactions: preview.map((transaction) => ({
|
|
160
|
-
id: transaction.id,
|
|
161
|
-
date: transaction.date,
|
|
162
|
-
amount: milliunitsToAmount(transaction.amount),
|
|
163
|
-
memo: transaction.memo,
|
|
164
|
-
payee_name: transaction.payee_name,
|
|
165
|
-
category_name: transaction.category_name,
|
|
166
|
-
})),
|
|
167
|
-
}),
|
|
168
|
-
},
|
|
169
|
-
],
|
|
170
|
-
};
|
|
171
|
-
}
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
**Changes:**
|
|
175
|
-
- Added `cached: cacheHit,` after `estimated_size_kb`
|
|
176
|
-
- Added `cache_info` with same pattern as normal response path
|
|
177
|
-
|
|
178
|
-
**Step 3: Run unit tests to verify fix**
|
|
179
|
-
|
|
180
|
-
```bash
|
|
181
|
-
npm run test:unit -- src/tools/__tests__/transactionTools.test.ts -t "should include cached property in large response path"
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
Expected: PASS
|
|
185
|
-
|
|
186
|
-
**Step 4: Run all transaction tool tests**
|
|
187
|
-
|
|
188
|
-
```bash
|
|
189
|
-
npm run test:unit -- src/tools/__tests__/transactionTools.test.ts
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
Expected: All tests PASS
|
|
193
|
-
|
|
194
|
-
**Step 5: Commit the fix**
|
|
195
|
-
|
|
196
|
-
```bash
|
|
197
|
-
git add src/tools/transactionTools.ts
|
|
198
|
-
git commit -m "fix: add cached property to large transaction response path
|
|
199
|
-
|
|
200
|
-
- Large responses (>90KB) now include cached and cache_info properties
|
|
201
|
-
- Maintains consistency with normal response path
|
|
202
|
-
- Fixes test failure in delta integration tests"
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
---
|
|
206
|
-
|
|
207
|
-
## Task 3: Verify Integration Test Now Passes
|
|
208
|
-
|
|
209
|
-
**Files:**
|
|
210
|
-
- Test: `src/tools/__tests__/accountTools.delta.integration.test.ts`
|
|
211
|
-
|
|
212
|
-
**Step 1: Run the failing integration test locally**
|
|
213
|
-
|
|
214
|
-
```bash
|
|
215
|
-
npm run test:integration -- src/tools/__tests__/accountTools.delta.integration.test.ts -t "reports delta usage for list_transactions after a change"
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
Expected: PASS (requires YNAB_ACCESS_TOKEN environment variable)
|
|
219
|
-
|
|
220
|
-
Note: If you don't have a YNAB token or want to skip, this is acceptable - the GitHub Action will verify.
|
|
221
|
-
|
|
222
|
-
**Step 2: Run type checking**
|
|
223
|
-
|
|
224
|
-
```bash
|
|
225
|
-
npm run type-check
|
|
226
|
-
```
|
|
227
|
-
|
|
228
|
-
Expected: No TypeScript errors
|
|
229
|
-
|
|
230
|
-
**Step 3: Run all unit tests to ensure no regressions**
|
|
231
|
-
|
|
232
|
-
```bash
|
|
233
|
-
npm run test:unit
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
Expected: All tests PASS
|
|
237
|
-
|
|
238
|
-
**Step 4: Commit verification checkpoint**
|
|
239
|
-
|
|
240
|
-
```bash
|
|
241
|
-
git add -A
|
|
242
|
-
git commit -m "test: verify integration test passes with cached property fix"
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
---
|
|
246
|
-
|
|
247
|
-
## Task 4: Update CHANGELOG and Documentation
|
|
248
|
-
|
|
249
|
-
**Files:**
|
|
250
|
-
- Modify: `CHANGELOG.md` (add entry at top of Unreleased section)
|
|
251
|
-
|
|
252
|
-
**Step 1: Add CHANGELOG entry**
|
|
253
|
-
|
|
254
|
-
Add this entry to the `## [Unreleased]` section in `CHANGELOG.md`:
|
|
255
|
-
|
|
256
|
-
```markdown
|
|
257
|
-
### Fixed
|
|
258
|
-
- Fixed missing `cached` property in large transaction list responses (>90KB)
|
|
259
|
-
- Large response path now includes `cached` and `cache_info` properties
|
|
260
|
-
- Maintains consistency with normal response path
|
|
261
|
-
- Resolves integration test failures when accounts have many transactions
|
|
262
|
-
```
|
|
263
|
-
|
|
264
|
-
**Step 2: Commit documentation**
|
|
265
|
-
|
|
266
|
-
```bash
|
|
267
|
-
git add CHANGELOG.md
|
|
268
|
-
git commit -m "docs: add CHANGELOG entry for cached property fix"
|
|
269
|
-
```
|
|
270
|
-
|
|
271
|
-
---
|
|
272
|
-
|
|
273
|
-
## Task 5: Push and Verify GitHub Action
|
|
274
|
-
|
|
275
|
-
**Files:**
|
|
276
|
-
- Remote: GitHub Actions CI
|
|
277
|
-
|
|
278
|
-
**Step 1: Push all commits to remote**
|
|
279
|
-
|
|
280
|
-
```bash
|
|
281
|
-
git push origin HEAD
|
|
282
|
-
```
|
|
283
|
-
|
|
284
|
-
Expected: Push successful
|
|
285
|
-
|
|
286
|
-
**Step 2: Monitor GitHub Action**
|
|
287
|
-
|
|
288
|
-
```bash
|
|
289
|
-
gh run watch
|
|
290
|
-
```
|
|
291
|
-
|
|
292
|
-
Expected:
|
|
293
|
-
- Job `unit-tests` should PASS
|
|
294
|
-
- Job `integration-core` should PASS (was previously failing at accountTools.delta.integration.test.ts)
|
|
295
|
-
|
|
296
|
-
**Step 3: Verify specific test that was failing**
|
|
297
|
-
|
|
298
|
-
Check GitHub Action logs for:
|
|
299
|
-
```
|
|
300
|
-
✓ src/tools/__tests__/accountTools.delta.integration.test.ts > Delta-backed account tool handlers > reports delta usage for list_transactions after a change
|
|
301
|
-
```
|
|
302
|
-
|
|
303
|
-
Expected: Green checkmark, no assertion errors
|
|
304
|
-
|
|
305
|
-
**Step 4: Create completion summary**
|
|
306
|
-
|
|
307
|
-
Document verification results:
|
|
308
|
-
```markdown
|
|
309
|
-
## Verification Complete
|
|
310
|
-
|
|
311
|
-
- ✅ Unit tests passing locally
|
|
312
|
-
- ✅ Integration tests passing locally (if run)
|
|
313
|
-
- ✅ Type checking passing
|
|
314
|
-
- ✅ GitHub Actions CI passing
|
|
315
|
-
- ✅ Specific failing test now passes
|
|
316
|
-
|
|
317
|
-
The `cached` property is now consistently included in all transaction list responses.
|
|
318
|
-
```
|
|
319
|
-
|
|
320
|
-
---
|
|
321
|
-
|
|
322
|
-
## Testing Strategy
|
|
323
|
-
|
|
324
|
-
**Unit Tests:**
|
|
325
|
-
- New test verifies large response path includes `cached` property
|
|
326
|
-
- Existing tests verify normal response path unchanged
|
|
327
|
-
|
|
328
|
-
**Integration Tests:**
|
|
329
|
-
- `accountTools.delta.integration.test.ts` verifies delta fetcher integration
|
|
330
|
-
- Test creates real transaction, expects `cached: false` on first call
|
|
331
|
-
- Was failing because large accounts returned `cached: undefined`
|
|
332
|
-
|
|
333
|
-
**Manual Verification:**
|
|
334
|
-
- GitHub Action will run full integration suite with real YNAB API
|
|
335
|
-
- Throttled test runner prevents rate limit issues
|
|
336
|
-
- Sequential execution ensures reliable results
|
|
337
|
-
|
|
338
|
-
---
|
|
339
|
-
|
|
340
|
-
## Rate Limiting Context (For Reference)
|
|
341
|
-
|
|
342
|
-
**Note:** The GitHub Action failure was NOT a rate limiting issue. The codebase already has excellent rate limiting:
|
|
343
|
-
|
|
344
|
-
**Existing Rate Limit Infrastructure:**
|
|
345
|
-
- `scripts/run-throttled-integration-tests.js` - Sequential test execution with request tracking
|
|
346
|
-
- Client-side throttling (200 req/hour with 20 req buffer)
|
|
347
|
-
- Request history pruning (60-minute sliding window)
|
|
348
|
-
- Intelligent wait logic with min/max bounds
|
|
349
|
-
- Per-test estimated API call counts
|
|
350
|
-
|
|
351
|
-
**No changes needed to rate limiting.** The issue was purely a missing property in the response object.
|
|
352
|
-
|
|
353
|
-
---
|
|
354
|
-
|
|
355
|
-
## Success Criteria
|
|
356
|
-
|
|
357
|
-
- ✅ Unit test passes for large response cached property
|
|
358
|
-
- ✅ Integration test `accountTools.delta.integration.test.ts:94` passes
|
|
359
|
-
- ✅ GitHub Action CI pipeline passes completely
|
|
360
|
-
- ✅ No TypeScript errors
|
|
361
|
-
- ✅ CHANGELOG updated
|
|
362
|
-
- ✅ All commits follow conventional commit format
|
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
# Reconciliation Error Handling Implementation Plan
|
|
2
|
-
|
|
3
|
-
> **For Claude:** REQUIRED SUB-SKILL: Use superpowers:executing-plans to implement this plan task-by-task.
|
|
4
|
-
|
|
5
|
-
**Goal:** Fix reconciliation integration failures by properly surfacing YNAB API errors (invalid accounts, rate limits) so tests skip or fail appropriately instead of silently returning zero creations.
|
|
6
|
-
|
|
7
|
-
**Architecture:** Add a small error-normalization layer inside the reconciliation executor to interpret YNAB SDK error payloads, propagate fatal conditions (429/invalid account) as errors, and include actionable reasons in action logs for rate-limit detection. Keep bulk/sequential creation flow intact while improving error transparency.
|
|
8
|
-
|
|
9
|
-
**Tech Stack:** TypeScript, Vitest, YNAB SDK, Node 22+
|
|
10
|
-
|
|
11
|
-
### Task 1: Normalize YNAB API errors
|
|
12
|
-
|
|
13
|
-
**Files:**
|
|
14
|
-
- Modify: `src/tools/reconciliation/executor.ts`
|
|
15
|
-
- Test: `src/tools/reconciliation/__tests__/executor.test.ts`
|
|
16
|
-
|
|
17
|
-
**Step 1: Add error normalization utilities**
|
|
18
|
-
|
|
19
|
-
```ts
|
|
20
|
-
// executor.ts (near helper section)
|
|
21
|
-
interface NormalizedYnabError { status?: number; name?: string; message: string; detail?: string }
|
|
22
|
-
function normalizeYnabError(err: unknown): NormalizedYnabError { /* parse err.error.id/detail/status, strings, Error */ }
|
|
23
|
-
function shouldPropagateYnabError(err: NormalizedYnabError): boolean { return [401, 403, 404, 429, 500].includes(err.status ?? 0); }
|
|
24
|
-
function attachStatus(err: NormalizedYnabError): Error { const e = new Error(err.message || err.detail || 'YNAB API error'); if (err.status) (e as any).status = err.status; if (err.name) e.name = err.name; return e; }
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
**Step 2: Use normalized errors in bulk chunk handling**
|
|
28
|
-
|
|
29
|
-
```ts
|
|
30
|
-
// executor.ts processBulkChunk catch
|
|
31
|
-
const ynabErr = normalizeYnabError(error);
|
|
32
|
-
if (shouldPropagateYnabError(ynabErr)) throw attachStatus(ynabErr);
|
|
33
|
-
const reason = ynabErr.message;
|
|
34
|
-
bulkOperationDetails.bulk_chunk_failures += 1;
|
|
35
|
-
actions_taken.push({ type: 'bulk_create_fallback', reason: `Bulk chunk #${chunkIndex} failed (${reason})...` });
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
Expected: rate-limit or invalid-account errors now bubble; other bulk failures still fall back.
|
|
39
|
-
|
|
40
|
-
### Task 2: Propagate fatal errors during sequential creation
|
|
41
|
-
|
|
42
|
-
**Files:**
|
|
43
|
-
- Modify: `src/tools/reconciliation/executor.ts`
|
|
44
|
-
- Test: `src/tools/reconciliation/__tests__/executor.integration.test.ts`
|
|
45
|
-
|
|
46
|
-
**Step 1: Update sequential catch block**
|
|
47
|
-
|
|
48
|
-
```ts
|
|
49
|
-
const ynabErr = normalizeYnabError(error);
|
|
50
|
-
const failureReason = ynabErr.message;
|
|
51
|
-
actions_taken.push({ type: 'create_transaction_failed', reason: ...failureReason... });
|
|
52
|
-
if (shouldPropagateYnabError(ynabErr)) throw attachStatus(ynabErr);
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
Include status-aware message so `containsRateLimitFailure` sees 429 text.
|
|
56
|
-
|
|
57
|
-
**Step 2: Ensure transaction failure counters reflect thrown errors**
|
|
58
|
-
|
|
59
|
-
If fatal error occurs, increment `transaction_failures` before throw to preserve metrics.
|
|
60
|
-
|
|
61
|
-
### Task 3: Cover new error handling with tests
|
|
62
|
-
|
|
63
|
-
**Files:**
|
|
64
|
-
- Modify: `src/tools/reconciliation/__tests__/executor.test.ts`
|
|
65
|
-
- Modify: `src/tools/reconciliation/__tests__/executor.integration.test.ts` (if needed for assertions/fixtures)
|
|
66
|
-
|
|
67
|
-
**Step 1: Add unit tests for non-Error YNAB payload**
|
|
68
|
-
|
|
69
|
-
```ts
|
|
70
|
-
it('propagates rate-limit error objects with status codes', async () => {
|
|
71
|
-
mockCreateTransactions.rejects({ error: { id: '429', detail: 'Too many requests' } });
|
|
72
|
-
await expect(executeReconciliation(...)).rejects.toMatchObject({ status: 429 });
|
|
73
|
-
});
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
**Step 2: Add unit test for invalid account error propagation**
|
|
77
|
-
|
|
78
|
-
Mock 404 payload and expect rejection; verify action reason contains detail when not thrown.
|
|
79
|
-
|
|
80
|
-
**Step 3: Adjust integration expectation if fixtures rely on new messaging**
|
|
81
|
-
|
|
82
|
-
Ensure `containsRateLimitFailure` continues to match updated reason text (no code changes anticipated).
|
|
83
|
-
|
|
84
|
-
### Task 4: Verify fixes locally
|
|
85
|
-
|
|
86
|
-
**Commands:**
|
|
87
|
-
- `npx vitest run --project unit --runInBand src/tools/reconciliation/__tests__/executor.test.ts`
|
|
88
|
-
- `npm run test:integration:core -- --testNamePattern="Reconciliation Executor - Bulk Create Integration"` (rerun the failing suite)
|
|
89
|
-
|
|
90
|
-
Expected: unit tests pass; integration suite either passes or rate-limit skips instead of failing counts.
|