Skip to content
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

[feature](sqle/knowledge): optimize permission control and graph rendering #589

Merged
merged 1 commit into from
Feb 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
59 changes: 59 additions & 0 deletions packages/base/public/static/image/knowledge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions packages/base/src/page/Nav/SideMenu/QuickActions/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,13 @@ const QuickActions = () => {
<ProfileSquareFilled width={18} height={18} color="currentColor" />
)
},
// #if [ee]
{
key: 'knowledge',
title: t('dmsMenu.globalSettings.knowledge'),
path: ROUTE_PATHS.SQLE.KNOWLEDGE.index.path,
icon: <BookMarkOutlined width={18} height={18} color="currentColor" />,
permission: PERMISSIONS.PAGES.SQLE.KNOWLEDGE
}
// #endif
];
return actionList.filter((item) => {
if (!item.permission) {
Expand Down
5 changes: 3 additions & 2 deletions packages/sqle/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"@react-sigma/core": "^5.0.2",
"@react-sigma/graph-search": "^5.0.3",
"@react-sigma/layout-force": "^5.0.2",
"@sigma/node-image": "^3.0.0",
"@uiw/react-md-editor": "^3.23.5",
"graphology": "^0.25.4",
"react-grid-layout": "^1.3.4",
Expand All @@ -20,8 +21,8 @@
},
"devDependencies": {
"@types/react-grid-layout": "^1.3.2",
"jest-canvas-mock": "^2.2.0",
"graphology-types": "^0.24.8"
"graphology-types": "^0.24.8",
"jest-canvas-mock": "^2.2.0"
},
"scripts": {
"start": "PORT=3030 craco start",
Expand Down
5 changes: 4 additions & 1 deletion packages/sqle/src/locale/zh-CN/knowledgeBase.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
// eslint-disable-next-line import/no-anonymous-default-export
export default {
pageTitle: '知识库',
ceTips:
'当您需要系统性学习数据库规范或日常开发需要了解特定SQL语法规范时,可以使用平台的数据库语法知识图谱功能,快速掌握SQL语法。',
searchResults: {
backToKnowledgeBase: '返回知识库',
searchPlaceholder: '请输入关键字搜索你感兴趣的SQL语法'
},
graph: {
viewRelatedRules: '查看关联规则'
viewRelatedRules: '查看关联规则',
loadingTips: '加载知识图谱中...'
},
search: {
retrieveKnowledgeGraph: '检索知识图谱',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ const KnowledgeSearchBar: React.FC<KnowledgeSearchBarProps> = (props) => {
}}
rows={1}
bordered={false}
autoSize
autoSize={{ minRows: 1, maxRows: 3 }}
/>
<div className="search-icon">
<SearchOutlined width={20} height={20} onClick={handleSearch} />
Expand Down
48 changes: 24 additions & 24 deletions packages/sqle/src/page/Knowledge/Graph/common/LoadGraph.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
INodeResponse,
IEdgeResponse
} from '@actiontech/shared/lib/api/sqle/service/common';
import useThemeStyleData from '../../../../hooks/useThemeStyleData';

type props = {
graphData?: {
Expand All @@ -19,18 +20,26 @@ type props = {
};
hoveredNode: string | null;
setHoveredNode: (node: string | null) => void;
onLoaded?: () => void;
};
const LoadGraph: FC<props> = ({ graphData, hoveredNode, setHoveredNode }) => {
const LoadGraph: FC<props> = ({
graphData,
hoveredNode,
setHoveredNode,
onLoaded
}) => {
const { createGraph } = useGraph();
const sigma = useSigma<NodeType, EdgeType>();
const registerEvents = useRegisterEvents<NodeType, EdgeType>();
const setSettings = useSetSettings<NodeType, EdgeType>();
const loadGraph = useLoadGraph<NodeType, EdgeType>();
const { sharedTheme } = useThemeStyleData();

useEffect(() => {
if (graphData) {
const graph = createGraph(graphData);
loadGraph(graph);
onLoaded?.();

const handleEnterNode = (event: any) => {
setHoveredNode(event.node);
Expand All @@ -57,7 +66,8 @@ const LoadGraph: FC<props> = ({ graphData, hoveredNode, setHoveredNode }) => {
loadGraph,
registerEvents,
setHoveredNode,
sigma
sigma,
onLoaded
]);

useEffect(() => {
Expand All @@ -70,19 +80,13 @@ const LoadGraph: FC<props> = ({ graphData, hoveredNode, setHoveredNode }) => {
};

if (hoveredNode && graph.hasNode(hoveredNode)) {
try {
const isNeighbor =
node === hoveredNode ||
graph.neighbors(hoveredNode).includes(node);
if (isNeighbor) {
newData.highlighted = true;
} else {
newData.color = '#E2E2E2';
newData.highlighted = false;
}
} catch (error) {
// 如果出现错误,保持节点原样
console.debug('Failed to process node highlighting:', error);
const isNeighbor =
node === hoveredNode || graph.neighbors(hoveredNode).includes(node);
if (isNeighbor) {
newData.highlighted = true;
} else {
newData.color = sharedTheme.uiToken.colorFillSecondary;
newData.highlighted = false;
}
}
return newData;
Expand All @@ -93,20 +97,16 @@ const LoadGraph: FC<props> = ({ graphData, hoveredNode, setHoveredNode }) => {
const newData = { ...data, hidden: false, size: edgeSize };

if (hoveredNode && graph.hasNode(hoveredNode)) {
try {
if (graph.extremities(edge).includes(hoveredNode)) {
newData.size = edgeSize * 1.5;
} else {
newData.hidden = true;
}
} catch (error) {
console.debug('Failed to process edge highlighting:', error);
if (graph.extremities(edge).includes(hoveredNode)) {
newData.size = edgeSize * 1.5;
} else {
newData.hidden = true;
}
}
return newData;
}
});
}, [hoveredNode, setSettings, sigma]);
}, [hoveredNode, setSettings, sharedTheme.uiToken.colorFillSecondary, sigma]);

return null;
};
Expand Down
21 changes: 17 additions & 4 deletions packages/sqle/src/page/Knowledge/Graph/common/data.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { SigmaContainerProps } from '@react-sigma/core';
import { EdgeType, NodeType } from '../index.type';
import { Attributes } from 'graphology-types';
import { NodeProgramType } from 'sigma/rendering';
import { NodeImageProgram } from '@sigma/node-image';

export const sigmaSettings: SigmaContainerProps<
NodeType,
Expand All @@ -9,25 +11,36 @@ export const sigmaSettings: SigmaContainerProps<
>['settings'] = {
// 允许在无效容器中渲染 (默认值: false)
allowInvalidContainer: true,
defaultNodeType: 'circle',
defaultNodeType: 'image',
// 设置边的默认类型 (默认值: 'line')
defaultEdgeType: 'arrow',
defaultEdgeType: 'line',

// 相机缩放比例限制 (默认值: min: 0.1, max: 32)
minCameraRatio: 0.2,
maxCameraRatio: 5,

// 节点渲染程序类 (默认值: {})
nodeProgramClasses: {},
nodeProgramClasses: {
image: NodeImageProgram as unknown as NodeProgramType<
NodeType,
EdgeType,
Attributes
>
},

// 渲染性能优化
hideEdgesOnMove: true, // 移动时隐藏边 (默认值: false)
hideLabelsOnMove: false, // 移动时隐藏标签 (默认值: false)
renderLabels: true, // 是否渲染标签 (默认值: true)
renderEdgeLabels: false, // 是否渲染边标签 (默认值: false)

labelFont: `'PlusJakartaSans Medium', -apple-system, 'Microsoft YaHei',
BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, 'Noto Sans',
sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol',
'Noto Color Emoji`,
labelSize: 14,
// 标签渲染优化
labelDensity: 0.1, // 标签密度 (默认值: 0.03)
labelDensity: 0.07, // 标签密度 (默认值: 0.03)
labelGridCellSize: 100, // 标签网格大小 (默认值: 100)
labelRenderedSizeThreshold: 8, // 标签大小阈值 (默认值: 6)

Expand Down
19 changes: 14 additions & 5 deletions packages/sqle/src/page/Knowledge/Graph/hooks/useGraph.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ import {
INodeResponse
} from '@actiontech/shared/lib/api/sqle/service/common';
import { EdgeType, NodeType } from '../index.type';
import useThemeStyleData from '../../../../hooks/useThemeStyleData';

const useGraph = () => {
const randomColor = useCallback(() => {
const { sqleTheme } = useThemeStyleData();
const generateNodeColor = useCallback(() => {
const digits = '0123456789abcdef';
let code = '#';
for (let i = 0; i < 6; i++) {
Expand Down Expand Up @@ -72,10 +74,11 @@ const useGraph = () => {
graph.addNode(node.id, {
label: node.name ?? '',
size: normalizedSize,
color: randomColor(),
color: generateNodeColor(),
x: 0.5 + radius * Math.cos(theta),
y: 0.5 + radius * Math.sin(theta),
shortLabel: (node.name ?? '')[0]?.toUpperCase() ?? ''
shortLabel: (node.name ?? '')[0]?.toUpperCase() ?? '',
image: '/static/image/knowledge.svg'
});
});

Expand All @@ -90,13 +93,19 @@ const useGraph = () => {

graph.addEdge(edge.from_id, edge.to_id, {
size: normalizedSize,
forceLabel: false
forceLabel: false,
color: sqleTheme.knowledgeTheme.graph.edge.color
});
});

return graph as Graph<NodeType, EdgeType>;
},
[calculateNormalizedSize, getWeightRange, randomColor]
[
getWeightRange,
calculateNormalizedSize,
generateNodeColor,
sqleTheme.knowledgeTheme.graph.edge.color
]
);

return { createGraph };
Expand Down
Loading
Loading