Skip to content

Move modeling events to new ModelingEvents class #3005

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 1 commit into from
Oct 23, 2023
Merged

Move modeling events to new ModelingEvents class #3005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions extensions/ql-vscode/src/model-editor/method-modeling/method-modeling-panel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ import { ModelingStore } from "../modeling-store";
import { ModelEditorViewTracker } from "../model-editor-view-tracker";
import { ModelConfigListener } from "../../config";
import { DatabaseItem } from "../../databases/local-databases";
import { ModelingEvents } from "../modeling-events";

export class MethodModelingPanel extends DisposableObject {
private readonly provider: MethodModelingViewProvider;

constructor(
app: App,
modelingStore: ModelingStore,
modelingEvents: ModelingEvents,
editorViewTracker: ModelEditorViewTracker,
) {
super();
Expand All @@ -26,6 +28,7 @@ export class MethodModelingPanel extends DisposableObject {
this.provider = new MethodModelingViewProvider(
app,
modelingStore,
modelingEvents,
editorViewTracker,
modelConfig,
);
Expand Down
18 changes: 10 additions & 8 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 { ModelingEvents } from "../modeling-events";

export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
ToMethodModelingMessage,
Expand All @@ -27,6 +28,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
constructor(
app: App,
private readonly modelingStore: ModelingStore,
private readonly modelingEvents: ModelingEvents,
private readonly editorViewTracker: ModelEditorViewTracker,
private readonly modelConfig: ModelConfigListener,
) {
Expand All @@ -35,7 +37,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<

protected override async onWebViewLoaded(): Promise<void> {
await Promise.all([this.setViewState(), this.setInitialState()]);
this.registerToModelingStoreEvents();
this.registerToModelingEvents();
this.registerToModelConfigEvents();
}

Expand Down Expand Up @@ -150,9 +152,9 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
await view?.revealMethod(method);
}

private registerToModelingStoreEvents(): void {
private registerToModelingEvents(): void {
this.push(
this.modelingStore.onModeledMethodsChanged(async (e) => {
this.modelingEvents.onModeledMethodsChanged(async (e) => {
if (this.webviewView && e.isActiveDb && this.method) {
const modeledMethods = e.modeledMethods[this.method.signature];
if (modeledMethods) {
Expand All @@ -167,7 +169,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
);

this.push(
this.modelingStore.onModifiedMethodsChanged(async (e) => {
this.modelingEvents.onModifiedMethodsChanged(async (e) => {
if (this.webviewView && e.isActiveDb && this.method) {
const isModified = e.modifiedMethods.has(this.method.signature);
await this.postMessage({
Expand All @@ -179,7 +181,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
);

this.push(
this.modelingStore.onSelectedMethodChanged(async (e) => {
this.modelingEvents.onSelectedMethodChanged(async (e) => {
if (this.webviewView) {
this.method = e.method;
this.databaseItem = e.databaseItem;
Expand All @@ -196,7 +198,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
);

this.push(
this.modelingStore.onDbOpened(async () => {
this.modelingEvents.onDbOpened(async () => {
await this.postMessage({
t: "setInModelingMode",
inModelingMode: true,
Expand All @@ -205,7 +207,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
);

this.push(
this.modelingStore.onDbClosed(async (dbUri) => {
this.modelingEvents.onDbClosed(async (dbUri) => {
if (!this.modelingStore.anyDbsBeingModeled()) {
await this.postMessage({
t: "setInModelingMode",
Expand All @@ -220,7 +222,7 @@ export class MethodModelingViewProvider extends AbstractWebviewViewProvider<
);

this.push(
this.modelingStore.onInProgressMethodsChanged(async (e) => {
this.modelingEvents.onInProgressMethodsChanged(async (e) => {
if (this.method && this.databaseItem) {
const dbUri = this.databaseItem.databaseUri.toString();
if (e.dbUri === dbUri) {
Expand Down
16 changes: 9 additions & 7 deletions extensions/ql-vscode/src/model-editor/methods-usage/methods-usage-panel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ import { CodeQLCliServer } from "../../codeql-cli/cli";
import { ModelingStore } from "../modeling-store";
import { ModeledMethod } from "../modeled-method";
import { Mode } from "../shared/mode";
import { ModelingEvents } from "../modeling-events";

export class MethodsUsagePanel extends DisposableObject {
private readonly dataProvider: MethodsUsageDataProvider;
private readonly treeView: TreeView<MethodsUsageTreeViewItem>;

public constructor(
private readonly modelingStore: ModelingStore,
private readonly modelingEvents: ModelingEvents,
cliServer: CodeQLCliServer,
) {
super();
Expand All @@ -28,7 +30,7 @@ export class MethodsUsagePanel extends DisposableObject {
});
this.push(this.treeView);

this.registerToModelingStoreEvents();
this.registerToModelingEvents();
}

public async setState(
Expand Down Expand Up @@ -69,39 +71,39 @@ export class MethodsUsagePanel extends DisposableObject {
}
}

private registerToModelingStoreEvents(): void {
private registerToModelingEvents(): void {
this.push(
this.modelingStore.onActiveDbChanged(async () => {
this.modelingEvents.onActiveDbChanged(async () => {
await this.handleStateChangeEvent();
}),
);

this.push(
this.modelingStore.onMethodsChanged(async (event) => {
this.modelingEvents.onMethodsChanged(async (event) => {
if (event.isActiveDb) {
await this.handleStateChangeEvent();
}
}),
);

this.push(
this.modelingStore.onHideModeledMethodsChanged(async (event) => {
this.modelingEvents.onHideModeledMethodsChanged(async (event) => {
if (event.isActiveDb) {
await this.handleStateChangeEvent();
}
}),
);

this.push(
this.modelingStore.onModeChanged(async (event) => {
this.modelingEvents.onModeChanged(async (event) => {
if (event.isActiveDb) {
await this.handleStateChangeEvent();
}
}),
);

this.push(
this.modelingStore.onModifiedMethodsChanged(async (event) => {
this.modelingEvents.onModifiedMethodsChanged(async (event) => {
if (event.isActiveDb) {
await this.handleStateChangeEvent();
}
Expand Down
23 changes: 16 additions & 7 deletions extensions/ql-vscode/src/model-editor/model-editor-module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ import { ModelingStore } from "./modeling-store";
import { showResolvableLocation } from "../databases/local-databases/locations";
import { ModelEditorViewTracker } from "./model-editor-view-tracker";
import { ModelConfigListener } from "../config";
import { ModelingEvents } from "./modeling-events";

const SUPPORTED_LANGUAGES: string[] = ["java", "csharp"];

export class ModelEditorModule extends DisposableObject {
private readonly queryStorageDir: string;
private readonly modelingStore: ModelingStore;
private readonly modelingEvents: ModelingEvents;
private readonly editorViewTracker: ModelEditorViewTracker<ModelEditorView>;
private readonly methodsUsagePanel: MethodsUsagePanel;
private readonly methodModelingPanel: MethodModelingPanel;
Expand All @@ -40,16 +42,22 @@ export class ModelEditorModule extends DisposableObject {
) {
super();
this.queryStorageDir = join(baseQueryStorageDir, "model-editor-results");
this.modelingStore = new ModelingStore(app);
this.modelingEvents = new ModelingEvents(app);
this.modelingStore = new ModelingStore(this.modelingEvents);
this.editorViewTracker = new ModelEditorViewTracker();
this.methodsUsagePanel = this.push(
new MethodsUsagePanel(this.modelingStore, cliServer),
new MethodsUsagePanel(this.modelingStore, this.modelingEvents, cliServer),
);
this.methodModelingPanel = this.push(
new MethodModelingPanel(app, this.modelingStore, this.editorViewTracker),
new MethodModelingPanel(
app,
this.modelingStore,
this.modelingEvents,
this.editorViewTracker,
),
);

this.registerToModelingStoreEvents();
this.registerToModelingEvents();
}

public static async initialize(
Expand Down Expand Up @@ -90,9 +98,9 @@ export class ModelEditorModule extends DisposableObject {
await ensureDir(this.queryStorageDir);
}

private registerToModelingStoreEvents(): void {
private registerToModelingEvents(): void {
this.push(
this.modelingStore.onSelectedMethodChanged(async (event) => {
this.modelingEvents.onSelectedMethodChanged(async (event) => {
await this.showMethod(event.databaseItem, event.method, event.usage);
}),
);
Expand Down Expand Up @@ -215,6 +223,7 @@ export class ModelEditorModule extends DisposableObject {
const view = new ModelEditorView(
this.app,
this.modelingStore,
this.modelingEvents,
this.editorViewTracker,
modelConfig,
this.databaseManager,
Expand All @@ -226,7 +235,7 @@ export class ModelEditorModule extends DisposableObject {
modelFile,
);

this.modelingStore.onDbClosed(async (dbUri) => {
this.modelingEvents.onDbClosed(async (dbUri) => {
if (dbUri === db.databaseUri.toString()) {
await cleanupQueryDir();
}
Expand Down
15 changes: 9 additions & 6 deletions extensions/ql-vscode/src/model-editor/model-editor-view.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ import { AutoModeler } from "./auto-modeler";
import { telemetryListener } from "../common/vscode/telemetry";
import { ModelingStore } from "./modeling-store";
import { ModelEditorViewTracker } from "./model-editor-view-tracker";
import { ModelingEvents } from "./modeling-events";

export class ModelEditorView extends AbstractWebview<
ToModelEditorMessage,
Expand All @@ -53,6 +54,7 @@ export class ModelEditorView extends AbstractWebview<
public constructor(
protected readonly app: App,
private readonly modelingStore: ModelingStore,
private readonly modelingEvents: ModelingEvents,
private readonly viewTracker: ModelEditorViewTracker<ModelEditorView>,
private readonly modelConfig: ModelConfigListener,
private readonly databaseManager: DatabaseManager,
Expand All @@ -67,7 +69,7 @@ export class ModelEditorView extends AbstractWebview<
super(app);

this.modelingStore.initializeStateForDb(databaseItem, initialMode);
this.registerToModelingStoreEvents();
this.registerToModelingEvents();
this.registerToModelConfigEvents();

this.viewTracker.registerView(this);
Expand Down Expand Up @@ -567,6 +569,7 @@ export class ModelEditorView extends AbstractWebview<
const view = new ModelEditorView(
this.app,
this.modelingStore,
this.modelingEvents,
this.viewTracker,
this.modelConfig,
this.databaseManager,
Expand Down Expand Up @@ -655,9 +658,9 @@ export class ModelEditorView extends AbstractWebview<
return addedDatabase;
}

private registerToModelingStoreEvents() {
private registerToModelingEvents() {
this.push(
this.modelingStore.onMethodsChanged(async (event) => {
this.modelingEvents.onMethodsChanged(async (event) => {
if (event.dbUri === this.databaseItem.databaseUri.toString()) {
await this.postMessage({
t: "setMethods",
Expand All @@ -668,7 +671,7 @@ export class ModelEditorView extends AbstractWebview<
);

this.push(
this.modelingStore.onModeledMethodsChanged(async (event) => {
this.modelingEvents.onModeledMethodsChanged(async (event) => {
if (event.dbUri === this.databaseItem.databaseUri.toString()) {
await this.postMessage({
t: "setModeledMethods",
Expand All @@ -679,7 +682,7 @@ export class ModelEditorView extends AbstractWebview<
);

this.push(
this.modelingStore.onModifiedMethodsChanged(async (event) => {
this.modelingEvents.onModifiedMethodsChanged(async (event) => {
if (event.dbUri === this.databaseItem.databaseUri.toString()) {
await this.postMessage({
t: "setModifiedMethods",
Expand All @@ -690,7 +693,7 @@ export class ModelEditorView extends AbstractWebview<
);

this.push(
this.modelingStore.onInProgressMethodsChanged(async (event) => {
this.modelingEvents.onInProgressMethodsChanged(async (event) => {
if (event.dbUri === this.databaseItem.databaseUri.toString()) {
await this.postMessage({
t: "setInProgressMethods",
Expand Down
Loading