Fix issues with LiveShare and triple quotes (#5084)

For #5012 and bugs found while testing the fix for 5012 around liveshare

<!--
  If an item below does not apply to you, then go ahead and check it off as "done" and strikethrough the text, e.g.:
    - [x] ~Has unit tests & system/integration tests~
-->
- [x] Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR)
- [x] Title summarizes what is changing
- [x] Has a [news entry](https://github.com/Microsoft/vscode-python/tree/master/news) file (remember to thank yourself!)
- [x] Has sufficient logging.
- [ ] Has telemetry for enhancements.
- [x] Unit tests & system/integration tests are added/updated
- [ ] [Test plan](https://github.com/Microsoft/vscode-python/blob/master/.github/test_plan.md) is updated as appropriate
- [ ] [`package-lock.json`](https://github.com/Microsoft/vscode-python/blob/master/package-lock.json) has been regenerated by running `npm install` (if dependencies have changed)
- [ ] The wiki is updated with any design decisions/details.

Author: rchiodo

build/ci/vscode-python-ci.yaml

@@ -18,7 +18,7 @@ variables:
   NpmVersion: 'latest'
   MOCHA_FILE: '$(Build.ArtifactStagingDirectory)/test-junit.xml' # All test files will write their JUnit xml output to this file, clobbering the last time it was written.
   MOCHA_REPORTER_JUNIT: true # Use the mocha-multi-reporters and send output to both console (spec) and JUnit (mocha-junit-reporter).
-  # VSC_PYTHON_FORCE_LOGGING: true - Enable this to turn on console output for the logger
+  VSC_PYTHON_FORCE_LOGGING: true # Enable this to turn on console output for the logger
 
 jobs:
 
@@ -213,47 +213,41 @@ jobs:
         NeedsPythonFunctionalReqs: true
         # This tells the functional tests to not mock out Jupyter...
         VSCODE_PYTHON_ROLLING: true
-        VSC_PYTHON_FORCE_LOGGING: true
       'Linux-Py3.7 Functional':
         PythonVersion: '3.7'
         VMImageName: 'ubuntu-16.04'
         TestsToRun: 'testfunctional'
         NeedsPythonTestReqs: true
         NeedsPythonFunctionalReqs: true
         VSCODE_PYTHON_ROLLING: true
-        VSC_PYTHON_FORCE_LOGGING: true
       'Mac-Py3.7 Functional':
         PythonVersion: '3.7'
         VMImageName: 'macos-10.13'
         TestsToRun: 'testfunctional'
         NeedsPythonTestReqs: true
         NeedsPythonFunctionalReqs: true
         VSCODE_PYTHON_ROLLING: true
-        VSC_PYTHON_FORCE_LOGGING: true
       'Windows-Py3.6 Functional':
         PythonVersion: '3.6'
         VMImageName: 'vs2017-win2016'
         TestsToRun: 'testfunctional'
         NeedsPythonTestReqs: true
         NeedsPythonFunctionalReqs: true
         VSCODE_PYTHON_ROLLING: true
-        VSC_PYTHON_FORCE_LOGGING: true
       'Linux-Py3.6 Functional':
         PythonVersion: '3.6'
         VMImageName: 'ubuntu-16.04'
         TestsToRun: 'testfunctional'
         NeedsPythonTestReqs: true
         NeedsPythonFunctionalReqs: true
         VSCODE_PYTHON_ROLLING: true
-        VSC_PYTHON_FORCE_LOGGING: true
       'Mac-Py3.6 Functional':
         PythonVersion: '3.6'
         VMImageName: 'macos-10.13'
         TestsToRun: 'testfunctional'
         NeedsPythonTestReqs: true
         NeedsPythonFunctionalReqs: true
         VSCODE_PYTHON_ROLLING: true
-        VSC_PYTHON_FORCE_LOGGING: true
 
   pool:
     vmImage: $(VMImageName)

news/2 Fixes/5012.md

@@ -0,0 +1 @@
+Fix triple quoted comments in cells to not affect anything

src/client/datascience/history/history.ts

@@ -23,6 +23,7 @@ import {
 import { CancellationError } from '../../common/cancellation';
 import { EXTENSION_ROOT_DIR } from '../../common/constants';
 import { ContextKey } from '../../common/contextKey';
+import { traceInfo } from '../../common/logger';
 import { IFileSystem } from '../../common/platform/types';
 import { IConfigurationService, IDisposable, IDisposableRegistry, ILogger } from '../../common/types';
 import { createDeferred, Deferred } from '../../common/utils/async';
@@ -594,6 +595,7 @@ export class History implements IHistory {
 
                 // Wait for the cell to finish
                 await finishedAddingCode.promise;
+                traceInfo(`Finished execution for ${id}`);
             }
         } catch (err) {
             status.dispose();

src/client/datascience/jupyter/jupyterServer.ts

@@ -21,7 +21,7 @@ import { createDeferred, Deferred, sleep } from '../../common/utils/async';
 import * as localize from '../../common/utils/localize';
 import { noop } from '../../common/utils/misc';
 import { generateCells } from '../cellFactory';
-import { concatMultilineString, stripComments } from '../common';
+import { concatMultilineString } from '../common';
 import { Identifiers } from '../constants';
 import {
     CellState,
@@ -563,7 +563,7 @@ export class JupyterServerBase implements INotebookServer {
                 subscriber.error(this.sessionStartTime, new Error(localize.DataScience.jupyterServerCrashed().format(exitCode.toString())));
                 subscriber.complete(this.sessionStartTime);
             } else {
-                const request = this.generateRequest(concatMultilineString(stripComments(subscriber.cell.data.source)), silent);
+                const request = this.generateRequest(concatMultilineString(subscriber.cell.data.source), silent);
 
                 // tslint:disable-next-line:no-require-imports
                 const jupyterLab = require('@jupyterlab/services') as typeof import('@jupyterlab/services');

src/client/datascience/jupyter/jupyterServerFactory.ts

@@ -103,8 +103,12 @@ export class JupyterServerFactory implements INotebookServer {
         return new Observable<ICell[]>(subscriber => {
             this.serverFactory.get().then(s => {
                 s.executeObservable(code, file, line, id, silent)
-                    .forEach(n => subscriber.next(n), Promise)
-                    .then(_f => subscriber.complete())
+                    .forEach(n => {
+                        subscriber.next(n); // Separate lines so can break on this call.
+                    }, Promise)
+                    .then(_f => {
+                        subscriber.complete();
+                    })
                     .catch(e => subscriber.error(e));
             },
             r => {

src/client/datascience/jupyter/jupyterSession.ts

@@ -171,7 +171,6 @@ export class JupyterSession implements IJupyterSession {
     }
 
     private onStatusChanged(_s: Session.ISession, a: Kernel.Status) {
-        traceInfo(`Status changed to ${a} from OnStatusChangedEvent`);
         if (a === 'starting' && this.onRestartedEvent) {
             this.onRestartedEvent.fire();
         }

src/client/datascience/jupyter/liveshare/guestJupyterServer.ts

@@ -7,6 +7,7 @@ import * as vsls from 'vsls/vscode';
 
 import { ILiveShareApi } from '../../../common/application/types';
 import { CancellationError } from '../../../common/cancellation';
+import { traceInfo } from '../../../common/logger';
 import { IAsyncDisposableRegistry, IConfigurationService, IDisposableRegistry, ILogger } from '../../../common/types';
 import { createDeferred, Deferred } from '../../../common/utils/async';
 import * as localize from '../../../common/utils/localize';
@@ -22,7 +23,7 @@ import {
 } from '../../types';
 import { LiveShareParticipantDefault, LiveShareParticipantGuest } from './liveShareParticipantMixin';
 import { ResponseQueue } from './responseQueue';
-import { ILiveShareParticipant, IServerResponse } from './types';
+import { IExecuteObservableResponse, ILiveShareParticipant, IServerResponse } from './types';
 
 export class GuestJupyterServer
     extends LiveShareParticipantGuest(LiveShareParticipantDefault, LiveShare.JupyterServerSharedService)
@@ -104,7 +105,7 @@ export class GuestJupyterServer
                 s.notify(LiveShareCommands.executeObservable, { code, file, line, id });
             }
         }).ignoreErrors();
-        return this.responseQueue.waitForObservable(code, file, line, id);
+        return this.responseQueue.waitForObservable(code, id);
     }
 
     public async restartKernel(): Promise<void> {
@@ -176,6 +177,8 @@ export class GuestJupyterServer
     }
 
     private onServerResponse = (args: Object) => {
+        const er = args as IExecuteObservableResponse;
+        traceInfo(`Guest serverResponse ${er.pos} ${er.id}`);
         // Args should be of type ServerResponse. Stick in our queue if so.
         if (args.hasOwnProperty('type')) {
             this.responseQueue.push(args as IServerResponse);