Skip to content

Remove conditionals and version constraints for unsupported CLI versions #2627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
charisk merged 4 commits into from
Jul 24, 2023
Merged

Remove conditionals and version constraints for unsupported CLI versions #2627

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f03ef66
Update handling of return value from packlist command
charisk Jul 21, 2023
3064415
Remove setting of evaluator log verbosity level
charisk Jul 21, 2023
0f59470
Remove CLI_VERSION_WITH_STRUCTURED_EVAL_LOG constraint
charisk Jul 21, 2023
e80ef7c
Remove CLI_VERSION_WITH_PER_QUERY_EVAL_LOG constraint
charisk Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 6 additions & 26 deletions extensions/ql-vscode/src/codeql-cli/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1428,21 +1428,13 @@ export class CodeQLCliServer implements Disposable {

async packPacklist(dir: string, includeQueries: boolean): Promise<string[]> {
const args = includeQueries ? [dir] : ["--no-include-queries", dir];
// since 2.7.1, packlist returns an object with a "paths" property that is a list of packs.
// previous versions return a list of packs.
const results: { paths: string[] } | string[] =
await this.runJsonCodeQlCliCommand(
["pack", "packlist"],
args,
"Generating the pack list",
);
const results: { paths: string[] } = await this.runJsonCodeQlCliCommand(
["pack", "packlist"],
args,
"Generating the pack list",
);

// Once we no longer need to support 2.7.0 or earlier, we can remove this and assume all versions return an object.
if ("paths" in results) {
return results.paths;
} else {
return results;
}
return results.paths;
}

async packResolveDependencies(
Expand Down Expand Up @@ -1811,12 +1803,6 @@ export class CliVersionConstraint {
*/
public static CLI_VERSION_WITH_RESOLVE_EXTENSIONS = new SemVer("2.10.2");

/**
* CLI version where the `--evaluator-log` and related options to the query server were introduced,
* on a per-query server basis.
*/
public static CLI_VERSION_WITH_STRUCTURED_EVAL_LOG = new SemVer("2.8.2");

/**
* CLI version that supports rotating structured logs to produce one per query.
*
Expand Down Expand Up @@ -1893,12 +1879,6 @@ export class CliVersionConstraint {
);
}

async supportsStructuredEvalLog() {
return this.isVersionAtLeast(
CliVersionConstraint.CLI_VERSION_WITH_STRUCTURED_EVAL_LOG,
);
}

async supportsPerQueryEvalLog() {
return this.isVersionAtLeast(
CliVersionConstraint.CLI_VERSION_WITH_PER_QUERY_EVAL_LOG,
Expand Down
15 changes: 4 additions & 11 deletions extensions/ql-vscode/src/query-server/legacy/query-server-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,18 +150,11 @@ export class QueryServerClient extends DisposableObject {
args.push("--old-eval-stats");
}

if (await this.cliServer.cliConstraints.supportsStructuredEvalLog()) {
const structuredLogFile = `${this.opts.contextStoragePath}/structured-evaluator-log.json`;
await ensureFile(structuredLogFile);
const structuredLogFile = `${this.opts.contextStoragePath}/structured-evaluator-log.json`;
await ensureFile(structuredLogFile);

args.push("--evaluator-log");
args.push(structuredLogFile);

// We hard-code the verbosity level to 5 and minify to false.
// This will be the behavior of the per-query structured logging in the CLI after 2.8.3.
args.push("--evaluator-log-level");
args.push("5");
}
args.push("--evaluator-log");
args.push(structuredLogFile);

if (this.config.debug) {
args.push("--debug", "--tuple-counting");
Expand Down
5 changes: 0 additions & 5 deletions extensions/ql-vscode/src/query-server/query-server-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,11 +194,6 @@ export class QueryServerClient extends DisposableObject {
args.push("--evaluator-log");
args.push(structuredLogFile);

// We hard-code the verbosity level to 5 and minify to false.
// This will be the behavior of the per-query structured logging in the CLI after 2.8.3.
args.push("--evaluator-log-level");
args.push("5");

if (this.config.debug) {
args.push("--debug", "--tuple-counting");
}
Expand Down