qsharp-lang 1.1.4-dev → 1.1.5-dev

package/dist/language-service/language-service.d.ts

@@ -1,5 +1,5 @@
 import type { ICodeLens, ICompletionList, IHover, ILocation, INotebookMetadata, IPosition, ISignatureHelp, ITextEdit, IWorkspaceConfiguration, IWorkspaceEdit, VSDiagnostic } from "../../lib/node/qsc_wasm.cjs";
-import { IServiceProxy } from "../worker-proxy.js";
+import { IServiceProxy, ServiceProtocol } from "../workers/common.js";
 type QscWasm = typeof import("../../lib/node/qsc_wasm.cjs");
 export type LanguageServiceEvent = {
     type: "diagnostics";
@@ -71,4 +71,10 @@ export declare class QSharpLanguageService implements ILanguageService {
     }>) => void): void;
     onDiagnostics(uri: string, version: number | undefined, diagnostics: VSDiagnostic[]): Promise<void>;
 }
+/**
+ * The protocol definition to allow running the language service in a worker.
+ *
+ * Not to be confused with "the" LSP (Language Server Protocol).
+ */
+export declare const languageServiceProtocol: ServiceProtocol<ILanguageService, LanguageServiceEvent>;
 export {};

package/dist/language-service/language-service.js

@@ -75,3 +75,30 @@ export class QSharpLanguageService {
         }
     }
 }
+/**
+ * The protocol definition to allow running the language service in a worker.
+ *
+ * Not to be confused with "the" LSP (Language Server Protocol).
+ */
+export const languageServiceProtocol = {
+    class: QSharpLanguageService,
+    methods: {
+        updateConfiguration: "request",
+        updateDocument: "request",
+        updateNotebookDocument: "request",
+        closeDocument: "request",
+        closeNotebookDocument: "request",
+        getCompletions: "request",
+        getHover: "request",
+        getDefinition: "request",
+        getReferences: "request",
+        getSignatureHelp: "request",
+        getRename: "request",
+        prepareRename: "request",
+        getCodeLenses: "request",
+        dispose: "request",
+        addEventListener: "addEventListener",
+        removeEventListener: "removeEventListener",
+    },
+    eventNames: ["diagnostics"],
+};

package/dist/language-service/worker-browser.d.ts

@@ -1 +1 @@
-export declare function messageHandler(e: MessageEvent): void;
+export declare const messageHandler: (e: MessageEvent<any>) => void;

package/dist/language-service/worker-browser.js

@@ -1,32 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import * as wasm from "../../lib/web/qsc_wasm.js";
-import { log } from "../log.js";
-import { QSharpLanguageService } from "./language-service.js";
-import { createLanguageServiceDispatcher } from "./worker-proxy.js";
-let invokeCompiler = null;
+import { createWorker } from "../workers/browser.js";
+import { languageServiceProtocol } from "./language-service.js";
 // This export should be assigned to 'self.onmessage' in a WebWorker
-export function messageHandler(e) {
-    const data = e.data;
-    if (!data.type || typeof data.type !== "string") {
-        log.error(`Unrecognized msg: ${data}`);
-        return;
-    }
-    switch (data.type) {
-        case "init":
-            {
-                log.setLogLevel(data.qscLogLevel);
-                wasm.initSync(data.wasmModule);
-                const languageService = new QSharpLanguageService(wasm);
-                invokeCompiler = createLanguageServiceDispatcher(self.postMessage.bind(self), languageService);
-            }
-            break;
-        default:
-            if (!invokeCompiler) {
-                log.error(`Received message before the compiler was initialized: %o`, data);
-            }
-            else {
-                invokeCompiler(data);
-            }
-    }
-}
+export const messageHandler = createWorker(languageServiceProtocol);

package/dist/language-service/worker-node.js

@@ -1,30 +1,5 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-// This module supports running the qsharp compiler in a Node.js worker thread. It should be
-// used in a Node.js module in a manner similar to the below to create it with the right log level:
-//
-//     const worker = new Worker(join(thisDir,"worker-node.js"), {
-//         workerData: {qscLogLevel: log.getLogLevel() }
-//     });
-import { isMainThread, parentPort, workerData } from "node:worker_threads";
-import * as wasm from "../../lib/node/qsc_wasm.cjs";
-import { log } from "../log.js";
-import { QSharpLanguageService } from "./language-service.js";
-import { createLanguageServiceDispatcher } from "./worker-proxy.js";
-if (isMainThread)
-    throw "Worker script should be loaded in a Worker thread only";
-if (workerData && typeof workerData.qscLogLevel === "number") {
-    log.setLogLevel(workerData.qscLogLevel);
-}
-const port = parentPort; // eslint-disable-line @typescript-eslint/no-non-null-assertion
-const postMessage = port.postMessage.bind(port);
-const compiler = new QSharpLanguageService(wasm);
-const invokeCompiler = createLanguageServiceDispatcher(postMessage, compiler);
-function messageHandler(data) {
-    if (!data.type || typeof data.type !== "string") {
-        log.error(`Unrecognized msg: %O"`, data);
-        return;
-    }
-    invokeCompiler(data);
-}
-port.addListener("message", messageHandler);
+import { createWorker } from "../workers/node.js";
+import { languageServiceProtocol } from "./language-service.js";
+createWorker(languageServiceProtocol);

package/dist/main.d.ts

@@ -1,7 +1,7 @@
+import { ProjectLoader } from "../lib/node/qsc_wasm.cjs";
 import { ICompiler, ICompilerWorker } from "./compiler/compiler.js";
-import { ILanguageService, ILanguageServiceWorker, qsharpLibraryUriScheme } from "./language-service/language-service.js";
 import { IDebugService, IDebugServiceWorker } from "./debug-service/debug-service.js";
-import { ProjectLoader } from "../lib/node/qsc_wasm.cjs";
+import { ILanguageService, ILanguageServiceWorker, qsharpLibraryUriScheme } from "./language-service/language-service.js";
 export { qsharpLibraryUriScheme };
 export declare function getLibrarySourceContent(path: string): Promise<string | undefined>;
 export declare function getCompiler(): ICompiler;

package/dist/main.js

@@ -3,16 +3,11 @@
 // This module is the main entry point for use in Node.js environments. For browser environments,
 // the "./browser.js" file is the entry point module.
 import { createRequire } from "node:module";
-import { Worker } from "node:worker_threads";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
+import { Compiler, compilerProtocol, } from "./compiler/compiler.js";
+import { QSharpDebugService, debugServiceProtocol, } from "./debug-service/debug-service.js";
+import { QSharpLanguageService, languageServiceProtocol, qsharpLibraryUriScheme, } from "./language-service/language-service.js";
 import { log } from "./log.js";
-import { Compiler } from "./compiler/compiler.js";
-import { createCompilerProxy } from "./compiler/worker-proxy.js";
-import { QSharpLanguageService, qsharpLibraryUriScheme, } from "./language-service/language-service.js";
-import { createLanguageServiceProxy } from "./language-service/worker-proxy.js";
-import { QSharpDebugService, } from "./debug-service/debug-service.js";
-import { createDebugServiceProxy } from "./debug-service/worker-proxy.js";
+import { createProxy } from "./workers/node.js";
 export { qsharpLibraryUriScheme };
 let wasm = null;
 const require = createRequire(import.meta.url);
@@ -41,17 +36,7 @@ export function getProjectLoader(readFile, loadDirectory, getManifest) {
     return new wasm.ProjectLoader(readFile, loadDirectory, getManifest);
 }
 export function getCompilerWorker() {
-    const thisDir = dirname(fileURLToPath(import.meta.url));
-    const worker = new Worker(join(thisDir, "./compiler/worker-node.js"), {
-        workerData: { qscLogLevel: log.getLogLevel() },
-    });
-    // Create the proxy which will forward method calls to the worker
-    const proxy = createCompilerProxy(
-    // If you lose the 'this' binding, some environments have issues.
-    worker.postMessage.bind(worker), () => worker.terminate());
-    // Let proxy handle response and event messages from the worker
-    worker.addListener("message", proxy.onMsgFromWorker);
-    return proxy;
+    return createProxy("../compiler/worker-node.js", compilerProtocol);
 }
 export function getDebugService() {
     if (!wasm)
@@ -59,17 +44,7 @@ export function getDebugService() {
     return new QSharpDebugService(wasm);
 }
 export function getDebugServiceWorker() {
-    const thisDir = dirname(fileURLToPath(import.meta.url));
-    const worker = new Worker(join(thisDir, "./debug-service/worker-node.js"), {
-        workerData: { qscLogLevel: log.getLogLevel() },
-    });
-    // Create the proxy which will forward method calls to the worker
-    const proxy = createDebugServiceProxy(
-    // If you lose the 'this' binding, some environments have issues.
-    worker.postMessage.bind(worker), () => worker.terminate());
-    // Let proxy handle response and event messages from the worker
-    worker.addListener("message", proxy.onMsgFromWorker);
-    return proxy;
+    return createProxy("../debug-service/worker-node.js", debugServiceProtocol);
 }
 export function getLanguageService(readFile, listDir, getManifest) {
     if (!wasm)
@@ -77,16 +52,6 @@ export function getLanguageService(readFile, listDir, getManifest) {
     return new QSharpLanguageService(wasm, readFile, listDir, getManifest);
 }
 export function getLanguageServiceWorker() {
-    const thisDir = dirname(fileURLToPath(import.meta.url));
-    const worker = new Worker(join(thisDir, "./language-service/worker-node.js"), {
-        workerData: { qscLogLevel: log.getLogLevel() },
-    });
-    // Create the proxy which will forward method calls to the worker
-    const proxy = createLanguageServiceProxy(
-    // If you lose the 'this' binding, some environments have issues.
-    worker.postMessage.bind(worker), () => worker.terminate());
-    // Let proxy handle response and event messages from the worker
-    worker.addListener("message", proxy.onMsgFromWorker);
-    return proxy;
+    return createProxy("../language-service/worker-node.js", languageServiceProtocol);
 }
 export * as utils from "./utils.js";

package/dist/samples.generated.js

@@ -82,7 +82,7 @@ export default [
     {
         "title": "Dynamics (Resource Estimation)",
         "shots": 1,
-        "code": "/// # Sample\n/// Quantum Dynamics\n///\n/// # Description\n/// This example demonstrates quantum dynamics in a style tailored for\n/// resource estimation. The sample is specifically the simulation\n/// of an Ising model Hamiltonian on an N1xN2 2D lattice using a\n/// fourth-order Trotter Suzuki product formula, assuming\n/// a 2D qubit architecture with nearest-neighbor connectivity.\n/// The is an example of a program that is not amenable to simulating\n/// classically, but can be run through resource estimation to determine\n/// what size of quantum system would be needed to solve the problem.\nnamespace QuantumDynamics {\n\n    open Microsoft.Quantum.Math;\n    open Microsoft.Quantum.Arrays;\n\n\n    @EntryPoint()\n    operation Main() : Unit {\n        // n : Int, m : Int, t: Double, u : Double, tstep : Double\n        \n        let n = 30;\n        let m = 30;\n\n        let J = 1.0;\n        let g = 1.0;\n\n        let totTime = 30.0;\n        let dt = 0.9;\n\n        IsingModel2DSim(n, m, J, g, totTime, dt);\n    }\n\n    /// # Summary\n    /// The function below creates a sequence containing the rotation angles that will be applied with the two operators used in the expansion of the Trotter-Suzuki formula.\n    /// # Input\n    /// ## p (Double) : Constant used for fourth-order formulas\n    /// \n    /// ## dt (Double) : Time-step used to compute rotation angles\n    /// \n    /// ## J (Double) : coefficient for 2-qubit interactions\n    /// \n    /// ## g (Double) : coefficient for transverse field\n    ///\n    /// # Output\n    /// ## values (Double[]) : The list of rotation angles to be applies in sequence with the corresponding operators\n    ///\n    function SetAngleSequence(p : Double, dt : Double, J : Double, g : Double) : Double[] {\n\n        let len1 = 3;\n        let len2 = 3;\n        let valLength = 2*len1+len2+1;\n        mutable values = [0.0, size=valLength];\n\n        let val1 = J*p*dt;\n        let val2 = -g*p*dt;\n        let val3 = J*(1.0 - 3.0*p)*dt/2.0;\n        let val4 = g*(1.0 - 4.0*p)*dt/2.0;\n\n        for i in 0..len1 {\n            \n            if (i % 2 == 0) {\n                set values w/= i <- val1;\n            }\n            else {\n                set values w/= i <- val2;\n            }\n\n        }\n\n        for i in len1+1..len1+len2 {\n            if (i % 2 == 0) {\n                set values w/= i <- val3;\n            }\n            else {\n                set values w/= i <- val4;\n            }\n        }\n\n        for i in len1+len2+1..valLength-1 {\n            if (i % 2 == 0) {\n                set values w/= i <- val1;\n            }\n            else {\n                set values w/= i <- val2;\n            }\n        }\n        return values;\n    }\n\n    /// # Summary\n    /// Applies e^-iX(theta) on all qubits in the 2D lattice as part of simulating the transverse field in the Ising model\n    /// # Input\n    /// ## n (Int) : Lattice size for an n x n lattice\n    /// \n    /// ## qArr (Qubit[][]) : Array of qubits representing the lattice\n    /// \n    /// ## theta (Double) : The angle/time-step for which the unitary simulation is done.\n    /// \n    operation ApplyAllX(n : Int, qArr : Qubit[][], theta : Double) : Unit {\n        // This applies `Rx` with an angle of `2.0 * theta` to all qubits in `qs`\n        // using partial application\n        for row in 0..n-1 {\n            ApplyToEach(Rx(2.0 * theta, _), qArr[row]);\n        }\n    }\n\n    /// # Summary\n    /// Applies e^-iP(theta) where P = Z o Z as part of the repulsion terms.\n    /// # Input\n    /// ## n, m (Int, Int) : Lattice sizes for an n x m lattice\n    /// \n    /// ## qArr (Qubit[]) : Array of qubits representing the lattice\n    /// \n    /// ## theta (Double) : The angle/time-step for which unitary simulation is done.\n    /// \n    /// ## dir (Bool) : Direction is true for vertical direction.\n    ///\n    /// ## grp (Bool) : Group is true for odd starting indices\n    ///\n    operation ApplyDoubleZ(n : Int, m : Int, qArr : Qubit[][], theta : Double, dir : Bool, grp : Bool) : Unit {\n        let start = grp ? 1 | 0;    // Choose either odd or even indices based on group number\n        let P_op = [PauliZ, PauliZ];\n        let c_end = dir ? m-1 | m-2;\n        let r_end = dir ? m-2 | m-1;\n\n        for row in 0..r_end {\n            for col in start..2..c_end {    // Iterate through even or odd columns based on `grp`\n\n                let row2 = dir ? row+1 | row;\n                let col2 = dir ? col | col+1;\n\n                Exp(P_op, theta, [qArr[row][col], qArr[row2][col2]]);\n            }\n        }\n    }\n\n    /// # Summary\n    /// The main function that takes in various parameters and calls the operations needed to simulate fourth order Trotterizatiuon of the Ising Hamiltonian for a given time-step\n    /// # Input\n    /// ## N1, N2 (Int, Int) : Lattice sizes for an N1 x N2 lattice\n    /// \n    /// ## J (Double) : coefficient for 2-qubit interactions\n    /// \n    /// ## g (Double) : coefficient for transverse field\n    ///\n    /// ## totTime (Double) : The total time-step for which unitary simulation is done.\n    ///\n    /// ## dt (Double) : The time the simulation is done for each timestep\n    ///\n    operation IsingModel2DSim(N1 : Int, N2 : Int, J : Double, g : Double, totTime : Double, dt : Double) : Unit {\n        \n        use qs = Qubit[N1*N2];\n        let qubitArray = Chunks(N2, qs); // qubits are re-arranged to be in an N1 x N2 array\n\n        let p = 1.0 / (4.0 - 4.0^(1.0 / 3.0));\n        let t = Ceiling(totTime / dt);\n\n        let seqLen = 10 * t + 1;\n\n        let angSeq = SetAngleSequence(p, dt, J, g);\n\n        for i in 0..seqLen - 1 {\n            let theta = (i==0 or i==seqLen-1) ? J*p*dt/2.0 | angSeq[i%10];\n\n            // for even indexes\n            if i % 2 == 0 {\n                ApplyAllX(N1, qubitArray, theta);\n            } else {\n                // iterate through all possible combinations for `dir` and `grp`.\n                for (dir, grp) in [(true, true), (true, false), (false, true), (false, false)] {\n                    ApplyDoubleZ(N1, N2, qubitArray, theta, dir, grp);\n                }\n            }\n        }\n    }\n\n}\n",
+        "code": "/// # Sample\n/// Quantum Dynamics\n///\n/// # Description\n/// This example demonstrates quantum dynamics in a style tailored for\n/// resource estimation. The sample is specifically the simulation\n/// of an Ising model Hamiltonian on an N1xN2 2D lattice using a\n/// fourth-order Trotter Suzuki product formula, assuming\n/// a 2D qubit architecture with nearest-neighbor connectivity.\n/// The is an example of a program that is not amenable to simulating\n/// classically, but can be run through resource estimation to determine\n/// what size of quantum system would be needed to solve the problem.\nnamespace QuantumDynamics {\n\n    open Microsoft.Quantum.Math;\n    open Microsoft.Quantum.Arrays;\n\n\n    @EntryPoint()\n    operation Main() : Unit {\n        // n : Int, m : Int, t: Double, u : Double, tstep : Double\n\n        let n = 10;\n        let m = 10;\n\n        let J = 1.0;\n        let g = 1.0;\n\n        let totTime = 30.0;\n        let dt = 0.9;\n\n        IsingModel2DSim(n, m, J, g, totTime, dt);\n    }\n\n    /// # Summary\n    /// The function below creates a sequence containing the rotation angles that will be applied with the two operators used in the expansion of the Trotter-Suzuki formula.\n    /// # Input\n    /// ## p (Double) : Constant used for fourth-order formulas\n    ///\n    /// ## dt (Double) : Time-step used to compute rotation angles\n    ///\n    /// ## J (Double) : coefficient for 2-qubit interactions\n    ///\n    /// ## g (Double) : coefficient for transverse field\n    ///\n    /// # Output\n    /// ## values (Double[]) : The list of rotation angles to be applies in sequence with the corresponding operators\n    ///\n    function SetAngleSequence(p : Double, dt : Double, J : Double, g : Double) : Double[] {\n\n        let len1 = 3;\n        let len2 = 3;\n        let valLength = 2*len1+len2+1;\n        mutable values = [0.0, size=valLength];\n\n        let val1 = J*p*dt;\n        let val2 = -g*p*dt;\n        let val3 = J*(1.0 - 3.0*p)*dt/2.0;\n        let val4 = g*(1.0 - 4.0*p)*dt/2.0;\n\n        for i in 0..len1 {\n\n            if (i % 2 == 0) {\n                set values w/= i <- val1;\n            }\n            else {\n                set values w/= i <- val2;\n            }\n\n        }\n\n        for i in len1+1..len1+len2 {\n            if (i % 2 == 0) {\n                set values w/= i <- val3;\n            }\n            else {\n                set values w/= i <- val4;\n            }\n        }\n\n        for i in len1+len2+1..valLength-1 {\n            if (i % 2 == 0) {\n                set values w/= i <- val1;\n            }\n            else {\n                set values w/= i <- val2;\n            }\n        }\n        return values;\n    }\n\n    /// # Summary\n    /// Applies e^-iX(theta) on all qubits in the 2D lattice as part of simulating the transverse field in the Ising model\n    /// # Input\n    /// ## n (Int) : Lattice size for an n x n lattice\n    ///\n    /// ## qArr (Qubit[][]) : Array of qubits representing the lattice\n    ///\n    /// ## theta (Double) : The angle/time-step for which the unitary simulation is done.\n    ///\n    operation ApplyAllX(n : Int, qArr : Qubit[][], theta : Double) : Unit {\n        // This applies `Rx` with an angle of `2.0 * theta` to all qubits in `qs`\n        // using partial application\n        for row in 0..n-1 {\n            ApplyToEach(Rx(2.0 * theta, _), qArr[row]);\n        }\n    }\n\n    /// # Summary\n    /// Applies e^-iP(theta) where P = Z o Z as part of the repulsion terms.\n    /// # Input\n    /// ## n, m (Int, Int) : Lattice sizes for an n x m lattice\n    ///\n    /// ## qArr (Qubit[]) : Array of qubits representing the lattice\n    ///\n    /// ## theta (Double) : The angle/time-step for which unitary simulation is done.\n    ///\n    /// ## dir (Bool) : Direction is true for vertical direction.\n    ///\n    /// ## grp (Bool) : Group is true for odd starting indices\n    ///\n    operation ApplyDoubleZ(n : Int, m : Int, qArr : Qubit[][], theta : Double, dir : Bool, grp : Bool) : Unit {\n        let start = grp ? 1 | 0;    // Choose either odd or even indices based on group number\n        let P_op = [PauliZ, PauliZ];\n        let c_end = dir ? m-1 | m-2;\n        let r_end = dir ? m-2 | m-1;\n\n        for row in 0..r_end {\n            for col in start..2..c_end {    // Iterate through even or odd columns based on `grp`\n\n                let row2 = dir ? row+1 | row;\n                let col2 = dir ? col | col+1;\n\n                Exp(P_op, theta, [qArr[row][col], qArr[row2][col2]]);\n            }\n        }\n    }\n\n    /// # Summary\n    /// The main function that takes in various parameters and calls the operations needed to simulate fourth order Trotterizatiuon of the Ising Hamiltonian for a given time-step\n    /// # Input\n    /// ## N1, N2 (Int, Int) : Lattice sizes for an N1 x N2 lattice\n    ///\n    /// ## J (Double) : coefficient for 2-qubit interactions\n    ///\n    /// ## g (Double) : coefficient for transverse field\n    ///\n    /// ## totTime (Double) : The total time-step for which unitary simulation is done.\n    ///\n    /// ## dt (Double) : The time the simulation is done for each timestep\n    ///\n    operation IsingModel2DSim(N1 : Int, N2 : Int, J : Double, g : Double, totTime : Double, dt : Double) : Unit {\n\n        use qs = Qubit[N1*N2];\n        let qubitArray = Chunks(N2, qs); // qubits are re-arranged to be in an N1 x N2 array\n\n        let p = 1.0 / (4.0 - 4.0^(1.0 / 3.0));\n        let t = Ceiling(totTime / dt);\n\n        let seqLen = 10 * t + 1;\n\n        let angSeq = SetAngleSequence(p, dt, J, g);\n\n        for i in 0..seqLen - 1 {\n            let theta = (i==0 or i==seqLen-1) ? J*p*dt/2.0 | angSeq[i%10];\n\n            // for even indexes\n            if i % 2 == 0 {\n                ApplyAllX(N1, qubitArray, theta);\n            } else {\n                // iterate through all possible combinations for `dir` and `grp`.\n                for (dir, grp) in [(true, true), (true, false), (false, true), (false, false)] {\n                    ApplyDoubleZ(N1, N2, qubitArray, theta, dir, grp);\n                }\n            }\n        }\n    }\n\n}\n",
         "omitFromTests": true
     },
     {

package/dist/workers/browser.d.ts

@@ -0,0 +1,21 @@
+import { IServiceEventMessage, IServiceProxy, ServiceMethods, ServiceProtocol } from "./common.js";
+/**
+ * Creates an initializes a service, setting it up to receive requests.
+ * This function to be is used in the worker.
+ *
+ * @param serviceProtocol An object that describes the service: its constructor, methods and events
+ * @returns A message handler to be assigned to the `self.onmessage` handler in a web worker
+ */
+export declare function createWorker<TService extends ServiceMethods<TService>, TServiceEventMsg extends IServiceEventMessage>(serviceProtocol: ServiceProtocol<TService, TServiceEventMsg>): (e: MessageEvent) => void;
+/**
+ * Creates and initializes a service in a web worker, and returns a proxy for the service
+ * to be used from the main thread.
+ *
+ * @param workerArg The service web worker or the URL of the web worker script.
+ * @param wasmModule The wasm module to initialize the service with
+ * @param serviceProtocol An object that describes the service: its constructor, methods and events
+ * @returns A proxy object that implements the service interface.
+ *   This interface can now be used as if calling into the real service,
+ *   and the calls will be proxied to the web worker.
+ */
+export declare function createProxy<TService extends ServiceMethods<TService>, TServiceEventMsg extends IServiceEventMessage>(workerArg: string | Worker, wasmModule: WebAssembly.Module, serviceProtocol: ServiceProtocol<TService, TServiceEventMsg>): TService & IServiceProxy;

package/dist/workers/browser.js

@@ -0,0 +1,67 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import * as wasm from "../../lib/web/qsc_wasm.js";
+import { log } from "../log.js";
+import { createProxyInternal, initService, } from "./common.js";
+/**
+ * Creates an initializes a service, setting it up to receive requests.
+ * This function to be is used in the worker.
+ *
+ * @param serviceProtocol An object that describes the service: its constructor, methods and events
+ * @returns A message handler to be assigned to the `self.onmessage` handler in a web worker
+ */
+export function createWorker(serviceProtocol) {
+    let invokeService = null;
+    // This export should be assigned to 'self.onmessage' in a WebWorker
+    return function messageHandler(e) {
+        const data = e.data;
+        if (!data.type || typeof data.type !== "string") {
+            log.error(`Unrecognized msg: ${data}`);
+            return;
+        }
+        switch (data.type) {
+            case "init":
+                {
+                    wasm.initSync(data.wasmModule);
+                    invokeService = initService(self.postMessage.bind(self), serviceProtocol, wasm, data.qscLogLevel);
+                }
+                break;
+            default:
+                if (!invokeService) {
+                    log.error(`Received message before the service was initialized: %o`, data);
+                }
+                else {
+                    invokeService(data);
+                }
+        }
+    };
+}
+/**
+ * Creates and initializes a service in a web worker, and returns a proxy for the service
+ * to be used from the main thread.
+ *
+ * @param workerArg The service web worker or the URL of the web worker script.
+ * @param wasmModule The wasm module to initialize the service with
+ * @param serviceProtocol An object that describes the service: its constructor, methods and events
+ * @returns A proxy object that implements the service interface.
+ *   This interface can now be used as if calling into the real service,
+ *   and the calls will be proxied to the web worker.
+ */
+export function createProxy(workerArg, wasmModule, serviceProtocol) {
+    // Create or use the WebWorker
+    const worker = typeof workerArg === "string" ? new Worker(workerArg) : workerArg;
+    // Send it the Wasm module to instantiate
+    worker.postMessage({
+        type: "init",
+        wasmModule,
+        qscLogLevel: log.getLogLevel(),
+    });
+    // If you lose the 'this' binding, some environments have issues
+    const postMessage = worker.postMessage.bind(worker);
+    const onTerminate = () => worker.terminate();
+    // Create the proxy which will forward method calls to the worker
+    const proxy = createProxyInternal(postMessage, onTerminate, serviceProtocol.methods);
+    // Let proxy handle response and event messages from the worker
+    worker.onmessage = (ev) => proxy.onMsgFromWorker(ev.data);
+    return proxy;
+}

package/dist/{worker-proxy.d.ts → workers/common.d.ts}

@@ -1,17 +1,34 @@
+type Wasm = typeof import("../../lib/node/qsc_wasm.cjs");
+/**
+ * Describes a service that can be run in a worker.
+ */
+export interface ServiceProtocol<TService extends ServiceMethods<TService>, TServiceEventMsg extends IServiceEventMessage> {
+    /** The concrete class that implements the service. */
+    class: {
+        new (wasmModule: Wasm): TService;
+    };
+    /** Methods that can be proxied from the main thread to the worker. @see MethodMap*/
+    methods: MethodMap<TService>;
+    /** Events that can be received by the main thread from the worker. */
+    eventNames: TServiceEventMsg["type"][];
+}
 /**
  * Used as a type constraint for a "service", i.e. an object
  * we can create proxy methods for. The type shouldn't define
  * any non-method properties.
  */
-type ServiceMethods<T> = {
+export type ServiceMethods<T> = {
     [x in keyof T]: (...args: any[]) => any;
 };
 /**
  * Defines the service methods that the proxy will handle and their types.
+ *
  * "request" is a normal async method.
- * "requestWithProgress" methods take an @see IServiceEventTarget to
+ *
+ * "requestWithProgress" methods take an `IServiceEventTarget` to
  *   communicate events back to the main thread as they run. They also set
  *   the service state to "busy" while they run.
+ *
  * "addEventListener" and "removeEventListener" methods are used to
  *   subscribe to events from the service.
  */
@@ -52,7 +69,7 @@ export type EventMessage<TEventMsg extends IServiceEventMessage> = {
     messageType: "event";
 } & TEventMsg;
 /** Used as a constraint for events defined by the service */
-interface IServiceEventMessage {
+export interface IServiceEventMessage {
     type: string;
     detail: unknown;
 }
@@ -78,18 +95,18 @@ export interface IServiceEventTarget<TEvents extends IServiceEventMessage> {
  * @returns The proxy object. The caller should then set the onMsgFromWorker
  * property to a callback that will receive messages from the worker.
  */
-export declare function createProxy<TService extends ServiceMethods<TService>, TServiceEventMsg extends IServiceEventMessage>(postMessage: (msg: RequestMessage<TService>) => void, terminator: () => void, methods: MethodMap<TService>): TService & IServiceProxy & {
+export declare function createProxyInternal<TService extends ServiceMethods<TService>, TServiceEventMsg extends IServiceEventMessage>(postMessage: (msg: RequestMessage<TService>) => void, terminator: () => void, methods: MethodMap<TService>): TService & IServiceProxy & {
     onMsgFromWorker: (msg: ResponseMessage<TService> | EventMessage<TServiceEventMsg>) => void;
 };
 /**
- * Function to wrap a service in a dispatcher. To be used in the worker thread.
+ * Creates and initializes the actual service. To be used in the worker thread.
  *
- * @param service The service to be wrapped
- * @param methods A map of method names. Should match the list passed into @see createProxy.
- * @param eventNames The list of event names that the service can emit
  * @param postMessage A function to post messages back to the main thread
+ * @param serviceProtocol An object that describes the service: its constructor, methods and events
+ * @param wasm The wasm module to initialize the service with
+ * @param qscLogLevel The log level to initialize the service with
  * @returns A function that takes a message and invokes the corresponding
  * method on the service. The caller should then set this method as a message handler.
  */
-export declare function createDispatcher<TService extends ServiceMethods<TService>, TServiceEventMsg extends IServiceEventMessage>(postMessage: (msg: ResponseMessage<TService> | EventMessage<TServiceEventMsg>) => void, service: TService, methods: MethodMap<TService>, eventNames: TServiceEventMsg["type"][]): (req: RequestMessage<TService>) => any;
+export declare function initService<TService extends ServiceMethods<TService>, TServiceEventMsg extends IServiceEventMessage>(postMessage: (msg: ResponseMessage<TService> | EventMessage<TServiceEventMsg>) => void, serviceProtocol: ServiceProtocol<TService, TServiceEventMsg>, wasm: Wasm, qscLogLevel?: number): (req: RequestMessage<TService>) => Promise<void>;
 export {};

package/dist/{worker-proxy.js → workers/common.js}

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { log } from "./log.js";
+import { log } from "../log.js";
 /*
 The WorkerProxy works by queuing up requests to send over to the Worker, only
 ever having one in flight at a time. By queuing on the caller side, this allows
@@ -23,7 +23,7 @@ complete the request.
  * @returns The proxy object. The caller should then set the onMsgFromWorker
  * property to a callback that will receive messages from the worker.
  */
-export function createProxy(postMessage, terminator, methods) {
+export function createProxyInternal(postMessage, terminator, methods) {
     const queue = [];
     const eventTarget = new EventTarget();
     let curr;
@@ -172,13 +172,13 @@ export function createProxy(postMessage, terminator, methods) {
  * Function to wrap a service in a dispatcher. To be used in the worker thread.
  *
  * @param service The service to be wrapped
- * @param methods A map of method names. Should match the list passed into @see createProxy.
+ * @param methods A map of method names. Should match the list passed into @see createProxyInternal.
  * @param eventNames The list of event names that the service can emit
  * @param postMessage A function to post messages back to the main thread
  * @returns A function that takes a message and invokes the corresponding
  * method on the service. The caller should then set this method as a message handler.
  */
-export function createDispatcher(postMessage, service, methods, eventNames) {
+function createDispatcher(postMessage, service, methods, eventNames) {
     log.debug("Worker: Constructing WorkerEventHandler");
     function logAndPost(msg) {
         log.debug("Worker: Sending %s message from worker: %o", msg.messageType, msg);
@@ -224,3 +224,32 @@ export function createDispatcher(postMessage, service, methods, eventNames) {
         }));
     };
 }
+/**
+ * Creates and initializes the actual service. To be used in the worker thread.
+ *
+ * @param postMessage A function to post messages back to the main thread
+ * @param serviceProtocol An object that describes the service: its constructor, methods and events
+ * @param wasm The wasm module to initialize the service with
+ * @param qscLogLevel The log level to initialize the service with
+ * @returns A function that takes a message and invokes the corresponding
+ * method on the service. The caller should then set this method as a message handler.
+ */
+export function initService(postMessage, serviceProtocol, wasm, qscLogLevel) {
+    function telemetryHandler(telemetry) {
+        postMessage({
+            messageType: "event",
+            type: "telemetry-event",
+            detail: telemetry,
+        });
+    }
+    if (qscLogLevel !== undefined) {
+        log.setLogLevel(qscLogLevel);
+    }
+    // Set up logging and telemetry as soon as possible after instantiating
+    log.onLevelChanged = (level) => wasm.setLogLevel(level);
+    log.setTelemetryCollector(telemetryHandler);
+    wasm.initLogging(log.logWithLevel, log.getLogLevel());
+    // Create the actual service and return the dispatcher method
+    const service = new serviceProtocol.class(wasm);
+    return createDispatcher(postMessage, service, serviceProtocol.methods, serviceProtocol.eventNames);
+}

package/dist/workers/node.d.ts

@@ -0,0 +1,20 @@
+import { IServiceEventMessage, IServiceProxy, ServiceMethods, ServiceProtocol } from "./common.js";
+/**
+ * Creates an initializes a service, setting it up to receive requests.
+ * This function to be is used in the worker.
+ *
+ * @param serviceProtocol An object that describes the service: its constructor, methods and events
+ */
+export declare function createWorker<TService extends ServiceMethods<TService>, TServiceEventMsg extends IServiceEventMessage>(protocol: ServiceProtocol<TService, TServiceEventMsg>): void;
+/**
+ * Creates and initializes a service in a worker thread, and returns a proxy for the service
+ * to be used from the main thread.
+ *
+ * @param workerArg The the URL of the service web worker script.
+ * @param wasmModule The wasm module to initialize the service with
+ * @param serviceProtocol An object that describes the service: its constructor, methods and events
+ * @returns A proxy object that implements the service interface.
+ *   This interface can now be used as if calling into the real service,
+ *   and the calls will be proxied to the web worker.
+ */
+export declare function createProxy<TService extends ServiceMethods<TService>, TServiceEventMsg extends IServiceEventMessage>(workerArg: string, serviceProtocol: ServiceProtocol<TService, TServiceEventMsg>): TService & IServiceProxy;

package/dist/workers/node.js

@@ -0,0 +1,55 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { Worker, isMainThread, parentPort, workerData, } from "node:worker_threads";
+import * as wasm from "../../lib/node/qsc_wasm.cjs";
+import { log } from "../log.js";
+import { createProxyInternal, initService, } from "./common.js";
+/**
+ * Creates an initializes a service, setting it up to receive requests.
+ * This function to be is used in the worker.
+ *
+ * @param serviceProtocol An object that describes the service: its constructor, methods and events
+ */
+export function createWorker(protocol) {
+    if (isMainThread)
+        throw "Worker script should be loaded in a Worker thread only";
+    const port = parentPort; // eslint-disable-line @typescript-eslint/no-non-null-assertion
+    const postMessage = port.postMessage.bind(port);
+    const invokeService = initService(postMessage, protocol, wasm, workerData && typeof workerData.qscLogLevel === "number"
+        ? workerData.qscLogLevel
+        : undefined);
+    function messageHandler(data) {
+        if (!data.type || typeof data.type !== "string") {
+            log.error(`Unrecognized msg: %O"`, data);
+            return;
+        }
+        invokeService(data);
+    }
+    port.addListener("message", messageHandler);
+}
+/**
+ * Creates and initializes a service in a worker thread, and returns a proxy for the service
+ * to be used from the main thread.
+ *
+ * @param workerArg The the URL of the service web worker script.
+ * @param wasmModule The wasm module to initialize the service with
+ * @param serviceProtocol An object that describes the service: its constructor, methods and events
+ * @returns A proxy object that implements the service interface.
+ *   This interface can now be used as if calling into the real service,
+ *   and the calls will be proxied to the web worker.
+ */
+export function createProxy(workerArg, serviceProtocol) {
+    const thisDir = dirname(fileURLToPath(import.meta.url));
+    const worker = new Worker(join(thisDir, workerArg), {
+        workerData: { qscLogLevel: log.getLogLevel() },
+    });
+    // Create the proxy which will forward method calls to the worker
+    const proxy = createProxyInternal(
+    // If you lose the 'this' binding, some environments have issues.
+    worker.postMessage.bind(worker), () => worker.terminate(), serviceProtocol.methods);
+    // Let proxy handle response and event messages from the worker
+    worker.addListener("message", proxy.onMsgFromWorker);
+    return proxy;
+}

package/docs/Microsoft.Quantum.Arrays/All.md

@@ -1,19 +1,17 @@
 ---
-uid: Microsoft.Quantum.Arrays.All
+uid: Qdk.Microsoft.Quantum.Arrays.All
 title: All function
-ms.date: 02/16/2024 12:00:00 AM
+ms.date: 02/23/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Microsoft.Quantum.Arrays
 qsharp.name: All
-qsharp.summary: Given an array and a predicate that is defined
-for the elements of the array, and checks if all elements of the
-array satisfy the predicate.
+qsharp.summary: Given an array and a predicate that is defined for the elements of the array, and checks if all elements of the array satisfy the predicate.
 ---
 
 # All function
 
-Namespace: [Microsoft.Quantum.Arrays](xref:Microsoft.Quantum.Arrays)
+Namespace: Microsoft.Quantum.Arrays
 
 ```qsharp
 function All<'T>(predicate : ('T -> Bool), array : 'T[]) : Bool

package/docs/Microsoft.Quantum.Arrays/Any.md

@@ -1,19 +1,17 @@
 ---
-uid: Microsoft.Quantum.Arrays.Any
+uid: Qdk.Microsoft.Quantum.Arrays.Any
 title: Any function
-ms.date: 02/16/2024 12:00:00 AM
+ms.date: 02/23/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Microsoft.Quantum.Arrays
 qsharp.name: Any
-qsharp.summary: Given an array and a predicate that is defined
-for the elements of the array, checks if at least one element of
-the array satisfies the predicate.
+qsharp.summary: Given an array and a predicate that is defined for the elements of the array, checks if at least one element of the array satisfies the predicate.
 ---
 
 # Any function
 
-Namespace: [Microsoft.Quantum.Arrays](xref:Microsoft.Quantum.Arrays)
+Namespace: Microsoft.Quantum.Arrays
 
 ```qsharp
 function Any<'T>(predicate : ('T -> Bool), array : 'T[]) : Bool

package/docs/Microsoft.Quantum.Arrays/Chunks.md

@@ -1,7 +1,7 @@
 ---
-uid: Microsoft.Quantum.Arrays.Chunks
+uid: Qdk.Microsoft.Quantum.Arrays.Chunks
 title: Chunks function
-ms.date: 02/16/2024 12:00:00 AM
+ms.date: 02/23/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Microsoft.Quantum.Arrays
@@ -11,7 +11,7 @@ qsharp.summary: Splits an array into multiple parts of equal length.
 
 # Chunks function
 
-Namespace: [Microsoft.Quantum.Arrays](xref:Microsoft.Quantum.Arrays)
+Namespace: Microsoft.Quantum.Arrays
 
 ```qsharp
 function Chunks<'T>(chunkSize : Int, array : 'T[]) : 'T[][]