Skip to content

Convert SetSelectedMethodMessage to include multiple modeled methods #2947

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
koesie10 merged 3 commits into from
Oct 11, 2023
Merged

Convert SetSelectedMethodMessage to include multiple modeled methods #2947

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a62d05
Convert SetSelectedMethodMessage to include multiple modeled methods
koesie10 Oct 11, 2023
667bf19
Add methodSignature to SetMultipleModeledMethodsMessage
koesie10 Oct 11, 2023
84211c6
Merge remote-tracking branch 'origin/main' into koesie10/update-set-s…
koesie10 Oct 11, 2023
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
10 changes: 8 additions & 2 deletions extensions/ql-vscode/src/common/interface-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,6 +577,12 @@ interface SetModeledMethodMessage {
method: ModeledMethod;
}

interface SetMultipleModeledMethodsMessage {
Comment thread
koesie10 marked this conversation as resolved.
t: "setMultipleModeledMethods";
methodSignature: string;
modeledMethods: ModeledMethod[];
Copy link
Copy Markdown
Contributor

@robertbrignull robertbrignull Oct 11, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did we discuss including methodSignature: string; in this message, so you don't have to work out the signature by looking at the modeled methods?

That would also make it easier to remove all modeled methods for a method signature, instead of having to set it to the array containing one element with type: "none".

I'm happy for you to make this change in this PR or I can do it in a followup, because I'll be using this message in my next PR.

Copy link
Copy Markdown
Member Author

@koesie10 koesie10 Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does make sense to add it here. Right now, this message is only used for communication from the extension host to the view, but we'll definitely need the signature for the communication from the view to the extension host. I'll change the message now so that I can also use it in a follow-up PR (after #2924).

}

interface SetInModelingModeMessage {
t: "setInModelingMode";
inModelingMode: boolean;
Expand Down Expand Up @@ -643,14 +649,14 @@ interface SetMethodModifiedMessage {
interface SetSelectedMethodMessage {
t: "setSelectedMethod";
method: Method;
modeledMethod?: ModeledMethod;
modeledMethods: ModeledMethod[];
isModified: boolean;
}

export type ToMethodModelingMessage =
| SetMethodModelingPanelViewStateMessage
| SetMethodMessage
| SetModeledMethodMessage
| SetMultipleModeledMethodsMessage
| SetMethodModifiedMessage
| SetSelectedMethodMessage
| SetInModelingModeMessage;
27 changes: 10 additions & 17 deletions extensions/ql-vscode/src/model-editor/method-modeling/method-modeling-view-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ import { assertNever } from "../../common/helpers-pure";
import { ModelEditorViewTracker } from "../model-editor-view-tracker";
import { ModelConfigListener } from "../../config";
import { DatabaseItem } from "../../databases/local-databases";
import {
convertFromLegacyModeledMethod,
convertToLegacyModeledMethod,
} from "../shared/modeled-methods-legacy";
import { convertFromLegacyModeledMethod } from "../shared/modeled-methods-legacy";

export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
ToMethodModelingMessage,
Expand Down Expand Up @@ -77,9 +74,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
await this.postMessage({
t: "setSelectedMethod",
method: selectedMethod.method,
modeledMethod: convertToLegacyModeledMethod(
selectedMethod.modeledMethods,
),
modeledMethods: selectedMethod.modeledMethods,
isModified: selectedMethod.isModified,
});
}
Expand Down Expand Up @@ -162,16 +157,14 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
private registerToModelingStoreEvents(): void {
this.push(
this.modelingStore.onModeledMethodsChanged(async (e) => {
if (this.webviewView && e.isActiveDb) {
const modeledMethods = e.modeledMethods[this.method?.signature ?? ""];
if (this.webviewView && e.isActiveDb && this.method) {
const modeledMethods = e.modeledMethods[this.method.signature];
if (modeledMethods) {
const modeledMethod = convertToLegacyModeledMethod(modeledMethods);
if (modeledMethod) {
await this.postMessage({
t: "setModeledMethod",
method: modeledMethod,
});
}
await this.postMessage({
t: "setMultipleModeledMethods",
methodSignature: this.method.signature,
modeledMethods,
});
}
}
}),
Expand All @@ -198,7 +191,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
await this.postMessage({
t: "setSelectedMethod",
method: e.method,
modeledMethod: convertToLegacyModeledMethod(e.modeledMethods),
modeledMethods: e.modeledMethods,
isModified: e.isModified,
});
}
Expand Down
4 changes: 2 additions & 2 deletions extensions/ql-vscode/src/model-editor/method.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ export function getArgumentsList(methodParameters: string): string[] {

export function canMethodBeModeled(
method: Method,
modeledMethod: ModeledMethod | undefined,
modeledMethods: ModeledMethod[],
methodIsUnsaved: boolean,
): boolean {
return (
!method.supported ||
(modeledMethod && modeledMethod?.type !== "none") ||
modeledMethods.some((modeledMethod) => modeledMethod.type !== "none") ||
methodIsUnsaved
);
}
23 changes: 8 additions & 15 deletions extensions/ql-vscode/src/view/method-modeling/MethodModelingView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import { vscode } from "../vscode-api";
import { NotInModelingMode } from "./NotInModelingMode";
import { NoMethodSelected } from "./NoMethodSelected";
import { MethodModelingPanelViewState } from "../../model-editor/shared/view-state";
import { convertFromLegacyModeledMethod } from "../../model-editor/shared/modeled-methods-legacy";
import { MethodAlreadyModeled } from "./MethodAlreadyModeled";

type Props = {
Expand All @@ -25,19 +24,13 @@ export function MethodModelingView({ initialViewState }: Props): JSX.Element {

const [method, setMethod] = useState<Method | undefined>(undefined);

const [modeledMethod, setModeledMethod] = React.useState<
ModeledMethod | undefined
>(undefined);
const [modeledMethods, setModeledMethods] = useState<ModeledMethod[]>([]);

const [isMethodModified, setIsMethodModified] = useState<boolean>(false);

const modelingStatus = useMemo(
() =>
getModelingStatus(
convertFromLegacyModeledMethod(modeledMethod),
isMethodModified,
),
[modeledMethod, isMethodModified],
() => getModelingStatus(modeledMethods, isMethodModified),
[modeledMethods, isMethodModified],
);

useEffect(() => {
Expand All @@ -54,15 +47,15 @@ export function MethodModelingView({ initialViewState }: Props): JSX.Element {
case "setMethod":
setMethod(msg.method);
break;
case "setModeledMethod":
setModeledMethod(msg.method);
case "setMultipleModeledMethods":
setModeledMethods(msg.modeledMethods);
break;
case "setMethodModified":
setIsMethodModified(msg.isModified);
break;
case "setSelectedMethod":
setMethod(msg.method);
setModeledMethod(msg.modeledMethod);
setModeledMethods(msg.modeledMethods);
setIsMethodModified(msg.isModified);
break;
default:
Expand All @@ -89,7 +82,7 @@ export function MethodModelingView({ initialViewState }: Props): JSX.Element {
return <NoMethodSelected />;
}

if (!canMethodBeModeled(method, modeledMethod, isMethodModified)) {
if (!canMethodBeModeled(method, modeledMethods, isMethodModified)) {
return <MethodAlreadyModeled />;
}

Expand All @@ -104,7 +97,7 @@ export function MethodModelingView({ initialViewState }: Props): JSX.Element {
<MethodModeling
modelingStatus={modelingStatus}
method={method}
modeledMethods={convertFromLegacyModeledMethod(modeledMethod)}
modeledMethods={modeledMethods}
showMultipleModels={viewState?.showMultipleModels}
onChange={onChange}
/>
Expand Down
3 changes: 2 additions & 1 deletion extensions/ql-vscode/src/view/model-editor/ModeledMethodDataGrid.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { sortMethods } from "../../model-editor/shared/sorting";
import { InProgressMethods } from "../../model-editor/shared/in-progress-methods";
import { HiddenMethodsRow } from "./HiddenMethodsRow";
import { ModelEditorViewState } from "../../model-editor/shared/view-state";
import { convertFromLegacyModeledMethod } from "../../model-editor/shared/modeled-methods-legacy";

export const GRID_TEMPLATE_COLUMNS = "0.5fr 0.125fr 0.125fr 0.125fr 0.125fr";

Expand Down Expand Up @@ -49,7 +50,7 @@ export const ModeledMethodDataGrid = ({
const methodIsUnsaved = modifiedSignatures.has(method.signature);
const methodCanBeModeled = canMethodBeModeled(
method,
modeledMethod,
convertFromLegacyModeledMethod(modeledMethod),
methodIsUnsaved,
);

Expand Down