React 19 Plugin Migration

作者 grafana1ccacf29049fApache-2.0279 个星标收录于 2026年10月8日更新于 2026年10月8日仓库今天更新

Migrate a Grafana plugin to React 19 compatibility. Use when the user asks to update a plugin for React 19, prepare for React 19, fix React 19 compatibility, upgrade to React 19, migrate to React 19, bump grafanaDependency to 12.3.0, externalize jsx-runtime, or run react-detect. Triggers on phrases like "update plugin for React 19", "React 19 migration", "prepare for React 19", "plugin React 19 compat", "grafanaDependency 12.3.0", "JSX runtime externals", "react-detect", "SECRET_INTERNALS", "ReactCurrentOwner", or "ReactCurrentDispatcher".

AI 生成的概览

指导将 Grafana 插件迁移至 React 19 兼容,按顺序完成构建、依赖与源码修改步骤。

功能
提供一套按顺序执行的十一步流程,使 Grafana 插件向前兼容 React 19,而不升级 React 本身。内容包括识别插件上下文、运行 react-detect 扫描、更新 create-plugin 脚手架、完成 ESLint 9 扁平配置迁移、外置 jsx-runtime、提升 grafanaDependency 以及 Grafana、Faro、React 相关依赖、修复 peer 依赖,并修正源码中已弃用的 React API。最后进行构建、类型检查与测试验证、CI 检查,并压缩为单个提交,同时指向一个已知问题参考文件。
适用场景
当用户要求为 React 19 更新 Grafana 插件、为 React 19 做准备、修复 React 19 兼容性、将 grafanaDependency 提升到 12.3.0、外置 jsx-runtime 或运行 react-detect 时使用。适用于为 Grafana 13 做准备的插件仓库。
运行要求
需要具备 shell 与 git 访问权限的智能体,并在 Grafana 插件仓库中工作。需要 Node.js、npm/npx、yarn 或 pnpm、jq,以及用于获取 @grafana/create-plugin 和 @grafana/react-detect 的网络访问。多个步骤要求 git 工作区干净。不附带脚本,仅为说明文档,另有一份已知问题参考文档。

Migrate Grafana Plugin to React 19

Grafana 13 (April 2026) moves from React 18 to React 19. Incompatible plugins will break. Do not upgrade React to 19 — only make forward-compatible changes.

All changes go in one PR. Execute steps in order. Never manually edit yarn.lock.


Step 1: Detect plugin context

bash
PLUGIN_JSON=$([ -f src/plugin.json ] && echo "src/plugin.json" \  || ([ -f plugin/src/plugin.json ] && echo "plugin/src/plugin.json" || echo ""))PKG_JSON=$([ -f package.json ] && echo "package.json" \  || ([ -f plugin/package.json ] && echo "plugin/package.json" || echo ""))PLUGIN_ID=$(jq -r '.id' $PLUGIN_JSON 2>/dev/null)[ -f yarn.lock ] && PM="yarn" || ([ -f pnpm-lock.yaml ] && PM="pnpm" || PM="npm")CP_VERSION=$(jq -r '.version' .config/.cprc.json 2>/dev/null)echo "PLUGIN_ID=$PLUGIN_ID  PM=$PM  CP=$CP_VERSION"

If PLUGIN_ID is empty, ask the user for the plugin root path.


Step 2: Scan for compatibility issues

Build the plugin and run the React 19 compatibility scanner:

bash
npm run build 2>&1 | tail -5npx -y @grafana/react-detect@latest 2>&1

Save the output. It flags:

  • jsxRuntimeImport / __SECRET_INTERNALS → Step 4 fixes this
  • defaultProps / propTypes / ReactDOM.render → Step 8 (source fixes)
  • findDOMNode → Step 6 (dependency bump) or Step 8 (source fix)

If the build fails (plugin hasn't been built before), skip this step and run react-detect after Step 9 instead. If output says "No breaking changes detected", still proceed — jsx-runtime externalization and grafanaDependency bump are always required.

Re-run react-detect after Step 9 to confirm all issues are resolved.


Step 3: Update @grafana/create-plugin

The scaffolding update brings in externals extraction, jest mocks, Docker fixes, and webpack improvements needed for React 19. Always do this before add externalize-jsx-runtime.

Requires a clean git working tree. Create a feature branch first if not already on one.

Run the update

bash
npx @grafana/create-plugin@latest update 2>&1

If yarn install fails with "engine is incompatible"

The update runs an intermediate yarn install without --ignore-engines. Complete it manually:

bash
yarn install --ignore-scripts --ignore-engines 2>&1 | tail -10

Commit the intermediate state and re-run:

bash
git add -A && git commit -m "chore: intermediate create-plugin update" --no-verifynpx @grafana/create-plugin@latest update 2>&1

If ESLint 9 migration (004) fails with a parser error

The auto-migration can generate invalid JS on plugins with complex ESLint configs. Do not skip — commit what succeeded, then complete the ESLint 9 migration manually:

bash
git add -A && git commit -m "chore: update create-plugin (ESLint 9 migration manual)" --no-verify

Then follow the "Complete ESLint 9 migration" section below to finish.

After the update

Always run install and verify:

bash
yarn install --ignore-scripts --ignore-engines 2>&1 | tail -10cat .config/.cprc.json

Commit if there are changes:

bash
git add -A && git diff --cached --quiet || git commit -m "chore: update create-plugin scaffolding" --no-verify

Step 3b: Complete ESLint 9 migration

The create-plugin update bumps ESLint to v9, which requires flat config (eslint.config.js) instead of .eslintrc. Whether the auto-migration (004) succeeded, partially succeeded, or failed, you must ensure ESLint works before proceeding.

Check the current state

bash
ls eslint.config.js .eslintrc* .config/.eslintrc* 2>/dev/nullnpx eslint --version 2>&1

Three scenarios:

A) eslint.config.js exists and yarn lint passes — auto-migration succeeded. Proceed.

B) eslint.config.js exists but yarn lint fails — partial migration. Fix the issues:

bash
yarn lint 2>&1 | head -30

Common fixes:

  • Invalid option '--ignore-path' or Invalid option '--ext' → remove those flags from the lint script in package.json. In ESLint v9 flat config, ignores and file matching are configured inside eslint.config.js, not via CLI flags. Update to: eslint --cache .
  • Cannot find module 'eslint-plugin-deprecation' → remove the import/reference from eslint.config.js (replaced by @typescript-eslint/no-deprecated)
  • Other dead plugin imports → remove them from the config if the package was removed

C) No eslint.config.js exists — auto-migration failed. Create one manually:

bash
ls node_modules/@grafana/eslint-config/flat.js 2>/dev/null

If flat.js exists, create eslint.config.js using it as the base:

js
import grafanaConfig from '@grafana/eslint-config/flat';
export default [  ...grafanaConfig,  {    ignores: ['**/dist/', '**/node_modules/', '**/.config/', '**/coverage/'],  },];

Then migrate any custom rules from the old .eslintrc into additional config objects in the array. After creating the flat config:

  1. Update the lint script: "lint": "eslint --cache ."
  2. Delete the root .eslintrc (leave .config/.eslintrc — it's scaffolded and harmless)

Verify lint works

bash
yarn lint 2>&1 | tail -20

Fix auto-fixable issues with yarn lint --fix. Commit:

bash
git add -A && git diff --cached --quiet || git commit -m "chore: complete ESLint 9 flat config migration" --no-verify

Step 4: Externalize jsx-runtime

Always use the create-plugin add command. Requires a clean git working tree.

bash
npx @grafana/create-plugin@latest add externalize-jsx-runtime 2>&1

Verify:

bash
grep "jsx-runtime" .config/bundler/externals.ts 2>/dev/null
  • Found → commit and proceed.
  • Not found → command failed. Only then add externals manually to the root webpack.config.ts:
ts
externals: ['react/jsx-runtime', 'react/jsx-dev-runtime'],

Commit:

bash
git add -A && git diff --cached --quiet || git commit -m "feat: externalize jsx-runtime" --no-verify

Step 5: Bump grafanaDependency

bash
jq -r '.dependencies.grafanaDependency' $PLUGIN_JSON

If not already >=12.3.0, update it. The create-plugin add in Step 3 may have already done this.


Step 6: Bump dependencies

Faro (if present)

bash
grep '"@grafana/faro' $PKG_JSON
PackageTarget
@grafana/faro-react^2.2.3
@grafana/faro-web-sdk^2.2.3
@grafana/faro-web-tracing^2.0.0

Grafana packages

bash
grep '"@grafana/' $PKG_JSON | grep -v faro | grep -v create-plugin

Bump @grafana/data, @grafana/runtime, @grafana/schema, @grafana/ui to ^12.2.0 or later. Add @grafana/i18n@^12.2.0 if the plugin uses translations or @grafana/scenes requires it.

React types

Bump react and react-dom to ^18.3.0 (surfaces React 19 issues early). Add @types/react@^18.3.0 and @types/react-dom@^18.3.0 to devDependencies if missing.

Remove deprecated packages

Remove from devDependencies if present:

  • eslint-plugin-deprecation (replaced by @typescript-eslint/no-deprecated)
  • @types/testing-library__jest-dom (replaced by setupTests.d.ts)

Broken transitive dependencies

If yarn install fails with a stale git reference, do not edit yarn.lock. Add a resolutions entry:

json
"resolutions": {  "<package-name>": "<working-version-or-git-ref>"}

Then delete yarn.lock and node_modules and reinstall:

bash
rm -rf node_modules yarn.lockyarn install --ignore-engines 2>&1 | tail -10

Step 7: Fix unmet @openfeature/web-sdk peer dependency

@grafana/runtime depends on @openfeature/react-sdk which has @openfeature/web-sdk as a peer dependency. Yarn v1 (classic) does not auto-install peer deps.

Check if the plugin uses yarn classic:

bash
yarn --version 2>&1 | head -1

If version starts with 1., check for warnings:

bash
yarn install --ignore-engines 2>&1 | grep "unmet peer dependency.*openfeature/web-sdk"

If warnings are found:

bash
yarn add -D @openfeature/web-sdk @openfeature/core --ignore-engines

Skip condition: Yarn v2+ or npm v7+ (peer deps are auto-installed).


Step 8: Fix source code issues

bash
grep -rn "ReactDOM\.render\|ReactDOM\.unmountComponentAtNode\|ReactDOM\.findDOMNode" src/ --include="*.tsx" --include="*.ts"grep -rn "\.defaultProps\s*=" src/ --include="*.tsx" --include="*.ts"grep -rn "\.propTypes\s*=" src/ --include="*.tsx" --include="*.ts"grep -rn "contextTypes\|getChildContext" src/ --include="*.tsx" --include="*.ts"grep -rn "createFactory" src/ --include="*.tsx" --include="*.ts"grep -rn "ChangeEvent<HTMLInputElement>" src/ --include="*.tsx" --include="*.ts"
PatternFix
ReactDOM.render()createRoot(container).render(element)
defaultProps on function componentsMove to destructured parameter defaults
defaultProps on class componentsLeave — still works
propTypesRemove
contextTypes / getChildContextUse React.createContext() + useContext()
createFactoryUse JSX or createElement()
ChangeEvent<HTMLInputElement> on checkboxChange to FormEvent<HTMLInputElement>

Step 9: Build, typecheck, test

bash
rm -rf node_modules distyarn install --ignore-engines 2>&1 | tail -10yarn build 2>&1 | tail -10yarn typecheck 2>&1 | tail -10yarn test --watchAll=false 2>&1 | tail -10
ErrorFix
Cannot find module 'react/jsx-runtime'Step 4 not applied — re-run create-plugin add
Cannot find module '@openfeature/web-sdk'Step 7 — yarn add -D @openfeature/web-sdk @openfeature/core
Can't resolve '@grafana/i18n'yarn add @grafana/i18n@^12.2.0
Cannot read properties of undefined (reading 'ReactCurrentOwner')Bump @grafana-cloud/* packages — see Step 6
aria-label is missing on icon-only ButtonAdd aria-label prop (newer @grafana/ui requires it)
Stale git hash in yarn.lockAdd resolutions in package.json, delete lockfile, reinstall

For detailed known issues (i18n crash, @grafana/schema type breaks, publicPath mismatch), see references/known-issues.md [blocked].


Step 10: Update CI (if applicable)

bash
grep -rn "plugin-ci-workflows\|e2e-version" .github/workflows/ 2>/dev/null
  • plugin-ci-workflows@main or >= 6.0.0 → already tests React 19. No changes needed.
  • plugin-actions/e2e-version → add skip-grafana-react-19-preview-image: false.
  • Neither found → test manually with GRAFANA_VERSION=dev-preview-react19 docker compose up --build.

Step 11: Squash and push

bash
git reset --soft origin/maingit add -Agit commit -m "fix: Prepare plugin for React 19 compatibility"

Commit message body should list: create-plugin version change, ESLint 9 migration, key dependency bumps, and any source code fixes.


References

来源与署名

来源:grafana/skills位于skills/grafana-plugins/react-19-plugin-migration提交1ccacf2

许可证: Apache-2.0

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架

更多来自 grafana/skills 的技能

Plugin Bundle Size

grafana

指导使用 React.lazy、Suspense 和 webpack 代码分割来优化 Grafana 应用插件包体积。

Software Development279今天更新

Grafana Scenes

grafana

使用 @grafana/scenes 框架构建 Grafana 插件页面,涵盖场景、面板、变量与下钻导航。

Software Development279今天更新

Check Npm

grafana

对 JS/TS 仓库的 npm、yarn 或 pnpm 配置进行只读供应链加固审计。

Security279今天更新

Mimir

grafana

指导搭建和运维 Grafana Mimir,用于可扩展、多租户、长期的 Prometheus 与 OTLP 指标存储。

DevOps & Cloud279今天更新

K6 Trend Analysis

grafana

Analyze Grafana Cloud k6 test run trends over time. Detects slow metric drift (e.g., P95 latency creeping up while still passing thresholds), computes headroom to thresholds, flags anomalies, and recommends threshold tightening. Use when the user asks about test performance trends, wants to know if metrics are degrading, asks whether thresholds should be tightened, or wants a health check across recent runs for a specific test. Trigger on phrases like "how is my test trending", "is P95 getting worse", "check for performance regression", "should I tighten thresholds", "are my tests degrading", "show me trends for test X", "analyze my k6 test runs", or "is my test getting slower". Also trigger when a user asks to check all tests in a project -- run this skill once per test and synthesize.

待分类279今天更新

K6 Test Maintenance

grafana

维护和改进现有 k6 负载测试脚本:收紧阈值、版本迁移、重构以及最佳实践审计。

Software Development279今天更新