Remove kernel change on the Interactive Window (microsoft#12439)

* add 'select kernel' handle message on the interactive window * remove kernel toolbar from the interactive window if th user uses a local jupyter server * add setting to enable it back * add news file * oops * Add the experiment, as well as IExperimentService on everything that extends WebViewHost * removed setting * add setting back
ericsnowcurrently · Jun 23, 2020 · 88f3b43 · 88f3b43
1 parent 53c3fc6
commit 88f3b43
Show file tree

Hide file tree

Showing 16 changed files with 89 additions and 19 deletions.
diff --git a/news/2 Fixes/11347.md b/news/2 Fixes/11347.md
@@ -0,0 +1,2 @@
+Removed the Kernel Selection toolbar from the Interactive Window when using a local Jupyter Server.
+To show it again, set the setting 'Python > Data Science > Show Kernel Selection On Interactive Window'.
diff --git a/package.json b/package.json
@@ -1925,6 +1925,12 @@
                     "description": "Automatically scroll the interactive window to show the output of the last statement executed. If false, the interactive window will only automatically scroll if the bottom of the prior cell is visible.",
                     "scope": "resource"
                 },
+                "python.dataScience.showKernelSelectionOnInteractiveWindow": {
+                    "type": "boolean",
+                    "default": false,
+                    "description": "When set to true, enables the kernel selector in the Interactive Window. By default, the Interactive Window will use your Python Interpreters kernel.",
+                    "scope": "resource"
+                },
                 "python.dataScience.enableScrollingForCellOutputs": {
                     "type": "boolean",
                     "default": true,

diff --git a/src/client/common/experiments/groups.ts b/src/client/common/experiments/groups.ts
@@ -87,3 +87,10 @@ export enum NotebookEditorSupport {
 export enum EnableStartPage {
     experiment = 'EnableStartPage'
 }
+
+// Experiment to remove the Kernel/Server Tooblar in the Interactive Window when running a local Jupyter Server.
+// It doesn't make sense to have it there, the user can already change the kernel
+// by changing the python interpreter on the status bar.
+export enum RemoveKernelToolbarInInteractiveWindow {
+    experiment = 'RemoveKernelToolbarInInteractiveWindow'
+}
diff --git a/src/client/common/startPage/startPage.ts b/src/client/common/startPage/startPage.ts
@@ -66,7 +66,8 @@ export class StartPage extends WebViewHost<IStartPageMapping> implements IStartP
             localize.StartPage.getStarted(),
             ViewColumn.One,
             false,
-            false
+            false,
+            Promise.resolve(false)
         );
         this.timer = new StopWatch();
     }

diff --git a/src/client/common/types.ts b/src/client/common/types.ts
@@ -399,6 +399,7 @@ export interface IDataScienceSettings {
     jupyterCommandLineArguments: string[];
     widgetScriptSources: WidgetCDNs[];
     alwaysScrollOnNewCell?: boolean;
+    showKernelSelectionOnInteractiveWindow?: boolean;
 }
 
 export type WidgetCDNs = 'unpkg.com' | 'jsdelivr.com';

diff --git a/src/client/datascience/data-viewing/dataViewer.ts b/src/client/datascience/data-viewing/dataViewer.ts
@@ -58,7 +58,8 @@ export class DataViewer extends WebViewHost<IDataViewerMapping> implements IData
             localize.DataScience.dataExplorerTitle(),
             ViewColumn.One,
             useCustomEditorApi,
-            false
+            false,
+            Promise.resolve(false)
         );
     }
 

diff --git a/src/client/datascience/interactive-common/interactiveBase.ts b/src/client/datascience/interactive-common/interactiveBase.ts
@@ -35,10 +35,15 @@ import {
 } from '../../common/application/types';
 import { CancellationError } from '../../common/cancellation';
 import { EXTENSION_ROOT_DIR, isTestExecution, PYTHON_LANGUAGE } from '../../common/constants';
-import { RunByLine } from '../../common/experiments/groups';
+import { RemoveKernelToolbarInInteractiveWindow, RunByLine } from '../../common/experiments/groups';
 import { traceError, traceInfo, traceWarning } from '../../common/logger';
 import { IFileSystem } from '../../common/platform/types';
-import { IConfigurationService, IDisposableRegistry, IExperimentsManager } from '../../common/types';
+import {
+    IConfigurationService,
+    IDisposableRegistry,
+    IExperimentService,
+    IExperimentsManager
+} from '../../common/types';
 import { createDeferred, Deferred } from '../../common/utils/async';
 import * as localize from '../../common/utils/localize';
 import { isUntitledFile, noop } from '../../common/utils/misc';
@@ -153,7 +158,8 @@ export abstract class InteractiveBase extends WebViewHost<IInteractiveWindowMapp
         @unmanaged() experimentsManager: IExperimentsManager,
         @unmanaged() private switcher: KernelSwitcher,
         @unmanaged() private readonly notebookProvider: INotebookProvider,
-        @unmanaged() useCustomEditorApi: boolean
+        @unmanaged() useCustomEditorApi: boolean,
+        @unmanaged() expService: IExperimentService
     ) {
         super(
             configuration,
@@ -167,7 +173,8 @@ export abstract class InteractiveBase extends WebViewHost<IInteractiveWindowMapp
             title,
             viewColumn,
             useCustomEditorApi,
-            experimentsManager.inExperiment(RunByLine.experiment)
+            experimentsManager.inExperiment(RunByLine.experiment),
+            expService.inExperiment(RemoveKernelToolbarInInteractiveWindow.experiment)
         );
 
         // Create our unique id. We use this to skip messages we send to other interactive windows

diff --git a/src/client/datascience/interactive-ipynb/nativeEditor.ts b/src/client/datascience/interactive-ipynb/nativeEditor.ts
@@ -34,6 +34,7 @@ import {
     IAsyncDisposableRegistry,
     IConfigurationService,
     IDisposableRegistry,
+    IExperimentService,
     IExperimentsManager,
     IMemento,
     Resource,
@@ -179,7 +180,8 @@ export class NativeEditor extends InteractiveBase implements INotebookEditor {
         @inject(IAsyncDisposableRegistry) asyncRegistry: IAsyncDisposableRegistry,
         @inject(KernelSwitcher) switcher: KernelSwitcher,
         @inject(INotebookProvider) notebookProvider: INotebookProvider,
-        @inject(UseCustomEditorApi) useCustomEditorApi: boolean
+        @inject(UseCustomEditorApi) useCustomEditorApi: boolean,
+        @inject(IExperimentService) expService: IExperimentService
     ) {
         super(
             listeners,
@@ -216,7 +218,8 @@ export class NativeEditor extends InteractiveBase implements INotebookEditor {
             experimentsManager,
             switcher,
             notebookProvider,
-            useCustomEditorApi
+            useCustomEditorApi,
+            expService
         );
         asyncRegistry.push(this);
 

diff --git a/src/client/datascience/interactive-ipynb/nativeEditorOldWebView.ts b/src/client/datascience/interactive-ipynb/nativeEditorOldWebView.ts
@@ -23,6 +23,7 @@ import {
     IAsyncDisposableRegistry,
     IConfigurationService,
     IDisposableRegistry,
+    IExperimentService,
     IExperimentsManager,
     IMemento,
     WORKSPACE_MEMENTO
@@ -101,7 +102,8 @@ export class NativeEditorOldWebView extends NativeEditor {
         @inject(KernelSwitcher) switcher: KernelSwitcher,
         @inject(INotebookProvider) notebookProvider: INotebookProvider,
         @inject(UseCustomEditorApi) useCustomEditorApi: boolean,
-        @inject(INotebookStorageProvider) private readonly storage: INotebookStorageProvider
+        @inject(INotebookStorageProvider) private readonly storage: INotebookStorageProvider,
+        @inject(IExperimentService) expService: IExperimentService
     ) {
         super(
             listeners,
@@ -132,7 +134,8 @@ export class NativeEditorOldWebView extends NativeEditor {
             asyncRegistry,
             switcher,
             notebookProvider,
-            useCustomEditorApi
+            useCustomEditorApi,
+            expService
         );
         asyncRegistry.push(this);
         // No ui syncing in old notebooks.

diff --git a/src/client/datascience/interactive-window/interactiveWindow.ts b/src/client/datascience/interactive-window/interactiveWindow.ts
@@ -22,6 +22,7 @@ import {
     GLOBAL_MEMENTO,
     IConfigurationService,
     IDisposableRegistry,
+    IExperimentService,
     IExperimentsManager,
     IMemento,
     IPersistentStateFactory,
@@ -113,7 +114,8 @@ export class InteractiveWindow extends InteractiveBase implements IInteractiveWi
         @inject(IExperimentsManager) experimentsManager: IExperimentsManager,
         @inject(KernelSwitcher) switcher: KernelSwitcher,
         @inject(INotebookProvider) notebookProvider: INotebookProvider,
-        @inject(UseCustomEditorApi) useCustomEditorApi: boolean
+        @inject(UseCustomEditorApi) useCustomEditorApi: boolean,
+        @inject(IExperimentService) expService: IExperimentService
     ) {
         super(
             listeners,
@@ -150,7 +152,8 @@ export class InteractiveWindow extends InteractiveBase implements IInteractiveWi
             experimentsManager,
             switcher,
             notebookProvider,
-            useCustomEditorApi
+            useCustomEditorApi,
+            expService
         );
 
         // Send a telemetry event to indicate window is opening

diff --git a/src/client/datascience/plotting/plotViewer.ts b/src/client/datascience/plotting/plotViewer.ts
@@ -48,7 +48,8 @@ export class PlotViewer extends WebViewHost<IPlotViewerMapping> implements IPlot
             localize.DataScience.plotViewerTitle(),
             ViewColumn.One,
             useCustomEditorApi,
-            false
+            false,
+            Promise.resolve(false)
         );
         // Load the web panel using our current directory as we don't expect to load any other files
         super.loadWebPanel(process.cwd()).catch(traceError);

diff --git a/src/client/datascience/types.ts b/src/client/datascience/types.ts
@@ -764,6 +764,10 @@ export interface IDataScienceExtraSettings extends IDataScienceSettings {
     variableOptions: {
         enableDuringDebugger: boolean;
     };
+
+    webviewExperiments: {
+        removeKernelToolbarInInteractiveWindow: boolean;
+    };
 }
 
 // Get variables from the currently running active Jupyter server

diff --git a/src/client/datascience/webViewHost.ts b/src/client/datascience/webViewHost.ts
@@ -51,7 +51,8 @@ export abstract class WebViewHost<IMapping> implements IDisposable {
         @unmanaged() private title: string,
         @unmanaged() private viewColumn: ViewColumn,
         @unmanaged() protected readonly useCustomEditorApi: boolean,
-        @unmanaged() private readonly enableVariablesDuringDebugging: boolean
+        @unmanaged() private readonly enableVariablesDuringDebugging: boolean,
+        @unmanaged() private readonly hideKernelToolbarInInteractiveWindow: Promise<boolean>
     ) {
         // Create our message listener for our web panel.
         this.messageListener = messageListenerCtor(
@@ -214,6 +215,9 @@ export abstract class WebViewHost<IMapping> implements IDisposable {
             },
             variableOptions: {
                 enableDuringDebugger: this.enableVariablesDuringDebugging
+            },
+            webviewExperiments: {
+                removeKernelToolbarInInteractiveWindow: await this.hideKernelToolbarInInteractiveWindow
             }
         };
     }

diff --git a/src/datascience-ui/history-react/interactivePanel.tsx b/src/datascience-ui/history-react/interactivePanel.tsx
@@ -203,15 +203,41 @@ ${buildSettingsCss(this.props.settings)}`}</style>
                             />
                         </ImageButton>
                     </div>
+                    {this.renderKernelSelection()}
+                </div>
+            </div>
+        );
+    }
+
+    private renderKernelSelection() {
+        if (
+            this.props.settings &&
+            this.props.settings.webviewExperiments &&
+            this.props.settings.webviewExperiments.removeKernelToolbarInInteractiveWindow
+        ) {
+            if (this.props.settings.showKernelSelectionOnInteractiveWindow) {
+                return (
                     <KernelSelection
                         baseTheme={this.props.baseTheme}
                         font={this.props.font}
                         kernel={this.props.kernel}
                         selectServer={this.props.selectServer}
                         selectKernel={this.props.selectKernel}
                     />
-                </div>
-            </div>
+                );
+            } else if (this.props.kernel.localizedUri === getLocString('DataScience.localJupyterServer', 'local')) {
+                return;
+            }
+        }
+
+        return (
+            <KernelSelection
+                baseTheme={this.props.baseTheme}
+                font={this.props.font}
+                kernel={this.props.kernel}
+                selectServer={this.props.selectServer}
+                selectKernel={this.props.selectKernel}
+            />
         );
     }
 

diff --git a/src/datascience-ui/interactive-common/kernelSelection.tsx b/src/datascience-ui/interactive-common/kernelSelection.tsx
@@ -85,9 +85,7 @@ export class KernelSelection extends React.Component<IKernelSelectionProps> {
     }
 
     private selectKernel() {
-        if (this.isKernelSelectionAllowed) {
-            this.props.selectKernel();
-        }
+        this.props.selectKernel();
     }
     private getIcon(): ImageName {
         return this.props.kernel.jupyterServerStatus === ServerStatus.NotStarted

diff --git a/src/datascience-ui/react-common/settingsReactSide.ts b/src/datascience-ui/react-common/settingsReactSide.ts
@@ -68,6 +68,9 @@ export function getDefaultSettings() {
         variableOptions: {
             enableDuringDebugger: false
         },
+        webviewExperiments: {
+            removeKernelToolbarInInteractiveWindow: false
+        },
         runStartupCommands: '',
         debugJustMyCode: true,
         variableQueries: [],