Skip to content

Commit 09dccc1

Browse files
chariskcharisk
authored
Renamed 'interface managers' to something more specific (#1510)
1 parent 2e9c0c3 commit 09dccc1

10 files changed

Lines changed: 45 additions & 45 deletions

File tree

extensions/ql-vscode/src/abstract-interface-manager.ts renamed to extensions/ql-vscode/src/abstract-webview.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export type InterfacePanelConfig = {
2222
additionalOptions?: WebviewPanelOptions & WebviewOptions;
2323
}
2424

25-
export abstract class AbstractInterfaceManager<ToMessage extends WebviewMessage, FromMessage extends WebviewMessage> extends DisposableObject {
25+
export abstract class AbstractWebview<ToMessage extends WebviewMessage, FromMessage extends WebviewMessage> extends DisposableObject {
2626
protected panel: WebviewPanel | undefined;
2727
protected panelLoaded = false;
2828
protected panelLoadedCallBacks: (() => void)[] = [];

extensions/ql-vscode/src/compare/compare-interface.ts renamed to extensions/ql-vscode/src/compare/compare-view.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ import resultsDiff from './resultsDiff';
1717
import { CompletedLocalQueryInfo } from '../query-results';
1818
import { getErrorMessage } from '../pure/helpers-pure';
1919
import { HistoryItemLabelProvider } from '../history-item-label-provider';
20-
import { AbstractInterfaceManager, InterfacePanelConfig } from '../abstract-interface-manager';
20+
import { AbstractWebview, InterfacePanelConfig } from '../abstract-webview';
2121

2222
interface ComparePair {
2323
from: CompletedLocalQueryInfo;
2424
to: CompletedLocalQueryInfo;
2525
}
2626

27-
export class CompareInterfaceManager extends AbstractInterfaceManager<ToCompareViewMessage, FromCompareViewMessage> {
27+
export class CompareView extends AbstractWebview<ToCompareViewMessage, FromCompareViewMessage> {
2828
private comparePair: ComparePair | undefined;
2929

3030
constructor(

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ import {
6868
} from './helpers';
6969
import { asError, assertNever, getErrorMessage } from './pure/helpers-pure';
7070
import { spawnIdeServer } from './ide-server';
71-
import { InterfaceManager } from './interface';
71+
import { ResultsView } from './interface';
7272
import { WebviewReveal } from './interface-utils';
7373
import { ideServerLogger, logger, queryServerLogger } from './logging';
7474
import { QueryHistoryManager } from './query-history';
@@ -78,7 +78,7 @@ import { displayQuickQuery } from './quick-query';
7878
import { compileAndRunQueryAgainstDatabase, createInitialQueryInfo } from './run-queries';
7979
import { QLTestAdapterFactory } from './test-adapter';
8080
import { TestUIService } from './test-ui';
81-
import { CompareInterfaceManager } from './compare/compare-interface';
81+
import { CompareView } from './compare/compare-view';
8282
import { gatherQlFiles } from './pure/files';
8383
import { initializeTelemetry } from './telemetry';
8484
import {
@@ -102,7 +102,7 @@ import { EvalLogViewer } from './eval-log-viewer';
102102
import { SummaryLanguageSupport } from './log-insights/summary-language-support';
103103
import { JoinOrderScannerProvider } from './log-insights/join-order';
104104
import { LogScannerService } from './log-insights/log-scanner-service';
105-
import { VariantAnalysisInterfaceManager } from './remote-queries/variant-analysis-interface';
105+
import { VariantAnalysisView } from './remote-queries/variant-analysis-view';
106106

107107
/**
108108
* extension.ts
@@ -461,8 +461,8 @@ async function activateWithInstalledDistribution(
461461
const labelProvider = new HistoryItemLabelProvider(queryHistoryConfigurationListener);
462462

463463
void logger.log('Initializing results panel interface.');
464-
const intm = new InterfaceManager(ctx, dbm, cliServer, queryServerLogger, labelProvider);
465-
ctx.subscriptions.push(intm);
464+
const localQueryResultsView = new ResultsView(ctx, dbm, cliServer, queryServerLogger, labelProvider);
465+
ctx.subscriptions.push(localQueryResultsView);
466466

467467
void logger.log('Initializing variant analysis manager.');
468468
const rqm = new RemoteQueriesManager(ctx, cliServer, queryStorageDir, logger);
@@ -472,7 +472,7 @@ async function activateWithInstalledDistribution(
472472
const qhm = new QueryHistoryManager(
473473
qs,
474474
dbm,
475-
intm,
475+
localQueryResultsView,
476476
rqm,
477477
evalLogViewer,
478478
queryStorageDir,
@@ -494,16 +494,16 @@ async function activateWithInstalledDistribution(
494494
void logger.log('Reading query history');
495495
await qhm.readQueryHistory();
496496

497-
void logger.log('Initializing compare panel interface.');
498-
const cmpm = new CompareInterfaceManager(
497+
void logger.log('Initializing compare view.');
498+
const compareView = new CompareView(
499499
ctx,
500500
dbm,
501501
cliServer,
502502
queryServerLogger,
503503
labelProvider,
504504
showResults
505505
);
506-
ctx.subscriptions.push(cmpm);
506+
ctx.subscriptions.push(compareView);
507507

508508
void logger.log('Initializing source archive filesystem provider.');
509509
archiveFilesystemProvider.activate(ctx);
@@ -513,7 +513,7 @@ async function activateWithInstalledDistribution(
513513
to: CompletedLocalQueryInfo
514514
): Promise<void> {
515515
try {
516-
await cmpm.showResults(from, to);
516+
await compareView.showResults(from, to);
517517
} catch (e) {
518518
void showAndLogErrorMessage(getErrorMessage(e));
519519
}
@@ -523,7 +523,7 @@ async function activateWithInstalledDistribution(
523523
query: CompletedLocalQueryInfo,
524524
forceReveal: WebviewReveal
525525
): Promise<void> {
526-
await intm.showResults(query, forceReveal, false);
526+
await localQueryResultsView.showResults(query, forceReveal, false);
527527
}
528528

529529
async function compileAndRunQuery(
@@ -922,7 +922,7 @@ async function activateWithInstalledDistribution(
922922

923923
ctx.subscriptions.push(
924924
commandRunner('codeQL.mockVariantAnalysisView', async () => {
925-
const variantAnalysisView = new VariantAnalysisInterfaceManager(ctx);
925+
const variantAnalysisView = new VariantAnalysisView(ctx);
926926
variantAnalysisView.openView();
927927
})
928928
);

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ import {
4444
} from './interface-utils';
4545
import { getDefaultResultSetName, ParsedResultSets } from './pure/interface-types';
4646
import { RawResultSet, transformBqrsResultSet, ResultSetSchema } from './pure/bqrs-cli-types';
47-
import { AbstractInterfaceManager, InterfacePanelConfig } from './abstract-interface-manager';
47+
import { AbstractWebview, InterfacePanelConfig } from './abstract-webview';
4848
import { PAGE_SIZE } from './config';
4949
import { CompletedLocalQueryInfo } from './query-results';
5050
import { HistoryItemLabelProvider } from './history-item-label-provider';
@@ -120,7 +120,7 @@ function numInterpretedPages(interpretation: Interpretation | undefined): number
120120
return Math.ceil(n / pageSize);
121121
}
122122

123-
export class InterfaceManager extends AbstractInterfaceManager<IntoResultsViewMsg, FromResultsViewMsg> {
123+
export class ResultsView extends AbstractWebview<IntoResultsViewMsg, FromResultsViewMsg> {
124124
private _displayedQuery?: CompletedLocalQueryInfo;
125125
private _interpretation?: Interpretation;
126126

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ import { Credentials } from './authentication';
4343
import { cancelRemoteQuery } from './remote-queries/gh-actions-api-client';
4444
import { RemoteQueriesManager } from './remote-queries/remote-queries-manager';
4545
import { RemoteQueryHistoryItem } from './remote-queries/remote-query-history-item';
46-
import { InterfaceManager } from './interface';
46+
import { ResultsView } from './interface';
4747
import { WebviewReveal } from './interface-utils';
4848
import { EvalLogViewer } from './eval-log-viewer';
4949
import EvalLogTreeBuilder from './eval-log-tree-builder';
@@ -331,7 +331,7 @@ export class QueryHistoryManager extends DisposableObject {
331331
constructor(
332332
private readonly qs: QueryServerClient,
333333
private readonly dbm: DatabaseManager,
334-
private readonly localQueriesInterfaceManager: InterfaceManager,
334+
private readonly localQueriesResultsView: ResultsView,
335335
private readonly remoteQueriesManager: RemoteQueriesManager,
336336
private readonly evalLogViewer: EvalLogViewer,
337337
private readonly queryStorageDir: string,
@@ -1360,7 +1360,7 @@ the file in the file explorer and dragging it into the workspace.`
13601360

13611361
private async openQueryResults(item: QueryHistoryInfo) {
13621362
if (item.t === 'local') {
1363-
await this.localQueriesInterfaceManager.showResults(item as CompletedLocalQueryInfo, WebviewReveal.Forced, false);
1363+
await this.localQueriesResultsView.showResults(item as CompletedLocalQueryInfo, WebviewReveal.Forced, false);
13641364
}
13651365
else if (item.t === 'remote') {
13661366
await this.remoteQueriesManager.openRemoteQueryResults(item.queryId);

‎extensions/ql-vscode/src/remote-queries/remote-queries-manager.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { ProgressCallback } from '../commandRunner';
1010
import { createTimestampFile, showAndLogErrorMessage, showAndLogInformationMessage, showInformationMessageWithAction } from '../helpers';
1111
import { Logger } from '../logging';
1212
import { runRemoteQuery } from './run-remote-query';
13-
import { RemoteQueriesInterfaceManager } from './remote-queries-interface';
13+
import { RemoteQueriesView } from './remote-queries-view';
1414
import { RemoteQuery } from './remote-query';
1515
import { RemoteQueriesMonitor } from './remote-queries-monitor';
1616
import { getRemoteQueryIndex, getRepositoriesMetadata, RepositoriesMetadata } from './gh-actions-api-client';
@@ -56,7 +56,7 @@ export class RemoteQueriesManager extends DisposableObject {
5656

5757
private readonly remoteQueriesMonitor: RemoteQueriesMonitor;
5858
private readonly analysesResultsManager: AnalysesResultsManager;
59-
private readonly interfaceManager: RemoteQueriesInterfaceManager;
59+
private readonly view: RemoteQueriesView;
6060

6161
constructor(
6262
private readonly ctx: ExtensionContext,
@@ -66,7 +66,7 @@ export class RemoteQueriesManager extends DisposableObject {
6666
) {
6767
super();
6868
this.analysesResultsManager = new AnalysesResultsManager(ctx, cliServer, storagePath, logger);
69-
this.interfaceManager = new RemoteQueriesInterfaceManager(ctx, logger, this.analysesResultsManager);
69+
this.view = new RemoteQueriesView(ctx, logger, this.analysesResultsManager);
7070
this.remoteQueriesMonitor = new RemoteQueriesMonitor(ctx, logger);
7171

7272
this.remoteQueryAddedEventEmitter = this.push(new EventEmitter<NewQueryEvent>());
@@ -76,7 +76,7 @@ export class RemoteQueriesManager extends DisposableObject {
7676
this.onRemoteQueryRemoved = this.remoteQueryRemovedEventEmitter.event;
7777
this.onRemoteQueryStatusUpdate = this.remoteQueryStatusUpdateEventEmitter.event;
7878

79-
this.push(this.interfaceManager);
79+
this.push(this.view);
8080
}
8181

8282
public async rehydrateRemoteQuery(queryId: string, query: RemoteQuery, status: QueryStatus) {
@@ -192,7 +192,7 @@ export class RemoteQueriesManager extends DisposableObject {
192192
await this.analysesResultsManager.loadAnalysesResults(
193193
analysesToDownload,
194194
token,
195-
results => this.interfaceManager.setAnalysisResults(results, queryResult.queryId));
195+
results => this.view.setAnalysisResults(results, queryResult.queryId));
196196
}
197197

198198
public async copyRemoteQueryRepoListToClipboard(queryId: string) {
@@ -248,7 +248,7 @@ export class RemoteQueriesManager extends DisposableObject {
248248
}
249249

250250
public async openResults(query: RemoteQuery, queryResult: RemoteQueryResult) {
251-
await this.interfaceManager.showResults(query, queryResult);
251+
await this.view.showResults(query, queryResult);
252252
}
253253

254254
private async askToOpenResults(query: RemoteQuery, queryResult: RemoteQueryResult): Promise<void> {

extensions/ql-vscode/src/remote-queries/remote-queries-interface.ts renamed to extensions/ql-vscode/src/remote-queries/remote-queries-view.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ import { SHOW_QUERY_TEXT_MSG } from '../query-history';
3232
import { AnalysesResultsManager } from './analyses-results-manager';
3333
import { AnalysisResults } from './shared/analysis-result';
3434
import { humanizeUnit } from '../pure/time';
35-
import { AbstractInterfaceManager, InterfacePanelConfig } from '../abstract-interface-manager';
35+
import { AbstractWebview, InterfacePanelConfig } from '../abstract-webview';
3636

37-
export class RemoteQueriesInterfaceManager extends AbstractInterfaceManager<ToRemoteQueriesMessage, FromRemoteQueriesMessage> {
37+
export class RemoteQueriesView extends AbstractWebview<ToRemoteQueriesMessage, FromRemoteQueriesMessage> {
3838
private currentQueryId: string | undefined;
3939

4040
constructor(

extensions/ql-vscode/src/remote-queries/variant-analysis-interface.ts renamed to extensions/ql-vscode/src/remote-queries/variant-analysis-view.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import { ViewColumn } from 'vscode';
2-
import { AbstractInterfaceManager, InterfacePanelConfig } from '../abstract-interface-manager';
2+
import { AbstractWebview, InterfacePanelConfig } from '../abstract-webview';
33
import { WebviewMessage } from '../interface-utils';
44
import { logger } from '../logging';
55

6-
export class VariantAnalysisInterfaceManager extends AbstractInterfaceManager<WebviewMessage, WebviewMessage> {
6+
export class VariantAnalysisView extends AbstractWebview<WebviewMessage, WebviewMessage> {
77
public openView() {
88
this.getPanel().reveal(undefined, true);
99
}

‎extensions/ql-vscode/src/vscode-tests/no-workspace/query-history.test.ts‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { tmpDir } from '../../helpers';
1919
import { getErrorMessage } from '../../pure/helpers-pure';
2020
import { HistoryItemLabelProvider } from '../../history-item-label-provider';
2121
import { RemoteQueriesManager } from '../../remote-queries/remote-queries-manager';
22-
import { InterfaceManager } from '../../interface';
22+
import { ResultsView } from '../../interface';
2323
import { EvalLogViewer } from '../../eval-log-viewer';
2424

2525
describe('query-history', () => {
@@ -32,7 +32,7 @@ describe('query-history', () => {
3232
let queryHistoryManager: QueryHistoryManager | undefined;
3333
let doCompareCallback: sinon.SinonStub;
3434

35-
let localQueriesInterfaceManagerStub: InterfaceManager;
35+
let localQueriesResultsViewStub: ResultsView;
3636
let remoteQueriesManagerStub: RemoteQueriesManager;
3737

3838
let tryOpenExternalFile: Function;
@@ -55,9 +55,9 @@ describe('query-history', () => {
5555
tryOpenExternalFile = (QueryHistoryManager.prototype as any).tryOpenExternalFile;
5656
configListener = new QueryHistoryConfigListener();
5757
doCompareCallback = sandbox.stub();
58-
localQueriesInterfaceManagerStub = {
58+
localQueriesResultsViewStub = {
5959
showResults: sandbox.stub()
60-
} as any as InterfaceManager;
60+
} as any as ResultsView;
6161
remoteQueriesManagerStub = {
6262
onRemoteQueryAdded: sandbox.stub(),
6363
onRemoteQueryRemoved: sandbox.stub(),
@@ -205,7 +205,7 @@ describe('query-history', () => {
205205

206206
await queryHistoryManager.handleItemClicked(allHistory[0], [allHistory[0]]);
207207

208-
expect(localQueriesInterfaceManagerStub.showResults).to.have.been.calledOnceWith(allHistory[0]);
208+
expect(localQueriesResultsViewStub.showResults).to.have.been.calledOnceWith(allHistory[0]);
209209
expect(queryHistoryManager.treeDataProvider.getCurrent()).to.eq(allHistory[0]);
210210
});
211211

@@ -214,7 +214,7 @@ describe('query-history', () => {
214214

215215
await queryHistoryManager.handleItemClicked(allHistory[0], [allHistory[0], allHistory[1]]);
216216

217-
expect(localQueriesInterfaceManagerStub.showResults).not.to.have.been.called;
217+
expect(localQueriesResultsViewStub.showResults).not.to.have.been.called;
218218
expect(queryHistoryManager.treeDataProvider.getCurrent()).to.be.undefined;
219219
});
220220

@@ -223,7 +223,7 @@ describe('query-history', () => {
223223

224224
await queryHistoryManager.handleItemClicked(undefined!, []);
225225

226-
expect(localQueriesInterfaceManagerStub.showResults).not.to.have.been.called;
226+
expect(localQueriesResultsViewStub.showResults).not.to.have.been.called;
227227
expect(queryHistoryManager.treeDataProvider.getCurrent()).to.be.undefined;
228228
});
229229
});
@@ -252,7 +252,7 @@ describe('query-history', () => {
252252
expect(queryHistoryManager.treeDataProvider.allHistory).not.to.contain(toDelete);
253253

254254
// the same item should be selected
255-
expect(localQueriesInterfaceManagerStub.showResults).to.have.been.calledOnceWith(selected);
255+
expect(localQueriesResultsViewStub.showResults).to.have.been.calledOnceWith(selected);
256256
});
257257

258258
it('should remove an item and select a new one', async () => {
@@ -272,7 +272,7 @@ describe('query-history', () => {
272272
expect(queryHistoryManager.treeDataProvider.allHistory).not.to.contain(toDelete);
273273

274274
// the current item should have been selected
275-
expect(localQueriesInterfaceManagerStub.showResults).to.have.been.calledOnceWith(newSelected);
275+
expect(localQueriesResultsViewStub.showResults).to.have.been.calledOnceWith(newSelected);
276276
});
277277

278278
describe('Compare callback', () => {
@@ -798,7 +798,7 @@ describe('query-history', () => {
798798
const qhm = new QueryHistoryManager(
799799
{} as QueryServerClient,
800800
{} as DatabaseManager,
801-
localQueriesInterfaceManagerStub,
801+
localQueriesResultsViewStub,
802802
remoteQueriesManagerStub,
803803
{} as EvalLogViewer,
804804
'xxx',

‎extensions/ql-vscode/src/vscode-tests/no-workspace/remote-queries/remote-query-history.test.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { walkDirectory } from '../../../helpers';
1818
import { getErrorMessage } from '../../../pure/helpers-pure';
1919
import { HistoryItemLabelProvider } from '../../../history-item-label-provider';
2020
import { RemoteQueriesManager } from '../../../remote-queries/remote-queries-manager';
21-
import { InterfaceManager } from '../../../interface';
21+
import { ResultsView } from '../../../interface';
2222
import { EvalLogViewer } from '../../../eval-log-viewer';
2323

2424
/**
@@ -33,7 +33,7 @@ describe('Remote queries and query history manager', function() {
3333

3434
let sandbox: sinon.SinonSandbox;
3535
let qhm: QueryHistoryManager;
36-
let localQueriesInterfaceManagerStub: InterfaceManager;
36+
let localQueriesResultsViewStub: ResultsView;
3737
let remoteQueriesManagerStub: RemoteQueriesManager;
3838
let rawQueryHistory: any;
3939
let remoteQueryResult0: RemoteQueryResult;
@@ -57,9 +57,9 @@ describe('Remote queries and query history manager', function() {
5757

5858
sandbox = sinon.createSandbox();
5959

60-
localQueriesInterfaceManagerStub = {
60+
localQueriesResultsViewStub = {
6161
showResults: sandbox.stub()
62-
} as any as InterfaceManager;
62+
} as any as ResultsView;
6363

6464
rehydrateRemoteQueryStub = sandbox.stub();
6565
removeRemoteQueryStub = sandbox.stub();
@@ -92,7 +92,7 @@ describe('Remote queries and query history manager', function() {
9292
qhm = new QueryHistoryManager(
9393
{} as QueryServerClient,
9494
{} as DatabaseManager,
95-
localQueriesInterfaceManagerStub,
95+
localQueriesResultsViewStub,
9696
remoteQueriesManagerStub,
9797
{} as EvalLogViewer,
9898
STORAGE_DIR,

0 commit comments

Comments
 (0)