-
Notifications
You must be signed in to change notification settings - Fork 55
Description
Coming from:
- [RFC] Upgrade to use Webpack v5, React v18, NodeJS v22 OpenSearch-Dashboards#11080
- RFC: OSD migrate from Webpack to Rspack OpenSearch-Dashboards#11125.
Background
As part of OpenSearch Dashboards' upgrade to Node.js v22.21.1 (later 22.22.0) and Rspack v1.6.4, we need to verify plugin compatibility. This is part of a larger initiative for OpenSearch 3.5.0.
-
Node.js 22 upgrade is necessary due to version 20 will reach end-of-life in April 2026. The related PR PR2 has PASSED ALL CI TESTS on the OpenSearch Dashboards main branch. There are no source code changes required in OpenSearch-Dashboards core, as changes are limited to unit test adjustments to accommodate Node.js 22 behavior.
-
The Rspack 1.6.4 upgrade is part of modernizing the build tool-chain, bringing improved build performance, better tree-shaking, and support for modern JavaScript features. The related PR has also been merged to main branch.
Timeline (⚠️ IMPORTANT! ⚠️ )
As an OpenSearch-Dashboards Plugin owner, please test your OSD Plugin by 2026/01/23 and report any issues before this deadline. We plan to onboard these changes to OS/OSD 3.5.0 which will have the code freeze by 2026/01/26.
Verification Steps
- Verify code compilation
# Checkout OSD core repo and switch to main branch
git clone https://github.com/opensearch-project/OpenSearch-Dashboards
git checkout main
# Install Node v22 (ensure you have NVM installed, or use other method to install Node.js)
nvm install 22.22.0
nvm use 22.22.0
# Clean legacy dependencies
yarn osd bootstrap clean
# Checkout your OSD Plugin repo in plugins directory, ex: https://github.com/opensearch-project/alerting-dashboards-plugin
cd plugins
git clone <your OSD plugin repository url / link>
cd <your OSD plugin directory>
# Bootstrap OpenSearch Dashboards and the plugin
yarn osd bootstrap
# Back to root folder of OSD repo
cd ../../
# Start OpenSearch Dashboards
yarn start
-
Bump plugin to version 3.5.0.0 if not already done, check
pull requesttab of your repo to see if there is any AUTOCUT PR to merge in order to bump your plugin to 3.5.0.0. -
Check Bundle Generation: Verify that your plugin's bundle files are created.
-
Browser Console Verification: Once OpenSearch Dashboards starts;
- Open browser developer tools (F12)
- Check the Console tab for:
- No module loading errors related to your plugin
- No "Failed to load plugin" messages
- Your plugin initialization logs (if any)
- Check the Network tab:
- Verify your plugin's bundle files load successfully (200 status)
- No 404 errors for plugin assets
-
Run automated tests within your plugin.
-
Perform manual functional testing to confirm everything works as expected.
Known issues (can ignore)
- fs.Stats deprecation warning: During the OpenSearch Dashboards upgrade, we encountered
fs.Statsdeprecation warnings introduced byvinyl-fs. This requires upgrading some third-party dependencies to avoid the warning. However, the API can still be used, and after discussion in an RFC, we decided to keep the current implementation and migrate it on the next Node.js version upgrade. Plugin owners should be aware of this warning but no immediate action is required.
Action Required
Please follow the Verification Steps section above to verify your plugin status.
-
If no issues are encountered, please close this issue.
-
If issues are found, please comment on this issue and the meta issue on the top to help other plugin maintainers who might face similar challenges.
Point of Contact
Please also tag @wanglam (node22) @ruanyl (Rspack) @peterzhuamazon (Release) for the matter.
Thanks.