Skip to content

Commit 288f44e

Browse files
koesie10koesie10
committed
Merge remote-tracking branch 'origin/main' into koesie10/modeled-method-validation-neutral
2 parents 1dbd5aa + fa9cc7c commit 288f44e

9 files changed

Lines changed: 53 additions & 59 deletions

File tree

‎extensions/ql-vscode/src/common/interface-types.ts‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -572,11 +572,6 @@ interface HideModeledMethodsMessage {
572572
hideModeledMethods: boolean;
573573
}
574574

575-
interface SetModeledMethodMessage {
576-
t: "setModeledMethod";
577-
method: ModeledMethod;
578-
}
579-
580575
interface SetMultipleModeledMethodsMessage {
581576
t: "setMultipleModeledMethods";
582577
methodSignature: string;
@@ -627,7 +622,7 @@ interface StartModelingMessage {
627622

628623
export type FromMethodModelingMessage =
629624
| CommonFromViewMessages
630-
| SetModeledMethodMessage
625+
| SetMultipleModeledMethodsMessage
631626
| RevealInEditorMessage
632627
| StartModelingMessage;
633628

‎extensions/ql-vscode/src/model-editor/method-modeling/method-modeling-view-provider.ts‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ import { assertNever } from "../../common/helpers-pure";
1414
import { ModelEditorViewTracker } from "../model-editor-view-tracker";
1515
import { ModelConfigListener } from "../../config";
1616
import { DatabaseItem } from "../../databases/local-databases";
17-
import { convertFromLegacyModeledMethod } from "../shared/modeled-methods-legacy";
1817

1918
export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
2019
ToMethodModelingMessage,
@@ -108,19 +107,19 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
108107
);
109108
break;
110109

111-
case "setModeledMethod": {
110+
case "setMultipleModeledMethods": {
112111
if (!this.databaseItem) {
113112
return;
114113
}
115114

116115
this.modelingStore.updateModeledMethods(
117116
this.databaseItem,
118-
msg.method.signature,
119-
convertFromLegacyModeledMethod(msg.method),
117+
msg.methodSignature,
118+
msg.modeledMethods,
120119
);
121120
this.modelingStore.addModifiedMethod(
122121
this.databaseItem,
123-
msg.method.signature,
122+
msg.methodSignature,
124123
);
125124
break;
126125
}

‎extensions/ql-vscode/src/model-editor/shared/modeled-methods-legacy.ts‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,5 @@
11
import { ModeledMethod } from "../modeled-method";
22

3-
/**
4-
* Converts a single ModeledMethod to a ModeledMethod[] for legacy usage. This function should always be used instead
5-
* of the trivial conversion to track usages of this conversion.
6-
*
7-
* This method should only be called inside a `onMessage` function (or its equivalent). If it's used anywhere else,
8-
* consider whether the boundary is correct: the boundary should as close as possible to the webview -> extension host
9-
* boundary.
10-
*
11-
* @param modeledMethod The single ModeledMethod
12-
*/
13-
export function convertFromLegacyModeledMethod(
14-
modeledMethod: ModeledMethod | undefined,
15-
): ModeledMethod[] {
16-
return modeledMethod ? [modeledMethod] : [];
17-
}
18-
193
/**
204
* Converts a ModeledMethod[] to a single ModeledMethod for legacy usage. This function should always be used instead
215
* of the trivial conversion to track usages of this conversion.

‎extensions/ql-vscode/src/stories/method-modeling/MultipleModeledMethodsPanel.stories.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ const Template: StoryFn<typeof MultipleModeledMethodsPanelComponent> = (
2525
}, [args.modeledMethods]);
2626

2727
const handleChange = useCallback(
28-
(modeledMethods: ModeledMethod[]) => {
29-
args.onChange(modeledMethods);
28+
(methodSignature: string, modeledMethods: ModeledMethod[]) => {
29+
args.onChange(methodSignature, modeledMethods);
3030
setModeledMethods(modeledMethods);
3131
},
3232
[args],

‎extensions/ql-vscode/src/view/method-modeling/MethodModeling.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export type MethodModelingProps = {
5353
method: Method;
5454
modeledMethods: ModeledMethod[];
5555
showMultipleModels?: boolean;
56-
onChange: (modeledMethod: ModeledMethod) => void;
56+
onChange: (methodSignature: string, modeledMethods: ModeledMethod[]) => void;
5757
};
5858

5959
export const MethodModeling = ({

‎extensions/ql-vscode/src/view/method-modeling/MethodModelingView.tsx‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,14 @@ export function MethodModelingView({ initialViewState }: Props): JSX.Element {
8686
return <MethodAlreadyModeled />;
8787
}
8888

89-
const onChange = (modeledMethod: ModeledMethod) => {
89+
const onChange = (
90+
methodSignature: string,
91+
modeledMethods: ModeledMethod[],
92+
) => {
9093
vscode.postMessage({
91-
t: "setModeledMethod",
92-
method: modeledMethod,
94+
t: "setMultipleModeledMethods",
95+
methodSignature,
96+
modeledMethods,
9397
});
9498
};
9599

‎extensions/ql-vscode/src/view/method-modeling/ModeledMethodsPanel.tsx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export type ModeledMethodsPanelProps = {
1111
method: Method;
1212
modeledMethods: ModeledMethod[];
1313
showMultipleModels: boolean;
14-
onChange: (modeledMethod: ModeledMethod) => void;
14+
onChange: (methodSignature: string, modeledMethods: ModeledMethod[]) => void;
1515
};
1616

1717
const SingleMethodModelingInputs = styled(MethodModelingInputs)`
@@ -24,9 +24,9 @@ export const ModeledMethodsPanel = ({
2424
showMultipleModels,
2525
onChange,
2626
}: ModeledMethodsPanelProps) => {
27-
const handleMultipleChange = useCallback(
28-
(modeledMethods: ModeledMethod[]) => {
29-
onChange(modeledMethods[0]);
27+
const handleSingleChange = useCallback(
28+
(modeledMethod: ModeledMethod) => {
29+
onChange(modeledMethod.signature, [modeledMethod]);
3030
},
3131
[onChange],
3232
);
@@ -36,7 +36,7 @@ export const ModeledMethodsPanel = ({
3636
<SingleMethodModelingInputs
3737
method={method}
3838
modeledMethod={convertToLegacyModeledMethod(modeledMethods)}
39-
onChange={onChange}
39+
onChange={handleSingleChange}
4040
/>
4141
);
4242
}
@@ -45,7 +45,7 @@ export const ModeledMethodsPanel = ({
4545
<MultipleModeledMethodsPanel
4646
method={method}
4747
modeledMethods={modeledMethods}
48-
onChange={handleMultipleChange}
48+
onChange={onChange}
4949
/>
5050
);
5151
};

‎extensions/ql-vscode/src/view/method-modeling/MultipleModeledMethodsPanel.tsx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { ModeledMethodAlert } from "./ModeledMethodAlert";
1212
export type MultipleModeledMethodsPanelProps = {
1313
method: Method;
1414
modeledMethods: ModeledMethod[];
15-
onChange: (modeledMethods: ModeledMethod[]) => void;
15+
onChange: (methodSignature: string, modeledMethods: ModeledMethod[]) => void;
1616
};
1717

1818
const Container = styled.div`
@@ -82,7 +82,7 @@ export const MultipleModeledMethodsPanel = ({
8282

8383
const newModeledMethods = [...modeledMethods, newModeledMethod];
8484

85-
onChange(newModeledMethods);
85+
onChange(method.signature, newModeledMethods);
8686
setSelectedIndex(newModeledMethods.length - 1);
8787
}, [onChange, modeledMethods, method]);
8888

@@ -96,21 +96,21 @@ export const MultipleModeledMethodsPanel = ({
9696
? selectedIndex - 1
9797
: selectedIndex;
9898

99-
onChange(newModeledMethods);
99+
onChange(method.signature, newModeledMethods);
100100
setSelectedIndex(newSelectedIndex);
101-
}, [onChange, modeledMethods, selectedIndex]);
101+
}, [onChange, modeledMethods, selectedIndex, method]);
102102

103103
const handleChange = useCallback(
104104
(modeledMethod: ModeledMethod) => {
105105
if (modeledMethods.length > 0) {
106106
const newModeledMethods = [...modeledMethods];
107107
newModeledMethods[selectedIndex] = modeledMethod;
108-
onChange(newModeledMethods);
108+
onChange(method.signature, newModeledMethods);
109109
} else {
110-
onChange([modeledMethod]);
110+
onChange(method.signature, [modeledMethod]);
111111
}
112112
},
113-
[modeledMethods, selectedIndex, onChange],
113+
[modeledMethods, selectedIndex, onChange, method],
114114
);
115115

116116
return (

‎extensions/ql-vscode/src/view/method-modeling/__tests__/MultipleModeledMethodsPanel.spec.tsx‎

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ describe(MultipleModeledMethodsPanel.name, () => {
1414
reactRender(<MultipleModeledMethodsPanel {...props} />);
1515

1616
const method = createMethod();
17-
const onChange = jest.fn<void, [ModeledMethod[]]>();
17+
const onChange = jest.fn<void, [string, ModeledMethod[]]>();
1818

1919
describe("with no modeled methods", () => {
2020
const modeledMethods: ModeledMethod[] = [];
@@ -138,7 +138,7 @@ describe(MultipleModeledMethodsPanel.name, () => {
138138

139139
await userEvent.click(screen.getByLabelText("Add modeling"));
140140

141-
expect(onChange).toHaveBeenCalledWith([
141+
expect(onChange).toHaveBeenCalledWith(method.signature, [
142142
...modeledMethods,
143143
{
144144
signature: method.signature,
@@ -275,7 +275,7 @@ describe(MultipleModeledMethodsPanel.name, () => {
275275

276276
await userEvent.selectOptions(modelTypeDropdown, "source");
277277

278-
expect(onChange).toHaveBeenCalledWith([
278+
expect(onChange).toHaveBeenCalledWith(method.signature, [
279279
{
280280
signature: method.signature,
281281
packageName: method.packageName,
@@ -307,7 +307,7 @@ describe(MultipleModeledMethodsPanel.name, () => {
307307

308308
await userEvent.selectOptions(modelTypeDropdown, "sink");
309309

310-
expect(onChange).toHaveBeenCalledWith([
310+
expect(onChange).toHaveBeenCalledWith(method.signature, [
311311
...modeledMethods.slice(0, 1),
312312
{
313313
signature: method.signature,
@@ -333,7 +333,10 @@ describe(MultipleModeledMethodsPanel.name, () => {
333333

334334
await userEvent.click(screen.getByLabelText("Delete modeling"));
335335

336-
expect(onChange).toHaveBeenCalledWith(modeledMethods.slice(1));
336+
expect(onChange).toHaveBeenCalledWith(
337+
method.signature,
338+
modeledMethods.slice(1),
339+
);
337340
});
338341

339342
it("can add modeling", async () => {
@@ -345,7 +348,7 @@ describe(MultipleModeledMethodsPanel.name, () => {
345348

346349
await userEvent.click(screen.getByLabelText("Add modeling"));
347350

348-
expect(onChange).toHaveBeenCalledWith([
351+
expect(onChange).toHaveBeenCalledWith(method.signature, [
349352
...modeledMethods,
350353
{
351354
signature: method.signature,
@@ -375,7 +378,7 @@ describe(MultipleModeledMethodsPanel.name, () => {
375378
<MultipleModeledMethodsPanel
376379
method={method}
377380
modeledMethods={
378-
onChange.mock.calls[onChange.mock.calls.length - 1][0]
381+
onChange.mock.calls[onChange.mock.calls.length - 1][1]
379382
}
380383
onChange={onChange}
381384
/>,
@@ -393,7 +396,7 @@ describe(MultipleModeledMethodsPanel.name, () => {
393396
<MultipleModeledMethodsPanel
394397
method={method}
395398
modeledMethods={
396-
onChange.mock.calls[onChange.mock.calls.length - 1][0]
399+
onChange.mock.calls[onChange.mock.calls.length - 1][1]
397400
}
398401
onChange={onChange}
399402
/>,
@@ -409,7 +412,7 @@ describe(MultipleModeledMethodsPanel.name, () => {
409412
<MultipleModeledMethodsPanel
410413
method={method}
411414
modeledMethods={
412-
onChange.mock.calls[onChange.mock.calls.length - 1][0]
415+
onChange.mock.calls[onChange.mock.calls.length - 1][1]
413416
}
414417
onChange={onChange}
415418
/>,
@@ -575,7 +578,10 @@ describe(MultipleModeledMethodsPanel.name, () => {
575578

576579
await userEvent.click(screen.getByLabelText("Delete modeling"));
577580

578-
expect(onChange).toHaveBeenCalledWith(modeledMethods.slice(1));
581+
expect(onChange).toHaveBeenCalledWith(
582+
method.signature,
583+
modeledMethods.slice(1),
584+
);
579585
});
580586

581587
it("can delete second modeling", async () => {
@@ -588,7 +594,10 @@ describe(MultipleModeledMethodsPanel.name, () => {
588594
await userEvent.click(screen.getByLabelText("Next modeling"));
589595
await userEvent.click(screen.getByLabelText("Delete modeling"));
590596

591-
expect(onChange).toHaveBeenCalledWith(modeledMethods.slice(0, 1));
597+
expect(onChange).toHaveBeenCalledWith(
598+
method.signature,
599+
modeledMethods.slice(0, 1),
600+
);
592601
});
593602

594603
it("can add modeling after deleting second modeling", async () => {
@@ -601,7 +610,10 @@ describe(MultipleModeledMethodsPanel.name, () => {
601610
await userEvent.click(screen.getByLabelText("Next modeling"));
602611
await userEvent.click(screen.getByLabelText("Delete modeling"));
603612

604-
expect(onChange).toHaveBeenCalledWith(modeledMethods.slice(0, 1));
613+
expect(onChange).toHaveBeenCalledWith(
614+
method.signature,
615+
modeledMethods.slice(0, 1),
616+
);
605617

606618
rerender(
607619
<MultipleModeledMethodsPanel
@@ -614,7 +626,7 @@ describe(MultipleModeledMethodsPanel.name, () => {
614626
onChange.mockReset();
615627
await userEvent.click(screen.getByLabelText("Add modeling"));
616628

617-
expect(onChange).toHaveBeenCalledWith([
629+
expect(onChange).toHaveBeenCalledWith(method.signature, [
618630
...modeledMethods.slice(0, 1),
619631
{
620632
signature: method.signature,

0 commit comments

Comments
 (0)