Debugger tests

Author: Dave Bartolomeo

extensions/ql-vscode/src/debugger/debug-configuration.ts

@@ -7,12 +7,12 @@ import {
 import { getOnDiskWorkspaceFolders, showAndLogErrorMessage } from "../helpers";
 import { LocalQueries } from "../local-queries";
 import { getQuickEvalContext, validateQueryPath } from "../run-queries-shared";
-import * as CodeQLDebugProtocol from "./debug-protocol";
+import * as CodeQLProtocol from "./debug-protocol";
 
 /**
  * The CodeQL launch arguments, as specified in "launch.json".
  */
-interface QLDebugArgs {
+export interface QLDebugArgs {
   query?: string;
   database?: string;
   additionalPacks?: string[] | string;
@@ -26,14 +26,14 @@ interface QLDebugArgs {
  *
  * This just combines `QLDebugArgs` with the standard debug configuration properties.
  */
-type QLDebugConfiguration = DebugConfiguration & QLDebugArgs;
+export type QLDebugConfiguration = DebugConfiguration & QLDebugArgs;
 
 /**
  * A CodeQL debug configuration after all variables and defaults have been resolved. This is what
  * is passed to the debug adapter via the `launch` request.
  */
 export type QLResolvedDebugConfiguration = DebugConfiguration &
-  CodeQLDebugProtocol.LaunchConfig;
+  CodeQLProtocol.LaunchConfig;
 
 /**
  * Implementation of `DebugConfigurationProvider` for CodeQL.
@@ -114,7 +114,7 @@ export class QLDebugConfigurationProvider
       database: qlConfiguration.database,
       additionalPacks,
       extensionPacks,
-      quickEvalPosition: quickEvalContext?.quickEvalPosition,
+      quickEvalContext,
       noDebug: qlConfiguration.noDebug ?? false,
     };
 

extensions/ql-vscode/src/debugger/debug-protocol.ts

@@ -1,5 +1,8 @@
 import { DebugProtocol } from "@vscode/debugprotocol";
 import { QueryResultType } from "../pure/new-messages";
+import { QuickEvalContext } from "../run-queries-shared";
+
+// Events
 
 export type Event = { type: "event" };
 
@@ -9,65 +12,82 @@ export type StoppedEvent = DebugProtocol.StoppedEvent &
 export type InitializedEvent = DebugProtocol.InitializedEvent &
   Event & { event: "initialized" };
 
+export type ExitedEvent = DebugProtocol.ExitedEvent &
+  Event & { event: "exited" };
+
 export type OutputEvent = DebugProtocol.OutputEvent &
   Event & { event: "output" };
 
-export interface EvaluationStartedEventBody {
-  id: string;
-  outputDir: string;
-  quickEvalPosition: Position | undefined;
-}
-
 /**
  * Custom event to provide additional information about a running evaluation.
  */
-export interface EvaluationStartedEvent extends DebugProtocol.Event {
+export interface EvaluationStartedEvent extends Event {
   event: "codeql-evaluation-started";
-  body: EvaluationStartedEventBody;
-}
-
-export interface EvaluationCompletedEventBody {
-  resultType: QueryResultType;
-  message: string | undefined;
-  evaluationTime: number;
+  body: {
+    id: string;
+    outputDir: string;
+    quickEvalContext: QuickEvalContext | undefined;
+  };
 }
 
 /**
  * Custom event to provide additional information about a completed evaluation.
  */
-export interface EvaluationCompletedEvent extends DebugProtocol.Event {
+export interface EvaluationCompletedEvent extends Event {
   event: "codeql-evaluation-completed";
-  body: EvaluationCompletedEventBody;
+  body: {
+    resultType: QueryResultType;
+    message: string | undefined;
+    evaluationTime: number;
+  };
 }
 
 export type AnyEvent =
   | StoppedEvent
+  | ExitedEvent
   | InitializedEvent
   | OutputEvent
   | EvaluationStartedEvent
   | EvaluationCompletedEvent;
 
+// Requests
+
 export type Request = DebugProtocol.Request & { type: "request" };
 
+export type InitializeRequest = DebugProtocol.InitializeRequest &
+  Request & { command: "initialize" };
+
+export interface LaunchConfig {
+  /** Full path to query (.ql) file. */
+  query: string;
+  /** Full path to the database directory. */
+  database: string;
+  /** Full paths to `--additional-packs` directories. */
+  additionalPacks: string[];
+  /** Pack names of extension packs. */
+  extensionPacks: string[];
+  /** Optional quick evaluation context. */
+  quickEvalContext: QuickEvalContext | undefined;
+  /** Run the query without debugging it. */
+  noDebug: boolean;
+}
+
+export interface LaunchRequest extends Request, DebugProtocol.LaunchRequest {
+  type: "request";
+  command: "launch";
+  arguments: DebugProtocol.LaunchRequestArguments & LaunchConfig;
+}
+
 export interface QuickEvalRequest extends Request {
   command: "codeql-quickeval";
   arguments: {
-    quickEvalPosition: Position;
+    quickEvalContext: QuickEvalContext;
   };
 }
 
-export interface DebugResultRequest extends Request {
-  command: "codeql-debug-result";
-  arguments: undefined;
-}
-
-export type InitializeRequest = DebugProtocol.InitializeRequest &
-  Request & { command: "initialize" };
+export type AnyRequest = InitializeRequest | LaunchRequest | QuickEvalRequest;
 
-export type AnyRequest =
-  | InitializeRequest
-  | DebugResultRequest
-  | QuickEvalRequest;
+// Responses
 
 export type Response = DebugProtocol.Response & { type: "response" };
 
@@ -77,32 +97,6 @@ export type InitializeResponse = DebugProtocol.InitializeResponse &
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface QuickEvalResponse extends Response {}
 
-export type AnyResponse = InitializeResponse;
+export type AnyResponse = InitializeResponse | QuickEvalResponse;
 
 export type AnyProtocolMessage = AnyEvent | AnyRequest | AnyResponse;
-
-export interface Position {
-  fileName: string;
-  line: number;
-  column: number;
-  endLine: number;
-  endColumn: number;
-}
-
-export interface LaunchConfig {
-  /** Full path to query (.ql) file. */
-  query: string;
-  /** Full path to the database directory. */
-  database: string;
-  /** Full paths to `--additional-packs` directories. */
-  additionalPacks: string[];
-  /** Pack names of extension packs. */
-  extensionPacks: string[];
-  /** Optional quick evaluation position. */
-  quickEvalPosition: Position | undefined;
-  /** Run the query without debugging it. */
-  noDebug: boolean;
-}
-
-export type LaunchRequestArguments = DebugProtocol.LaunchRequestArguments &
-  LaunchConfig;