Fix run by line to scroll to the current location when stepping (microsoft#11754)

* Fix run by line to scroll to the current location when stepping Fix install message to reference run by line * Add in icon changes as well * Fix merge error too

Author: rchiodo

news/2 Fixes/11661.md

@@ -0,0 +1 @@
+Fix install message to reference run by line instead of debugging.

news/2 Fixes/11662.md

@@ -0,0 +1 @@
+Run by line does not scroll to the line that is being run.

package.json

@@ -1764,7 +1764,7 @@
  "python.dataScience.alwaysScrollOnNewCell": {
  "type": "boolean",
  "default": false,
- "description": "If a new cell comes in, scroll the interactive window to the bottom regardless of where the scroll bar is. The default is to only scroll if the current position was already at the bottom when the new cell is created",
+ "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.enableScrollingForCellOutputs": {

package.nls.json

@@ -403,7 +403,9 @@
  "DataScience.jupyterDebuggerPortNotAvailableSearchError": "Ports in the range {0}-{1} cannot be found for debugging. Please specify a port in the remoteDebuggerPort setting.",
  "DataScience.jupyterDebuggerPortBlockedSearchError": "A port cannot be connected to for debugging. Please let ports {0}-{1} through your firewall.",
  "DataScience.jupyterDebuggerInstallNew": "Pip module {0} is required for debugging cells. Install {0} and continue to debug cell?",
+ "DataScience.jupyterDebuggerInstallNewRunByLine": "Pip module {0} is required for running by line. Install {0} and continue to run by line?",
  "DataScience.jupyterDebuggerInstallUpdate": "The version of {0} installed does not support debugging cells. Update {0} to newest version and continue to debug cell?",
+ "DataScience.jupyterDebuggerInstallUpdateRunByLine": "The version of {0} installed does not support running by line. Update {0} to newest version and continue to run by line?",
  "DataScience.jupyterDebuggerInstallYes": "Yes",
  "DataScience.jupyterDebuggerInstallNo": "No",
  "DataScience.cellStopOnErrorFormatMessage": "{0} cells were canceled due to an error in the previous cell.",

src/client/common/utils/localize.ts

@@ -714,10 +714,18 @@ export namespace DataScience {
  'DataScience.jupyterDebuggerInstallNew',
  'Pip module {0} is required for debugging cells. Install {0} and continue to debug cell?'
  );
+ export const jupyterDebuggerInstallNewRunByLine = localize(
+ 'DataScience.jupyterDebuggerInstallNewRunByLine',
+ 'Pip module {0} is required for running by line. Install {0} and continue to run by line?'
+ );
  export const jupyterDebuggerInstallUpdate = localize(
  'DataScience.jupyterDebuggerInstallUpdate',
  'The version of {0} installed does not support debugging cells. Update {0} to newest version and continue to debug cell?'
  );
+ export const jupyterDebuggerInstallUpdateRunByLine = localize(
+ 'DataScience.jupyterDebuggerInstallUpdateRunByLine',
+ 'The version of {0} installed does not support running by line. Update {0} to newest version and continue to run by line?'
+ );
  export const jupyterDebuggerInstallYes = localize('DataScience.jupyterDebuggerInstallYes', 'Yes');
  export const jupyterDebuggerInstallNo = localize('DataScience.jupyterDebuggerInstallNo', 'No');
  export const cellStopOnErrorFormatMessage = localize(

src/client/datascience/jupyter/jupyterDebugger.ts

@@ -82,14 +82,19 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
  }
  ]
  };
- return this.startDebugSession((c) => this.debugService.startRunByLine(c), notebook, config);
+ return this.startDebugSession((c) => this.debugService.startRunByLine(c), notebook, config, true);
  }
 
  public async startDebugging(notebook: INotebook): Promise<void> {
  const settings = this.configService.getSettings(notebook.resource);
- return this.startDebugSession((c) => this.debugService.startDebugging(undefined, c), notebook, {
- justMyCode: settings.datascience.debugJustMyCode
- });
+ return this.startDebugSession(
+ (c) => this.debugService.startDebugging(undefined, c),
+ notebook,
+ {
+ justMyCode: settings.datascience.debugJustMyCode
+ },
+ false
+ );
  }
 
  public async stopDebugging(notebook: INotebook): Promise<void> {
@@ -129,12 +134,13 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
  private async startDebugSession(
  startCommand: (config: DebugConfiguration) => Thenable<boolean>,
  notebook: INotebook,
- extraConfig: Partial<DebugConfiguration>
+ extraConfig: Partial<DebugConfiguration>,
+ runByLine: boolean
  ) {
  traceInfo('start debugging');
 
  // Try to connect to this notebook
- const config = await this.connect(notebook, extraConfig);
+ const config = await this.connect(notebook, runByLine, extraConfig);
  if (config) {
  traceInfo('connected to notebook during debugging');
 
@@ -182,6 +188,7 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
 
  private async connect(
  notebook: INotebook,
+ runByLine: boolean,
  extraConfig: Partial<DebugConfiguration>
  ): Promise<DebugConfiguration | undefined> {
  // If we already have configuration, we're already attached, don't do it again.
@@ -203,7 +210,7 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
 
  // If we don't have debugger installed or the version is too old then we need to install it
  if (!debuggerVersion || !this.debuggerMeetsRequirement(debuggerVersion, requiredVersion)) {
- await this.promptToInstallDebugger(notebook, debuggerVersion);
+ await this.promptToInstallDebugger(notebook, debuggerVersion, runByLine);
  }
 
  // Connect local or remote based on what type of notebook we're talking to
@@ -387,10 +394,18 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
  }
 
  @captureTelemetry(Telemetry.PtvsdPromptToInstall)
- private async promptToInstallDebugger(notebook: INotebook, oldVersion: Version | undefined): Promise<void> {
- const promptMessage = oldVersion
- ? localize.DataScience.jupyterDebuggerInstallUpdate().format(this.debuggerPackage)
+ private async promptToInstallDebugger(
+ notebook: INotebook,
+ oldVersion: Version | undefined,
+ runByLine: boolean
+ ): Promise<void> {
+ const updateMessage = runByLine
+ ? localize.DataScience.jupyterDebuggerInstallUpdateRunByLine().format(this.debuggerPackage)
+ : localize.DataScience.jupyterDebuggerInstallUpdate().format(this.debuggerPackage);
+ const newMessage = runByLine
+ ? localize.DataScience.jupyterDebuggerInstallNewRunByLine().format(this.debuggerPackage)
  : localize.DataScience.jupyterDebuggerInstallNew().format(this.debuggerPackage);
+ const promptMessage = oldVersion ? updateMessage : newMessage;
  const result = await this.appShell.showInformationMessage(
  promptMessage,
  localize.DataScience.jupyterDebuggerInstallYes(),

src/datascience-ui/interactive-common/editor.tsx

@@ -57,6 +57,7 @@ export class Editor extends React.Component<IEditorProps> {
  private lastCleanVersionId: number = 0;
  private monacoRef: React.RefObject<MonacoEditor> = React.createRef<MonacoEditor>();
  private modelRef: monacoEditor.editor.ITextModel | null = null;
+ private editorRef: monacoEditor.editor.IStandaloneCodeEditor | null = null;
  private decorationIds: string[] = [];
 
  constructor(prop: IEditorProps) {
@@ -76,6 +77,9 @@ export class Editor extends React.Component<IEditorProps> {
  } else if (this.decorationIds.length) {
  this.decorationIds = this.modelRef.deltaDecorations(this.decorationIds, []);
  }
+ if (this.editorRef && this.props.ipLocation) {
+ this.editorRef.setPosition({ lineNumber: this.props.ipLocation, column: 1 });
+ }
  }
  }
  }
@@ -176,6 +180,7 @@ export class Editor extends React.Component<IEditorProps> {
  };
 
  private editorDidMount = (editor: monacoEditor.editor.IStandaloneCodeEditor) => {
+ this.editorRef = editor;
  const model = editor.getModel();
  this.modelRef = model;
 

src/datascience-ui/native-editor/nativeCell.tsx

@@ -572,12 +572,14 @@ export class NativeCell extends React.Component<INativeCellProps> {
  this.props.sendCommand(NativeMouseCommandTelemetry.DeleteCell);
  };
  const runbyline = () => {
+ this.props.focusCell(cellId);
  this.props.runByLine(cellId);
  };
  const cont = () => {
  this.props.continue(cellId);
  };
  const step = () => {
+ this.props.focusCell(cellId);
  this.props.step(cellId);
  };
  const gatherDisabled =