Ignore other notebooks (avoid conflicts with non jupyter nbs) (#12335)

DonJayamanne · web-flow · commit b5332bcbe4c6 · 2020-06-15T13:01:17.000-07:00
For #10496

Ensure we do not treat notebooks such as Github Issues NB as one of ours.
diff --git a/src/client/datascience/notebook/cellEditSyncService.ts b/src/client/datascience/notebook/cellEditSyncService.ts
@@ -18,6 +18,7 @@ import { getOriginalCellId } from './helpers/cellMappers';
 export class CellEditSyncService implements IExtensionSingleActivationService, IDisposable {
     private readonly disposables: IDisposable[] = [];
     private mappedDocuments = new WeakMap<TextDocument, { cellId: string; model: INotebookModel }>();
+    private nonJupyterNotebookDocuments = new WeakSet<TextDocument>();
     constructor(
         @inject(IDocumentManager) private readonly documentManager: IDocumentManager,
         @inject(IDisposableRegistry) disposableRegistry: IDisposableRegistry,
@@ -65,6 +66,9 @@ export class CellEditSyncService implements IExtensionSingleActivationService, I
         if (this.mappedDocuments.has(cellDocument)) {
             return this.mappedDocuments.get(cellDocument)!;
         }
+        if (this.nonJupyterNotebookDocuments.has(cellDocument)) {
+            return;
+        }
 
         let document: NotebookDocument | undefined;
         let cell: NotebookCell | undefined;
@@ -77,20 +81,17 @@ export class CellEditSyncService implements IExtensionSingleActivationService, I
             return !!found;
         });
 
-        if (!document) {
+        if (!document || !cell) {
+            if (this.isNonJupyterTextDocument(cellDocument)) {
+                return;
+            }
+
             traceError(
                 `Syncing Cell Editor aborted, Unable to find corresponding Notebook for ${cellDocument.uri.toString()}`,
                 new Error('Unable to find corresponding Notebook')
             );
             return;
         }
-        if (!cell) {
-            traceError(
-                `Syncing Cell Editor aborted, Unable to find corresponding NotebookCell for ${cellDocument.uri.toString()}`,
-                new Error('Unable to find corresponding NotebookCell')
-            );
-            return;
-        }
 
         // Check if we have an editor associated with this document.
         const editor = this.editorProvider.editors.find((item) => item.file.toString() === document?.uri.toString());
@@ -112,4 +113,19 @@ export class CellEditSyncService implements IExtensionSingleActivationService, I
         this.mappedDocuments.set(cellDocument, { model: editor.model, cellId: getOriginalCellId(cell)! });
         return this.mappedDocuments.get(cellDocument);
     }
+    /**
+     * Check if the text document belongs to a notebook that's not ours.
+     */
+    private isNonJupyterTextDocument(cellDocument: TextDocument) {
+        // If this text document is for a note book thats
+        if (
+            this.vscNotebook.notebookDocuments.find(
+                (doc) => doc.cells.findIndex((cell) => cell.document === cellDocument) >= 0
+            )
+        ) {
+            this.nonJupyterNotebookDocuments.add(cellDocument);
+            return true;
+        }
+        return false;
+    }
 }
diff --git a/src/client/datascience/notebook/helpers/helpers.ts b/src/client/datascience/notebook/helpers/helpers.ts
@@ -13,7 +13,8 @@ import type {
     NotebookCell,
     NotebookCellData,
     NotebookCellMetadata,
-    NotebookData
+    NotebookData,
+    NotebookDocument
 } from 'vscode-proposed';
 import { NotebookCellRunState } from '../../../../../typings/vscode-proposed';
 import {
@@ -30,13 +31,22 @@ import { mapVSCNotebookCellToCellModel } from './cellMappers';
 const vscodeNotebookEnums = require('vscode') as typeof import('vscode-proposed');
 // tslint:disable-next-line: no-require-imports
 import cloneDeep = require('lodash/cloneDeep');
+import { JupyterNotebookView } from '../constants';
 
 // This is the custom type we are adding into nbformat.IBaseCellMetadata
 interface IBaseCellVSCodeMetadata {
     end_execution_time?: string;
     start_execution_time?: string;
 }
 
+/**
+ * Whether this is a Notebook we created/manage/use.
+ * Remember, there could be other notebooks such as GitHub Issues nb by VS Code.
+ */
+export function isJupyterNotebook(notebook: NotebookDocument) {
+    return notebook.viewType === JupyterNotebookView;
+}
+
 /**
  * Converts a NotebookModel into VSCode friendly format.
  */
diff --git a/src/client/datascience/notebook/integration.ts b/src/client/datascience/notebook/integration.ts
@@ -9,6 +9,7 @@ import { NotebookEditorSupport } from '../../common/experiments/groups';
 import { IFileSystem } from '../../common/platform/types';
 import { IDisposableRegistry, IExperimentsManager, IExtensionContext } from '../../common/types';
 import { noop } from '../../common/utils/misc';
+import { JupyterNotebookView } from './constants';
 import { NotebookContentProvider } from './contentProvider';
 import { NotebookKernel } from './notebookKernel';
 import { NotebookOutputRenderer } from './renderer';
@@ -75,7 +76,7 @@ export class NotebookIntegration implements IExtensionSingleActivationService {
             ];
             content.contributes.notebookProvider = [
                 {
-                    viewType: 'jupyter-notebook',
+                    viewType: JupyterNotebookView,
                     displayName: 'Jupyter Notebook',
                     selector: [
                         {
@@ -92,10 +93,10 @@ export class NotebookIntegration implements IExtensionSingleActivationService {
         }
 
         this.disposables.push(
-            this.vscNotebook.registerNotebookContentProvider('jupyter-notebook', this.notebookContentProvider)
+            this.vscNotebook.registerNotebookContentProvider(JupyterNotebookView, this.notebookContentProvider)
         );
         this.disposables.push(
-            this.vscNotebook.registerNotebookKernel('jupyter-notebook', ['**/*.ipynb'], this.notebookKernel)
+            this.vscNotebook.registerNotebookKernel(JupyterNotebookView, ['**/*.ipynb'], this.notebookKernel)
         );
         this.disposables.push(
             this.vscNotebook.registerNotebookOutputRenderer(
diff --git a/src/client/datascience/notebook/notebookEditorProvider.ts b/src/client/datascience/notebook/notebookEditorProvider.ts
@@ -27,6 +27,7 @@ import { INotebookEditor, INotebookEditorProvider, INotebookProvider, IStatusPro
 import { JupyterNotebookView } from './constants';
 import { mapVSCNotebookCellsToNotebookCellModels } from './helpers/cellMappers';
 import { updateCellModelWithChangesToVSCCell } from './helpers/cellUpdateHelpers';
+import { isJupyterNotebook } from './helpers/helpers';
 import { NotebookEditor } from './notebookEditor';
 import { INotebookExecutionService } from './types';
 
@@ -186,6 +187,9 @@ export class NotebookEditorProvider implements INotebookEditorProvider {
     }
 
     private async onDidOpenNotebookDocument(doc: NotebookDocument): Promise<void> {
+        if (!isJupyterNotebook(doc)) {
+            return;
+        }
         const uri = doc.uri;
         const model = await this.storage.load(uri);
         // tslint:disable-next-line: no-suspicious-comment
@@ -256,6 +260,9 @@ export class NotebookEditorProvider implements INotebookEditorProvider {
     private async onDidChangeNotebookDocument(
         e: NotebookCellsChangeEvent | NotebookCellOutputsChangeEvent | NotebookCellLanguageChangeEvent
     ): Promise<void> {
+        if (!isJupyterNotebook(e.document)) {
+            return;
+        }
         const model = await this.storage.load(e.document.uri);
         updateCellModelWithChangesToVSCCell(e, model);
     }
