ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-01-26 09:35:38 -05:00
Code Issues Packages Projects Releases Wiki Activity

Notebooks: Support User-Installed Kernels (#10194)

Browse Source 
* Fixes for attach to. Still need to update cache

* Don't have jupyter hardcoded

* Handle DOTNET_ROOT env var

* Fix on load

* Put behind feature flag

* Cleanup

* Error check

* PR feedback
This commit is contained in:
Chris LaFreniere
2020-04-29 10:34:27 -07:00
committed by GitHub
parent 5b57b13005
commit 0a3a0ec80f
7 changed files with 78 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/sql/workbench/contrib/notebook/browser/notebook.component.ts
View File

@@ -396,7 +396,7 @@ export class NotebookComponent extends AngularDisposable implements OnInit, OnDe
protected initActionBar(): void {
let kernelContainer = document.createElement('div');
let kernelDropdown = new KernelsDropdown(kernelContainer, this.contextViewService, this.modelReady);
let kernelDropdown = this.instantiationService.createInstance(KernelsDropdown, kernelContainer, this.contextViewService, this.modelReady);
kernelDropdown.render(kernelContainer);
attachSelectBoxStyler(kernelDropdown, this.themeService);

13
src/sql/workbench/contrib/notebook/browser/notebook.contribution.ts
View File

@@ -197,6 +197,19 @@ configurationRegistry.registerConfiguration({
}
});
configurationRegistry.registerConfiguration({
'id': 'notebook',
'title': 'Notebook',
'type': 'object',
'properties': {
'notebook.showAllKernels': {
'type': 'boolean',
'default': false,
'description': localize('notebook.showAllKernels', "(Preview) show all kernels for the current notebook provider.")
}
}
});
/* *************** Output components *************** */
// Note: most existing types use the same component to render. In order to
// preserve correct rank order, we register it once for each different rank of

35
src/sql/workbench/contrib/notebook/browser/notebookActions.ts
View File

@@ -27,6 +27,7 @@ import { IObjectExplorerService } from 'sql/workbench/services/objectExplorer/br
import { TreeUpdateUtils } from 'sql/workbench/services/objectExplorer/browser/treeUpdateUtils';
import { find, firstIndex } from 'vs/base/common/arrays';
import { INotebookEditor } from 'sql/workbench/services/notebook/browser/notebookService';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
const msgLoading = localize('loading', "Loading kernels...");
const msgChanging = localize('changing', "Changing kernel...");
@@ -208,9 +209,12 @@ export class CollapseCellsAction extends ToggleableAction {
}
}
const ShowAllKernelsConfigName = 'notebook.showAllKernels';
const WorkbenchPreviewConfigName = 'workbench.enablePreviewFeatures';
export class KernelsDropdown extends SelectBox {
private model: NotebookModel;
constructor(container: HTMLElement, contextViewProvider: IContextViewProvider, modelReady: Promise<INotebookModel>) {
private _showAllKernels: boolean = false;
constructor(container: HTMLElement, contextViewProvider: IContextViewProvider, modelReady: Promise<INotebookModel>, @IConfigurationService private _configurationService: IConfigurationService) {
super([msgLoading], msgLoading, contextViewProvider, container, { labelText: kernelLabel, labelOnTop: false, ariaLabel: kernelLabel } as ISelectBoxOptionsWithLabel);
if (modelReady) {
@@ -222,6 +226,12 @@ export class KernelsDropdown extends SelectBox {
}
this.onDidSelect(e => this.doChangeKernel(e.selected));
this.getAllKernelConfigValue();
this._register(this._configurationService.onDidChangeConfiguration(e => {
if (e.affectsConfiguration(ShowAllKernelsConfigName) || e.affectsConfiguration(WorkbenchPreviewConfigName)) {
this.getAllKernelConfigValue();
}
}));
}
updateModel(model: INotebookModel): void {
@@ -235,12 +245,23 @@ export class KernelsDropdown extends SelectBox {
// Update SelectBox values
public updateKernel(kernel: azdata.nb.IKernel) {
let kernels: string[] = this.model.standardKernelsDisplayName();
let kernels: string[] = this._showAllKernels ? [...new Set(this.model.specs.kernels.map(a => a.display_name).concat(this.model.standardKernelsDisplayName()))]
: this.model.standardKernelsDisplayName();
if (kernel && kernel.isReady) {
let standardKernel = this.model.getStandardKernelFromName(kernel.name);
if (kernels && standardKernel) {
let index = firstIndex(kernels, kernel => kernel === standardKernel.displayName);
if (kernels) {
let index;
if (standardKernel) {
index = firstIndex(kernels, kernel => kernel === standardKernel.displayName);
} else {
let kernelSpec = this.model.specs.kernels.find(k => k.name === kernel.name);
index = firstIndex(kernels, k => k === kernelSpec.display_name);
}
// This is an error case that should never happen
// Just in case, setting index to 0
if (index < 0) {
index = 0;
}
this.setOptions(kernels, index);
}
} else if (this.model.clientSession.isInErrorState) {
@@ -254,6 +275,10 @@ export class KernelsDropdown extends SelectBox {
this.setOptions([msgChanging], 0);
this.model.changeKernel(displayName);
}
private getAllKernelConfigValue(): void {
this._showAllKernels = !!this._configurationService.getValue(ShowAllKernelsConfigName) && !!this._configurationService.getValue(WorkbenchPreviewConfigName);
}
}
export class AttachToDropdown extends SelectBox {

14
src/sql/workbench/contrib/notebook/test/electron-browser/notebookModel.test.ts
View File

@@ -402,20 +402,6 @@ suite('notebook model', function (): void {
assert.deepEqual(model.clientSession, mockClientSession.object);
});
test('Should sanitize kernel display name when IP is included', async function (): Promise<void> {
let model = new NotebookModel(defaultModelOptions, undefined, logService, undefined, new NullAdsTelemetryService());
let displayName = 'PySpark (1.1.1.1)';
let sanitizedDisplayName = model.sanitizeDisplayName(displayName);
assert.equal(sanitizedDisplayName, 'PySpark');
});
test('Should sanitize kernel display name properly when IP is not included', async function (): Promise<void> {
let model = new NotebookModel(defaultModelOptions, undefined, logService, undefined, new NullAdsTelemetryService());
let displayName = 'PySpark';
let sanitizedDisplayName = model.sanitizeDisplayName(displayName);
assert.equal(sanitizedDisplayName, 'PySpark');
});
test('Should notify on trust set', async function () {
// Given a notebook that's been loaded
let mockContentManager = TypeMoq.Mock.ofType(NotebookEditorContentManager);

37
src/sql/workbench/services/notebook/browser/models/notebookModel.ts
View File

@@ -464,7 +464,9 @@ export class NotebookModel extends Disposable implements INotebookModel {
public async startSession(manager: INotebookManager, displayName?: string, setErrorStateOnFail?: boolean): Promise<void> {
if (displayName && this._standardKernels) {
let standardKernel = find(this._standardKernels, kernel => kernel.displayName === displayName);
this._defaultKernel = { name: standardKernel.name, display_name: standardKernel.displayName };
if (standardKernel) {
this._defaultKernel = { name: standardKernel.name, display_name: standardKernel.displayName };
}
}
if (this._defaultKernel) {
let clientSession = this._notebookOptions.factory.createClientSession({
@@ -519,6 +521,13 @@ export class NotebookModel extends Disposable implements INotebookModel {
let provider = this._kernelDisplayNameToNotebookProviderIds.get(this._savedKernelInfo.display_name);
if (provider && provider !== this._providerId) {
this._providerId = provider;
} else if (!provider) {
this.notebookOptions.notebookManagers.forEach(m => {
if (m.providerId !== SQL_NOTEBOOK_PROVIDER) {
// We don't know which provider it is before that provider is chosen to query its specs. Choosing the "last" one registered.
this._providerId = m.providerId;
}
});
}
this._defaultKernel = this._savedKernelInfo;
} else if (this._defaultKernel) {
@@ -616,10 +625,12 @@ export class NotebookModel extends Disposable implements INotebookModel {
} else if (language.toLowerCase() === 'ipython') {
// Special case ipython because in many cases this is defined as the code mirror mode for python notebooks
language = 'python';
} else if (language.toLowerCase() === 'c#') {
language = 'cs';
}
}
this._language = language;
this._language = language.toLowerCase();
}
public changeKernel(displayName: string): void {
@@ -750,7 +761,6 @@ export class NotebookModel extends Disposable implements INotebookModel {
}
private getKernelSpecFromDisplayName(displayName: string): nb.IKernelSpec {
displayName = this.sanitizeDisplayName(displayName);
let kernel: nb.IKernelSpec = find(this.specs.kernels, k => k.display_name.toLowerCase() === displayName.toLowerCase());
if (!kernel) {
return undefined; // undefined is handled gracefully in the session to default to the default kernel
@@ -762,7 +772,7 @@ export class NotebookModel extends Disposable implements INotebookModel {
private sanitizeSavedKernelInfo() {
if (this._savedKernelInfo) {
let displayName = this.sanitizeDisplayName(this._savedKernelInfo.display_name);
let displayName = this._savedKernelInfo.display_name;
if (this._savedKernelInfo.display_name !== displayName) {
this._savedKernelInfo.display_name = displayName;
@@ -843,21 +853,6 @@ export class NotebookModel extends Disposable implements INotebookModel {
}
}
/**
* Sanitizes display name to remove IP address in order to fairly compare kernels
* In some notebooks, display name is in the format <kernel> (<ip address>)
* example: PySpark (25.23.32.4)
* @param displayName Display Name for the kernel
*/
public sanitizeDisplayName(displayName: string): string {
let name = displayName;
if (name) {
let index = name.indexOf('(');
name = (index > -1) ? name.substr(0, index - 1).trim() : name;
}
return name;
}
private async updateKernelInfo(kernel: nb.IKernel): Promise<void> {
if (kernel) {
try {
@@ -912,6 +907,10 @@ export class NotebookModel extends Disposable implements INotebookModel {
if (alwaysReturnId || (!this._oldKernel || this._oldKernel.name !== standardKernel.name)) {
return providerId;
}
} else {
if (this.notebookManagers?.length) {
return this.notebookManagers.map(m => m.providerId).find(p => p !== DEFAULT_NOTEBOOK_PROVIDER && p !== SQL_NOTEBOOK_PROVIDER);
}
}
return undefined;
}