Run all internal scripts isolated.

Author: ericsnowcurrently

src/client/common/process/internal/scripts/index.ts

@@ -8,6 +8,8 @@ import { PythonVersionInfo } from '../../types';
 // It is simpler to hard-code it instead of using vscode.ExtensionContext.extensionPath.
 export const _SCRIPTS_DIR = path.join(EXTENSION_ROOT_DIR, 'pythonFiles');
 const SCRIPTS_DIR = _SCRIPTS_DIR;
+export const _ISOLATED = path.join(_SCRIPTS_DIR, 'pyvsc-run-isolated.py');
+const ISOLATED = _ISOLATED;
 
 // "scripts" contains everything relevant to the scripts found under
 // the top-level "pythonFiles" directory.  Each of those scripts has
@@ -48,7 +50,7 @@ type PythonEnvInfo = {
 
 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;
@@ -158,7 +160,7 @@ namespace _completion {
 
 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);
@@ -176,7 +178,7 @@ export function completion(jediPath?: string): [string[], (out: string) => _comp
 
 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);
     }
@@ -194,7 +196,7 @@ export function sortImports(filename: string, sortArgs?: string[]): [string[], (
 
 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
@@ -216,7 +218,7 @@ export function refactor(root: string): [string[], (out: string) => object[]] {
 
 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.
@@ -256,7 +258,7 @@ export function symbolProvider(
     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);
     }
@@ -273,7 +275,7 @@ export function symbolProvider(
 
 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);
@@ -287,7 +289,7 @@ export function printEnvVariables(): [string[], (out: string) => NodeJS.ProcessE
 
 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);
@@ -304,6 +306,7 @@ export function shell_exec(command: string, lockfile: string, shellArgs: string[
     // 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
@@ -319,7 +322,7 @@ export function shell_exec(command: string, lockfile: string, shellArgs: string[
 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];
 }
 
 //============================
@@ -328,5 +331,5 @@ export function testlauncher(testArgs: string[]): string[] {
 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];
 }

src/client/common/process/internal/scripts/testing_tools.ts

@@ -47,6 +47,9 @@ export type DiscoveredTests = {
 
 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[] {

src/client/common/process/internal/scripts/vscode_datascience_helpers.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import * as path from 'path';
-import { _SCRIPTS_DIR } from './index';
+import { _ISOLATED as ISOLATED, _SCRIPTS_DIR } from './index';
 
 const SCRIPTS_DIR = path.join(_SCRIPTS_DIR, 'vscode_datascience_helpers');
 
@@ -12,7 +12,7 @@ const SCRIPTS_DIR = path.join(_SCRIPTS_DIR, 'vscode_datascience_helpers');
 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];
 }
 
 //============================
@@ -21,7 +21,7 @@ export function getJupyterVariableDataFrameInfo(): string[] {
 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];
 }
 
 //============================
@@ -41,7 +41,7 @@ type JupyterServerInfo = {
 
 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());
@@ -56,7 +56,7 @@ export function getServerInfo(): [string[], (out: string) => JupyterServerInfo[]
 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];
 }
 
 //============================
@@ -65,15 +65,15 @@ export function getJupyterKernels(): string[] {
 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 }))