Notebook extensibility: Move New Notebook and configuration to an extension (#3382)

initial support for Notebook extensibility. Fixes #3148 , Fixes #3382.

## Design notes
The extensibility patterns are modeled after the VSCode Document and Editor APIs but need to be different since core editor concepts are different - for example Notebooks have cells, and cells have contents rather than editors which have text lines.

Most importantly, a lot of the code is based on the MainThreadDocumentsAndEditors class, with some related classes (the MainThreadDocuments, and MainThreadEditors) brought in too. Given our current limitations I felt moving to add 3 full sets of extension host API classes was overkill so am currently using one. Will see if we need to change this in the future based on what we add in the additional APIs

## Limitations
The current implementation is limited to visible editors, rather than all documents in the workspace. We are not following the `openDocument` -> `showDocument` pattern, but instead just supporting `showDocument` directly.

## Changes in this PR
- Renamed existing APIs to make clear that they were about notebook contents, not about notebook behavior
- Added new APIs for querying notebook documents and editors 
- Added new API for opening a notebook
- Moved `New Notebook` command to an extension, and added an `Open Notebook` command too
- Moved notebook feature flag to the extension

## Not covered in this PR
- Need to actually implement support for defining the provider and connection IDs for a notebook. this will be important to support New Notebook from a big data connection in Object Explorer
- Need to add APIs for adding cells, to support 
- Need to implement the metadata for getting full notebook contents. I've only implemented to key APIs needed to make this all work.

src/sql/parts/notebook/models/cell.ts

@@ -35,7 +35,7 @@ export class CellModel implements ICellModel {
 	private _active: boolean;
 	private _cellUri: URI;
 
-	constructor(private factory: IModelFactory, cellData?: nb.ICell, private _options?: ICellModelOptions) {
+	constructor(private factory: IModelFactory, cellData?: nb.ICellContents, private _options?: ICellModelOptions) {
 		this.id = `${modelId++}`;
 		CellModel.CreateLanguageMappings();
 		// Do nothing for now
@@ -263,8 +263,8 @@ export class CellModel implements ICellModel {
 		return transient['display_id'] as string;
 	}
 
-	public toJSON(): nb.ICell {
-		let cellJson: Partial<nb.ICell> = {
+	public toJSON(): nb.ICellContents {
+		let cellJson: Partial<nb.ICellContents> = {
 			cell_type: this._cellType,
 			source: this._source,
 			metadata: {
@@ -275,10 +275,10 @@ export class CellModel implements ICellModel {
 			cellJson.outputs = this._outputs;
 			cellJson.execution_count = 1; // TODO: keep track of actual execution count
 		}
-		return cellJson as nb.ICell;
+		return cellJson as nb.ICellContents;
 	}
 
-	public fromJSON(cell: nb.ICell): void {
+	public fromJSON(cell: nb.ICellContents): void {
 		if (!cell) {
 			return;
 		}

src/sql/parts/notebook/models/modelFactory.ts

@@ -13,7 +13,7 @@ import { ClientSession } from './clientSession';
 
 export class ModelFactory implements IModelFactory {
 
-	public createCell(cell: nb.ICell, options: ICellModelOptions): ICellModel {
+	public createCell(cell: nb.ICellContents, options: ICellModelOptions): ICellModel {
 		return new CellModel(this, cell, options);
 	}
 

src/sql/parts/notebook/models/modelInterfaces.ts

@@ -348,7 +348,7 @@ export interface ICellModel {
 	readonly onOutputsChanged: Event<ReadonlyArray<nb.ICellOutput>>;
 	setFuture(future: FutureInternal): void;
 	equals(cellModel: ICellModel): boolean;
-	toJSON(): nb.ICell;
+	toJSON(): nb.ICellContents;
 }
 
 export interface FutureInternal extends nb.IFuture {
@@ -357,7 +357,7 @@ export interface FutureInternal extends nb.IFuture {
 
 export interface IModelFactory {
 
-	createCell(cell: nb.ICell, options: ICellModelOptions): ICellModel;
+	createCell(cell: nb.ICellContents, options: ICellModelOptions): ICellModel;
 	createClientSession(options: IClientSessionOptions): IClientSession;
 }
 

src/sql/parts/notebook/models/notebookModel.ts

@@ -237,7 +237,7 @@ export class NotebookModel extends Disposable implements INotebookModel {
 	}
 
 	private createCell(cellType: CellType): ICellModel {
-		let singleCell: nb.ICell = {
+		let singleCell: nb.ICellContents = {
 			cell_type: cellType,
 			source: '',
 			metadata: {},
@@ -389,7 +389,7 @@ export class NotebookModel extends Disposable implements INotebookModel {
 
 	// Get default language if saved in notebook file
 	// Otherwise, default to python
-	private getDefaultLanguageInfo(notebook: nb.INotebook): nb.ILanguageInfo {
+	private getDefaultLanguageInfo(notebook: nb.INotebookContents): nb.ILanguageInfo {
 		return notebook!.metadata!.language_info || {
 			name: 'python',
 			version: '',
@@ -398,7 +398,7 @@ export class NotebookModel extends Disposable implements INotebookModel {
 	}
 
 	// Get default kernel info if saved in notebook file
-	private getSavedKernelInfo(notebook: nb.INotebook): nb.IKernelInfo {
+	private getSavedKernelInfo(notebook: nb.INotebookContents): nb.IKernelInfo {
 		return notebook!.metadata!.kernelspec;
 	}
 
@@ -490,8 +490,8 @@ export class NotebookModel extends Disposable implements INotebookModel {
 	/**
 	 * Serialize the model to JSON.
 	 */
-	toJSON(): nb.INotebook {
-		let cells: nb.ICell[] = this.cells.map(c => c.toJSON());
+	toJSON(): nb.INotebookContents {
+		let cells: nb.ICellContents[] = this.cells.map(c => c.toJSON());
 		let metadata = Object.create(null) as nb.INotebookMetadata;
 		// TODO update language and kernel when these change
 		metadata.kernelspec = this._savedKernelInfo;

src/sql/parts/notebook/notebook.component.ts

@@ -7,7 +7,7 @@ import './notebookStyles';
 
 import { nb } from 'sqlops';
 
-import { OnInit, Component, Inject, forwardRef, ElementRef, ChangeDetectorRef, ViewChild } from '@angular/core';
+import { OnInit, Component, Inject, forwardRef, ElementRef, ChangeDetectorRef, ViewChild, OnDestroy } from '@angular/core';
 
 import { IColorTheme, IWorkbenchThemeService } from 'vs/workbench/services/themes/common/workbenchThemeService';
 import * as themeColors from 'vs/workbench/common/theme';
@@ -20,7 +20,7 @@ import { AngularDisposable } from 'sql/base/common/lifecycle';
 import { CellTypes, CellType } from 'sql/parts/notebook/models/contracts';
 import { ICellModel, IModelFactory, notebookConstants } from 'sql/parts/notebook/models/modelInterfaces';
 import { IConnectionManagementService, IConnectionDialogService } from 'sql/parts/connection/common/connectionManagement';
-import { INotebookService, INotebookParams, INotebookManager } from 'sql/services/notebook/notebookService';
+import { INotebookService, INotebookParams, INotebookManager, INotebookEditor } from 'sql/services/notebook/notebookService';
 import { IBootstrapParams } from 'sql/services/bootstrap/bootstrapService';
 import { NotebookModel, NotebookContentChange } from 'sql/parts/notebook/models/notebookModel';
 import { ModelFactory } from 'sql/parts/notebook/models/modelFactory';
@@ -48,7 +48,7 @@ export const NOTEBOOK_SELECTOR: string = 'notebook-component';
 	selector: NOTEBOOK_SELECTOR,
 	templateUrl: decodeURI(require.toUrl('./notebook.component.html'))
 })
-export class NotebookComponent extends AngularDisposable implements OnInit {
+export class NotebookComponent extends AngularDisposable implements OnInit, OnDestroy, INotebookEditor {
 	@ViewChild('toolbar', { read: ElementRef }) private toolbar: ElementRef;
 	private _model: NotebookModel;
 	private _isInErrorState: boolean = false;
@@ -73,7 +73,7 @@ export class NotebookComponent extends AngularDisposable implements OnInit {
 		@Inject(IEditorService) private editorService: IEditorService,
 		@Inject(INotificationService) private notificationService: INotificationService,
 		@Inject(INotebookService) private notebookService: INotebookService,
-		@Inject(IBootstrapParams) private notebookParams: INotebookParams,
+		@Inject(IBootstrapParams) private _notebookParams: INotebookParams,
 		@Inject(IInstantiationService) private instantiationService: IInstantiationService,
 		@Inject(IContextMenuService) private contextMenuService: IContextMenuService,
 		@Inject(IContextViewService) private contextViewService: IContextViewService,
@@ -108,10 +108,17 @@ export class NotebookComponent extends AngularDisposable implements OnInit {
 	ngOnInit() {
 		this._register(this.themeService.onDidColorThemeChange(this.updateTheme, this));
 		this.updateTheme(this.themeService.getColorTheme());
+		this.notebookService.addNotebookEditor(this);
 		this.initActionBar();
 		this.doLoad();
 	}
 
+	ngOnDestroy() {
+		if (this.notebookService) {
+			this.notebookService.removeNotebookEditor(this);
+		}
+	}
+
 	public get model(): NotebookModel {
 		return this._model;
 	}
@@ -201,16 +208,16 @@ export class NotebookComponent extends AngularDisposable implements OnInit {
 	}
 
 	private async loadModel(): Promise<void> {
-		this.notebookManager = await this.notebookService.getOrCreateNotebookManager(this.notebookParams.providerId, this.notebookParams.notebookUri);
+		this.notebookManager = await this.notebookService.getOrCreateNotebookManager(this._notebookParams.providerId, this._notebookParams.notebookUri);
 		let model = new NotebookModel({
 			factory: this.modelFactory,
-			notebookUri: this.notebookParams.notebookUri,
+			notebookUri: this._notebookParams.notebookUri,
 			connectionService: this.connectionManagementService,
 			notificationService: this.notificationService,
 			notebookManager: this.notebookManager
 		}, false, this.profile);
 		model.onError((errInfo: INotification) => this.handleModelError(errInfo));
-		await model.requestModelLoad(this.notebookParams.isTrusted);
+		await model.requestModelLoad(this._notebookParams.isTrusted);
 		model.contentChanged((change) => this.handleContentChanged(change));
 		this._model = model;
 		this.updateToolbarComponents(this._model.trustedMode);
@@ -231,10 +238,10 @@ export class NotebookComponent extends AngularDisposable implements OnInit {
 	}
 
 	private get modelFactory(): IModelFactory {
-		if (!this.notebookParams.modelFactory) {
-			this.notebookParams.modelFactory = new ModelFactory();
+		if (!this._notebookParams.modelFactory) {
+			this._notebookParams.modelFactory = new ModelFactory();
 		}
-		return this.notebookParams.modelFactory;
+		return this._notebookParams.modelFactory;
 	}
 	private handleModelError(notification: INotification): void {
 		this.notificationService.notify(notification);
@@ -337,4 +344,24 @@ export class NotebookComponent extends AngularDisposable implements OnInit {
 		return undefined;
 	}
 
+	public get notebookParams(): INotebookParams {
+		return this._notebookParams;
+	}
+
+	public get id(): string {
+		return this._notebookParams.notebookUri.toString();
+	}
+
+	isActive(): boolean {
+		return this.editorService.activeEditor === this.notebookParams.input;
+	}
+
+	isVisible(): boolean {
+		let notebookEditor = this.notebookParams.input;
+		return this.editorService.visibleEditors.some(e => e === notebookEditor);
+	}
+
+	isDirty(): boolean {
+		return this.notebookParams.input.isDirty();
+	}
 }

src/sql/parts/notebook/notebook.contribution.ts

@@ -4,60 +4,10 @@
  *--------------------------------------------------------------------------------------------*/
 import { Registry } from 'vs/platform/registry/common/platform';
 import { EditorDescriptor, IEditorRegistry, Extensions as EditorExtensions } from 'vs/workbench/browser/editor';
-import { IConfigurationRegistry, Extensions as ConfigExtensions } from 'vs/platform/configuration/common/configurationRegistry';
 import { SyncDescriptor } from 'vs/platform/instantiation/common/descriptors';
-import { MenuRegistry, MenuId } from 'vs/platform/actions/common/actions';
-import { Action } from 'vs/base/common/actions';
-import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
-import { TPromise } from 'vs/base/common/winjs.base';
-import { Schemas } from 'vs/base/common/network';
-import URI from 'vs/base/common/uri';
-import { localize } from 'vs/nls';
-import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
 
-import { NotebookInput, NotebookInputModel, notebooksEnabledCondition } from 'sql/parts/notebook/notebookInput';
+import { NotebookInput } from 'sql/parts/notebook/notebookInput';
 import { NotebookEditor } from 'sql/parts/notebook/notebookEditor';
-import { CommandsRegistry } from 'vs/platform/commands/common/commands';
-import { INotebookProviderRegistry } from 'sql/services/notebook/notebookRegistry';
-
-const DEFAULT_NOTEBOOK_FILETYPE = 'IPYNB';
-const Extensions = {
-	NotebookProviderContribution: 'notebook.providers'
-};
-
-let counter = 0;
-
-/**
- * todo: Will remove this code.
- * This is the entry point to open the new Notebook
- */
-export class NewNotebookAction extends Action {
-
-	public static ID = 'workbench.action.newnotebook';
-	public static LABEL = localize('workbench.action.newnotebook.description', 'New Notebook');
-
-	constructor(
-		id: string,
-		label: string,
-		@IEditorService private _editorService: IEditorService,
-		@IInstantiationService private _instantiationService: IInstantiationService
-	) {
-		super(id, label);
-	}
-
-	public run(): TPromise<void> {
-		let title = `Untitled-${counter++}`;
-		let untitledUri = URI.from({ scheme: Schemas.untitled, path: title });
-		let model = new NotebookInputModel(untitledUri, undefined, false, undefined);
-		if(!model.providerId)
-		{
-			let notebookRegistry = Registry.as<INotebookProviderRegistry>(Extensions.NotebookProviderContribution);
-			model.providerId = notebookRegistry.getProviderForFileType(DEFAULT_NOTEBOOK_FILETYPE);
-		}
-		let input = this._instantiationService.createInstance(NotebookInput, title, model);
-		return this._editorService.openEditor(input, { pinned: true }).then(() => undefined);
-	}
-}
 
 // Model View editor registration
 const viewModelEditorDescriptor = new EditorDescriptor(
@@ -68,31 +18,3 @@ const viewModelEditorDescriptor = new EditorDescriptor(
 
 Registry.as<IEditorRegistry>(EditorExtensions.Editors)
 	.registerEditor(viewModelEditorDescriptor, [new SyncDescriptor(NotebookInput)]);
-
-// Feature flag for built-in Notebooks. Will be removed in the future.
-const configurationRegistry = Registry.as<IConfigurationRegistry>(ConfigExtensions.Configuration);
-configurationRegistry.registerConfiguration({
-	'id': 'notebook',
-	'title': 'Notebook',
-	'type': 'object',
-	'properties': {
-		'notebook.enabled': {
-			'type': 'boolean',
-			'default': false,
-			'description': localize('notebook.enabledDescription', 'Enable viewing notebook files using built-in notebook editor.')
-		}
-	}
-});
-
-// this is the entry point to open the new Notebook
-CommandsRegistry.registerCommand(NewNotebookAction.ID, serviceAccessor => {
-	serviceAccessor.get(IInstantiationService).createInstance(NewNotebookAction, NewNotebookAction.ID, NewNotebookAction.LABEL).run();
-});
-
-MenuRegistry.appendMenuItem(MenuId.CommandPalette, {
-	command: {
-		id: NewNotebookAction.ID,
-		title:NewNotebookAction.LABEL,
-	},
-	when: notebooksEnabledCondition
-});

src/sql/parts/notebook/notebookEditor.ts

@@ -86,6 +86,7 @@ export class NotebookEditor extends BaseEditor {
 		input.hasBootstrapped = true;
 		let params: INotebookParams = {
 			notebookUri: input.notebookUri,
+			input: input,
 			providerId: input.providerId ? input.providerId : DEFAULT_NOTEBOOK_PROVIDER,
 			isTrusted: input.isTrusted
 		};

src/sql/parts/notebook/notebookInput.ts

@@ -11,6 +11,7 @@ import { EditorInput, EditorModel, ConfirmResult } from 'vs/workbench/common/edi
 import { Emitter, Event } from 'vs/base/common/event';
 import URI from 'vs/base/common/uri';
 import { IContextKeyService, ContextKeyExpr } from 'vs/platform/contextkey/common/contextkey';
+import * as resources from 'vs/base/common/resources';
 
 import { INotebookService } from 'sql/services/notebook/notebookService';
 
@@ -88,15 +89,6 @@ export class NotebookInput extends EditorInput {
 	) {
 		super();
 		this._model.onDidChangeDirty(() => this._onDidChangeDirty.fire());
-		this.onDispose(() => {
-			if (this.notebookService) {
-				this.notebookService.handleNotebookClosed(this.notebookUri);
-			}
-		});
-	}
-
-	public get title(): string {
-		return this._title;
 	}
 
 	public get notebookUri(): URI {
@@ -116,6 +108,10 @@ export class NotebookInput extends EditorInput {
 	}
 
 	public getName(): string {
+		if (!this._title) {
+			this._title = resources.basenameOrAuthority(this._model.notebookUri);
+		}
+
 		return this._title;
 	}
 

src/sql/parts/notebook/notebookUtils.ts

@@ -5,11 +5,15 @@
 
 'use strict';
 
+import * as path from 'path';
 import { nb } from 'sqlops';
 import * as os from 'os';
 import * as pfs from 'vs/base/node/pfs';
 import { localize } from 'vs/nls';
 import { IOutputChannel } from 'vs/workbench/parts/output/common/output';
+import { Registry } from 'vs/platform/registry/common/platform';
+import { INotebookProviderRegistry, Extensions } from 'sql/services/notebook/notebookRegistry';
+import { DEFAULT_NOTEBOOK_PROVIDER, DEFAULT_NOTEBOOK_FILETYPE } from 'sql/services/notebook/notebookService';
 
 
 /**
@@ -36,3 +40,23 @@ export async function mkDir(dirPath: string, outputChannel?: IOutputChannel): Pr
 		await pfs.mkdirp(dirPath);
 	}
 }
+
+export function getProviderForFileName(fileName: string): string {
+	let fileExt = path.extname(fileName);
+	let provider: string;
+	let notebookRegistry = Registry.as<INotebookProviderRegistry>(Extensions.NotebookProviderContribution);
+	// First try to get provider for actual file type
+	if (fileExt && fileExt.startsWith('.')) {
+		fileExt = fileExt.slice(1,fileExt.length);
+		provider = notebookRegistry.getProviderForFileType(fileExt);
+	}
+	// Fallback to provider for default file type (assume this is a global handler)
+	if (!provider) {
+		provider = notebookRegistry.getProviderForFileType(DEFAULT_NOTEBOOK_FILETYPE);
+	}
+	// Finally if all else fails, use the built-in handler
+	if (!provider) {
+		provider = DEFAULT_NOTEBOOK_PROVIDER;
+	}
+	return provider;
+}