From e09dd87e7758d7a197353535c7cf2d2f2bc6c518 Mon Sep 17 00:00:00 2001 From: moklick Date: Mon, 20 Mar 2023 11:19:32 +0100 Subject: [PATCH] refactor(error-messages): prefix error keys with error closes #2919 --- packages/core/src/components/Handle/index.tsx | 2 +- .../container/EdgeRenderer/MarkerSymbols.tsx | 2 +- .../core/src/container/EdgeRenderer/index.tsx | 4 ++-- .../core/src/container/NodeRenderer/index.tsx | 2 +- .../core/src/container/ReactFlow/utils.ts | 2 +- packages/core/src/contants.ts | 22 +++++++++---------- packages/core/src/hooks/useDrag/utils.ts | 2 +- packages/core/src/hooks/useResizeHandler.ts | 2 +- packages/core/src/hooks/useStore.ts | 2 +- packages/core/src/utils/graph.ts | 13 +++++++---- 10 files changed, 29 insertions(+), 24 deletions(-) diff --git a/packages/core/src/components/Handle/index.tsx b/packages/core/src/components/Handle/index.tsx index e2d57d4d..c66f5272 100644 --- a/packages/core/src/components/Handle/index.tsx +++ b/packages/core/src/components/Handle/index.tsx @@ -43,7 +43,7 @@ const Handle = forwardRef( const nodeId = useNodeId(); if (!nodeId) { - store.getState().onError?.('010', errorMessages['010']()); + store.getState().onError?.('010', errorMessages['error010']()); return null; } diff --git a/packages/core/src/container/EdgeRenderer/MarkerSymbols.tsx b/packages/core/src/container/EdgeRenderer/MarkerSymbols.tsx index aa561242..f4d86a07 100644 --- a/packages/core/src/container/EdgeRenderer/MarkerSymbols.tsx +++ b/packages/core/src/container/EdgeRenderer/MarkerSymbols.tsx @@ -45,7 +45,7 @@ export function useMarkerSymbol(type: MarkerType) { const symbolExists = Object.prototype.hasOwnProperty.call(MarkerSymbols, type); if (!symbolExists) { - store.getState().onError?.('009', errorMessages['009'](type)); + store.getState().onError?.('009', errorMessages['error009'](type)); return null; } diff --git a/packages/core/src/container/EdgeRenderer/index.tsx b/packages/core/src/container/EdgeRenderer/index.tsx index ddc4aa4d..09b8f0c6 100644 --- a/packages/core/src/container/EdgeRenderer/index.tsx +++ b/packages/core/src/container/EdgeRenderer/index.tsx @@ -99,7 +99,7 @@ const EdgeRenderer = ({ let edgeType = edge.type || 'default'; if (!edgeTypes[edgeType]) { - onError?.('011', errorMessages['011'](edgeType)); + onError?.('011', errorMessages['error011'](edgeType)); edgeType = 'default'; } @@ -116,7 +116,7 @@ const EdgeRenderer = ({ const isFocusable = !!(edge.focusable || (edgesFocusable && typeof edge.focusable === 'undefined')); if (!sourceHandle || !targetHandle) { - onError?.('008', errorMessages['008'](sourceHandle, edge)); + onError?.('008', errorMessages['error008'](sourceHandle, edge)); return null; } diff --git a/packages/core/src/container/NodeRenderer/index.tsx b/packages/core/src/container/NodeRenderer/index.tsx index ab35cb74..0b4c03c6 100644 --- a/packages/core/src/container/NodeRenderer/index.tsx +++ b/packages/core/src/container/NodeRenderer/index.tsx @@ -78,7 +78,7 @@ const NodeRenderer = (props: NodeRendererProps) => { let nodeType = node.type || 'default'; if (!props.nodeTypes[nodeType]) { - onError?.('003', errorMessages['003'](nodeType)); + onError?.('003', errorMessages['error003'](nodeType)); nodeType = 'default'; } diff --git a/packages/core/src/container/ReactFlow/utils.ts b/packages/core/src/container/ReactFlow/utils.ts index cc5ab36d..9b52e135 100644 --- a/packages/core/src/container/ReactFlow/utils.ts +++ b/packages/core/src/container/ReactFlow/utils.ts @@ -17,7 +17,7 @@ export function useNodeOrEdgeTypes(nodeOrEdgeTypes: any, createTypes: any): any if (process.env.NODE_ENV === 'development') { const typeKeys = Object.keys(nodeOrEdgeTypes); if (shallow(typesKeysRef.current, typeKeys)) { - devWarn('002', errorMessages['002']()); + devWarn('002', errorMessages['error002']()); } typesKeysRef.current = typeKeys; diff --git a/packages/core/src/contants.ts b/packages/core/src/contants.ts index 815ac6f0..54c4a696 100644 --- a/packages/core/src/contants.ts +++ b/packages/core/src/contants.ts @@ -1,20 +1,20 @@ import { Edge, HandleElement } from './types'; export const errorMessages = { - '001': () => + error001: () => '[React Flow]: Seems like you have not used zustand provider as an ancestor. Help: https://reactflow.dev/error#001', - '002': () => + error002: () => "It looks like you've created a new nodeTypes or edgeTypes object. If this wasn't on purpose please define the nodeTypes/edgeTypes outside of the component or memoize them.", - '003': (nodeType: string) => `Node type "${nodeType}" not found. Using fallback type "default".`, - '004': () => 'The React Flow parent container needs a width and a height to render the graph.', - '005': () => 'Only child nodes can use a parent extent.', - '006': () => "Can't create edge. An edge needs a source and a target.", - '007': (id: string) => `The old edge with id=${id} does not exist.`, - '009': (type: string) => `Marker type "${type}" doesn't exist.`, - '008': (sourceHandle: HandleElement | null, edge: Edge) => + error003: (nodeType: string) => `Node type "${nodeType}" not found. Using fallback type "default".`, + error004: () => 'The React Flow parent container needs a width and a height to render the graph.', + error005: () => 'Only child nodes can use a parent extent.', + error006: () => "Can't create edge. An edge needs a source and a target.", + error007: (id: string) => `The old edge with id=${id} does not exist.`, + error009: (type: string) => `Marker type "${type}" doesn't exist.`, + error008: (sourceHandle: HandleElement | null, edge: Edge) => `Couldn't create edge for ${!sourceHandle ? 'source' : 'target'} handle id: "${ !sourceHandle ? edge.sourceHandle : edge.targetHandle }", edge id: ${edge.id}.`, - '010': () => 'Handle: No node id found. Make sure to only use a Handle inside a custom Node.', - '011': (edgeType: string) => `Edge type "${edgeType}" not found. Using fallback type "default".`, + error010: () => 'Handle: No node id found. Make sure to only use a Handle inside a custom Node.', + error011: (edgeType: string) => `Edge type "${edgeType}" not found. Using fallback type "default".`, }; diff --git a/packages/core/src/hooks/useDrag/utils.ts b/packages/core/src/hooks/useDrag/utils.ts index 5ef3b3b2..50882d2e 100644 --- a/packages/core/src/hooks/useDrag/utils.ts +++ b/packages/core/src/hooks/useDrag/utils.ts @@ -93,7 +93,7 @@ export function calcNextPosition( ] : currentExtent; } else { - onError?.('005', errorMessages['005']()); + onError?.('005', errorMessages['error005']()); currentExtent = nodeExtent; } diff --git a/packages/core/src/hooks/useResizeHandler.ts b/packages/core/src/hooks/useResizeHandler.ts index a6d6d921..5691ca43 100644 --- a/packages/core/src/hooks/useResizeHandler.ts +++ b/packages/core/src/hooks/useResizeHandler.ts @@ -19,7 +19,7 @@ function useResizeHandler(rendererNode: MutableRefObject) const size = getDimensions(rendererNode.current); if (size.height === 0 || size.width === 0) { - store.getState().onError?.('004', errorMessages['004']()); + store.getState().onError?.('004', errorMessages['error004']()); } store.setState({ width: size.width || 500, height: size.height || 500 }); diff --git a/packages/core/src/hooks/useStore.ts b/packages/core/src/hooks/useStore.ts index 3983579d..3ad18d59 100644 --- a/packages/core/src/hooks/useStore.ts +++ b/packages/core/src/hooks/useStore.ts @@ -6,7 +6,7 @@ import StoreContext from '../contexts/RFStoreContext'; import { errorMessages } from '../contants'; import type { ReactFlowState } from '../types'; -const zustandErrorMessage = errorMessages['001'](); +const zustandErrorMessage = errorMessages['error001'](); type ExtractState = StoreApi extends { getState: () => infer T } ? T : never; diff --git a/packages/core/src/utils/graph.ts b/packages/core/src/utils/graph.ts index 0d28d659..2db9fc09 100644 --- a/packages/core/src/utils/graph.ts +++ b/packages/core/src/utils/graph.ts @@ -72,7 +72,7 @@ const connectionExists = (edge: Edge, edges: Edge[]) => { export const addEdge = (edgeParams: Edge | Connection, edges: Edge[]): Edge[] => { if (!edgeParams.source || !edgeParams.target) { - devWarn('006', errorMessages['006']()); + devWarn('006', errorMessages['error006']()); return edges; } @@ -94,11 +94,16 @@ export const addEdge = (edgeParams: Edge | Connection, edges: Edge[]): Edge[] => return edges.concat(edge); }; -export const updateEdge = (oldEdge: Edge, newConnection: Connection, edges: Edge[], options: UpdateEdgeOptions = { shouldReplaceId: true }): Edge[] => { +export const updateEdge = ( + oldEdge: Edge, + newConnection: Connection, + edges: Edge[], + options: UpdateEdgeOptions = { shouldReplaceId: true } +): Edge[] => { const { id: oldEdgeId, ...rest } = oldEdge; if (!newConnection.source || !newConnection.target) { - devWarn('006', errorMessages['006']()); + devWarn('006', errorMessages['error006']()); return edges; } @@ -106,7 +111,7 @@ export const updateEdge = (oldEdge: Edge, newConnection: Connection, edges: Edge const foundEdge = edges.find((e) => e.id === oldEdgeId) as Edge; if (!foundEdge) { - devWarn('007', errorMessages['007'](oldEdgeId)); + devWarn('007', errorMessages['error007'](oldEdgeId)); return edges; }