fix: remove param valiidation of getPlugins #3502
Open
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
nameless-mc
requested review from
chihiro-adachi and
shabaraba
and removed request for
a team
Copilot finished reviewing on behalf of
nameless-mc
November 19, 2025 06:36
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR removes runtime parameter validation from the PluginClient.getPlugins() method to achieve consistency with other similar API methods in the codebase. The change shifts validation responsibility entirely to TypeScript's type system.
Key Changes:
- Removed runtime validation logic for the
idsparameter ingetPlugins() - Removed 5 corresponding test cases that validated the runtime checks
- Maintained existing tests for normal operation with the
idsparameter
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
packages/rest-api-client/src/client/PluginClient.ts |
Removed runtime validation for ids parameter (array type check and string element check) from getPlugins() method |
packages/rest-api-client/src/client/__tests__/PluginClient.test.ts |
Removed 5 test cases that validated the runtime parameter checking behavior |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Why
Only the
PluginClient.getPlugins()method performs runtime validation for theidsparameter, while other API methods (such asAppClient.getApps(),PluginClient.getRequiredPlugins()) do not implement similar validation. To maintain consistency across the API, we should remove the validation fromgetPlugins()and rely on TypeScript's type system like other methods.What
idsparameter fromPluginClient.getPlugins()methodwith ids parameter)With this change, the
getPlugins()method will rely solely on TypeScript's type checking, consistent with other methods.How to test
Checklist
pnpm lintandpnpm teston the root directory.