Skip to content

[OE] plugins should not include devDependencies in their dependencies and only have dependencies they need #6306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kavilla opened this issue Apr 2, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers operational excellence

Comments

@kavilla
Copy link
Member

kavilla commented Apr 2, 2024

Is your feature request related to a problem? Please describe.

dependences with package.json is what the plugin will be compiled down with to use for release builds. Even if those dependencies are utilized in dev only. This will increase the distribution size, risk security issues, and increase the build time.

Example:
https://github.com/opensearch-project/dashboards-assistant/blob/3991de2f7a732ddd87c29ae30ad03e8ee768cd10/package.json#L24

^ note: This could be on purpose, I'm not sure how it is using JSDOM.

Describe the solution you'd like

Audit https://github.com/opensearch-project plugins for OpenSearch Dashboards and verify their dependencies does not include any obvious devDependencies. Like anything with tests would be easy to spot.

In this process, we should verify that dependencies from the plugins are required. If it is not use, then likely just needs to be cleaned up.

If so, create an issue in their repo (potentially make the change). Track it apart of this issue. Maybe, just create an issue for every OpenSearch Dashboards to have them verify their dependencies are valid.

Describe alternatives you've considered

n/a

Additional context

n/a

@kavilla kavilla added enhancement New feature or request good first issue Good for newcomers operational excellence labels Apr 2, 2024
@kavilla kavilla removed the untriaged label Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers operational excellence
Projects
None yet
Development

No branches or pull requests

1 participant