Skip to content

feat(dashboard): rewrite grafana import with migration ledger and con… #2287

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.

Sign up for GitHub

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

Merged
jsers merged 1 commit into from
Aug 25, 2026
Merged

feat(dashboard): rewrite grafana import with migration ledger and con… #2287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions scripts/check-dashboard-types/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ const ts = require('typescript');
const configPath = path.resolve(__dirname, 'tsconfig.json');
const config = ts.readConfigFile(configPath, ts.sys.readFile);
if (config.error) {
console.error(ts.formatDiagnostic(config.error, {
getCanonicalFileName: (fileName) => fileName,
getCurrentDirectory: ts.sys.getCurrentDirectory,
getNewLine: () => '\n',
}));
console.error(
ts.formatDiagnostic(config.error, {
getCanonicalFileName: (fileName) => fileName,
getCurrentDirectory: ts.sys.getCurrentDirectory,
getNewLine: () => '\n',
}),
);
process.exit(1);
}

Expand All @@ -18,7 +20,7 @@ const program = ts.createProgram(parsed.fileNames, parsed.options);
const dashboardRoot = path.resolve(__dirname, '../../src/pages/dashboard') + path.sep;
const excludedPathSegments = [
`${path.sep}VariableConfig${path.sep}`,
`${path.sep}updateSchema.ts`,
`${path.sep}grafanaImport${path.sep}`,
`${path.sep}transformations${path.sep}AddFieldFromCalculationTransformation${path.sep}`,
`${path.sep}transformations${path.sep}ConcatenateFieldsTransformation${path.sep}`,
`${path.sep}transformations${path.sep}ConfigFromQueryResultsTransformation${path.sep}`,
Expand Down Expand Up @@ -68,10 +70,7 @@ const diagnostics = ts
.getPreEmitDiagnostics(program)
.filter(
(diagnostic) =>
diagnostic.file &&
isActiveDashboardFile(diagnostic.file.fileName) &&
implicitAnyCodes.has(diagnostic.code) &&
!isIgnoredPosition(diagnostic.file, diagnostic.start ?? 0),
diagnostic.file && isActiveDashboardFile(diagnostic.file.fileName) && implicitAnyCodes.has(diagnostic.code) && !isIgnoredPosition(diagnostic.file, diagnostic.start ?? 0),
);

const anyDiagnostics = [];
Expand All @@ -92,11 +91,13 @@ for (const sourceFile of program.getSourceFiles()) {
}

if (diagnostics.length) {
console.error(ts.formatDiagnosticsWithColorAndContext(diagnostics, {
getCanonicalFileName: (fileName) => fileName,
getCurrentDirectory: ts.sys.getCurrentDirectory,
getNewLine: () => '\n',
}));
console.error(
ts.formatDiagnosticsWithColorAndContext(diagnostics, {
getCanonicalFileName: (fileName) => fileName,
getCurrentDirectory: ts.sys.getCurrentDirectory,
getNewLine: () => '\n',
}),
);
process.exitCode = 1;
}

Expand Down
173 changes: 173 additions & 0 deletions src/pages/dashboard/List/Import/ImportGrafanaReport.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
/*
* Grafana 导入两步式：转换报告视图。
* 展示转换结果概览、迁移台账、不支持项，并提供「确认导入 / 返回修改 / 复制 Markdown 报告」。
*/
import React from 'react';
import { Alert, Button, Collapse, Descriptions, Space, Table, Tag, message } from 'antd';
import { useTranslation } from 'react-i18next';

import type { ConvertResult } from '@/pages/dashboard/utils/grafanaImport';

interface Props {
result: ConvertResult;
/** 保存（createDashboard）失败的错误信息；存在时展示在顶部并允许重试 */
error?: string;
saving: boolean;
onConfirm: () => void;
onBack: () => void;
}

const actionColors: Record<string, string> = {
dropped: 'red',
downgraded: 'orange',
defaulted: 'default',
};
const statusColors: Record<string, string> = {
applied: 'green',
'not-applicable': 'default',
skipped: 'orange',
};

/** 序列化为 skill 风格的 Markdown 报告（便于反馈排障） */
export function buildMarkdownReport(result: ConvertResult): string {
const { report } = result;
const lines: string[] = [];
lines.push('## Migration ledger');
lines.push(`- input schemaVersion: ${report.migration.inputSchemaVersion} -> target: ${report.migration.targetSchemaVersion}`);
for (const m of report.migration.migrations) {
lines.push(`- v${m.version}: ${m.status} - ${m.reason}`);
}
lines.push('');
lines.push('## Unsupported items');
if (report.unsupportedItems.length === 0) {
lines.push('No unsupported configuration was found');
} else {
lines.push('| scope | path | action | reason |');
lines.push('| --- | --- | --- | --- |');
for (const item of report.unsupportedItems) {
lines.push(`| ${item.scope} | ${item.path || '-'} | ${item.action} | ${item.reason} |`);
}
}
return lines.join('\n');
}

export default function ImportGrafanaReport(props: Props) {
const { t } = useTranslation('dashboard');
const { result, error, saving, onConfirm, onBack } = props;
const { dashboard, report } = result;
const summary = report.summary;
const hasUnsupported = report.unsupportedItems.length > 0;

const handleCopy = async () => {
try {
await navigator.clipboard?.writeText(buildMarkdownReport(result));
message.success(t('batch.import_grafana_report.copied'));
} catch (e) {
message.error(t('batch.import_grafana_report.copy'));
}
};
Comment on lines +61 to +68

return (
<div>
{error ? (
<Alert
type='error'
showIcon
message={t('batch.import_grafana_report.save_error')}
description={
<pre className='mb-0' style={{ whiteSpace: 'pre-wrap' }}>
{error}
</pre>
}
style={{ marginBottom: 12 }}
/>
) : (
<Alert
type={hasUnsupported ? 'warning' : 'success'}
showIcon
message={t('batch.import_grafana_report.title')}
description={
<Space size={16} wrap>
<span>
{t('batch.import_grafana_report.panels')}: {summary?.convertedPanels}/{summary?.panels}
</span>
<span>
{t('batch.import_grafana_report.targets')}: {summary?.targets}
</span>
<span>
{t('batch.import_grafana_report.variables')}: {summary?.variables}
</span>
{(summary?.droppedPanels ?? 0) > 0 && (
<Tag color='red'>
{t('batch.import_grafana_report.dropped')} {summary?.droppedPanels}
</Tag>
)}
{(summary?.droppedTargets ?? 0) > 0 && (
<Tag color='red'>
{t('batch.import_grafana_report.dropped')} {summary?.droppedTargets}
</Tag>
)}
{(summary?.droppedVariables ?? 0) > 0 && (
<Tag color='red'>
{t('batch.import_grafana_report.dropped')} {summary?.droppedVariables}
</Tag>
)}
</Space>
}
style={{ marginBottom: 12 }}
/>
)}

<Collapse ghost defaultActiveKey={['unsupported']} style={{ marginBottom: 12 }}>
<Collapse.Panel header={`${t('batch.import_grafana_report.unsupported')} (${report.unsupportedItems.length})`} key='unsupported'>
{report.unsupportedItems.length === 0 ? (
<span>{t('batch.import_grafana_report.unsupported_empty')}</span>
) : (
<Table
size='small'
className='samll_table'
pagination={false}
rowKey={(r) => `${r.scope}-${r.path}-${r.action}-${r.reason}`}
dataSource={report.unsupportedItems}
columns={[
{ title: t('batch.import_grafana_report.scope'), dataIndex: 'scope', width: 90 },
{ title: t('batch.import_grafana_report.path'), dataIndex: 'path', ellipsis: true },
{ title: t('batch.import_grafana_report.action'), dataIndex: 'action', width: 110, render: (v: string) => <Tag color={actionColors[v]}>{v}</Tag> },
{ title: t('batch.import_grafana_report.reason'), dataIndex: 'reason' },
]}
scroll={{ y: 220 }}
/>
)}
</Collapse.Panel>
<Collapse.Panel header={t('batch.import_grafana_report.ledger')} key='ledger'>
<Descriptions size='small' column={1} style={{ marginBottom: 8 }}>
<Descriptions.Item label={t('batch.import_grafana_report.schema')}>
{report.migration.inputSchemaVersion} → {report.migration.targetSchemaVersion}
</Descriptions.Item>
</Descriptions>
<Table
size='small'
className='samll_table'
pagination={false}
rowKey='version'
dataSource={report.migration.migrations}
columns={[
{ title: t('batch.import_grafana_report.version'), dataIndex: 'version', width: 80 },
{ title: t('batch.import_grafana_report.status'), dataIndex: 'status', width: 140, render: (v: string) => <Tag color={statusColors[v]}>{v}</Tag> },
{ title: t('batch.import_grafana_report.reason'), dataIndex: 'reason' },
]}
scroll={{ y: 200 }}
/>
</Collapse.Panel>
</Collapse>

<Space>
<Button type='primary' loading={saving} onClick={onConfirm}>
{t('batch.import_grafana_report.confirm')}
</Button>
<Button onClick={onBack}>{t('batch.import_grafana_report.back')}</Button>
<Button onClick={handleCopy}>{t('batch.import_grafana_report.copy')}</Button>
</Space>
</div>
);
}
Loading