Provide a default configuration for jupyter startup (microsoft#3558)

* Implement basic custom config and add some tests

Author: rchiodo

news/2 Fixes/3475.md

@@ -0,0 +1 @@
+Create a default config when starting a local jupyter server to resolve potential conflicts with user's custom configurations.

news/2 Fixes/3533.md

@@ -0,0 +1 @@
+Fix problems with jupyter startup related to custom configurations.

package-lock.json

@@ -1024,6 +1024,12 @@
  "description": "Select the Jupyter server URI to connect to. Select 'local' to launch a new Juypter server on the local machine.",
  "scope": "resource"
  },
+ "python.dataScience.useDefaultConfigForJupyter": {
+ "type": "boolean",
+ "default": true,
+ "description": "When running Jupyter locally, create a default empty Jupyter config for the Python Interactive window",
+ "scope": "resource"
+ },
  "python.disableInstallationCheck": {
  "type": "boolean",
  "default": false,

package.json

@@ -268,6 +268,7 @@ export interface IDataScienceSettings {
  enabled: boolean;
  jupyterLaunchTimeout: number;
  jupyterServerURI: string;
+ useDefaultConfigForJupyter: boolean;
 }
 
 export const IConfigurationService = Symbol('IConfigurationService');

src/client/common/types.ts

@@ -54,7 +54,7 @@ function generateMarkdownCell(code: string[], file: string, line: number) : ICel
 
 export function generateCells(code: string, file: string, line: number, splitMarkdown?: boolean) : ICell[] {
  // Determine if we have a markdown cell/ markdown and code cell combined/ or just a code cell
- const split = code.splitLines();
+ const split = code.splitLines({trim: false});
  const firstLine = split[0];
  if (RegExpValues.PythonMarkdownCellMarker.test(firstLine)) {
  // We have at least one markdown. We might have to split it if there any lines that don't begin

src/client/datascience/cellFactory.ts

@@ -79,6 +79,7 @@ export namespace Telemetry {
  export const Interrupt = 'DATASCIENCE.INTERRUPT';
  export const ExportPythonFile = 'DATASCIENCE.EXPORT_PYTHON_FILE';
  export const ExportPythonFileAndOutput = 'DATASCIENCE.EXPORT_PYTHON_FILE_AND_OUTPUT';
+ export const StartJupyter = 'DATASCIENCE.JUPYTERSTARTUPCOST';
 }
 
 export namespace HelpLinks {

src/client/datascience/constants.ts

@@ -154,7 +154,7 @@ export class CodeWatcher implements ICodeWatcher {
 
  // tslint:disable-next-line:no-any
  private handleError = (err : any) => {
- if ((<JupyterInstallError>err).actionTitle !== undefined) {
+ if (err instanceof JupyterInstallError) {
  const jupyterError = err as JupyterInstallError;
 
  // This is a special error that shows a link to open for more help

src/client/datascience/editor-integration/codewatcher.ts

@@ -54,12 +54,12 @@ export class History implements IWebPanelMessageListener, IHistory {
  private addedSysInfo: boolean = false;
  private ignoreCount: number = 0;
  private waitingForExportCells : boolean = false;
+ private jupyterServer: INotebookServer | undefined;
 
  constructor(
  @inject(IApplicationShell) private applicationShell: IApplicationShell,
  @inject(IDocumentManager) private documentManager: IDocumentManager,
  @inject(IInterpreterService) private interpreterService: IInterpreterService,
- @inject(INotebookServer) private jupyterServer: INotebookServer,
  @inject(IWebPanelProvider) private provider: IWebPanelProvider,
  @inject(IDisposableRegistry) private disposables: IDisposableRegistry,
  @inject(ICodeCssGenerator) private cssGenerator : ICodeCssGenerator,
@@ -283,14 +283,16 @@ export class History implements IWebPanelMessageListener, IHistory {
  const status = this.statusProvider.set(localize.DataScience.restartingKernelStatus(), this);
 
  // Then restart the kernel. When that finishes, add our sys info again
- this.jupyterServer.restartKernel()
- .then(() => {
- this.addRestartSysInfo().then(status.dispose()).ignoreErrors();
- })
- .catch(err => {
- this.logger.logError(err);
- status.dispose();
- });
+ if (this.jupyterServer) {
+ this.jupyterServer.restartKernel()
+ .then(() => {
+ this.addRestartSysInfo().then(status.dispose()).ignoreErrors();
+ })
+ .catch(err => {
+ this.logger.logError(err);
+ status.dispose();
+ });
+ }
  this.restartingKernel = false;
  } else {
  this.restartingKernel = false;
@@ -495,14 +497,15 @@ export class History implements IWebPanelMessageListener, IHistory {
  // Startup our jupyter server
  const settings = this.configuration.getSettings();
  let serverURI: string | undefined = settings.datascience.jupyterServerURI;
+ const useDefaultConfig : boolean | undefined = settings.datascience.useDefaultConfigForJupyter;
 
  const status = this.setStatus(localize.DataScience.connectingToJupyter());
  try {
  // For the local case pass in our URI as undefined, that way connect doesn't have to check the setting
  if (serverURI === Settings.JupyterServerLocalLaunch) {
  serverURI = undefined;
  }
- this.jupyterServer = await this.jupyterExecution.connectToNotebookServer(serverURI);
+ this.jupyterServer = await this.jupyterExecution.connectToNotebookServer(serverURI, useDefaultConfig);
 
  // If this is a restart, show our restart info
  if (restart) {
@@ -536,40 +539,42 @@ export class History implements IWebPanelMessageListener, IHistory {
  return result;
  }
 
- private generateSysInfoCell = async (message: string) : Promise<ICell> => {
+ private generateSysInfoCell = async (message: string) : Promise<ICell | undefined> => {
  // Execute the code 'import sys\r\nsys.version' and 'import sys\r\nsys.executable' to get our
  // version and executable
- // tslint:disable-next-line:no-multiline-string
- const versionCells = await this.jupyterServer.execute(`import sys\r\nsys.version`, 'foo.py', 0);
- // tslint:disable-next-line:no-multiline-string
- const pathCells = await this.jupyterServer.execute(`import sys\r\nsys.executable`, 'foo.py', 0);
- // tslint:disable-next-line:no-multiline-string
- const notebookVersionCells = await this.jupyterServer.execute(`import notebook\r\nnotebook.version_info`, 'foo.py', 0);
-
- // Both should have streamed output
- const version = versionCells.length > 0 ? this.extractStreamOutput(versionCells[0]).trimQuotes() : '';
- const notebookVersion = notebookVersionCells.length > 0 ? this.extractStreamOutput(notebookVersionCells[0]).trimQuotes() : '';
- const pythonPath = versionCells.length > 0 ? this.extractStreamOutput(pathCells[0]).trimQuotes() : '';
-
- // Both should influence our ignore count. We don't want them to count against execution
- this.ignoreCount = this.ignoreCount + 3;
-
- // Combine this data together to make our sys info
- return {
- data: {
- cell_type : 'sys_info',
- message: message,
- version: version,
- notebook_version: localize.DataScience.notebookVersionFormat().format(notebookVersion),
- path: pythonPath,
- metadata : {},
- source : []
- },
- id: uuid(),
- file: '',
- line: 0,
- state: CellState.finished
- };
+ if (this.jupyterServer) {
+ // tslint:disable-next-line:no-multiline-string
+ const versionCells = await this.jupyterServer.execute(`import sys\r\nsys.version`, 'foo.py', 0);
+ // tslint:disable-next-line:no-multiline-string
+ const pathCells = await this.jupyterServer.execute(`import sys\r\nsys.executable`, 'foo.py', 0);
+ // tslint:disable-next-line:no-multiline-string
+ const notebookVersionCells = await this.jupyterServer.execute(`import notebook\r\nnotebook.version_info`, 'foo.py', 0);
+
+ // Both should have streamed output
+ const version = versionCells.length > 0 ? this.extractStreamOutput(versionCells[0]).trimQuotes() : '';
+ const notebookVersion = notebookVersionCells.length > 0 ? this.extractStreamOutput(notebookVersionCells[0]).trimQuotes() : '';
+ const pythonPath = versionCells.length > 0 ? this.extractStreamOutput(pathCells[0]).trimQuotes() : '';
+
+ // Both should influence our ignore count. We don't want them to count against execution
+ this.ignoreCount = this.ignoreCount + 3;
+
+ // Combine this data together to make our sys info
+ return {
+ data: {
+ cell_type: 'sys_info',
+ message: message,
+ version: version,
+ notebook_version: localize.DataScience.notebookVersionFormat().format(notebookVersion),
+ path: pythonPath,
+ metadata: {},
+ source: []
+ },
+ id: uuid(),
+ file: '',
+ line: 0,
+ state: CellState.finished
+ };
+ }
  }
 
  private addInitialSysInfo = async () : Promise<void> => {
@@ -594,7 +599,9 @@ export class History implements IWebPanelMessageListener, IHistory {
 
  // Generate a new sys info cell and send it to the web panel.
  const sysInfo = await this.generateSysInfoCell(message);
- this.onAddCodeEvent([sysInfo]);
+ if (sysInfo) {
+ this.onAddCodeEvent([sysInfo]);
+ }
  }
  }
 

src/client/datascience/history.ts

@@ -194,8 +194,11 @@ export class HistoryCommandListener implements IDataScienceCommandListener {
  private async exportCellsWithOutput(ranges: {range: Range; title: string}[], document: TextDocument, file: string, cancelToken: CancellationToken) : Promise<void> {
  let server: INotebookServer | undefined;
  try {
+ const settings = this.configuration.getSettings();
+ const useDefaultConfig : boolean | undefined = settings.datascience.useDefaultConfigForJupyter;
+
  // Try starting a server.
- server = await this.jupyterExecution.connectToNotebookServer(undefined, cancelToken);
+ server = await this.jupyterExecution.connectToNotebookServer(undefined, useDefaultConfig, cancelToken);
 
  // If that works, then execute all of the cells.
  const cells = Array.prototype.concat(... await Promise.all(ranges.map(r => {