fix: make X-Glean options survive Speakeasy SDK regeneration #96
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The X-Glean feature added in PR #95 placed custom properties directly in src/lib/config.ts, which is regenerated by Speakeasy. This caused CI failures when the Generate workflow ran, as the custom properties were overwritten. This fix: - Creates a separate XGleanOptions interface in src/hooks/x-glean-options.ts (hooks directory is not regenerated after initial creation) - Updates the hook to cast options to the new interface - Updates tests to use intersection types for type safety - Removes the custom properties from config.ts (they would be removed during regeneration anyway) Co-Authored-By: Claude Opus 4.5 <[email protected]>
travis-hoover-glean
approved these changes
Feb 3, 2026
chris-freeman-glean
deleted the
cfreeman/fix-x-glean-sdk-options-regeneration
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the CI "Generate" workflow failures that have been occurring since #95 was merged.
Root cause: PR #95 added custom properties (
excludeDeprecatedAfter,includeExperimental) directly toSDKOptionsinsrc/lib/config.ts. However, this file is generated by Speakeasy and gets overwritten during SDK regeneration, removing the custom properties and causing TypeScript compilation errors.Solution:
XGleanOptionsinterface insrc/hooks/x-glean-options.ts(the hooks directory is only generated once by Speakeasy, so files there persist across regenerations)hookCtx.optionsto the new interfaceSDKOptions & XGleanOptions)config.ts(they would be removed during regeneration anyway)Test plan
speakeasy runregeneration locally🤖 Generated with Claude Code