2.8 KiB
| description | keywords | title | menutitle | weight | |||||
|---|---|---|---|---|---|---|---|---|---|
| Guide for migrating plugins from Grafana v9.x to v10.x |
|
Migrating plugins from Grafana 9.x to 10.x | v9.x to v10.x | 1900 |
Migrating plugins from Grafana version 9.x to 10.x
Verifying plugin behaviour with React 18
Grafana 10 includes our upgrade to React 18 and use of the new React client rendering API. These changes were delivered to the core grafana repo with PR 64428.
Whilst this brings us many significant benefits, there's a potential for this to impact the way your plugin works. In particular, there could be unintended side effects caused by the changes around improving consistency with useEffect timings and automatic batching of state updates.
Recommended actions:
- Review the React 18 upgrade docs
- Test your plugins against one of the latest grafana-dev docker images (for example, this one)
- Add a comment to the forum discussion if your plugin is impacted in any way. Either to socialise the changes needed for your plugin or to reach out and ask for help yourself.
DataFrame field values are now just arrays
In Grafana 10, the values in DataFrames are now managed as simple JavaScript arrays (see #66480). It is no longer necessary to wrap values in a Vector implementation. Most code targeting 9.x will continue to work without any issues. In the rare case that existing code directly implements Vector rather than extending/using base classes, this should either return an array or extend FunctionalVector. All Vector implementations have been deprecated and will be removed in the future.
When writing plugins that should run on 9.x, continue to use the Vector interfaces; when targeting 10+ you can now use simple arrays rather than wrapper classes.
To make this transition seamless, the Original JavaScript Sin™ was employed: the native Array prototype had to be extended with several Vector methods. We will atone and undo this in v11, when Vector interfaces and classes are removed.