Update NativeNotebook types in type definition (microsoft#13527)

DonJayamanne · web-flow · commit fec21d0288bc · 2020-08-19T15:51:34.000-07:00
diff --git a/src/client/datascience/interactive-ipynb/nativeEditorViewTracker.ts b/src/client/datascience/interactive-ipynb/nativeEditorViewTracker.ts
@@ -3,7 +3,6 @@ import { Memento, Uri } from 'vscode';
 import { IExtensionSingleActivationService } from '../../activation/types';
 import { UseCustomEditorApi } from '../../common/constants';
 import { IDisposableRegistry, IMemento, WORKSPACE_MEMENTO } from '../../common/types';
-import { isUntitled } from '../notebookStorage/nativeEditorStorage';
 import { INotebookEditor, INotebookEditorProvider } from '../types';
 
 const MEMENTO_KEY = 'nativeEditorViewTracking';
@@ -48,9 +47,9 @@ export class NativeEditorViewTracker implements IExtensionSingleActivationServic
         const fileKey = editor.file.toString();
 
         // Skip untitled files. They have to be changed first.
-        if (!list.includes(fileKey) && (!isUntitled(editor.model) || editor.isDirty)) {
+        if (!list.includes(fileKey) && (!editor.model.isUntitled || editor.isDirty)) {
             this.workspaceMemento.update(MEMENTO_KEY, [...list, fileKey]);
-        } else if (isUntitled(editor.model) && editor.model) {
+        } else if (editor.model.isUntitled && editor.model) {
             editor.model.changed(this.onUntitledChanged.bind(this, editor.file));
         }
     }
diff --git a/src/client/datascience/notebookStorage/baseModel.ts b/src/client/datascience/notebookStorage/baseModel.ts
@@ -4,6 +4,7 @@
 import { nbformat } from '@jupyterlab/coreutils/lib/nbformat';
 import { Event, EventEmitter, Memento, Uri } from 'vscode';
 import { ICryptoUtils } from '../../common/types';
+import { isUntitledFile } from '../../common/utils/misc';
 import { pruneCell } from '../common';
 import { NotebookModelChange } from '../interactive-common/interactiveWindowTypes';
 import {
@@ -12,7 +13,6 @@ import {
 } from '../jupyter/kernels/helpers';
 import { KernelConnectionMetadata } from '../jupyter/kernels/types';
 import { ICell, INotebookMetadataLive, INotebookModel } from '../types';
-import { isUntitled } from './nativeEditorStorage';
 
 export const ActiveKernelIdList = `Active_Kernel_Id_List`;
 // This is the number of kernel ids that will be remembered between opening and closing VS code
@@ -121,7 +121,7 @@ export abstract class BaseNotebookModel implements INotebookModel {
     }
 
     public get isUntitled(): boolean {
-        return isUntitled(this);
+        return isUntitledFile(this.file);
     }
     public get cells(): ICell[] {
         return this._cells;
diff --git a/src/client/datascience/notebookStorage/nativeEditorStorage.ts b/src/client/datascience/notebookStorage/nativeEditorStorage.ts
@@ -29,10 +29,6 @@ import { VSCodeNotebookModel } from './vscNotebookModel';
 const KeyPrefix = 'notebook-storage-';
 const NotebookTransferKey = 'notebook-transfered';
 
-export function isUntitled(model?: INotebookModel): boolean {
-    return isUntitledFile(model?.file);
-}
-
 export function getNextUntitledCounter(file: Uri | undefined, currentValue: number): number {
     if (file && isUntitledFile(file)) {
         const basename = path.basename(file.fsPath, 'ipynb');
diff --git a/src/client/datascience/notebookStorage/vscNotebookModel.ts b/src/client/datascience/notebookStorage/vscNotebookModel.ts
@@ -72,6 +72,9 @@ export class VSCodeNotebookModel extends BaseNotebookModel {
             cells: []
         };
     }
+    public get isUntitled(): boolean {
+        return this.document ? this.document.isUntitled : super.isUntitled;
+    }
 
     constructor(
         isTrusted: boolean,
diff --git a/src/test/datascience/nativeEditorViewTracker.unit.test.ts b/src/test/datascience/nativeEditorViewTracker.unit.test.ts
@@ -61,15 +61,22 @@ suite('DataScience - View tracker', () => {
         when(editorProvider.onDidOpenNotebookEditor).thenReturn(openEvent.event);
         editor1 = mock(NativeEditor);
         when(editor1.file).thenReturn(file1);
+        when(editor1.isUntitled).thenReturn(false);
+        const model1 = mock<INotebookModel>();
+        when(editor1.model).thenReturn(instance(model1));
+        when(model1.isUntitled).thenReturn(false);
         editor2 = mock(NativeEditor);
         when(editor2.file).thenReturn(file2);
-        editor1 = mock(NativeEditor);
-        when(editor1.file).thenReturn(file1);
+        when(editor2.isUntitled).thenReturn(false);
+        const model2 = mock<INotebookModel>();
+        when(editor2.model).thenReturn(instance(model2));
+        when(model2.isUntitled).thenReturn(false);
         untitled1 = mock(NativeEditor);
         when(untitled1.file).thenReturn(untitledFile);
         when(untitled1.model).thenReturn(instance(untitledModel));
         when(untitledModel.file).thenReturn(untitledFile);
         when(untitledModel.changed).thenReturn(untitledChangeEvent.event);
+        when(untitledModel.isUntitled).thenReturn(true);
         memento = new MockMemento();
     });
 
diff --git a/src/test/datascience/notebook/helper.ts b/src/test/datascience/notebook/helper.ts
@@ -427,6 +427,7 @@ export function createNotebookDocument(
         isDirty: false,
         languages: [],
         uri: model.file,
+        isUntitled: false,
         viewType,
         metadata: {
             cellEditable: model.isTrusted,
diff --git a/src/test/datascience/notebook/rendererExension.unit.test.ts b/src/test/datascience/notebook/rendererExension.unit.test.ts
@@ -27,12 +27,14 @@ suite('DataScience - NativeNotebook Renderer Extension', () => {
         isDirty: false,
         languages: [],
         metadata: {},
+        isUntitled: false,
         viewType: JupyterNotebookView
     };
     const nonJupyterNotebook: NotebookDocument = {
         cells: [],
         uri: Uri.file('one.xyz'),
         fileName: '',
+        isUntitled: false,
         isDirty: false,
         languages: [],
         metadata: {},
diff --git a/types/vscode-proposed/index.d.ts b/types/vscode-proposed/index.d.ts
@@ -215,6 +215,7 @@ export interface NotebookDocument {
     readonly fileName: string;
     readonly viewType: string;
     readonly isDirty: boolean;
+    readonly isUntitled: boolean;
     readonly cells: NotebookCell[];
     languages: string[];
     displayOrder?: GlobPattern[];
@@ -569,6 +570,7 @@ export namespace notebook {
 
     export const onDidOpenNotebookDocument: Event<NotebookDocument>;
     export const onDidCloseNotebookDocument: Event<NotebookDocument>;
+    export const onDidSaveNotebookDocument: Event<NotebookDocument>;
 
     /**
      * All currently known notebook documents.
diff --git a/types/vscode.proposed.d.ts b/types/vscode.proposed.d.ts
diff --git a/typings/vscode-proposed/index.d.ts b/typings/vscode-proposed/index.d.ts

Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,9 @@ export class VSCodeNotebookModel extends BaseNotebookModel {`
`72`	`72`	`cells: []`
`73`	`73`	`};`
`74`	`74`	`}`
	`75`	`+ public get isUntitled(): boolean {`
	`76`	`+ return this.document ? this.document.isUntitled : super.isUntitled;`
	`77`	`+ }`
`75`	`78`
`76`	`79`	`constructor(`
`77`	`80`	`isTrusted: boolean,`