Skip to content

Commit 58bffe1

Browse files
koesie10koesie10
committed
Merge remote-tracking branch 'origin/main' into koesie10/typed-local-database-ui-commands
2 parents e603de4 + 3c229d2 commit 58bffe1

12 files changed

Lines changed: 224 additions & 236 deletions

File tree

‎extensions/ql-vscode/src/common/commands.ts‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { CommandManager } from "../packages/commands";
22
import type { Uri } from "vscode";
3+
import type { DbTreeViewItem } from "../databases/ui/db-tree-view-item";
34
import type { DatabaseItem } from "../local-databases";
45
import type { QueryHistoryInfo } from "../query-history/query-history-info";
56

@@ -10,6 +11,12 @@ export type SelectionCommandFunction<Item> = (
1011
multiSelect: Item[],
1112
) => Promise<void>;
1213

14+
// A command function matching the signature that VS Code calls when
15+
// a command on a selection is invoked when canSelectMany is false.
16+
export type SingleSelectionCommandFunction<Item> = (
17+
singleItem: Item,
18+
) => Promise<void>;
19+
1320
/**
1421
* Contains type definitions for all commands used by the extension.
1522
*
@@ -88,9 +95,23 @@ export type VariantAnalysisCommands = {
8895
"codeQL.runVariantAnalysisContextEditor": (uri?: Uri) => Promise<void>;
8996
};
9097

98+
export type DatabasePanelCommands = {
99+
"codeQLVariantAnalysisRepositories.openConfigFile": () => Promise<void>;
100+
"codeQLVariantAnalysisRepositories.addNewDatabase": () => Promise<void>;
101+
"codeQLVariantAnalysisRepositories.addNewList": () => Promise<void>;
102+
"codeQLVariantAnalysisRepositories.setupControllerRepository": () => Promise<void>;
103+
104+
"codeQLVariantAnalysisRepositories.setSelectedItem": SingleSelectionCommandFunction<DbTreeViewItem>;
105+
"codeQLVariantAnalysisRepositories.setSelectedItemContextMenu": SingleSelectionCommandFunction<DbTreeViewItem>;
106+
"codeQLVariantAnalysisRepositories.openOnGitHubContextMenu": SingleSelectionCommandFunction<DbTreeViewItem>;
107+
"codeQLVariantAnalysisRepositories.renameItemContextMenu": SingleSelectionCommandFunction<DbTreeViewItem>;
108+
"codeQLVariantAnalysisRepositories.removeItemContextMenu": SingleSelectionCommandFunction<DbTreeViewItem>;
109+
};
110+
91111
export type AllCommands = BaseCommands &
92112
QueryHistoryCommands &
93113
LocalDatabasesCommands &
94-
VariantAnalysisCommands;
114+
VariantAnalysisCommands &
115+
DatabasePanelCommands;
95116

96117
export type AppCommandManager = CommandManager<AllCommands>;

‎extensions/ql-vscode/src/databases/db-module.ts‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ import { DbConfigStore } from "./config/db-config-store";
66
import { DbManager } from "./db-manager";
77
import { DbPanel } from "./ui/db-panel";
88
import { DbSelectionDecorationProvider } from "./ui/db-selection-decoration-provider";
9+
import { DatabasePanelCommands } from "../common/commands";
910

1011
export class DbModule extends DisposableObject {
1112
public readonly dbManager: DbManager;
1213
private readonly dbConfigStore: DbConfigStore;
14+
private dbPanel: DbPanel | undefined;
1315

1416
private constructor(app: App) {
1517
super();
@@ -26,15 +28,24 @@ export class DbModule extends DisposableObject {
2628
return dbModule;
2729
}
2830

31+
public getCommands(): DatabasePanelCommands {
32+
if (!this.dbPanel) {
33+
throw new Error("Database panel not initialized");
34+
}
35+
36+
return {
37+
...this.dbPanel.getCommands(),
38+
};
39+
}
40+
2941
private async initialize(app: App): Promise<void> {
3042
void extLogger.log("Initializing database module");
3143

3244
await this.dbConfigStore.initialize();
3345

34-
const dbPanel = new DbPanel(this.dbManager, app.credentials);
35-
await dbPanel.initialize();
46+
this.dbPanel = new DbPanel(this.dbManager, app.credentials);
3647

37-
this.push(dbPanel);
48+
this.push(this.dbPanel);
3849
this.push(this.dbConfigStore);
3950

4051
const dbSelectionDecorationProvider = new DbSelectionDecorationProvider();

‎extensions/ql-vscode/src/databases/ui/db-panel.ts‎

Lines changed: 24 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {
77
window,
88
workspace,
99
} from "vscode";
10-
import { commandRunner, UserCancellationException } from "../../commandRunner";
10+
import { UserCancellationException } from "../../commandRunner";
1111
import {
1212
getNwoFromGitHubUrl,
1313
isValidGitHubNwo,
@@ -32,6 +32,7 @@ import { getGitHubUrl } from "./db-tree-view-item-action";
3232
import { getControllerRepo } from "../../variant-analysis/run-remote-query";
3333
import { getErrorMessage } from "../../pure/helpers-pure";
3434
import { Credentials } from "../../common/authentication";
35+
import { DatabasePanelCommands } from "../../common/commands";
3536

3637
export interface RemoteDatabaseQuickPickItem extends QuickPickItem {
3738
kind: string;
@@ -72,58 +73,28 @@ export class DbPanel extends DisposableObject {
7273
this.push(this.treeView);
7374
}
7475

75-
public async initialize(): Promise<void> {
76-
this.push(
77-
commandRunner("codeQLVariantAnalysisRepositories.openConfigFile", () =>
78-
this.openConfigFile(),
79-
),
80-
);
81-
this.push(
82-
commandRunner("codeQLVariantAnalysisRepositories.addNewDatabase", () =>
83-
this.addNewRemoteDatabase(),
84-
),
85-
);
86-
this.push(
87-
commandRunner("codeQLVariantAnalysisRepositories.addNewList", () =>
88-
this.addNewList(),
89-
),
90-
);
91-
this.push(
92-
commandRunner(
93-
"codeQLVariantAnalysisRepositories.setSelectedItem",
94-
(treeViewItem: DbTreeViewItem) => this.setSelectedItem(treeViewItem),
95-
),
96-
);
97-
this.push(
98-
commandRunner(
99-
"codeQLVariantAnalysisRepositories.setSelectedItemContextMenu",
100-
(treeViewItem: DbTreeViewItem) => this.setSelectedItem(treeViewItem),
101-
),
102-
);
103-
this.push(
104-
commandRunner(
105-
"codeQLVariantAnalysisRepositories.openOnGitHubContextMenu",
106-
(treeViewItem: DbTreeViewItem) => this.openOnGitHub(treeViewItem),
107-
),
108-
);
109-
this.push(
110-
commandRunner(
111-
"codeQLVariantAnalysisRepositories.renameItemContextMenu",
112-
(treeViewItem: DbTreeViewItem) => this.renameItem(treeViewItem),
113-
),
114-
);
115-
this.push(
116-
commandRunner(
117-
"codeQLVariantAnalysisRepositories.removeItemContextMenu",
118-
(treeViewItem: DbTreeViewItem) => this.removeItem(treeViewItem),
119-
),
120-
);
121-
this.push(
122-
commandRunner(
123-
"codeQLVariantAnalysisRepositories.setupControllerRepository",
124-
() => this.setupControllerRepository(),
125-
),
126-
);
76+
public getCommands(): DatabasePanelCommands {
77+
return {
78+
"codeQLVariantAnalysisRepositories.openConfigFile":
79+
this.openConfigFile.bind(this),
80+
"codeQLVariantAnalysisRepositories.addNewDatabase":
81+
this.addNewRemoteDatabase.bind(this),
82+
"codeQLVariantAnalysisRepositories.addNewList":
83+
this.addNewList.bind(this),
84+
"codeQLVariantAnalysisRepositories.setupControllerRepository":
85+
this.setupControllerRepository.bind(this),
86+
87+
"codeQLVariantAnalysisRepositories.setSelectedItem":
88+
this.setSelectedItem.bind(this),
89+
"codeQLVariantAnalysisRepositories.setSelectedItemContextMenu":
90+
this.setSelectedItem.bind(this),
91+
"codeQLVariantAnalysisRepositories.openOnGitHubContextMenu":
92+
this.openOnGitHub.bind(this),
93+
"codeQLVariantAnalysisRepositories.renameItemContextMenu":
94+
this.renameItem.bind(this),
95+
"codeQLVariantAnalysisRepositories.removeItemContextMenu":
96+
this.removeItem.bind(this),
97+
};
12798
}
12899

129100
private async openConfigFile(): Promise<void> {

‎extensions/ql-vscode/src/extension.ts‎

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,7 @@ import {
108108
handleInstallPackDependencies,
109109
} from "./packaging";
110110
import { HistoryItemLabelProvider } from "./query-history/history-item-label-provider";
111-
import {
112-
exportSelectedVariantAnalysisResults,
113-
exportVariantAnalysisResults,
114-
} from "./variant-analysis/export-results";
111+
import { exportSelectedVariantAnalysisResults } from "./variant-analysis/export-results";
115112
import { EvalLogViewer } from "./eval-log-viewer";
116113
import { SummaryLanguageSupport } from "./log-insights/summary-language-support";
117114
import { JoinOrderScannerProvider } from "./log-insights/join-order";
@@ -1095,6 +1092,7 @@ async function activateWithInstalledDistribution(
10951092
...qhm.getCommands(),
10961093
...variantAnalysisManager.getCommands(),
10971094
...databaseUI.getCommands(),
1095+
...dbModule.getCommands(),
10981096
};
10991097

11001098
for (const [commandName, command] of Object.entries(allCommands)) {
@@ -1145,46 +1143,12 @@ async function activateWithInstalledDistribution(
11451143
),
11461144
);
11471145

1148-
ctx.subscriptions.push(
1149-
commandRunner(
1150-
"codeQL.cancelVariantAnalysis",
1151-
async (variantAnalysisId: number) => {
1152-
await variantAnalysisManager.cancelVariantAnalysis(variantAnalysisId);
1153-
},
1154-
),
1155-
);
1156-
11571146
ctx.subscriptions.push(
11581147
commandRunner("codeQL.exportSelectedVariantAnalysisResults", async () => {
1159-
await exportSelectedVariantAnalysisResults(qhm);
1148+
await exportSelectedVariantAnalysisResults(variantAnalysisManager, qhm);
11601149
}),
11611150
);
11621151

1163-
ctx.subscriptions.push(
1164-
commandRunnerWithProgress(
1165-
"codeQL.exportVariantAnalysisResults",
1166-
async (
1167-
progress: ProgressCallback,
1168-
token: CancellationToken,
1169-
variantAnalysisId: number,
1170-
filterSort?: RepositoriesFilterSortStateWithIds,
1171-
) => {
1172-
await exportVariantAnalysisResults(
1173-
variantAnalysisManager,
1174-
variantAnalysisId,
1175-
filterSort,
1176-
app.credentials,
1177-
progress,
1178-
token,
1179-
);
1180-
},
1181-
{
1182-
title: "Exporting variant analysis results",
1183-
cancellable: true,
1184-
},
1185-
),
1186-
);
1187-
11881152
ctx.subscriptions.push(
11891153
commandRunner(
11901154
"codeQL.loadVariantAnalysisRepoResults",
@@ -1207,15 +1171,6 @@ async function activateWithInstalledDistribution(
12071171
),
12081172
);
12091173

1210-
ctx.subscriptions.push(
1211-
commandRunner(
1212-
"codeQL.openVariantAnalysisQueryText",
1213-
async (variantAnalysisId: number) => {
1214-
await variantAnalysisManager.openQueryText(variantAnalysisId);
1215-
},
1216-
),
1217-
);
1218-
12191174
ctx.subscriptions.push(
12201175
commandRunner("codeQL.openReferencedFile", async (selectedQuery: Uri) => {
12211176
await openReferencedFile(qs, cliServer, selectedQuery);

‎extensions/ql-vscode/src/query-history/query-history-manager.ts‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -894,8 +894,7 @@ export class QueryHistoryManager extends DisposableObject {
894894
if (item.t === "local") {
895895
item.cancel();
896896
} else if (item.t === "variant-analysis") {
897-
await commands.executeCommand(
898-
"codeQL.cancelVariantAnalysis",
897+
await this.variantAnalysisManager.cancelVariantAnalysis(
899898
item.variantAnalysis.id,
900899
);
901900
} else {
@@ -921,8 +920,7 @@ export class QueryHistoryManager extends DisposableObject {
921920
}
922921

923922
if (finalSingleItem.t === "variant-analysis") {
924-
await commands.executeCommand(
925-
"codeQL.openVariantAnalysisQueryText",
923+
await this.variantAnalysisManager.openQueryText(
926924
finalSingleItem.variantAnalysis.id,
927925
);
928926
return;
@@ -1124,8 +1122,7 @@ export class QueryHistoryManager extends DisposableObject {
11241122
return;
11251123
}
11261124

1127-
await commands.executeCommand(
1128-
"codeQL.exportVariantAnalysisResults",
1125+
await this.variantAnalysisManager.exportResults(
11291126
finalSingleItem.variantAnalysis.id,
11301127
);
11311128
}

0 commit comments

Comments
 (0)