Run all internal scripts isolated.

Author: ericsnowcurrently

src/client/common/process/internal.ts

@@ -5,6 +5,10 @@ import * as path from 'path';
 import { EXTENSION_ROOT_DIR } from '../constants';
 import { PythonVersionInfo } from './types';
 
+// It is simpler to hard-code the extension root dir than to use vscode.ExtensionContext.extensionPath.
+const SCRIPTS_DIR = path.join(EXTENSION_ROOT_DIR, 'pythonFiles');
+const ISOLATED = path.join(SCRIPTS_DIR, 'pyvsc-run-isolated.py');
+
 /****************************
  * The following namespaces cover the following:
  *
@@ -40,9 +44,6 @@ import { PythonVersionInfo } from './types';
 //  * install_debugpy.py  (used only for extension development)
 //  * ptvsd_launcher.py  (used only for the old debug adapter)
 export namespace scripts {
-    // It is simpler to hard-code it instead of using vscode.ExtensionContext.extensionPath.
-    const SCRIPTS_DIR = path.join(EXTENSION_ROOT_DIR, 'pythonFiles');
-
     //============================
     // interpreterInfo.py
 
@@ -55,7 +56,7 @@ export namespace scripts {
 
     export function interpreterInfo(): [string[], (out: string) => PythonEnvInfo] {
         const script = path.join(SCRIPTS_DIR, 'interpreterInfo.py');
-        const args = [script];
+        const args = [ISOLATED, script];
 
         function parse(out: string): PythonEnvInfo {
             let json: PythonEnvInfo;
@@ -165,7 +166,7 @@ export namespace scripts {
 
     export function completion(jediPath?: string): [string[], (out: string) => _completion.Response[]] {
         const script = path.join(SCRIPTS_DIR, 'completion.py');
-        const args = [script];
+        const args = [ISOLATED, script];
         if (jediPath) {
             args.push('custom');
             args.push(jediPath);
@@ -183,7 +184,7 @@ export namespace scripts {
 
     export function sortImports(filename: string, sortArgs?: string[]): [string[], (out: string) => string] {
         const script = path.join(SCRIPTS_DIR, 'sortImports.py');
-        const args = [script, filename, '--diff'];
+        const args = [ISOLATED, script, filename, '--diff'];
         if (sortArgs) {
             args.push(...sortArgs);
         }
@@ -201,7 +202,7 @@ export namespace scripts {
 
     export function refactor(root: string): [string[], (out: string) => object[]] {
         const script = path.join(SCRIPTS_DIR, 'refactor.py');
-        const args = [script, root];
+        const args = [ISOLATED, script, root];
 
         // tslint:disable-next-line:no-suspicious-comment
         // TODO: Make the return type more specific, like we did
@@ -223,7 +224,7 @@ export namespace scripts {
 
     export function normalizeForInterpreter(code: string): [string[], (out: string) => string] {
         const script = path.join(SCRIPTS_DIR, 'normalizeForInterpreter.py');
-        const args = [script, code];
+        const args = [ISOLATED, script, code];
 
         function parse(out: string) {
             // The text will be used as-is.
@@ -262,7 +263,7 @@ export namespace scripts {
         text?: string
     ): [string[], (out: string) => _symbolProvider.Symbols] {
         const script = path.join(SCRIPTS_DIR, 'symbolProvider.py');
-        const args = [script, filename];
+        const args = [ISOLATED, script, filename];
         if (text) {
             args.push(text);
         }
@@ -279,7 +280,7 @@ export namespace scripts {
 
     export function printEnvVariables(): [string[], (out: string) => NodeJS.ProcessEnv] {
         const script = path.join(SCRIPTS_DIR, 'printEnvVariables.py').fileToCommandArgument();
-        const args = [script];
+        const args = [ISOLATED, script];
 
         function parse(out: string): NodeJS.ProcessEnv {
             return JSON.parse(out);
@@ -293,7 +294,7 @@ export namespace scripts {
 
     export function printEnvVariablesToFile(filename: string): [string[], (out: string) => NodeJS.ProcessEnv] {
         const script = path.join(SCRIPTS_DIR, 'printEnvVariablesToFile.py');
-        const args = [script, filename.fileToCommandArgument()];
+        const args = [ISOLATED, script, filename.fileToCommandArgument()];
 
         function parse(out: string): NodeJS.ProcessEnv {
             return JSON.parse(out);
@@ -310,6 +311,7 @@ export namespace scripts {
         // We don't bother with a "parse" function since the output
         // could be anything.
         return [
+            ISOLATED,
             script,
             command.fileToCommandArgument(),
             // The shell args must come after the command
@@ -325,7 +327,7 @@ export namespace scripts {
     export function testlauncher(testArgs: string[]): string[] {
         const script = path.join(SCRIPTS_DIR, 'testlauncher.py');
         // There is no output to parse, so we do not return a function.
-        return [script, ...testArgs];
+        return [ISOLATED, script, ...testArgs];
     }
 
     //============================
@@ -334,7 +336,7 @@ export namespace scripts {
     export function visualstudio_py_testlauncher(testArgs: string[]): string[] {
         const script = path.join(SCRIPTS_DIR, 'visualstudio_py_testlauncher.py');
         // There is no output to parse, so we do not return a function.
-        return [script, ...testArgs];
+        return [ISOLATED, script, ...testArgs];
     }
 
     //============================
@@ -384,6 +386,9 @@ export namespace scripts {
 
         export function run_adapter(adapterArgs: string[]): [string[], (out: string) => DiscoveredTests[]] {
             const script = path.join(_SCRIPTS_DIR, 'run_adapter.py');
+            // Note that we for now we do not run this "isolated".  The
+            // script relies on some magic that conflicts with the
+            // isolated script.
             const args = [script, ...adapterArgs];
 
             function parse(out: string): DiscoveredTests[] {
@@ -418,7 +423,7 @@ export namespace scripts {
         export function getJupyterVariableDataFrameInfo(): string[] {
             const script = path.join(_SCRIPTS_DIR, 'getJupyterVariableDataFrameInfo.py');
             // There is no script-specific output to parse, so we do not return a function.
-            return [script];
+            return [ISOLATED, script];
         }
 
         //============================
@@ -427,15 +432,15 @@ export namespace scripts {
         export function getJupyterVariableDataFrameRows(): string[] {
             const script = path.join(_SCRIPTS_DIR, 'getJupyterVariableDataFrameRows.py');
             // There is no script-specific output to parse, so we do not return a function.
-            return [script];
+            return [ISOLATED, script];
         }
 
         //============================
         // getServerInfo.py
 
         export function getServerInfo(): [string[], (out: string) => JupyterServerInfo[]] {
             const script = path.join(_SCRIPTS_DIR, 'getServerInfo.py');
-            const args = [script];
+            const args = [ISOLATED, script];
 
             function parse(out: string): JupyterServerInfo[] {
                 return JSON.parse(out.trim());
@@ -450,7 +455,7 @@ export namespace scripts {
         export function getJupyterKernels(): string[] {
             const script = path.join(_SCRIPTS_DIR, 'getJupyterKernels.py');
             // There is no script-specific output to parse, so we do not return a function.
-            return [script];
+            return [ISOLATED, script];
         }
 
         //============================
@@ -459,15 +464,15 @@ export namespace scripts {
         export function getJupyterKernelspecVersion(): string[] {
             const script = path.join(_SCRIPTS_DIR, 'getJupyterKernelspecVersion.py');
             // For now we do not worry about parsing the output here.
-            return [script];
+            return [ISOLATED, script];
         }
 
         //============================
         // jupyter_nbInstalled.py
 
         export function jupyter_nbInstalled(): [string[], (out: string) => boolean] {
             const script = path.join(_SCRIPTS_DIR, 'jupyter_nbInstalled.py');
-            const args = [script];
+            const args = [ISOLATED, script];
 
             function parse(out: string): boolean {
                 return out.toLowerCase().includes('available');

src/test/providers/importSortProvider.unit.test.ts

@@ -31,6 +31,8 @@ import { IServiceContainer } from '../../client/ioc/types';
 import { SortImportsEditingProvider } from '../../client/providers/importSortProvider';
 import { ISortImportsEditingProvider } from '../../client/providers/types';
 
+const ISOLATED = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'pyvsc-run-isolated.py');
+
 suite('Import Sort Provider', () => {
     let serviceContainer: TypeMoq.IMock<IServiceContainer>;
     let shell: TypeMoq.IMock<IApplicationShell>;
@@ -398,7 +400,7 @@ suite('Import Sort Provider', () => {
             .returns(() => Promise.resolve(processExeService.object))
             .verifiable(TypeMoq.Times.once());
         const importScript = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'sortImports.py');
-        const expectedArgs = [importScript, tmpFile.filePath, '--diff', '1', '2'];
+        const expectedArgs = [ISOLATED, importScript, tmpFile.filePath, '--diff', '1', '2'];
         processExeService
             .setup((p) =>
                 p.exec(TypeMoq.It.isValue(expectedArgs), TypeMoq.It.isValue({ throwOnStdErr: true, token: undefined }))