Merge pull request #3210 from github/koesie10/no-cycle

Remove all dependency cycles

Author: koesie10

extensions/ql-vscode/.eslintrc.js

@@ -63,7 +63,7 @@ const baseConfig = {
     "github/array-foreach": "off",
     "github/no-then": "off",
     "react/jsx-key": ["error", { checkFragmentShorthand: true }],
-    "import/no-cycle": "off",
+    "import/no-cycle": "error",
     // Never allow extensions in import paths, except for JSON files where they are required.
     "import/extensions": ["error", "never", { json: "always" }],
   },

extensions/ql-vscode/src/codeql-cli/cli-command.ts

@@ -0,0 +1,50 @@
+import { execFile } from "child_process";
+import { promisify } from "util";
+
+import type { BaseLogger } from "../common/logging";
+import type { ProgressReporter } from "../common/logging/vscode";
+import { getChildProcessErrorMessage } from "../common/helpers-pure";
+
+/**
+ * Flags to pass to all cli commands.
+ */
+export const LOGGING_FLAGS = ["-v", "--log-to-stderr"];
+
+/**
+ * Runs a CodeQL CLI command without invoking the CLI server, returning the output as a string.
+ * @param codeQlPath The path to the CLI.
+ * @param command The `codeql` command to be run, provided as an array of command/subcommand names.
+ * @param commandArgs The arguments to pass to the `codeql` command.
+ * @param description Description of the action being run, to be shown in log and error messages.
+ * @param logger Logger to write command log messages, e.g. to an output channel.
+ * @param progressReporter Used to output progress messages, e.g. to the status bar.
+ * @returns The contents of the command's stdout, if the command succeeded.
+ */
+export async function runCodeQlCliCommand(
+  codeQlPath: string,
+  command: string[],
+  commandArgs: string[],
+  description: string,
+  logger: BaseLogger,
+  progressReporter?: ProgressReporter,
+): Promise<string> {
+  // Add logging arguments first, in case commandArgs contains positional parameters.
+  const args = command.concat(LOGGING_FLAGS).concat(commandArgs);
+  const argsString = args.join(" ");
+  try {
+    if (progressReporter !== undefined) {
+      progressReporter.report({ message: description });
+    }
+    void logger.log(
+      `${description} using CodeQL CLI: ${codeQlPath} ${argsString}...`,
+    );
+    const result = await promisify(execFile)(codeQlPath, args);
+    void logger.log(result.stderr);
+    void logger.log("CLI command succeeded.");
+    return result.stdout;
+  } catch (err) {
+    throw new Error(
+      `${description} failed: ${getChildProcessErrorMessage(err)}`,
+    );
+  }
+}

extensions/ql-vscode/src/codeql-cli/cli-version.ts

@@ -1,6 +1,6 @@
 import type { SemVer } from "semver";
 import { parse } from "semver";
-import { runCodeQlCliCommand } from "./cli";
+import { runCodeQlCliCommand } from "./cli-command";
 import type { Logger } from "../common/logging";
 import { getErrorMessage } from "../common/helpers-pure";
 

extensions/ql-vscode/src/codeql-cli/cli.ts

@@ -1,14 +1,13 @@
 import { EOL } from "os";
 import { spawn } from "child-process-promise";
 import type { ChildProcessWithoutNullStreams } from "child_process";
-import { execFile, spawn as spawnChildProcess } from "child_process";
+import { spawn as spawnChildProcess } from "child_process";
 import { readFile } from "fs-extra";
 import { delimiter, dirname, join } from "path";
 import type { Log } from "sarif";
 import { SemVer } from "semver";
 import type { Readable } from "stream";
 import tk from "tree-kill";
-import { promisify } from "util";
 import type { CancellationToken, Disposable, Uri } from "vscode";
 
 import type {
@@ -21,7 +20,6 @@ import type { DistributionProvider } from "./distribution";
 import { FindDistributionResultKind } from "./distribution";
 import {
   assertNever,
-  getChildProcessErrorMessage,
   getErrorMessage,
   getErrorStack,
 } from "../common/helpers-pure";
@@ -35,6 +33,7 @@ import type { App } from "../common/app";
 import { QueryLanguage } from "../common/query-language";
 import { LINE_ENDINGS, splitStreamAtSeparators } from "../common/split-stream";
 import type { Position } from "../query-server/messages";
+import { LOGGING_FLAGS } from "./cli-command";
 
 /**
  * The version of the SARIF format that we are using.
@@ -46,11 +45,6 @@ const SARIF_FORMAT = "sarifv2.1.0";
  */
 const CSV_FORMAT = "csv";
 
-/**
- * Flags to pass to all cli commands.
- */
-const LOGGING_FLAGS = ["-v", "--log-to-stderr"];
-
 /**
  * The expected output of `codeql resolve queries --format bylanguage`.
  */
@@ -1632,45 +1626,6 @@ export function spawnServer(
   return child;
 }
 
-/**
- * Runs a CodeQL CLI command without invoking the CLI server, returning the output as a string.
- * @param codeQlPath The path to the CLI.
- * @param command The `codeql` command to be run, provided as an array of command/subcommand names.
- * @param commandArgs The arguments to pass to the `codeql` command.
- * @param description Description of the action being run, to be shown in log and error messages.
- * @param logger Logger to write command log messages, e.g. to an output channel.
- * @param progressReporter Used to output progress messages, e.g. to the status bar.
- * @returns The contents of the command's stdout, if the command succeeded.
- */
-export async function runCodeQlCliCommand(
-  codeQlPath: string,
-  command: string[],
-  commandArgs: string[],
-  description: string,
-  logger: Logger,
-  progressReporter?: ProgressReporter,
-): Promise<string> {
-  // Add logging arguments first, in case commandArgs contains positional parameters.
-  const args = command.concat(LOGGING_FLAGS).concat(commandArgs);
-  const argsString = args.join(" ");
-  try {
-    if (progressReporter !== undefined) {
-      progressReporter.report({ message: description });
-    }
-    void logger.log(
-      `${description} using CodeQL CLI: ${codeQlPath} ${argsString}...`,
-    );
-    const result = await promisify(execFile)(codeQlPath, args);
-    void logger.log(result.stderr);
-    void logger.log("CLI command succeeded.");
-    return result.stdout;
-  } catch (err) {
-    throw new Error(
-      `${description} failed: ${getChildProcessErrorMessage(err)}`,
-    );
-  }
-}
-
 /**
  * Log a text stream to a `Logger` interface.
  * @param stream The stream to log.

extensions/ql-vscode/src/debugger/debugger-ui.ts

@@ -11,10 +11,10 @@ import { DisposableObject } from "../common/disposable-object";
 import type { CoreQueryResults } from "../query-server";
 import {
   getQuickEvalContext,
-  QueryOutputDir,
   saveBeforeStart,
   validateQueryUri,
 } from "../run-queries-shared";
+import { QueryOutputDir } from "../local-queries/query-output-dir";
 import type { QLResolvedDebugConfiguration } from "./debug-configuration";
 import type {
   AnyProtocolMessage,

extensions/ql-vscode/src/language-support/ast-viewer/ast-builder.ts

@@ -7,7 +7,7 @@ import type {
 import type { DatabaseItem } from "../../databases/local-databases";
 import type { ChildAstItem, AstItem } from "./ast-viewer";
 import type { Uri } from "vscode";
-import type { QueryOutputDir } from "../../run-queries-shared";
+import type { QueryOutputDir } from "../../local-queries/query-output-dir";
 import { fileRangeFromURI } from "../contextual/file-range-from-uri";
 import { mapUrlValue } from "../../common/bqrs-raw-results-mapper";
 

extensions/ql-vscode/src/language-support/contextual/location-finder.ts

@@ -21,7 +21,7 @@ import {
 } from "./query-resolver";
 import type { CancellationToken, LocationLink } from "vscode";
 import { Uri } from "vscode";
-import type { QueryOutputDir } from "../../run-queries-shared";
+import type { QueryOutputDir } from "../../local-queries/query-output-dir";
 import type { QueryRunner } from "../../query-server";
 import { QueryResultType } from "../../query-server/messages";
 import { fileRangeFromURI } from "./file-range-from-uri";

extensions/ql-vscode/src/local-queries/local-queries.ts

@@ -29,7 +29,8 @@ import type {
   DatabaseItem,
   DatabaseManager,
 } from "../databases/local-databases";
-import type { QueryOutputDir, SelectedQuery } from "../run-queries-shared";
+import type { SelectedQuery } from "../run-queries-shared";
+import type { QueryOutputDir } from "./query-output-dir";
 import {
   createInitialQueryInfo,
   createTimestampFile,

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

@@ -9,9 +9,9 @@ import type { QueryHistoryManager } from "../query-history/query-history-manager
 import type { DatabaseItem } from "../databases/local-databases";
 import type {
   EvaluatorLogPaths,
-  QueryOutputDir,
   QueryWithResults,
 } from "../run-queries-shared";
+import type { QueryOutputDir } from "./query-output-dir";
 import {
   generateEvalLogSummaries,
   logEndSummary,

extensions/ql-vscode/src/local-queries/query-output-dir.ts

@@ -0,0 +1,75 @@
+import { join } from "path";
+
+function findQueryLogFile(resultPath: string): string {
+  return join(resultPath, "query.log");
+}
+
+function findQueryEvalLogFile(resultPath: string): string {
+  return join(resultPath, "evaluator-log.jsonl");
+}
+
+function findQueryEvalLogSummaryFile(resultPath: string): string {
+  return join(resultPath, "evaluator-log.summary");
+}
+
+function findJsonQueryEvalLogSummaryFile(resultPath: string): string {
+  return join(resultPath, "evaluator-log.summary.jsonl");
+}
+
+function findQueryEvalLogSummarySymbolsFile(resultPath: string): string {
+  return join(resultPath, "evaluator-log.summary.symbols.json");
+}
+
+function findQueryEvalLogEndSummaryFile(resultPath: string): string {
+  return join(resultPath, "evaluator-log-end.summary");
+}
+
+/**
+ * Provides paths to the files that can be generated in the output directory for a query evaluation.
+ */
+export class QueryOutputDir {
+  constructor(public readonly querySaveDir: string) {}
+
+  get dilPath() {
+    return join(this.querySaveDir, "results.dil");
+  }
+
+  /**
+   * Get the path that the compiled query is if it exists. Note that it only exists when using the legacy query server.
+   */
+  get compileQueryPath() {
+    return join(this.querySaveDir, "compiledQuery.qlo");
+  }
+
+  get csvPath() {
+    return join(this.querySaveDir, "results.csv");
+  }
+
+  get logPath() {
+    return findQueryLogFile(this.querySaveDir);
+  }
+
+  get evalLogPath() {
+    return findQueryEvalLogFile(this.querySaveDir);
+  }
+
+  get evalLogSummaryPath() {
+    return findQueryEvalLogSummaryFile(this.querySaveDir);
+  }
+
+  get jsonEvalLogSummaryPath() {
+    return findJsonQueryEvalLogSummaryFile(this.querySaveDir);
+  }
+
+  get evalLogSummarySymbolsPath() {
+    return findQueryEvalLogSummarySymbolsFile(this.querySaveDir);
+  }
+
+  get evalLogEndSummaryPath() {
+    return findQueryEvalLogEndSummaryFile(this.querySaveDir);
+  }
+
+  get bqrsPath() {
+    return join(this.querySaveDir, "results.bqrs");
+  }
+}