Skip to content

Removed the check that limited the filtering of class properties moved to internals#15845

Open
skywing918 wants to merge 3 commits into
mainfrom
DetectedClassProps
Open

Removed the check that limited the filtering of class properties moved to internals#15845
skywing918 wants to merge 3 commits into
mainfrom
DetectedClassProps

Conversation

@skywing918
Copy link
Copy Markdown
Contributor

This pull request removes a restriction in the filterClassPropertiesMovedToInternals method 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:

  • Removed the check that limited the filtering of class properties moved to internals to only HighLevelClient → ModularClient transitions in DifferenceDetector, making the filtering apply to all SDK type transitions.

Testing improvements:

  • Added a test case to changelogGenerator.test.ts to ensure that class properties which remain constructor parameters are filtered regardless of SDK type, confirming the broader applicability of the filtering logic.

Copilot AI review requested due to automatic review settings June 3, 2026 07:56
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread tools/js-sdk-release-tools/src/changelog/v2/DifferenceDetector.ts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants