Add fixes

Author: Kartik Raj

.gitignore

@@ -5,6 +5,7 @@ log.log
 **/node_modules
 *.pyc
 *.vsix
+envVars.txt
 **/.vscode/.ropeproject/**
 **/testFiles/**/.cache/**
 *.noseids

build/webpack/webpack.extension.config.js

@@ -19,6 +19,10 @@ const config = {
     target: 'node',
     entry: {
         extension: './src/client/extension.ts',
+        'shellExec.worker': './src/client/common/process/worker/shellExec.worker.ts',
+        'plainExec.worker': './src/client/common/process/worker/plainExec.worker.ts',
+        'registryKeys.worker': 'src/client/pythonEnvironments/common/registryKeys.worker.ts',
+        'registryValues.worker': 'src/client/pythonEnvironments/common/registryValues.worker.ts',
     },
     devtool: 'source-map',
     node: {
@@ -51,6 +55,10 @@ const config = {
                     },
                 ],
             },
+            {
+                test: /\.worker\.js$/,
+                use: { loader: 'worker-loader' },
+            },
         ],
     },
     externals: [

package-lock.json

@@ -1659,6 +1659,7 @@
         "typescript": "4.5.5",
         "uuid": "^8.3.2",
         "webpack": "^5.76.0",
+        "worker-loader": "^3.0.8",
         "webpack-bundle-analyzer": "^4.5.0",
         "webpack-cli": "^4.9.2",
         "webpack-fix-default-import-plugin": "^1.0.3",

package.json

@@ -2,13 +2,25 @@
 // Licensed under the MIT License.
 
 import { Worker } from 'worker_threads';
-import { traceError } from '../../../logging';
+import { traceVerbose, traceError } from '../../../logging/index';
 
+/**
+ * Executes a worker file. Make sure to declare the worker file as a entry in the webpack config.
+ * @param workerFileName Filename of the worker file to execute, it has to end with ".worker.js" for webpack to bundle it.
+ * @param workerData Arguments to the worker file.
+ * @returns
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
 export async function executeWorkerFile(workerFileName: string, workerData: any): Promise<any> {
+    if (!workerFileName.endsWith('.worker.js')) {
+        throw new Error('Worker file must end with ".worker.js" for webpack to bundle webworkers');
+    }
     return new Promise((resolve, reject) => {
+        traceVerbose(`Starting worker ${workerFileName} with data ${JSON.stringify(workerData)}`);
         const worker = new Worker(workerFileName, { workerData });
+        traceVerbose(`Started worker ${workerFileName}`);
         worker.on('message', (msg: { err: Error; res: unknown }) => {
+            traceVerbose(`Worker ${workerFileName} sent message ${JSON.stringify(msg)}`);
             if (msg.err) {
                 reject(msg.err);
             }
@@ -19,6 +31,7 @@ export async function executeWorkerFile(workerFileName: string, workerData: any)
             reject(ex);
         });
         worker.on('exit', (code) => {
+            traceVerbose(`Worker ${workerFileName} exited with code ${code}`);
             if (code !== 0) {
                 reject(new Error(`Worker ${workerFileName} stopped with exit code ${code}`));
             }

src/client/common/process/worker/main.ts

@@ -7,7 +7,7 @@ import { executeWorkerFile } from './main';
 import { ExecutionResult, ShellOptions } from './types';
 
 export function workerShellExec(command: string, options: ShellOptions): Promise<ExecutionResult<string>> {
-    return executeWorkerFile(path.join(__dirname, 'shellExecWorker.js'), {
+    return executeWorkerFile(path.join(__dirname, 'shellExec.worker.js'), {
         command,
         options,
     });
@@ -18,7 +18,7 @@ export function workerPlainExec(
     args: string[],
     options: SpawnOptions = {},
 ): Promise<ExecutionResult<string>> {
-    return executeWorkerFile(path.join(__dirname, 'plainExecWorker.js'), {
+    return executeWorkerFile(path.join(__dirname, 'plainExec.worker.js'), {
         file,
         args,
         options,

src/client/common/process/worker/plainExecWorker.ts renamed to src/client/common/process/worker/plainExec.worker.ts

@@ -39,7 +39,7 @@ export async function readRegistryValues(options: Options, useWorkerThreads: boo
         });
         return deferred.promise;
     }
-    return executeWorkerFile(path.join(__dirname, 'registryValuesWorker.js'), options);
+    return executeWorkerFile(path.join(__dirname, 'registryValues.worker.js'), options);
 }
 
 export async function readRegistryKeys(options: Options, useWorkerThreads: boolean): Promise<IRegistryKey[]> {
@@ -56,5 +56,5 @@ export async function readRegistryKeys(options: Options, useWorkerThreads: boole
         });
         return deferred.promise;
     }
-    return executeWorkerFile(path.join(__dirname, 'registryKeysWorker.js'), options);
+    return executeWorkerFile(path.join(__dirname, 'registryKeys.worker.js'), options);
 }