refactor: improve extension pattern filtering architecture #63
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
…s extension filtering to support multiple modes (whitelist, blacklist, combined) with better control flow.
TristanSpeakEasy
added
documentation
📊 Test Coverage ReportCurrent Coverage: Coverage Change: 📈 +.1% (improved) Coverage by Package
📋 Detailed Coverage by Function (click to expand)
Generated by GitHub Actions |
|
While this does contain a breaking change its a fast follow after the release of sanitize so should have no usage currently |
bflad
approved these changes
Oct 14, 2025
Co-authored-by: Brian Flad <[email protected]>
Co-authored-by: Brian Flad <[email protected]>
Co-authored-by: Brian Flad <[email protected]>
Co-authored-by: Brian Flad <[email protected]>
TristanSpeakEasy
deleted the
refactor/extension-filter-whitelist-blacklist
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.
Overview
Refactors the extension pattern filtering architecture in the sanitize functionality to support multiple filtering modes: whitelist (Keep), blacklist (Remove), and combined mode where whitelist takes precedence.
Addresses: #62 (comment)
This PR adds whitelist (Keep) functionality alongside the existing blacklist (Remove) patterns, making it much easier to maintain sanitization configs when you want to keep only specific extensions.
Changes
Core Architecture
New
ExtensionFilterstruct (openapi/sanitize.go:16-30)[]stringpattern list with structured filter supporting both Keep and Remove patternsKeep []string- Whitelist patterns (only matching extensions are kept)Remove []string- Blacklist patterns (only matching extensions are removed)Refactored filtering logic (
openapi/sanitize.go:232-336)determineRemovalAction()helper function for cleaner switch-based logicmatchInfotype for pattern usage trackingFiltering Modes
Testing
Updated existing tests to use new
&ExtensionFilter{Remove: []}syntaxNew test coverage:
TestSanitize_WhitelistMode_Success- Tests Keep patternsTestSanitize_WhitelistOverridesBlacklist_Success- Tests whitelist precedence with realistic scenario (remove allx-speakeasy-*exceptx-speakeasy-schema-*)TestSanitize_EmptyFilter_Success- Tests empty filter removes allTestSanitize_WildcardKeep_Success- Tests wildcard Keep patternTestSanitize_InvalidKeepPattern_Warning- Tests invalid Keep pattern warningsTestSanitize_InvalidRemovePattern_Warning- Tests invalid Remove pattern warningsAll 14 sanitize tests passing ✅
Configuration
YAML format (
openapi/testdata/sanitize/sanitize_pattern_config.yaml)Programmatic usage:
Breaking Changes
To:
Users must update their configuration files to use the new nested structure.
Documentation Updates
openapi/sanitize.gowith comprehensive examplesopenapi/cmd/sanitize.goCLI help textopenapi/cmd/README.mdwith new configuration formatLinter Compliance
CI Status
All CI checks passed: