Removed the check that limited the filtering of class properties moved to internals#15845
Open
skywing918 wants to merge 3 commits into
Open
Removed the check that limited the filtering of class properties moved to internals#15845skywing918 wants to merge 3 commits into
skywing918 wants to merge 3 commits into
Conversation
added 2 commits
June 3, 2026 15:38
…nt transition in filterClassPropertiesMovedToInternals
Contributor
There was a problem hiding this comment.
Pull request overview
This PR broadens the changelog filtering behavior in DifferenceDetector.filterClassPropertiesMovedToInternals so that class properties removed from the public surface (but still available via constructor parameters / option bags) are filtered for all SDK type transitions, not only HighLevelClient → ModularClient. It also adds a regression test to validate the expanded behavior on a ModularClient → ModularClient transition.
Changes:
- Removed the SDK-type guard that limited constructor-parameter/option-bag-based filtering to HighLevelClient → ModularClient transitions.
- Added a new test case asserting that removed class properties which remain direct constructor parameters are filtered regardless of SDK type.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| tools/js-sdk-release-tools/src/changelog/v2/DifferenceDetector.ts | Removes the HLC→Modular-only gating so the property-removal filtering runs for all SDK-type transitions. |
| tools/js-sdk-release-tools/src/test/changelog/changelogGenerator.test.ts | Adds coverage for Modular→Modular to ensure constructor-parameter-retained properties are filtered as intended. |
…vals in SDK transitions
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request removes a restriction in the
filterClassPropertiesMovedToInternalsmethod so that class properties that remain as constructor parameters are filtered out of changelogs for all SDK type transitions, not just HighLevelClient to ModularClient. A new test is added to verify this behavior for ModularClient to ModularClient transitions.Changelog filtering logic updates:
DifferenceDetector, making the filtering apply to all SDK type transitions.Testing improvements:
changelogGenerator.test.tsto ensure that class properties which remain constructor parameters are filtered regardless of SDK type, confirming the broader applicability of the filtering logic.