Put the new REPL normalization script behind an experiment (#14561)

kimadeline · web-flow · commit 2352196d7d9f · 2020-11-02T13:37:00.000-08:00
* Put new normalization script behind experiment
* Allow opt-in and opt-out
* Restructure &amp; add tests
* normalizeSelection.py only uses \n
* I should have read the documentation
* Save the string -_-
* Remove unnecessary check
* derped
* Fix tests after merge
* Use different normalize helper for each script
* ....
* Remember that both scripts only use \n
diff --git a/package.json b/package.json
@@ -1042,6 +1042,7 @@
                             "tryPylance",
                             "jediLSP",
                             "debuggerDataViewer",
+                            "pythonSendEntireLineToREPL",
                             "All"
                         ]
                     },
@@ -1068,6 +1069,7 @@
                             "tryPylance",
                             "jediLSP",
                             "debuggerDataViewer",
+                            "pythonSendEntireLineToREPL",
                             "All"
                         ]
                     },
diff --git a/src/client/common/experiments/groups.ts b/src/client/common/experiments/groups.ts
@@ -75,3 +75,8 @@ export enum JoinMailingListPromptVariants {
     variant2 = 'pythonJoinMailingListVar2',
     variant3 = 'pythonJoinMailingListVar3'
 }
+
+// Experiment to use a different method for normalizing code to be sent to the REPL.
+export enum SendSelectionToREPL {
+    experiment = 'pythonSendEntireLineToREPL'
+}
diff --git a/src/client/common/process/internal/scripts/index.ts b/src/client/common/process/internal/scripts/index.ts
@@ -227,6 +227,21 @@ export function normalizeForInterpreter(): [string[], (out: string) => string] {
     return [args, parse];
 }
 
+//============================
+// normalizeSelection.py
+
+export function normalizeSelection(): [string[], (out: string) => string] {
+    const script = path.join(SCRIPTS_DIR, 'normalizeSelection.py');
+    const args = [ISOLATED, script];
+
+    function parse(out: string) {
+        // The text will be used as-is.
+        return out;
+    }
+
+    return [args, parse];
+}
+
 //============================
 // symbolProvider.py
 
diff --git a/src/client/terminals/codeExecution/helper.ts b/src/client/terminals/codeExecution/helper.ts
@@ -7,9 +7,11 @@ import { Position, Range, TextEditor, Uri } from 'vscode';
 
 import { IApplicationShell, IDocumentManager } from '../../common/application/types';
 import { PYTHON_LANGUAGE } from '../../common/constants';
+import { SendSelectionToREPL } from '../../common/experiments/groups';
 import { traceError } from '../../common/logger';
 import * as internalScripts from '../../common/process/internal/scripts';
 import { IProcessServiceFactory } from '../../common/process/types';
+import { IExperimentService } from '../../common/types';
 import { createDeferred } from '../../common/utils/async';
 import { IInterpreterService } from '../../interpreter/contracts';
 import { IServiceContainer } from '../../ioc/types';
@@ -21,12 +23,14 @@ export class CodeExecutionHelper implements ICodeExecutionHelper {
     private readonly applicationShell: IApplicationShell;
     private readonly processServiceFactory: IProcessServiceFactory;
     private readonly interpreterService: IInterpreterService;
+    private readonly experimentService: IExperimentService;
 
     constructor(@inject(IServiceContainer) serviceContainer: IServiceContainer) {
         this.documentManager = serviceContainer.get<IDocumentManager>(IDocumentManager);
         this.applicationShell = serviceContainer.get<IApplicationShell>(IApplicationShell);
         this.processServiceFactory = serviceContainer.get<IProcessServiceFactory>(IProcessServiceFactory);
         this.interpreterService = serviceContainer.get<IInterpreterService>(IInterpreterService);
+        this.experimentService = serviceContainer.get<IExperimentService>(IExperimentService);
     }
 
     public async normalizeLines(code: string, resource?: Uri): Promise<string> {
@@ -40,7 +44,11 @@ export class CodeExecutionHelper implements ICodeExecutionHelper {
 
             const interpreter = await this.interpreterService.getActiveInterpreter(resource);
             const processService = await this.processServiceFactory.create(resource);
-            const [args, parse] = internalScripts.normalizeForInterpreter();
+
+            const inExperiment = await this.experimentService.inExperiment(SendSelectionToREPL.experiment);
+            const [args, parse] = inExperiment
+                ? internalScripts.normalizeSelection()
+                : internalScripts.normalizeForInterpreter();
             const observable = processService.execObservable(interpreter?.path || 'python', args, {
                 throwOnStdErr: true
             });
diff --git a/src/test/pythonFiles/terminalExec/sample1_normalized_selection.py b/src/test/pythonFiles/terminalExec/sample1_normalized_selection.py
@@ -0,0 +1,22 @@
+def square(x):
+    return x**2
+
+print('hello')
+# Sample block 2
+
+a = 2
+if a < 2:
+    print('less than 2')
+else:
+    print('more than 2')
+
+print('hello')
+# Sample block 3
+
+for i in range(5):
+    print(i)
+    print(i)
+    print(i)
+    print(i)
+
+print('complete')
diff --git a/src/test/pythonFiles/terminalExec/sample2_normalized_selection.py b/src/test/pythonFiles/terminalExec/sample2_normalized_selection.py
@@ -0,0 +1,7 @@
+def add(x, y):
+    """Adds x to y"""
+    # Some comment
+    return x + y
+
+v = add(1, 7)
+print(v)
diff --git a/src/test/pythonFiles/terminalExec/sample3_normalized_selection.py b/src/test/pythonFiles/terminalExec/sample3_normalized_selection.py
@@ -0,0 +1,5 @@
+if True:
+    print(1)
+    print(2)
+
+print(3)
diff --git a/src/test/pythonFiles/terminalExec/sample4_normalized_selection.py b/src/test/pythonFiles/terminalExec/sample4_normalized_selection.py
@@ -0,0 +1,7 @@
+class pc(object):
+    def __init__(self, pcname, model):
+        self.pcname = pcname
+        self.model = model
+    def print_name(self):
+        print('Workstation name is', self.pcname, 'model is', self.model)
+
diff --git a/src/test/pythonFiles/terminalExec/sample5_normalized_selection.py b/src/test/pythonFiles/terminalExec/sample5_normalized_selection.py
@@ -0,0 +1,9 @@
+for i in range(10):
+    print('a')
+    for j in range(5):
+        print('b')
+        print('b2')
+        for k in range(2):
+            print('c')
+    print('done with first loop')
+
diff --git a/src/test/pythonFiles/terminalExec/sample6_normalized_selection.py b/src/test/pythonFiles/terminalExec/sample6_normalized_selection.py
@@ -0,0 +1,15 @@
+if True:
+    print(1)
+else: print(2)
+
+print('🔨')
+print(3)
+print(3)
+if True:
+    print(1)
+else: print(2)
+
+if True:
+    print(1)
+else: print(2)
+
diff --git a/src/test/pythonFiles/terminalExec/sample7_normalized_selection.py b/src/test/pythonFiles/terminalExec/sample7_normalized_selection.py
@@ -0,0 +1,8 @@
+if True:
+    print(1)
+    print(1)
+else:
+    print(2)
+    print(2)
+
+print(3)
diff --git a/src/test/pythonFiles/terminalExec/sample8_normalized_selection.py b/src/test/pythonFiles/terminalExec/sample8_normalized_selection.py
@@ -0,0 +1,8 @@
+if True:
+    print(1)
+    print(1)
+else:
+    print(2)
+    print(2)
+
+print(3)
diff --git a/src/test/pythonFiles/terminalExec/sample_normalized_selection.py b/src/test/pythonFiles/terminalExec/sample_normalized_selection.py
@@ -0,0 +1,5 @@
+import sys
+print(sys.executable)
+print("1234")
+print(1)
+print(2)
diff --git a/src/test/terminals/codeExecution/helper.test.ts b/src/test/terminals/codeExecution/helper.test.ts

Original file line number	Diff line number	Diff line change
`@@ -75,3 +75,8 @@ export enum JoinMailingListPromptVariants {`
`75`	`75`	`variant2 = 'pythonJoinMailingListVar2',`
`76`	`76`	`variant3 = 'pythonJoinMailingListVar3'`
`77`	`77`	`}`
	`78`	`+`
	`79`	`+// Experiment to use a different method for normalizing code to be sent to the REPL.`
	`80`	`+export enum SendSelectionToREPL {`
	`81`	`+ experiment = 'pythonSendEntireLineToREPL'`
	`82`	`+}`