Skip to content

Commit 83ffba2

Browse files
committed
Rename remote queries -> variant analysis
In some user facing text.
1 parent 8b2d79a commit 83ffba2

5 files changed

Lines changed: 19 additions & 19 deletions

File tree

extensions/ql-vscode/src/cli.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -667,11 +667,11 @@ export class CodeQLCliServer implements Disposable {
667667

668668
/**
669669
* Generate a summary of an evaluation log.
670-
* @param endSummaryPath The path to write only the end of query part of the human-readable summary to.
670+
* @param endSummaryPath The path to write only the end of query part of the human-readable summary to.
671671
* @param inputPath The path of an evaluation event log.
672672
* @param outputPath The path to write a human-readable summary of it to.
673673
*/
674-
async generateLogSummary(
674+
async generateLogSummary(
675675
inputPath: string,
676676
outputPath: string,
677677
endSummaryPath: string,
@@ -1255,7 +1255,7 @@ export class CliVersionConstraint {
12551255
public static CLI_VERSION_WITH_NO_PRECOMPILE = new SemVer('2.7.1');
12561256

12571257
/**
1258-
* CLI version where remote queries are supported.
1258+
* CLI version where remote queries (variant analysis) are supported.
12591259
*/
12601260
public static CLI_VERSION_REMOTE_QUERIES = new SemVer('2.6.3');
12611261

@@ -1280,16 +1280,16 @@ export class CliVersionConstraint {
12801280
*/
12811281
public static CLI_VERSION_WITH_STRUCTURED_EVAL_LOG = new SemVer('2.8.2');
12821282

1283-
/**
1284-
* CLI version that supports rotating structured logs to produce one per query.
1285-
*
1286-
* Note that 2.8.4 supports generating the evaluation logs and summaries,
1287-
* but 2.9.0 includes a new option to produce the end-of-query summary logs to
1288-
* the query server console. For simplicity we gate all features behind 2.9.0,
1289-
* but if a user is tied to the 2.8 release, we can enable evaluator logs
1290-
* and summaries for them.
1291-
*/
1292-
public static CLI_VERSION_WITH_PER_QUERY_EVAL_LOG = new SemVer('2.9.0');
1283+
/**
1284+
* CLI version that supports rotating structured logs to produce one per query.
1285+
*
1286+
* Note that 2.8.4 supports generating the evaluation logs and summaries,
1287+
* but 2.9.0 includes a new option to produce the end-of-query summary logs to
1288+
* the query server console. For simplicity we gate all features behind 2.9.0,
1289+
* but if a user is tied to the 2.8 release, we can enable evaluator logs
1290+
* and summaries for them.
1291+
*/
1292+
public static CLI_VERSION_WITH_PER_QUERY_EVAL_LOG = new SemVer('2.9.0');
12931293

12941294
constructor(private readonly cli: CodeQLCliServer) {
12951295
/**/

extensions/ql-vscode/src/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ export function isCanary() {
322322
*/
323323
export const NO_CACHE_AST_VIEWER = new Setting('disableCache', AST_VIEWER_SETTING);
324324

325-
// Settings for remote queries
325+
// Settings for variant analysis
326326
const REMOTE_QUERIES_SETTING = new Setting('variantAnalysis', ROOT_SETTING);
327327

328328
/**

extensions/ql-vscode/src/extension.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -838,7 +838,7 @@ async function activateWithInstalledDistribution(
838838
)
839839
);
840840

841-
void logger.log('Initializing remote queries interface.');
841+
void logger.log('Initializing variant analysis results view.');
842842
const rqm = new RemoteQueriesManager(ctx, cliServer, qhm, queryStorageDir, logger);
843843
ctx.subscriptions.push(rqm);
844844

@@ -868,7 +868,7 @@ async function activateWithInstalledDistribution(
868868
token
869869
);
870870
} else {
871-
throw new Error('Remote queries require the CodeQL Canary version to run.');
871+
throw new Error('Variant analysis requires the CodeQL Canary version to run.');
872872
}
873873
}, {
874874
title: 'Run Variant Analysis',

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export class RemoteQueriesInterfaceManager {
3838
private readonly analysesResultsManager: AnalysesResultsManager
3939
) {
4040
this.panelLoadedCallBacks.push(() => {
41-
void logger.log('Remote queries view loaded');
41+
void logger.log('Variant analysis results view loaded');
4242
});
4343
}
4444

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ export async function runRemoteQuery(
171171
token: CancellationToken
172172
): Promise<void | RemoteQuerySubmissionResult> {
173173
if (!(await cliServer.cliConstraints.supportsRemoteQueries())) {
174-
throw new Error(`Remote queries are not supported by this version of CodeQL. Please upgrade to v${cli.CliVersionConstraint.CLI_VERSION_REMOTE_QUERIES
174+
throw new Error(`Variant analysis is not supported by this version of CodeQL. Please upgrade to v${cli.CliVersionConstraint.CLI_VERSION_REMOTE_QUERIES
175175
} or later.`);
176176
}
177177

@@ -207,7 +207,7 @@ export async function runRemoteQuery(
207207
if (!controllerRepo || !REPO_REGEX.test(controllerRepo)) {
208208
void logger.log(controllerRepo ? 'Invalid controller repository name.' : 'No controller repository defined.');
209209
controllerRepo = await window.showInputBox({
210-
title: 'Controller repository in which to display progress and results of remote queries',
210+
title: 'Controller repository in which to display progress and results of variant analysis',
211211
placeHolder: '<owner>/<repo>',
212212
prompt: 'Enter the name of a GitHub repository in the format <owner>/<repo>',
213213
ignoreFocusOut: true,

0 commit comments

Comments
 (0)