Skip to content

Commit 946c67d

Browse files
committed
Auto-fix formatting
1 parent 34faee2 commit 946c67d

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

docs/investigations/investigation-ee-18478.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,14 @@
2525
## Technical Details
2626

2727
### Published Version (v0.8.0)
28+
2829
- **Published**: 2025-08-26
2930
- **api-client version**: 0.9.1 ❌
3031
- **Missing enum values**: `AUTHOR_PREFIX`, `AUTHOR_SUFFIX`
3132
- **npm package**: https://www.npmjs.com/package/@gleanwork/local-mcp-server/v/0.8.0
3233

3334
### Current Main Branch
35+
3436
- **api-client version**: 0.13.0 ✅
3537
- **Includes enum values**: `AUTHOR_PREFIX`, `AUTHOR_SUFFIX`
3638
- **Merged**: 2025-11-01 (commit: 019672f)
@@ -60,47 +62,54 @@ grep -A 3 '@gleanwork/api-client@0.13.0' pnpm-lock.yaml
6062
## Customer Impact
6163

6264
### Affected User
65+
6366
- **Customer**: PebblePost (GCP)
6467
- **Contact**: mlyons@pebblepost.com
6568
- **Environment**: VSCode + GitHub Copilot with MCP
6669

6770
### Error Pattern
71+
6872
- **Frequency**: ~40-50% of queries (10/22 failed in testing)
6973
- **Tools Affected**: `company_search`
7074
- **Error Message**:
75+
7176
```
7277
Error: Response validation failed: [
7378
{
7479
"received": "AUTHOR_PREFIX",
7580
"code": "invalid_enum_value",
76-
"options": ["SIMILAR", "FRESHNESS", "TITLE", "CONTENT", "NONE",
81+
"options": ["SIMILAR", "FRESHNESS", "TITLE", "CONTENT", "NONE",
7782
"THREAD_REPLY", "THREAD_ROOT", "PREFIX", "SUFFIX"],
7883
"path": ["results", 9, "allClusteredResults", 0, "clusterType"],
79-
"message": "Invalid enum value. Expected 'SIMILAR' | 'FRESHNESS' | ...
84+
"message": "Invalid enum value. Expected 'SIMILAR' | 'FRESHNESS' | ...
8085
received 'AUTHOR_PREFIX'"
8186
}
8287
]
8388
```
8489

8590
### Why ~40% Failure Rate?
91+
8692
The enum values `AUTHOR_PREFIX` and `AUTHOR_SUFFIX` are returned by the Glean API for certain types of search results (likely email/slack thread results where clustering by author makes sense). Not all search results include these cluster types, which explains the intermittent nature of the errors.
8793

8894
---
8995

9096
## Related Resources
9197

9298
### Code Changes
99+
93100
- **PR #310**: https://github.com/gleanwork/mcp-server/pull/310
94101
- **Commit**: 019672f (2025-11-01)
95102
- **PR #299**: https://github.com/gleanwork/mcp-server/pull/299 (0.9.1 → 0.11.2)
96103
- **Commit**: faf6b39 (2025-10-13)
97104

98105
### Support Tickets
106+
99107
- **Zendesk**: #20013 - https://gleanwork.zendesk.com/agent/tickets/20013
100108
- **JIRA**: EE-18478 - https://askscio.atlassian.net/browse/EE-18478
101109
- **Slack**: https://askscio.slack.com/archives/C03F3JNP9HP/p1763745031689369
102110

103111
### API Client Versions
112+
104113
- **v0.9.1** (broken): https://raw.githubusercontent.com/gleanwork/api-client-typescript/v0.9.1/src/models/components/clustertypeenum.ts
105114
- **v0.13.0** (fixed): https://raw.githubusercontent.com/gleanwork/api-client-typescript/v0.13.0/src/models/components/clustertypeenum.ts
106115

@@ -109,12 +118,14 @@ The enum values `AUTHOR_PREFIX` and `AUTHOR_SUFFIX` are returned by the Glean AP
109118
## Resolution Steps
110119

111120
### Completed Actions
121+
112122
- ✅ Identified root cause: api-client 0.9.1 missing enum values
113123
- ✅ Verified fix in main branch: api-client 0.13.0 includes required enums
114124
- ✅ All tests passing with fix in place
115125
- ✅ PR #310 merged to main on 2025-11-01
116126

117127
### Next Steps
128+
118129
1. Cut v0.9.0 release from main branch
119130
2. Publish to npm registry
120131
3. Notify customer to update
@@ -124,6 +135,7 @@ The enum values `AUTHOR_PREFIX` and `AUTHOR_SUFFIX` are returned by the Glean AP
124135
## Prevention for Future
125136

126137
Consider:
138+
127139
1. Adding integration tests that use real API responses (not just mocks)
128140
2. Monitoring api-client releases for enum changes
129141
3. Dependabot is already configured and caught this (PR #310) - just needed to be released
@@ -134,4 +146,3 @@ Consider:
134146
Generated: 2025-11-21
135147
Investigated by: Chris Freeman
136148
Related Issues: EE-18478, Zendesk #20013
137-

0 commit comments

Comments
 (0)