mirror of
https://github.com/ckaczor/azuredatastudio.git
synced 2026-01-19 09:35:36 -05:00
cac8cc99e1
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.
90 lines
2.9 KiB
TypeScript
90 lines
2.9 KiB
TypeScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the Source EULA. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
|
|
'use strict';
|
|
|
|
import * as sqlops from 'sqlops';
|
|
|
|
import { Event } from 'vs/base/common/event';
|
|
import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
|
|
import URI from 'vs/base/common/uri';
|
|
import { IBootstrapParams } from 'sql/services/bootstrap/bootstrapService';
|
|
import { RenderMimeRegistry } from 'sql/parts/notebook/outputs/registry';
|
|
import { ModelFactory } from 'sql/parts/notebook/models/modelFactory';
|
|
import { IConnectionProfile } from 'sql/parts/connection/common/interfaces';
|
|
import { NotebookInput } from 'sql/parts/notebook/notebookInput';
|
|
|
|
export const SERVICE_ID = 'notebookService';
|
|
export const INotebookService = createDecorator<INotebookService>(SERVICE_ID);
|
|
|
|
export const DEFAULT_NOTEBOOK_PROVIDER = 'builtin';
|
|
export const DEFAULT_NOTEBOOK_FILETYPE = 'IPYNB';
|
|
|
|
export interface INotebookService {
|
|
_serviceBrand: any;
|
|
|
|
onNotebookEditorAdd: Event<INotebookEditor>;
|
|
onNotebookEditorRemove: Event<INotebookEditor>;
|
|
|
|
/**
|
|
* Register a metadata provider
|
|
*/
|
|
registerProvider(providerId: string, provider: INotebookProvider): void;
|
|
|
|
/**
|
|
* Register a metadata provider
|
|
*/
|
|
unregisterProvider(providerId: string): void;
|
|
|
|
/**
|
|
* Initializes and returns a Notebook manager that can handle all important calls to open, display, and
|
|
* run cells in a notebook.
|
|
* @param providerId ID for the provider to be used to instantiate a backend notebook service
|
|
* @param uri URI for a notebook that is to be opened. Based on this an existing manager may be used, or
|
|
* a new one may need to be created
|
|
*/
|
|
getOrCreateNotebookManager(providerId: string, uri: URI): Thenable<INotebookManager>;
|
|
|
|
addNotebookEditor(editor: INotebookEditor): void;
|
|
|
|
removeNotebookEditor(editor: INotebookEditor): void;
|
|
|
|
listNotebookEditors(): INotebookEditor[];
|
|
|
|
shutdown(): void;
|
|
|
|
getMimeRegistry(): RenderMimeRegistry;
|
|
}
|
|
|
|
export interface INotebookProvider {
|
|
readonly providerId: string;
|
|
getNotebookManager(notebookUri: URI): Thenable<INotebookManager>;
|
|
handleNotebookClosed(notebookUri: URI): void;
|
|
}
|
|
|
|
export interface INotebookManager {
|
|
providerId: string;
|
|
readonly contentManager: sqlops.nb.ContentManager;
|
|
readonly sessionManager: sqlops.nb.SessionManager;
|
|
readonly serverManager: sqlops.nb.ServerManager;
|
|
}
|
|
|
|
export interface INotebookParams extends IBootstrapParams {
|
|
notebookUri: URI;
|
|
input: NotebookInput;
|
|
providerId: string;
|
|
isTrusted: boolean;
|
|
profile?: IConnectionProfile;
|
|
modelFactory?: ModelFactory;
|
|
}
|
|
|
|
export interface INotebookEditor {
|
|
readonly notebookParams: INotebookParams;
|
|
readonly id: string;
|
|
isDirty(): boolean;
|
|
isActive(): boolean;
|
|
isVisible(): boolean;
|
|
save(): Promise<boolean>;
|
|
} |