Skip to content

Show in-progress state in method modeling panel #2979

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
charisk merged 2 commits into from
Oct 16, 2023
Merged

Show in-progress state in method modeling panel #2979

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4de3390
Show in-progress state in method modeling panel
charisk Oct 16, 2023
3f687d1
Remove inProgress instance variable
charisk Oct 16, 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
9 changes: 8 additions & 1 deletion 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 @@ -583,6 +583,11 @@ interface SetInModelingModeMessage {
inModelingMode: boolean;
}

interface SetInProgressMessage {
t: "setInProgress";
inProgress: boolean;
}

interface RevealMethodMessage {
t: "revealMethod";
methodSignature: string;
Expand Down Expand Up @@ -646,6 +651,7 @@ interface SetSelectedMethodMessage {
method: Method;
modeledMethods: ModeledMethod[];
isModified: boolean;
isInProgress: boolean;
}

export type ToMethodModelingMessage =
Expand All @@ -654,4 +660,5 @@ export type ToMethodModelingMessage =
| SetMultipleModeledMethodsMessage
| SetMethodModifiedMessage
| SetSelectedMethodMessage
| SetInModelingModeMessage;
| SetInModelingModeMessage
| SetInProgressMessage;
21 changes: 21 additions & 0 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,6 +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 { hasInProgressMethodSignature } from "../shared/in-progress-methods";

export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
ToMethodModelingMessage,
Expand Down Expand Up @@ -75,6 +76,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
method: selectedMethod.method,
modeledMethods: selectedMethod.modeledMethods,
isModified: selectedMethod.isModified,
isInProgress: selectedMethod.isInProgress,
});
}

Expand Down Expand Up @@ -188,6 +190,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
method: e.method,
modeledMethods: e.modeledMethods,
isModified: e.isModified,
isInProgress: e.isInProgress,
});
}
}),
Expand Down Expand Up @@ -216,6 +219,24 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
}
}),
);

this.push(
this.modelingStore.onInProgressMethodsChanged(async (e) => {
if (this.method && this.databaseItem) {
const dbUri = this.databaseItem.databaseUri.toString();
if (e.dbUri === dbUri) {
const inProgress = hasInProgressMethodSignature(
e.methods,
this.method.signature,
);
await this.postMessage({
t: "setInProgress",
inProgress,
});
}
}
}),
);
}

private registerToModelConfigEvents(): void {
Expand Down
15 changes: 14 additions & 1 deletion extensions/ql-vscode/src/model-editor/modeling-store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ import { DatabaseItem } from "../databases/local-databases";
import { Method, Usage } from "./method";
import { ModeledMethod } from "./modeled-method";
import { INITIAL_HIDE_MODELED_METHODS_VALUE } from "./shared/hide-modeled-methods";
import { InProgressMethods } from "./shared/in-progress-methods";
import {
InProgressMethods,
hasInProgressMethodSignature,
} from "./shared/in-progress-methods";
import { INITIAL_MODE, Mode } from "./shared/mode";

interface InternalDbModelingState {
Expand Down Expand Up @@ -37,6 +40,7 @@ interface SelectedMethodDetails {
readonly usage: Usage | undefined;
readonly modeledMethods: readonly ModeledMethod[];
readonly isModified: boolean;
readonly isInProgress: boolean;
}

interface MethodsChangedEvent {
Expand Down Expand Up @@ -73,6 +77,7 @@ interface SelectedMethodChangedEvent {
readonly usage: Usage;
readonly modeledMethods: readonly ModeledMethod[];
readonly isModified: boolean;
readonly isInProgress: boolean;
}

interface InProgressMethodsChangedEvent {
Expand Down Expand Up @@ -409,6 +414,10 @@ export class ModelingStore extends DisposableObject {
usage,
modeledMethods: dbState.modeledMethods[method.signature] ?? [],
isModified: dbState.modifiedMethodSignatures.has(method.signature),
isInProgress: hasInProgressMethodSignature(
dbState.inProgressMethods,
method.signature,
),
});
}

Expand Down Expand Up @@ -449,6 +458,10 @@ export class ModelingStore extends DisposableObject {
isModified: dbState.modifiedMethodSignatures.has(
selectedMethod.signature,
),
isInProgress: hasInProgressMethodSignature(
dbState.inProgressMethods,
selectedMethod.signature,
),
};
}

Expand Down
13 changes: 13 additions & 0 deletions extensions/ql-vscode/src/model-editor/shared/in-progress-methods.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,16 @@ export function hasInProgressMethod(

return false;
}

export function hasInProgressMethodSignature(
Comment thread
charisk marked this conversation as resolved.
inProgressMethods: InProgressMethods,
signature: string,
): boolean {
for (const methods of Object.values(inProgressMethods)) {
if (methods.includes(signature)) {
return true;
}
}

return false;
}
7 changes: 7 additions & 0 deletions extensions/ql-vscode/src/stories/method-modeling/MethodModelingInputs.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,10 @@ FullyModeledMethod.args = {
method,
modeledMethod,
};

export const ModelingInProgress = Template.bind({});
ModelingInProgress.args = {
method,
modeledMethod,
isModelingInProgress: true,
};
3 changes: 3 additions & 0 deletions extensions/ql-vscode/src/view/method-modeling/MethodModeling.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export type MethodModelingProps = {
modelingStatus: ModelingStatus;
method: Method;
modeledMethods: ModeledMethod[];
isModelingInProgress: boolean;
showMultipleModels?: boolean;
onChange: (methodSignature: string, modeledMethods: ModeledMethod[]) => void;
};
Expand All @@ -60,6 +61,7 @@ export const MethodModeling = ({
modelingStatus,
modeledMethods,
method,
isModelingInProgress,
showMultipleModels = false,
onChange,
}: MethodModelingProps): JSX.Element => {
Expand All @@ -78,6 +80,7 @@ export const MethodModeling = ({
method={method}
modeledMethods={modeledMethods}
showMultipleModels={showMultipleModels}
isModelingInProgress={isModelingInProgress}
onChange={onChange}
/>
<ReviewInEditorButton method={method} />
Expand Down
27 changes: 23 additions & 4 deletions extensions/ql-vscode/src/view/method-modeling/MethodModelingInputs.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { ModelTypeDropdown } from "../model-editor/ModelTypeDropdown";
import { ModelInputDropdown } from "../model-editor/ModelInputDropdown";
import { ModelOutputDropdown } from "../model-editor/ModelOutputDropdown";
import { ModelKindDropdown } from "../model-editor/ModelKindDropdown";
import { InProgressDropdown } from "../model-editor/InProgressDropdown";

const Container = styled.div`
padding-top: 0.5rem;
Expand All @@ -24,12 +25,14 @@ const Name = styled.span`
export type MethodModelingInputsProps = {
method: Method;
modeledMethod: ModeledMethod | undefined;
isModelingInProgress: boolean;
onChange: (modeledMethod: ModeledMethod) => void;
};

export const MethodModelingInputs = ({
method,
modeledMethod,
isModelingInProgress,
onChange,
}: MethodModelingInputsProps): JSX.Element => {
const inputProps = {
Expand All @@ -43,25 +46,41 @@ export const MethodModelingInputs = ({
<Container>
<Input>
<Name>Model Type</Name>
<ModelTypeDropdown {...inputProps} />
{isModelingInProgress ? (
<InProgressDropdown />
) : (
<ModelTypeDropdown {...inputProps} />
)}
</Input>
</Container>
<Container>
<Input>
<Name>Input</Name>
<ModelInputDropdown {...inputProps} />
{isModelingInProgress ? (
<InProgressDropdown />
) : (
<ModelInputDropdown {...inputProps} />
)}
</Input>
</Container>
<Container>
<Input>
<Name>Output</Name>
<ModelOutputDropdown {...inputProps} />
{isModelingInProgress ? (
<InProgressDropdown />
) : (
<ModelOutputDropdown {...inputProps} />
)}
</Input>
</Container>
<Container>
<Input>
<Name>Kind</Name>
<ModelKindDropdown {...inputProps} />
{isModelingInProgress ? (
<InProgressDropdown />
) : (
<ModelKindDropdown {...inputProps} />
)}
</Input>
</Container>
</>
Expand Down
7 changes: 7 additions & 0 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 @@ -28,6 +28,9 @@ export function MethodModelingView({ initialViewState }: Props): JSX.Element {

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

const [isModelingInProgress, setIsModelingInProgress] =
useState<boolean>(false);

const modelingStatus = useMemo(
() => getModelingStatus(modeledMethods, isMethodModified),
[modeledMethods, isMethodModified],
Expand Down Expand Up @@ -58,6 +61,9 @@ export function MethodModelingView({ initialViewState }: Props): JSX.Element {
setModeledMethods(msg.modeledMethods);
setIsMethodModified(msg.isModified);
break;
case "setInProgress":
setIsModelingInProgress(msg.inProgress);
break;
default:
assertNever(msg);
}
Expand Down Expand Up @@ -102,6 +108,7 @@ export function MethodModelingView({ initialViewState }: Props): JSX.Element {
modelingStatus={modelingStatus}
method={method}
modeledMethods={modeledMethods}
isModelingInProgress={isModelingInProgress}
showMultipleModels={viewState?.showMultipleModels}
onChange={onChange}
/>
Expand Down
4 changes: 4 additions & 0 deletions extensions/ql-vscode/src/view/method-modeling/ModeledMethodsPanel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { convertToLegacyModeledMethod } from "../../model-editor/shared/modeled-
export type ModeledMethodsPanelProps = {
method: Method;
modeledMethods: ModeledMethod[];
isModelingInProgress: boolean;
showMultipleModels: boolean;
onChange: (methodSignature: string, modeledMethods: ModeledMethod[]) => void;
};
Expand All @@ -21,6 +22,7 @@ const SingleMethodModelingInputs = styled(MethodModelingInputs)`
export const ModeledMethodsPanel = ({
method,
modeledMethods,
isModelingInProgress,
showMultipleModels,
onChange,
}: ModeledMethodsPanelProps) => {
Expand All @@ -36,6 +38,7 @@ export const ModeledMethodsPanel = ({
<SingleMethodModelingInputs
method={method}
modeledMethod={convertToLegacyModeledMethod(modeledMethods)}
isModelingInProgress={isModelingInProgress}
onChange={handleSingleChange}
/>
);
Expand All @@ -45,6 +48,7 @@ export const ModeledMethodsPanel = ({
<MultipleModeledMethodsPanel
method={method}
modeledMethods={modeledMethods}
isModelingInProgress={isModelingInProgress}
onChange={onChange}
/>
);
Expand Down
4 changes: 4 additions & 0 deletions extensions/ql-vscode/src/view/method-modeling/MultipleModeledMethodsPanel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { ModeledMethodAlert } from "./ModeledMethodAlert";
export type MultipleModeledMethodsPanelProps = {
method: Method;
modeledMethods: ModeledMethod[];
isModelingInProgress: boolean;
onChange: (methodSignature: string, modeledMethods: ModeledMethod[]) => void;
};

Expand Down Expand Up @@ -50,6 +51,7 @@ const ModificationActions = styled.div`
export const MultipleModeledMethodsPanel = ({
method,
modeledMethods,
isModelingInProgress,
onChange,
}: MultipleModeledMethodsPanelProps) => {
const [selectedIndex, setSelectedIndex] = useState<number>(0);
Expand Down Expand Up @@ -130,12 +132,14 @@ export const MultipleModeledMethodsPanel = ({
<MethodModelingInputs
method={method}
modeledMethod={modeledMethods[selectedIndex]}
isModelingInProgress={isModelingInProgress}
onChange={handleChange}
/>
) : (
<MethodModelingInputs
method={method}
modeledMethod={undefined}
isModelingInProgress={isModelingInProgress}
onChange={handleChange}
/>
)}
Expand Down
2 changes: 2 additions & 0 deletions extensions/ql-vscode/src/view/method-modeling/__tests__/MethodModeling.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ describe(MethodModeling.name, () => {
it("renders method modeling panel", () => {
const method = createMethod();
const modeledMethod = createModeledMethod();
const isModelingInProgress = false;
const onChange = jest.fn();

render({
modelingStatus: "saved",
method,
modeledMethods: [modeledMethod],
isModelingInProgress,
onChange,
});

Expand Down
Loading