kie-issues#1298: Decision Services & multiple DRDs: make it possible o add external Decisions to a Decision Service #2508
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -245,7 +245,11 @@ export function Palette({ pulse }: { pulse: boolean }) { | |
| <br /> | ||
| <aside className={"kie-dmn-editor--external-nodes-panel-toggle"}> | ||
| {diagram.openLhsPanel === DiagramLhsPanel.EXTERNAL_NODES && ( | ||
| <div | ||
| className={"kie-dmn-editor--palette-nodes-popover"} | ||
| style={{ maxHeight }} | ||
| data-testid={"kie-tools--dmn-editor--external-nodes-container"} | ||
| > | ||
|
There was a problem hiding this comment. The "DRG nodes" panel doesn't have a There was a problem hiding this comment. Do we have tests for "DRG Nodes" panel? I only found for drag nodes from the palette not from the "DRG Nodes" panel. 🤔 There was a problem hiding this comment. @tiagobento actually we are about to add One thing we could unify is the There was a problem hiding this comment. All good then! Thanks for the insights. I have no preference for the suffix, just please coordinate that it is consistent. @jomarko @danielzhe There was a problem hiding this comment. I'll change it to |
||
| <ExternalNodesPanel /> | ||
| </div> | ||
| )} | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,25 +25,42 @@ import { SnapGrid } from "../store/Store"; | |
| import { MIN_NODE_SIZES } from "../diagram/nodes/DefaultSizes"; | ||
| import { NODE_TYPES } from "../diagram/nodes/NodeTypes"; | ||
| import { Normalized } from "../normalization/normalize"; | ||
| import { | ||
| DMN15__tBusinessKnowledgeModel, | ||
| DMN15__tDecision, | ||
| DMN15__tDecisionService, | ||
| DMN15__tInputData, | ||
| DMN15__tKnowledgeSource, | ||
| } from "@kie-tools/dmn-marshaller/src/schemas/dmn-1_5/ts-gen/types"; | ||
|
|
||
| export type DrgElement = | ||
| | Normalized<{ __$$element: "decision" } & DMN15__tDecision> | ||
| | Normalized<{ __$$element: "businessKnowledgeModel" } & DMN15__tBusinessKnowledgeModel> | ||
| | Normalized<{ __$$element: "decisionService" } & DMN15__tDecisionService> | ||
| | Normalized<{ __$$element: "inputData" } & DMN15__tInputData> | ||
| | Normalized<{ __$$element: "knowledgeSource" } & DMN15__tKnowledgeSource>; | ||
|
|
||
| export function addDecisionToDecisionService({ | ||
| definitions, | ||
| drgElement, | ||
| decisionServiceId, | ||
| drdIndex, | ||
| snapGrid, | ||
| decisionShape, | ||
| elementId, | ||
| }: { | ||
| definitions: Normalized<DMN15__tDefinitions>; | ||
| drgElement: DrgElement; | ||
| decisionServiceId: string; | ||
| drdIndex: number; | ||
| snapGrid: SnapGrid; | ||
| decisionShape: Normalized<DMNDI15__DMNShape>; | ||
| elementId: string; | ||
| }) { | ||
|
There was a problem hiding this comment.
I understand There was a problem hiding this comment. In the previous code we was getting the ID, in So I think it is safe to assume that
About the ID, I can't see any case where the ID of the selected node will be different than the DRG, except for the imported nodes the ID in the DRG is not full, it is only the local ID (the Guid), but from There was a problem hiding this comment. In fact, we don't have DRG element always in the definitions: the external nodes do not have DRG element, only DMNDI. The DRG we have in Notice only the There was a problem hiding this comment. We only need the ID, but we need to know that this ID represents a Decision. The only way to know that is having the externalModelsByNamespace passed as parameter to the "addDecisionToDecisionService" mutation, so we can make that validation. You're mentioning the arguments you're passing when calling this mutation, but the mutation itself, after your changes, can be called with {
elementId: "bar"
drgElement: {
"@_id": "foo"
...
}
}which has the potential of being wrong. What I'm saying is that we rollback to the way it was before, and we include the There was a problem hiding this comment. I think got your point! I guarantee in the There was a problem hiding this comment. Yes, you can guarantee that you're calling it correctly now, but you can't guarantee that this will be true forever :P |
||
| console.debug(`DMN MUTATION: Adding Decision '${elementId}' to Decision Service '${decisionServiceId}'`); | ||
|
|
||
| if (drgElement?.__$$element !== "decision") { | ||
| throw new Error(`DMN MUTATION: DRG Element with id '${elementId}' is either not a Decision or doesn't exist.`); | ||
| } | ||
|
|
||
| const decisionService = definitions.drgElement?.find((s) => s["@_id"] === decisionServiceId); | ||
|
|
@@ -54,9 +71,6 @@ export function addDecisionToDecisionService({ | |
| } | ||
|
|
||
| const diagram = addOrGetDrd({ definitions, drdIndex }); | ||
|
|
||
| const decisionServiceShape = diagram.diagramElements.find( | ||
| (s) => s["@_dmnElementRef"] === decisionServiceId && s.__$$element === "dmndi:DMNShape" | ||
|
|
@@ -65,10 +79,10 @@ export function addDecisionToDecisionService({ | |
| const section = getSectionForDecisionInsideDecisionService({ decisionShape, decisionServiceShape, snapGrid }); | ||
| if (section === "encapsulated") { | ||
| decisionService.encapsulatedDecision ??= []; | ||
| decisionService.encapsulatedDecision.push({ "@_href": `${elementId}` }); | ||
| } else if (section === "output") { | ||
| decisionService.outputDecision ??= []; | ||
| decisionService.outputDecision.push({ "@_href": `${elementId}` }); | ||
| } else { | ||
| throw new Error(`DMN MUTATION: Invalid section to add decision to: '${section}' `); | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| import EmptyWithAvailableExternalModelsStories from "./EmptyWithAvailableExternalModels.stories"; | ||
| import { Meta } from "@storybook/blocks"; | ||
|
|
||
| <Meta title="MDX/Misc/EmptyWithAvailableExternalModelsStories" of={EmptyWithAvailableExternalModelsStories} /> | ||
|
|
||
| ## Empty With Available External Models | ||
|
|
||
| When user starts with an empty diagram, a wizard for quick content initialization is displayed. | ||
| The wizard enables to create simple diagram with one input and one output or a diagram with one decision table expression. | ||
| This model also have some external models available to be included. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import * as React from "react"; | ||
| import { useCallback, useMemo, useState } from "react"; | ||
| import type { Meta, StoryObj } from "@storybook/react"; | ||
| import { DmnLatestModel, DmnMarshaller, getMarshaller } from "@kie-tools/dmn-marshaller"; | ||
| import { ns as dmn15ns } from "@kie-tools/dmn-marshaller/dist/schemas/dmn-1_5/ts-gen/meta"; | ||
| import { generateUuid } from "@kie-tools/boxed-expression-component/dist/api"; | ||
| import { DMN15_SPEC } from "@kie-tools/dmn-marshaller/dist/schemas/dmn-1_5/Dmn15Spec"; | ||
| import { | ||
| DmnEditor, | ||
| DmnEditorProps, | ||
| ExternalModelsIndex, | ||
| OnRequestExternalModelByPath, | ||
| OnRequestExternalModelsAvailableToInclude, | ||
| OnDmnModelChange, | ||
| } from "@kie-tools/dmn-editor/dist/DmnEditor"; | ||
| import { normalize, Normalized } from "@kie-tools/dmn-editor/dist/normalization/normalize"; | ||
|
|
||
| import { DmnEditorWrapper, StorybookDmnEditorProps } from "../../dmnEditorStoriesWrapper"; | ||
|
|
||
| import { availableModelsByPath, modelsByNamespace } from "./availableModelsToInclude"; | ||
|
|
||
| export const generateEmptyDmn15 = () => `<?xml version="1.0" encoding="UTF-8"?> | ||
| <definitions | ||
| xmlns="${dmn15ns.get("")}" | ||
| expressionLanguage="${DMN15_SPEC.expressionLanguage.default}" | ||
| namespace="https://kie.apache.org/dmn/${generateUuid()}" | ||
| id="${generateUuid()}" | ||
| name="DMN${generateUuid()}"> | ||
| </definitions>`; | ||
|
|
||
| const initialModel = generateEmptyDmn15(); | ||
|
|
||
| function EmptyStoryWithIncludedModels(args: DmnEditorProps) { | ||
| const [state, setState] = useState<{ | ||
| marshaller: DmnMarshaller; | ||
| stack: Normalized<DmnLatestModel>[]; | ||
| pointer: number; | ||
| }>(() => { | ||
| const initialDmnMarshaller = getMarshaller(initialModel, { upgradeTo: "latest" }); | ||
| return { | ||
| marshaller: initialDmnMarshaller, | ||
| stack: [normalize(initialDmnMarshaller.parser.parse())], | ||
| pointer: 0, | ||
| }; | ||
| }); | ||
|
|
||
| const currentModel = state.stack[state.pointer]; | ||
|
|
||
| const externalModelsByNamespace = useMemo<ExternalModelsIndex>(() => { | ||
| return (currentModel.definitions.import ?? []).reduce((acc, i) => { | ||
| acc[i["@_namespace"]] = modelsByNamespace[i["@_namespace"]]; | ||
| return acc; | ||
| }, {} as ExternalModelsIndex); | ||
| }, [currentModel.definitions.import]); | ||
|
|
||
| const onRequestExternalModelByPath = useCallback<OnRequestExternalModelByPath>(async (path) => { | ||
| return availableModelsByPath[path] ?? null; | ||
| }, []); | ||
|
|
||
| const onRequestExternalModelsAvailableToInclude = useCallback<OnRequestExternalModelsAvailableToInclude>(async () => { | ||
| return Object.keys(availableModelsByPath); | ||
| }, []); | ||
|
|
||
| const onModelChange = useCallback<OnDmnModelChange>((model) => { | ||
| setState((prev) => { | ||
| const newStack = prev.stack.slice(0, prev.pointer + 1); | ||
| return { | ||
| ...prev, | ||
| stack: [...newStack, model], | ||
| pointer: newStack.length, | ||
| }; | ||
| }); | ||
| }, []); | ||
|
|
||
| return ( | ||
| <> | ||
| {DmnEditorWrapper({ | ||
| model: currentModel, | ||
| originalVersion: args.originalVersion, | ||
| onModelChange, | ||
| onRequestExternalModelByPath, | ||
| onRequestExternalModelsAvailableToInclude, | ||
| externalModelsByNamespace: externalModelsByNamespace, | ||
| externalContextName: args.externalContextName, | ||
| externalContextDescription: args.externalContextDescription, | ||
| validationMessages: args.validationMessages, | ||
| evaluationResults: args.evaluationResults, | ||
| issueTrackerHref: args.issueTrackerHref, | ||
| })} | ||
| </> | ||
| ); | ||
| } | ||
|
|
||
| const meta: Meta<DmnEditorProps> = { | ||
| title: "Misc/EmptyWithAvailableExternalModels", | ||
| component: DmnEditor, | ||
| includeStories: /^[A-Z]/, | ||
| }; | ||
|
|
||
| export default meta; | ||
| type Story = StoryObj<typeof EmptyStoryWithIncludedModels>; | ||
|
|
||
| export const EmptyWithAvailableExternalModels: Story = { | ||
| render: (args) => EmptyStoryWithIncludedModels(args), | ||
| args: { | ||
| model: getMarshaller(initialModel, { upgradeTo: "latest" }).parser.parse(), | ||
| originalVersion: "1.5", | ||
| evaluationResults: {}, | ||
| externalContextDescription: "External context description", | ||
| externalContextName: "Storybook - DMN Editor", | ||
| externalModelsByNamespace: {}, | ||
| issueTrackerHref: "", | ||
| validationMessages: {}, | ||
| }, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import { getMarshaller } from "@kie-tools/dmn-marshaller"; | ||
| import { normalize } from "@kie-tools/dmn-editor/dist/normalization/normalize"; | ||
| import { XML2PMML } from "@kie-tools/pmml-editor-marshaller"; | ||
| import * as DmnEditor from "@kie-tools/dmn-editor/dist/DmnEditor"; | ||
| import { getPmmlNamespace } from "@kie-tools/dmn-editor/dist/pmml/pmml"; | ||
| import { sumBkm, sumDiffDs, testTreePmml } from "./externalModels"; | ||
|
|
||
| export const sumBkmModel = normalize(getMarshaller(sumBkm, { upgradeTo: "latest" }).parser.parse()); | ||
| export const sumDiffDsModel = normalize(getMarshaller(sumDiffDs, { upgradeTo: "latest" }).parser.parse()); | ||
| export const testTreePmmlModel = XML2PMML(testTreePmml); | ||
|
|
||
| export const availableModels: DmnEditor.ExternalModel[] = [ | ||
| { | ||
| type: "dmn", | ||
| model: sumBkmModel, | ||
| svg: "", | ||
| normalizedPosixPathRelativeToTheOpenFile: "dev-webapp/available-models-to-include/sumBkm.dmn", | ||
| }, | ||
| { | ||
| type: "dmn", | ||
| model: sumDiffDsModel, | ||
| svg: "", | ||
| normalizedPosixPathRelativeToTheOpenFile: "dev-webapp/available-models-to-include/sumDiffDs.dmn", | ||
| }, | ||
| { | ||
| type: "dmn", | ||
| model: normalize( | ||
| getMarshaller(`<definitions xmlns="https://www.omg.org/spec/DMN/20230324/MODEL/" />`, { | ||
| upgradeTo: "latest", | ||
| }).parser.parse() | ||
| ), | ||
| svg: "", | ||
| normalizedPosixPathRelativeToTheOpenFile: "dev-webapp/available-models-to-include/empty.dmn", | ||
| }, | ||
| { | ||
| type: "pmml", | ||
| model: testTreePmmlModel, | ||
| normalizedPosixPathRelativeToTheOpenFile: "dev-webapp/available-models-to-include/testTree.pmml", | ||
| }, | ||
| ]; | ||
|
|
||
| export const availableModelsByPath: Record<string, DmnEditor.ExternalModel> = Object.values(availableModels).reduce( | ||
| (acc, v) => { | ||
| acc[v.normalizedPosixPathRelativeToTheOpenFile] = v; | ||
| return acc; | ||
| }, | ||
| {} as Record<string, DmnEditor.ExternalModel> | ||
| ); | ||
|
|
||
| export const modelsByNamespace = Object.values(availableModels).reduce((acc, v) => { | ||
| if (v.type === "dmn") { | ||
| acc[v.model.definitions["@_namespace"]] = v; | ||
| } else if (v.type === "pmml") { | ||
| acc[getPmmlNamespace({ normalizedPosixPathRelativeToTheOpenFile: v.normalizedPosixPathRelativeToTheOpenFile })] = v; | ||
| } | ||
| return acc; | ||
| }, {} as DmnEditor.ExternalModelsIndex); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please see my comment about the mutation itself...