-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Circuit code lens and webview showing rendered circuit in VS Code. Debugging not included - that will be in the next PR. --------- Co-authored-by: orpuente-MS <156957451+orpuente-MS@users.noreply.github.com>
- Loading branch information
1 parent
397307c
commit ea7a8bd
Showing
18 changed files
with
498 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| import { | ||
| IOperationInfo, | ||
| VSDiagnostic, | ||
| getCompilerWorker, | ||
| log, | ||
| } from "qsharp-lang"; | ||
| import { Uri, window } from "vscode"; | ||
| import { basename, isQsharpDocument } from "./common"; | ||
| import { getTarget, getTargetFriendlyName } from "./config"; | ||
| import { loadProject } from "./projectSystem"; | ||
| import { EventType, UserFlowStatus, sendTelemetryEvent } from "./telemetry"; | ||
| import { getRandomGuid } from "./utils"; | ||
| import { sendMessageToPanel } from "./webviewPanel"; | ||
|
|
||
| const compilerRunTimeoutMs = 1000 * 60 * 5; // 5 minutes | ||
|
|
||
| export async function showCircuitCommand( | ||
| extensionUri: Uri, | ||
| operation: IOperationInfo | undefined, | ||
| ) { | ||
| const associationId = getRandomGuid(); | ||
| sendTelemetryEvent(EventType.TriggerCircuit, { associationId }, {}); | ||
|
|
||
| const compilerWorkerScriptPath = Uri.joinPath( | ||
| extensionUri, | ||
| "./out/compilerWorker.js", | ||
| ).toString(); | ||
|
|
||
| const editor = window.activeTextEditor; | ||
| if (!editor || !isQsharpDocument(editor.document)) { | ||
| throw new Error("The currently active window is not a Q# file"); | ||
| } | ||
|
|
||
| sendMessageToPanel("circuit", true, undefined); | ||
|
|
||
| let timeout = false; | ||
|
|
||
| // Start the worker, run the code, and send the results to the webview | ||
| const worker = getCompilerWorker(compilerWorkerScriptPath); | ||
| const compilerTimeout = setTimeout(() => { | ||
| timeout = true; | ||
| sendTelemetryEvent(EventType.CircuitEnd, { | ||
| associationId, | ||
| reason: "timeout", | ||
| flowStatus: UserFlowStatus.Aborted, | ||
| }); | ||
| log.info("terminating circuit worker due to timeout"); | ||
| worker.terminate(); | ||
| }, compilerRunTimeoutMs); | ||
| let title; | ||
| let subtitle; | ||
| const targetProfile = getTarget(); | ||
| const sources = await loadProject(editor.document.uri); | ||
| if (operation) { | ||
| title = `${operation.operation} with ${operation.totalNumQubits} input qubits`; | ||
| subtitle = `${getTargetFriendlyName(targetProfile)} `; | ||
| } else { | ||
| title = basename(editor.document.uri.path) || "Circuit"; | ||
| subtitle = `${getTargetFriendlyName(targetProfile)}`; | ||
| } | ||
|
|
||
| try { | ||
| sendTelemetryEvent(EventType.CircuitStart, { associationId }, {}); | ||
| const circuit = await worker.getCircuit(sources, targetProfile, operation); | ||
| clearTimeout(compilerTimeout); | ||
|
|
||
| const message = { | ||
| command: "circuit", | ||
| circuit, | ||
| title, | ||
| subtitle, | ||
| }; | ||
| sendMessageToPanel("circuit", false, message); | ||
|
|
||
| sendTelemetryEvent(EventType.CircuitEnd, { | ||
| associationId, | ||
| flowStatus: UserFlowStatus.Succeeded, | ||
| }); | ||
| } catch (e: any) { | ||
| log.error("Circuit error. ", e.toString()); | ||
| clearTimeout(compilerTimeout); | ||
|
|
||
| const errors: [string, VSDiagnostic][] = | ||
| typeof e === "string" ? JSON.parse(e) : undefined; | ||
| let errorHtml = "There was an error generating the circuit."; | ||
| if (errors) { | ||
| errorHtml = errorsToHtml(errors); | ||
| } | ||
|
|
||
| if (!timeout) { | ||
| sendTelemetryEvent(EventType.CircuitEnd, { | ||
| associationId, | ||
| reason: errors && errors[0] ? errors[0][1].code : undefined, | ||
| flowStatus: UserFlowStatus.Failed, | ||
| }); | ||
| } | ||
|
|
||
| const message = { | ||
| command: "circuit", | ||
| title, | ||
| subtitle, | ||
| errorHtml, | ||
| }; | ||
| sendMessageToPanel("circuit", false, message); | ||
| } finally { | ||
| log.info("terminating circuit worker"); | ||
| worker.terminate(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Formats an array of compiler/runtime errors into HTML to be presented to the user. | ||
| * | ||
| * @param {[string, VSDiagnostic][]} errors | ||
| * The string is the document URI or "<project>" if the error isn't associated with a specific document. | ||
| * The VSDiagnostic is the error information. | ||
| * | ||
| * @returns {string} - The HTML formatted errors, to be set as the inner contents of a container element. | ||
| */ | ||
| function errorsToHtml(errors: [string, VSDiagnostic][]): string { | ||
| let errorHtml = ""; | ||
| for (const error of errors) { | ||
| let location; | ||
| const document = error[0]; | ||
| try { | ||
| // If the error location is a document URI, create a link to that document. | ||
| // We use the `vscode.open` command (https://code.visualstudio.com/api/references/commands#commands) | ||
| // to open the document in the editor. | ||
| // The line and column information is displayed, but are not part of the link. | ||
| // | ||
| // At the time of writing this is the only way we know to create a direct | ||
| // link to a Q# document from a Web View. | ||
| // | ||
| // If we wanted to handle line/column information from the link, an alternate | ||
| // implementation might be having our own command that navigates to the correct | ||
| // location. Then this would be a link to that command instead. | ||
| const uri = Uri.parse(document, true); | ||
| const openCommandUri = Uri.parse( | ||
| `command:vscode.open?${encodeURIComponent(JSON.stringify([uri]))}`, | ||
| true, | ||
| ); | ||
| const fsPath = escapeHtml(uri.fsPath); | ||
| const lineColumn = escapeHtml( | ||
| `:${error[1].range.start.line}:${error[1].range.start.character}`, | ||
| ); | ||
| location = `<a href="${openCommandUri}">${fsPath}</a>${lineColumn}`; | ||
| } catch (e) { | ||
| // Likely could not parse document URI - it must be a project level error, | ||
| // use the document name directly | ||
| location = escapeHtml(error[0]); | ||
| } | ||
|
|
||
| const message = escapeHtml( | ||
| `(${error[1].code}) ${error[1].message}`, | ||
| ).replace("\n", "<br/>"); | ||
|
|
||
| errorHtml += `${location}: ${message}<br/>`; | ||
| } | ||
| return errorHtml; | ||
| } | ||
|
|
||
| function escapeHtml(unsafe: string): string { | ||
| return unsafe | ||
| .replace(/&/g, "&") | ||
| .replace(/</g, "<") | ||
| .replace(/>/g, ">") | ||
| .replace(/"/g, """) | ||
| .replace(/'/g, "'"); | ||
| } |
Oops, something went wrong.