Refactoring

Author: idavis

language_service/src/qasm.rs

@@ -7,10 +7,7 @@ use qsc::{qasm::parser::ast::StmtKind, LanguageFeatures};
 use qsc_project::{FileSystemAsync, PackageGraphSources, PackageInfo, Project};
 use rustc_hash::FxHashMap;
 
-pub async fn load_openqasm_project<T>(
-    project_host: &T,
-    doc_uri: &Arc<str>,
-) -> Result<Project, Vec<qsc::project::Error>>
+pub async fn load_openqasm_project<T>(project_host: &T, doc_uri: &Arc<str>) -> Project
 where
     T: FileSystemAsync + ?Sized,
 {
@@ -75,7 +72,7 @@ where
 
     let sources = loaded_files.into_iter().collect::<Vec<_>>();
 
-    Ok(Project {
+    Project {
         package_graph_sources: PackageGraphSources {
             root: PackageInfo {
                 sources,
@@ -90,7 +87,7 @@ where
         lints: Vec::default(),
         errors,
         project_type: qsc_project::ProjectType::OpenQASM,
-    })
+    }
 }
 
 fn get_file_name_from_uri(uri: &Arc<str>) -> Arc<str> {

language_service/src/state.rs

@@ -183,9 +183,7 @@ impl<'a> CompilationStateUpdater<'a> {
 
     async fn load_project_from_doc_uri(&mut self, doc_uri: &Arc<str>, text: &Arc<str>) -> Project {
         if is_openqasm_file(doc_uri) {
-            if let Ok(project) = crate::load_openqasm_project(&*self.project_host, doc_uri).await {
-                return project;
-            }
+            return crate::load_openqasm_project(&*self.project_host, doc_uri).await;
         }
         match self.load_manifest(doc_uri).await {
             Ok(Some(p)) => p,

vscode/src/common.ts

@@ -52,13 +52,19 @@ export function isQsharpNotebookCell(document: TextDocument): boolean {
   );
 }
 
+// Returns true for only Q# notebook cell documents.
+export function isOpenQasmNotebookCell(document: TextDocument): boolean {
+  return (
+    document.languageId === openqasmLanguageId &&
+    document.uri.scheme === "vscode-notebook-cell"
+  );
+}
+
 // Returns true for all OpenQASM documents, including unsaved files, notebook cells, etc.
 export function isOpenQasmDocument(document: TextDocument): boolean {
   return (
     document.languageId === openqasmLanguageId &&
-    (Utils.extname(document.uri) === ".qasm" ||
-      Utils.extname(document.uri) === ".inc" ||
-      document.isUntitled) &&
+    (hasOpenQasmExt(document.uri) || document.isUntitled) &&
     document.uri.scheme !== "git" &&
     document.uri.scheme !== "pr" &&
     // The Copilot Chat window also creates documents with various schemes that start
@@ -67,6 +73,11 @@ export function isOpenQasmDocument(document: TextDocument): boolean {
   );
 }
 
+export function hasOpenQasmExt(uri: vscode.Uri): boolean {
+  const ext = Utils.extname(uri);
+  return ext === ".qasm" || ext === ".inc";
+}
+
 export const qsharpExtensionId = "qsharp-vscode";
 
 export function basename(path: string): string | undefined {

vscode/src/debugger/activate.ts

@@ -8,10 +8,11 @@ import * as vscode from "vscode";
 import { qsharpExtensionId } from "../common";
 import { clearCommandDiagnostics } from "../diagnostics";
 import {
+  FullProgramConfigOrError,
   getActiveOpenQasmDocumentUri,
   getActiveQSharpDocumentUri,
   getOpenQasmProgramForDocument,
-  getProgramForDocument,
+  getQSharpProgramForDocument,
 } from "../programConfig";
 import { getRandomGuid } from "../utils";
 import { QscDebugSession } from "./session";
@@ -37,7 +38,9 @@ export async function activateDebugger(
     vscode.debug.registerDebugConfigurationProvider("qsharp", provider),
   );
 
-  const factory = new InlineDebugAdapterFactory();
+  const factory = new InlineDebugAdapterFactory((uri) =>
+    getQSharpProgramForDocument(uri),
+  );
   context.subscriptions.push(
     vscode.debug.registerDebugAdapterDescriptorFactory("qsharp", factory),
   );
@@ -47,7 +50,9 @@ export async function activateDebugger(
     vscode.debug.registerDebugConfigurationProvider("openqasm", qasm_provider),
   );
 
-  const qasm_factory = new InlineOpenQasmDebugAdapterFactory();
+  const qasm_factory = new InlineDebugAdapterFactory((uri) =>
+    getOpenQasmProgramForDocument(uri),
+  );
   context.subscriptions.push(
     vscode.debug.registerDebugAdapterDescriptorFactory(
       "openqasm",
@@ -382,39 +387,19 @@ class OpenQasmDebugConfigProvider implements vscode.DebugConfigurationProvider {
 class InlineDebugAdapterFactory
   implements vscode.DebugAdapterDescriptorFactory
 {
-  async createDebugAdapterDescriptor(
-    session: vscode.DebugSession,
-    _executable: vscode.DebugAdapterExecutable | undefined,
-  ): Promise<vscode.DebugAdapterDescriptor> {
-    const worker = debugServiceWorkerFactory();
-    const uri = vscode.Uri.parse(session.configuration.programUri);
-    const program = await getProgramForDocument(uri);
-    if (!program.success) {
-      throw new Error(program.errorMsg);
-    }
+  constructor(
+    private programLoader: (
+      uri: vscode.Uri,
+    ) => Promise<FullProgramConfigOrError>,
+  ) {}
 
-    const qscSession = new QscDebugSession(
-      worker,
-      session.configuration,
-      program.programConfig,
-    );
-
-    await qscSession.init(getRandomGuid());
-
-    return new vscode.DebugAdapterInlineImplementation(qscSession);
-  }
-}
-
-class InlineOpenQasmDebugAdapterFactory
-  implements vscode.DebugAdapterDescriptorFactory
-{
   async createDebugAdapterDescriptor(
     session: vscode.DebugSession,
     _executable: vscode.DebugAdapterExecutable | undefined,
   ): Promise<vscode.DebugAdapterDescriptor> {
     const worker = debugServiceWorkerFactory();
     const uri = vscode.Uri.parse(session.configuration.programUri);
-    const program = await getOpenQasmProgramForDocument(uri);
+    const program = await this.programLoader(uri);
     if (!program.success) {
       throw new Error(program.errorMsg);
     }

vscode/src/diagnostics.ts

@@ -1,13 +1,15 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { IQSharpError, log, qsharpLibraryUriScheme } from "qsharp-lang";
+import { IQSharpError, log } from "qsharp-lang";
 import * as vscode from "vscode";
 import {
+  hasOpenQasmExt,
   qsharpExtensionId,
   qsharpLanguageId,
   toVsCodeDiagnostic,
 } from "./common.js";
+import { getSourceUri } from "./utils.js";
 
 /**
  * Initialize diagnostics for `qsharp.json` files and failures
@@ -176,9 +178,13 @@ function reportIfQSharpErrors(e: unknown) {
 
     for (const error of qsharpErrors) {
       const uri = getSourceUri(error.document);
+      let languageId = "Q#";
+      if (hasOpenQasmExt(uri)) {
+        languageId = "OpenQASM";
+      }
 
       const diagnostics = byUri.get(uri) || [];
-      error.diagnostic.message = `Q# command error: ${error.diagnostic.message}`;
+      error.diagnostic.message = `${languageId} command error: ${error.diagnostic.message}`;
       diagnostics.push(toVsCodeDiagnostic(error.diagnostic));
       byUri.set(uri, diagnostics);
     }
@@ -191,34 +197,8 @@ function reportIfQSharpErrors(e: unknown) {
     vscode.commands.executeCommand("workbench.action.problems.focus");
 
     vscode.window.showErrorMessage(
-      "The Q# command returned errors. Please see the Problems view.",
+      "The command returned errors. Please see the Problems view.",
       { modal: true },
     );
   }
 }
-
-/**
- * This is temporary until we're able to report proper stdlib and project URIs from
- * the wasm layer. See https://github.com/microsoft/qsharp/blob/f8d344b32a1f1f918f3c91edf58c975db10f4370/wasm/src/diagnostic.rs
- *
- * @param maybeUri A source name returned from a Q# diagnostic
- * @returns A VS code URI that's okay to use in a Diagnostic object
- */
-function getSourceUri(maybeUri: string): vscode.Uri {
-  // An error without a span (e.g. "no entrypoint found") gets reported as a "project-level" error.
-  // See: https://github.com/microsoft/qsharp/blob/f8d344b32a1f1f918f3c91edf58c975db10f4370/wasm/src/diagnostic.rs#L191
-  // Ideally this would be a proper URI pointing to the project root or root document.
-  // For now, make up a fake file path for display purposes.
-  if (maybeUri === "<project>") {
-    return vscode.Uri.file("Q# project");
-  }
-
-  try {
-    return vscode.Uri.parse(maybeUri, true);
-  } catch {
-    // Not a URI, assume it's a filename from the stdlib
-    // This URI should ideally be properly propagated from
-    // https://github.com/microsoft/qsharp/blob/f8d344b32a1f1f918f3c91edf58c975db10f4370/wasm/src/diagnostic.rs#L105
-    return vscode.Uri.from({ scheme: qsharpLibraryUriScheme, path: maybeUri });
-  }
-}

vscode/src/language-service/activate.ts

@@ -11,6 +11,7 @@ import * as vscode from "vscode";
 import {
   isCircuitDocument,
   isOpenQasmDocument,
+  isOpenQasmNotebookCell,
   isQsharpDocument,
   isQsharpNotebookCell,
   openqasmLanguageId,
@@ -212,71 +213,41 @@ function registerDocumentUpdateHandlers(
   languageService: ILanguageService,
 ): vscode.Disposable[] {
   vscode.workspace.textDocuments.forEach((document) => {
-    updateIfQsharpDocument(document);
-    updateIfOpenQasmDocument(document);
+    updateIfSupportedDocument(document);
   });
 
   // we manually send an OpenDocument telemetry event if this is a Q# document, because the
   // below subscriptions won't fire for documents that are already open when the extension is activated
   vscode.workspace.textDocuments.forEach((document) => {
-    if (isQsharpDocument(document)) {
-      const documentType = isQsharpNotebookCell(document)
-        ? QsharpDocumentType.JupyterCell
-        : isCircuitDocument(document)
-          ? QsharpDocumentType.Circuit
-          : QsharpDocumentType.Qsharp;
-      sendTelemetryEvent(
-        EventType.OpenedDocument,
-        { documentType },
-        { linesOfCode: document.lineCount },
-      );
-    }
-    if (isOpenQasmDocument(document)) {
-      const documentType = QsharpDocumentType.OpenQasm;
-      sendTelemetryEvent(
-        EventType.OpenedDocument,
-        { documentType },
-        { linesOfCode: document.lineCount },
-      );
-    }
+    sendDocumentOpenedEvent(document);
   });
 
   const subscriptions = [];
   subscriptions.push(
     vscode.workspace.onDidOpenTextDocument((document) => {
-      const documentType = isQsharpNotebookCell(document)
-        ? QsharpDocumentType.JupyterCell
-        : isCircuitDocument(document)
-          ? QsharpDocumentType.Circuit
-          : isQsharpDocument(document)
-            ? QsharpDocumentType.Qsharp
-            : isOpenQasmDocument(document)
-              ? QsharpDocumentType.OpenQasm
-              : QsharpDocumentType.Other;
+      const documentType = determineDocumentType(document);
       if (documentType !== QsharpDocumentType.Other) {
         sendTelemetryEvent(
           EventType.OpenedDocument,
           { documentType },
           { linesOfCode: document.lineCount },
         );
       }
-      updateIfQsharpDocument(document);
-      updateIfOpenQasmDocument(document);
+      updateIfSupportedDocument(document);
     }),
   );
 
   subscriptions.push(
     vscode.workspace.onDidChangeTextDocument((evt) => {
-      updateIfQsharpDocument(evt.document);
-      updateIfOpenQasmDocument(evt.document);
+      updateIfSupportedDocument(evt.document);
     }),
   );
 
   subscriptions.push(
     vscode.workspace.onDidCloseTextDocument((document) => {
       if (
         (isQsharpDocument(document) && !isQsharpNotebookCell(document)) ||
-        (isOpenQasmDocument(document) && !isQsharpNotebookCell(document))
+        (isOpenQasmDocument(document) && !isOpenQasmNotebookCell(document))
       ) {
         languageService.closeDocument(document.uri.toString());
       }
@@ -333,7 +304,7 @@ function registerDocumentUpdateHandlers(
   }
 
   async function updateIfOpenQasmDocument(document: vscode.TextDocument) {
-    if (isOpenQasmDocument(document) && !isQsharpNotebookCell(document)) {
+    if (isOpenQasmDocument(document) && !isOpenQasmNotebookCell(document)) {
       const content = document.getText();
 
       languageService.updateDocument(
@@ -344,9 +315,45 @@ function registerDocumentUpdateHandlers(
     }
   }
 
+  async function updateIfSupportedDocument(document: vscode.TextDocument) {
+    updateIfQsharpDocument(document);
+    updateIfOpenQasmDocument(document);
+  }
+
   return subscriptions;
 }
 
+function determineDocumentType(document: vscode.TextDocument) {
+  return isQsharpNotebookCell(document) || isOpenQasmNotebookCell(document)
+    ? QsharpDocumentType.JupyterCell
+    : isCircuitDocument(document)
+      ? QsharpDocumentType.Circuit
+      : isQsharpDocument(document)
+        ? QsharpDocumentType.Qsharp
+        : isOpenQasmDocument(document)
+          ? QsharpDocumentType.OpenQasm
+          : QsharpDocumentType.Other;
+}
+
+function sendDocumentOpenedEvent(document: vscode.TextDocument) {
+  if (isQsharpDocument(document)) {
+    const documentType = determineDocumentType(document);
+    sendTelemetryEvent(
+      EventType.OpenedDocument,
+      { documentType },
+      { linesOfCode: document.lineCount },
+    );
+  }
+  if (isOpenQasmDocument(document)) {
+    const documentType = QsharpDocumentType.OpenQasm;
+    sendTelemetryEvent(
+      EventType.OpenedDocument,
+      { documentType },
+      { linesOfCode: document.lineCount },
+    );
+  }
+}
+
 function registerConfigurationChangeHandlers(
   languageService: ILanguageService,
 ) {