Skip to content

Commit 2ca0060

Browse files
committed
Remove references to 'remote query' in user-facing text
(Only in recently introduced locations. More work still needs to be done.) Also: - Change error to info - Create credentials directly, don't use a callback.
1 parent 61d4305 commit 2ca0060

7 files changed

Lines changed: 12 additions & 14 deletions

File tree

extensions/ql-vscode/src/extension.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,6 @@ async function activateWithInstalledDistribution(
455455
queryStorageDir,
456456
ctx,
457457
queryHistoryConfigurationListener,
458-
() => Credentials.initialize(ctx),
459458
async (from: CompletedLocalQueryInfo, to: CompletedLocalQueryInfo) =>
460459
showResultsForComparison(from, to),
461460
);

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -318,9 +318,8 @@ export class QueryHistoryManager extends DisposableObject {
318318
private qs: QueryServerClient,
319319
private dbm: DatabaseManager,
320320
private queryStorageDir: string,
321-
ctx: ExtensionContext,
321+
private ctx: ExtensionContext,
322322
private queryHistoryConfigListener: QueryHistoryConfig,
323-
private readonly getCredentials: () => Promise<Credentials>,
324323
private doCompareCallback: (
325324
from: CompletedLocalQueryInfo,
326325
to: CompletedLocalQueryInfo
@@ -515,6 +514,10 @@ export class QueryHistoryManager extends DisposableObject {
515514
this.registerQueryHistoryScrubber(queryHistoryConfigListener, ctx);
516515
}
517516

517+
private getCredentials() {
518+
return Credentials.initialize(this.ctx);
519+
}
520+
518521
/**
519522
* Register and create the history scrubber.
520523
*/
@@ -839,7 +842,7 @@ export class QueryHistoryManager extends DisposableObject {
839842
if (item.t === 'local') {
840843
item.cancel();
841844
} else if (item.t === 'remote') {
842-
void showAndLogInformationMessage('Cancelling remote query. This may take a while.');
845+
void showAndLogInformationMessage('Cancelling variant analysis. This may take a while.');
843846
const credentials = await this.getCredentials();
844847
await cancelRemoteQuery(credentials, item.remoteQuery);
845848
}

extensions/ql-vscode/src/remote-queries/gh-actions-api-client.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export async function cancelRemoteQuery(
8282
const { actionsWorkflowRunId, controllerRepository: { owner, name } } = remoteQuery;
8383
const response = await octokit.request(`POST /repos/${owner}/${name}/actions/runs/${actionsWorkflowRunId}/cancel`);
8484
if (response.status >= 300) {
85-
throw new Error(`Error cancelling remote query: ${response.status}`);
85+
throw new Error(`Error cancelling variant analysis: ${response.status} ${response?.data?.message || ''}`);
8686
}
8787
}
8888

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import * as fs from 'fs-extra';
66
import { Credentials } from '../authentication';
77
import { CodeQLCliServer } from '../cli';
88
import { ProgressCallback } from '../commandRunner';
9-
import { createTimestampFile, showAndLogErrorMessage, showInformationMessageWithAction } from '../helpers';
9+
import { createTimestampFile, showAndLogErrorMessage, showAndLogInformationMessage, showInformationMessageWithAction } from '../helpers';
1010
import { Logger } from '../logging';
1111
import { runRemoteQuery } from './run-remote-query';
1212
import { RemoteQueriesInterfaceManager } from './remote-queries-interface';
@@ -159,7 +159,7 @@ export class RemoteQueriesManager extends DisposableObject {
159159
// workflow was cancelled on the server
160160
queryItem.failureReason = 'Cancelled';
161161
queryItem.status = QueryStatus.Failed;
162-
void showAndLogErrorMessage('Variant analysis monitoring was cancelled');
162+
void showAndLogInformationMessage('Variant analysis was cancelled');
163163
} else {
164164
queryItem.failureReason = queryWorkflowResult.error;
165165
queryItem.status = QueryStatus.Failed;
@@ -168,7 +168,7 @@ export class RemoteQueriesManager extends DisposableObject {
168168
} else if (queryWorkflowResult.status === 'Cancelled') {
169169
queryItem.failureReason = 'Cancelled';
170170
queryItem.status = QueryStatus.Failed;
171-
void showAndLogErrorMessage('Variant analysis monitoring was cancelled');
171+
void showAndLogErrorMessage('Variant analysis was cancelled');
172172
} else if (queryWorkflowResult.status === 'InProgress') {
173173
// Should not get here. Only including this to ensure `assertNever` uses proper type checking.
174174
void showAndLogErrorMessage(`Unexpected status: ${queryWorkflowResult.status}`);

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ describe('query-history', () => {
2727
let showQuickPickSpy: sinon.SinonStub;
2828
let queryHistoryManager: QueryHistoryManager | undefined;
2929
let selectedCallback: sinon.SinonStub;
30-
let getCredentialsCallback: sinon.SinonStub;
3130
let doCompareCallback: sinon.SinonStub;
3231

3332
let tryOpenExternalFile: Function;
@@ -50,7 +49,6 @@ describe('query-history', () => {
5049
tryOpenExternalFile = (QueryHistoryManager.prototype as any).tryOpenExternalFile;
5150
configListener = new QueryHistoryConfigListener();
5251
selectedCallback = sandbox.stub();
53-
getCredentialsCallback = sandbox.stub();
5452
doCompareCallback = sandbox.stub();
5553
});
5654

@@ -751,7 +749,6 @@ describe('query-history', () => {
751749
extensionPath: vscode.Uri.file('/x/y/z').fsPath,
752750
} as vscode.ExtensionContext,
753751
configListener,
754-
getCredentialsCallback,
755752
doCompareCallback
756753
);
757754
qhm.onWillOpenQueryItem(selectedCallback);

extensions/ql-vscode/src/vscode-tests/no-workspace/remote-queries/gh-actions-api-client.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ describe('gh-actions-api-client', () => {
3232
});
3333

3434
it('should fail to cancel a remote query', async () => {
35-
mockResponse = sinon.stub().resolves({ status: 409 });
35+
mockResponse = sinon.stub().resolves({ status: 409, data: { message: 'Uh oh!' } });
3636

37-
await expect(cancelRemoteQuery(mockCredentials, createMockRemoteQuery())).to.be.rejectedWith(/Error cancelling remote query/);
37+
await expect(cancelRemoteQuery(mockCredentials, createMockRemoteQuery())).to.be.rejectedWith(/Error cancelling variant analysis: 409 Uh oh!/);
3838
expect(mockResponse.calledOnce).to.be.true;
3939
expect(mockResponse.firstCall.args[0]).to.equal('POST /repos/github/codeql/actions/runs/123/cancel');
4040
});

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ describe('Remote queries and query history manager', function() {
7171
{
7272
onDidChangeConfiguration: () => new DisposableBucket(),
7373
} as unknown as QueryHistoryConfig,
74-
asyncNoop as any,
7574
asyncNoop
7675
);
7776
disposables.push(qhm);

0 commit comments

Comments
 (0)