Skip to content

Commit 2a8a90b

Browse files
authored
Change public occurrences of "remote queries" (#1215)
1 parent f36048c commit 2a8a90b

10 files changed

Lines changed: 29 additions & 29 deletions

File tree

extensions/ql-vscode/package.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@
258258
"scope": "application",
259259
"description": "Specifies whether or not to write telemetry events to the extension log."
260260
},
261-
"codeQL.remoteQueries.repositoryLists": {
261+
"codeQL.variantAnalysis.repositoryLists": {
262262
"type": [
263263
"object",
264264
null
@@ -272,14 +272,14 @@
272272
}
273273
},
274274
"default": null,
275-
"markdownDescription": "[For internal use only] Lists of GitHub repositories that you want to query remotely. This should be a JSON object where each key is a user-specified name for this repository list, and the value is an array of GitHub repositories (of the form `<owner>/<repo>`)."
275+
"markdownDescription": "[For internal use only] Lists of GitHub repositories that you want to run variant analysis against. This should be a JSON object where each key is a user-specified name for this repository list, and the value is an array of GitHub repositories (of the form `<owner>/<repo>`)."
276276
},
277-
"codeQL.remoteQueries.controllerRepo": {
277+
"codeQL.variantAnalysis.controllerRepo": {
278278
"type": "string",
279279
"default": "",
280280
"pattern": "^$|^(?:[a-zA-Z0-9]+-)*[a-zA-Z0-9]+/[a-zA-Z0-9-_]+$",
281281
"patternErrorMessage": "Please enter a valid GitHub repository",
282-
"markdownDescription": "[For internal use only] The name of the GitHub repository where you can view the progress and results of the \"Run Remote query\" command. The repository should be of the form `<owner>/<repo>`)."
282+
"markdownDescription": "[For internal use only] The name of the GitHub repository where you can view the progress and results of the \"Run Variant Analysis\" command. The repository should be of the form `<owner>/<repo>`)."
283283
}
284284
}
285285
},
@@ -297,8 +297,8 @@
297297
"title": "CodeQL: Run Query on Multiple Databases"
298298
},
299299
{
300-
"command": "codeQL.runRemoteQuery",
301-
"title": "CodeQL: Run Remote Query"
300+
"command": "codeQL.runVariantAnalysis",
301+
"title": "CodeQL: Run Variant Analysis"
302302
},
303303
{
304304
"command": "codeQL.runQueries",
@@ -542,7 +542,7 @@
542542
},
543543
{
544544
"command": "codeQLQueryHistory.openOnGithub",
545-
"title": "Open Remote Query on GitHub"
545+
"title": "Open Variant Analysis on GitHub"
546546
},
547547
{
548548
"command": "codeQLQueryResults.nextPathStep",
@@ -798,7 +798,7 @@
798798
"when": "resourceLangId == ql && resourceExtname == .ql"
799799
},
800800
{
801-
"command": "codeQL.runRemoteQuery",
801+
"command": "codeQL.runVariantAnalysis",
802802
"when": "config.codeQL.canary && editorLangId == ql && resourceExtname == .ql"
803803
},
804804
{
@@ -976,7 +976,7 @@
976976
"when": "editorLangId == ql && resourceExtname == .ql"
977977
},
978978
{
979-
"command": "codeQL.runRemoteQuery",
979+
"command": "codeQL.runVariantAnalysis",
980980
"when": "config.codeQL.canary && editorLangId == ql && resourceExtname == .ql"
981981
},
982982
{

extensions/ql-vscode/src/config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -323,10 +323,10 @@ export function isCanary() {
323323
export const NO_CACHE_AST_VIEWER = new Setting('disableCache', AST_VIEWER_SETTING);
324324

325325
// Settings for remote queries
326-
const REMOTE_QUERIES_SETTING = new Setting('remoteQueries', ROOT_SETTING);
326+
const REMOTE_QUERIES_SETTING = new Setting('variantAnalysis', ROOT_SETTING);
327327

328328
/**
329-
* Lists of GitHub repositories that you want to query remotely via the "Run Remote query" command.
329+
* Lists of GitHub repositories that you want to query remotely via the "Run Variant Analysis" command.
330330
* Note: This command is only available for internal users.
331331
*
332332
* This setting should be a JSON object where each key is a user-specified name (string),
@@ -343,7 +343,7 @@ export async function setRemoteRepositoryLists(lists: Record<string, string[]> |
343343
}
344344

345345
/**
346-
* The name of the "controller" repository that you want to use with the "Run Remote query" command.
346+
* The name of the "controller" repository that you want to use with the "Run Variant Analysis" command.
347347
* Note: This command is only available for internal users.
348348
*
349349
* This setting should be a GitHub repository of the form `<owner>/<repo>`.

extensions/ql-vscode/src/extension.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -844,9 +844,9 @@ async function activateWithInstalledDistribution(
844844

845845
registerRemoteQueryTextProvider();
846846

847-
// The "runRemoteQuery" command is internal-only.
847+
// The "runVariantAnalysis" command is internal-only.
848848
ctx.subscriptions.push(
849-
commandRunnerWithProgress('codeQL.runRemoteQuery', async (
849+
commandRunnerWithProgress('codeQL.runVariantAnalysis', async (
850850
progress: ProgressCallback,
851851
token: CancellationToken,
852852
uri: Uri | undefined
@@ -866,7 +866,7 @@ async function activateWithInstalledDistribution(
866866
throw new Error('Remote queries require the CodeQL Canary version to run.');
867867
}
868868
}, {
869-
title: 'Run Remote Query',
869+
title: 'Run Variant Analysis',
870870
cancellable: true
871871
})
872872
);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -577,7 +577,7 @@ export class QueryHistoryManager extends DisposableObject {
577577
this.treeDataProvider.remove(item);
578578
void logger.log(`Deleted ${item.label}.`);
579579
if (item.status === QueryStatus.InProgress) {
580-
void logger.log('The remote query is still running on GitHub Actions. To cancel there, you must go to the query run in your browser.');
580+
void logger.log('The variant analysis is still running on GitHub Actions. To cancel there, you must go to the workflow run in your browser.');
581581
}
582582

583583
this._onDidRemoveQueryItem.fire(item);

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -267,18 +267,18 @@ function getWorkflowError(conclusion: string | null): string {
267267
}
268268

269269
if (conclusion === 'cancelled') {
270-
return 'The remote query execution was cancelled.';
270+
return 'Variant analysis execution was cancelled.';
271271
}
272272

273273
if (conclusion === 'timed_out') {
274-
return 'The remote query execution timed out.';
274+
return 'Variant analysis execution timed out.';
275275
}
276276

277277
if (conclusion === 'failure') {
278278
// TODO: Get the actual error from the workflow or potentially
279279
// from an artifact from the action itself.
280-
return 'The remote query execution has failed.';
280+
return 'Variant analysis execution has failed.';
281281
}
282282

283-
return `Unexpected query execution conclusion: ${conclusion}`;
283+
return `Unexpected variant analysis execution conclusion: ${conclusion}`;
284284
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ export class RemoteQueriesInterfaceManager {
9191
const { ctx } = this;
9292
const panel = (this.panel = Window.createWebviewPanel(
9393
'remoteQueriesView',
94-
'Remote Query Results',
94+
'CodeQL Query Results',
9595
{ viewColumn: ViewColumn.Active, preserveFocus: true },
9696
{
9797
enableScripts: true,
@@ -186,7 +186,7 @@ export class RemoteQueriesInterfaceManager {
186186
break;
187187
case 'remoteQueryError':
188188
void this.logger.log(
189-
`Remote query error: ${msg.error}`
189+
`Variant analysis error: ${msg.error}`
190190
);
191191
break;
192192
case 'openFile':

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,11 +157,11 @@ export class RemoteQueriesManager extends DisposableObject {
157157
} else if (queryWorkflowResult.status === 'CompletedUnsuccessfully') {
158158
queryItem.failureReason = queryWorkflowResult.error;
159159
queryItem.status = QueryStatus.Failed;
160-
void showAndLogErrorMessage(`Remote query execution failed. Error: ${queryWorkflowResult.error}`);
160+
void showAndLogErrorMessage(`Variant analysis execution failed. Error: ${queryWorkflowResult.error}`);
161161
} else if (queryWorkflowResult.status === 'Cancelled') {
162162
queryItem.failureReason = 'Cancelled';
163163
queryItem.status = QueryStatus.Failed;
164-
void showAndLogErrorMessage('Remote query monitoring was cancelled');
164+
void showAndLogErrorMessage('Variant analysis monitoring was cancelled');
165165
} else if (queryWorkflowResult.status === 'InProgress') {
166166
// Should not get here. Only including this to ensure `assertNever` uses proper type checking.
167167
void showAndLogErrorMessage(`Unexpected status: ${queryWorkflowResult.status}`);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export class RemoteQueriesMonitor {
4949
attemptCount++;
5050
}
5151

52-
void this.logger.log('Remote query monitoring timed out after 2 days');
52+
void this.logger.log('Variant analysis monitoring timed out after 2 days');
5353
return { status: 'Cancelled' };
5454
}
5555

extensions/ql-vscode/src/remote-queries/run-remote-query.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export async function getRepositories(): Promise<string[] | undefined> {
6565
const quickpick = await window.showQuickPick<RepoListQuickPickItem>(
6666
quickPickItems,
6767
{
68-
placeHolder: 'Select a repository list. You can define repository lists in the `codeQL.remoteQueries.repositoryLists` setting.',
68+
placeHolder: 'Select a repository list. You can define repository lists in the `codeQL.variantAnalysis.repositoryLists` setting.',
6969
ignoreFocusOut: true,
7070
});
7171
if (quickpick?.repoList.length) {
@@ -80,7 +80,7 @@ export async function getRepositories(): Promise<string[] | undefined> {
8080
const remoteRepo = await window.showInputBox({
8181
title: 'Enter a GitHub repository in the format <owner>/<repo> (e.g. github/codeql)',
8282
placeHolder: '<owner>/<repo>',
83-
prompt: 'Tip: you can save frequently used repositories in the `codeQL.remoteQueries.repositoryLists` setting',
83+
prompt: 'Tip: you can save frequently used repositories in the `codeQL.variantAnalysis.repositoryLists` setting',
8484
ignoreFocusOut: true,
8585
});
8686
if (!remoteRepo) {
@@ -430,7 +430,7 @@ async function ensureNameAndSuite(queryPackDir: string, packRelativePath: string
430430
qlpack.name = QUERY_PACK_NAME;
431431

432432
qlpack.defaultSuite = [{
433-
description: 'Query suite for remote query'
433+
description: 'Query suite for variant analysis'
434434
}, {
435435
query: packRelativePath.replace(/\\/g, '/')
436436
}];

extensions/ql-vscode/src/vscode-tests/cli-integration/run-remote-query.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ describe('Remote queries', function() {
279279
},
280280
library: false,
281281
defaultSuite: [{
282-
description: 'Query suite for remote query'
282+
description: 'Query suite for variant analysis'
283283
}, {
284284
query: queryPath
285285
}]

0 commit comments

Comments
 (0)