-
Notifications
You must be signed in to change notification settings - Fork 296
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "removed Notebook creation from extension since it is moving t…
- Loading branch information
Showing
10 changed files
with
229 additions
and
5 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| import { inject, injectable } from 'inversify'; | ||
| import { QuickPickItem } from 'vscode'; | ||
| import { IApplicationShell } from '../client/common/application/types'; | ||
| import { PYTHON_LANGUAGE, JVSC_EXTENSION_ID, JVSC_EXTENSION_DisplayName } from '../client/common/constants'; | ||
| import { DataScience } from '../client/common/utils/localize'; | ||
| import { INotebookEditorProvider } from '../client/datascience/types'; | ||
| import { sendTelemetryEvent } from '../client/telemetry'; | ||
| import { Telemetry } from '../datascience-ui/common/constants'; | ||
| import { CreationOptionService } from '../kernels/common/creationOptionsService'; | ||
|
|
||
| @injectable() | ||
| export class NotebookCreator { | ||
| constructor( | ||
| @inject(INotebookEditorProvider) private readonly editorProvider: INotebookEditorProvider, | ||
| @inject(IApplicationShell) private readonly appShell: IApplicationShell, | ||
| @inject(CreationOptionService) private readonly creationOptionsService: CreationOptionService | ||
| ) {} | ||
|
|
||
| public async createNewNotebook() { | ||
| if (this.creationOptionsService.registrations.length === 0) { | ||
| await this.editorProvider.createNew(); | ||
| return; | ||
| } | ||
|
|
||
| const items: (QuickPickItem & { | ||
| extensionId: string; | ||
| defaultCellLanguage: string; | ||
| })[] = this.creationOptionsService.registrations.map((item) => { | ||
| return { | ||
| label: item.displayName, | ||
| detail: item.extensionId, | ||
| extensionId: item.extensionId, | ||
| defaultCellLanguage: item.defaultCellLanguage | ||
| }; | ||
| }); | ||
|
|
||
| // First item is the Jupyter extension. | ||
| items.splice(0, 0, { | ||
| defaultCellLanguage: PYTHON_LANGUAGE, | ||
| detail: JVSC_EXTENSION_ID, | ||
| extensionId: JVSC_EXTENSION_ID, | ||
| label: JVSC_EXTENSION_DisplayName | ||
| }); | ||
| const placeHolder = DataScience.placeHolderToSelectOptionForNotebookCreation(); | ||
| const item = await this.appShell.showQuickPick(items, { | ||
| matchOnDescription: true, | ||
| matchOnDetail: true, | ||
| placeHolder | ||
| }); | ||
| sendTelemetryEvent(Telemetry.OpenNotebookSelection, undefined, { extensionId: item?.extensionId }); | ||
| if (item) { | ||
| await this.editorProvider.createNew({ defaultCellLanguage: item.defaultCellLanguage }); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
134 changes: 134 additions & 0 deletions
134
src/test/datascience/notebook/creation/notebookCreation.vscode.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| 'use strict'; | ||
|
|
||
| /* eslint-disable @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires */ | ||
| import { assert } from 'chai'; | ||
| import * as sinon from 'sinon'; | ||
| import { commands } from 'vscode'; | ||
| import { IApplicationShell, IVSCodeNotebook } from '../../../../client/common/application/types'; | ||
| import { PYTHON_LANGUAGE } from '../../../../client/common/constants'; | ||
| import { traceInfo } from '../../../../client/common/logger'; | ||
| import { IDisposable } from '../../../../client/common/types'; | ||
| import { Commands } from '../../../../client/datascience/constants'; | ||
| import { CreationOptionService } from '../../../../kernels/common/creationOptionsService'; | ||
| import { IExtensionTestApi, waitForCondition } from '../../../common'; | ||
| import { IS_REMOTE_NATIVE_TEST } from '../../../constants'; | ||
| import { closeActiveWindows, initialize } from '../../../initialize'; | ||
| import { | ||
| closeNotebooksAndCleanUpAfterTests, | ||
| ensureNewNotebooksHavePythonCells, | ||
| workAroundVSCodeNotebookStartPages | ||
| } from '../helper'; | ||
|
|
||
| /* eslint-disable @typescript-eslint/no-explicit-any, no-invalid-this */ | ||
| suite('DataScience - VSCode Notebook - (Creation Integration)', function () { | ||
| this.timeout(15_000); | ||
| let api: IExtensionTestApi; | ||
| let vscodeNotebook: IVSCodeNotebook; | ||
| let creationOptions: CreationOptionService; | ||
| const disposables: IDisposable[] = []; | ||
| suiteSetup(async function () { | ||
| api = await initialize(); | ||
| if (IS_REMOTE_NATIVE_TEST) { | ||
| return this.skip(); | ||
| } | ||
| creationOptions = api.serviceContainer.get<CreationOptionService>(CreationOptionService); | ||
| vscodeNotebook = api.serviceContainer.get<IVSCodeNotebook>(IVSCodeNotebook); | ||
| creationOptions.clear(); | ||
| await workAroundVSCodeNotebookStartPages(); | ||
| await ensureNewNotebooksHavePythonCells(); | ||
| }); | ||
| teardown(async function () { | ||
| traceInfo(`Ended Test ${this.currentTest?.title}`); | ||
| sinon.restore(); | ||
| creationOptions.clear(); | ||
| await closeNotebooksAndCleanUpAfterTests(disposables); | ||
| traceInfo(`Ended Test (completed) ${this.currentTest?.title}`); | ||
| }); | ||
| setup(async function () { | ||
| traceInfo(`Start Test ${this.currentTest?.title}`); | ||
| sinon.restore(); | ||
| await closeNotebooksAndCleanUpAfterTests(disposables); | ||
| traceInfo(`Start Test (completed) ${this.currentTest?.title}`); | ||
| }); | ||
| suiteTeardown(() => { | ||
| try { | ||
| creationOptions.clear(); | ||
| } catch { | ||
| // | ||
| } | ||
| }); | ||
| teardown(async function () { | ||
| traceInfo(`End Test ${this.currentTest?.title}`); | ||
| await closeNotebooksAndCleanUpAfterTests(disposables); | ||
| traceInfo(`Ended Test (completed) ${this.currentTest?.title}`); | ||
| }); | ||
| async function createNotebookAndValidateLanguageOfFirstCell(expectedLanguage: string) { | ||
| await commands.executeCommand(Commands.CreateNewNotebook); | ||
| await waitForCondition(async () => !!vscodeNotebook.activeNotebookEditor, 10_000, 'New Notebook not created'); | ||
| assert.strictEqual( | ||
| vscodeNotebook.activeNotebookEditor!.document.cellAt(0).document.languageId.toLowerCase(), | ||
| expectedLanguage | ||
| ); | ||
| } | ||
| test('With 3rd party integration, display quick pick when selecting create blank notebook command', async function () { | ||
| await creationOptions.registerNewNotebookContent('javascript'); | ||
| assert.equal(creationOptions.registrations.length, 1); | ||
| assert.isUndefined(vscodeNotebook.activeNotebookEditor); | ||
|
|
||
| const appShell = api.serviceContainer.get<IApplicationShell>(IApplicationShell); | ||
| const stub = sinon.stub(appShell, 'showQuickPick').callsFake((items: any) => { | ||
| traceInfo(`Quick Pick displayed to user`); | ||
| assert.isAtLeast(items.length, 2); | ||
|
|
||
| // If this is the first time this prompt was displayed, then select the second item (javascript). | ||
| if (stub.callCount === 1) { | ||
| return items[1]; | ||
| } | ||
|
|
||
| // Pick the first item, that will be us. | ||
| return items[0]; | ||
| }); | ||
| disposables.push({ dispose: () => stub.restore() }); | ||
|
|
||
| // Create a blank notebook & we should have a javascript cell. | ||
| await createNotebookAndValidateLanguageOfFirstCell('javascript'); | ||
| assert.equal(stub.callCount, 1); | ||
|
|
||
| await closeActiveWindows(); | ||
|
|
||
| // Try again & this time select the first item from the list & we should end up with a python notebook. | ||
| await createNotebookAndValidateLanguageOfFirstCell(PYTHON_LANGUAGE.toLowerCase()); | ||
| assert.equal(stub.callCount, 2); | ||
| }); | ||
| test('Without 3rd party integration, do not display quick pick when selecting create blank notebook command', async function () { | ||
| assert.equal(creationOptions.registrations.length, 0); | ||
| assert.isUndefined(vscodeNotebook.activeNotebookEditor); | ||
|
|
||
| // Create a blank notebook & it should just work. | ||
| await createNotebookAndValidateLanguageOfFirstCell(PYTHON_LANGUAGE.toLowerCase()); | ||
| }); | ||
| test('Create javascript & powershell Notebook using API', async function () { | ||
| // See https://github.com/microsoft/vscode-jupyter/issues/9158 | ||
| this.skip(); | ||
| await api.createBlankNotebook({ defaultCellLanguage: 'javascript' }); | ||
|
|
||
| await waitForCondition(async () => !!vscodeNotebook.activeNotebookEditor, 10_000, 'New Notebook not created'); | ||
| assert.strictEqual( | ||
| vscodeNotebook.activeNotebookEditor!.document.cellAt(0).document.languageId.toLowerCase(), | ||
| 'javascript' | ||
| ); | ||
|
|
||
| await closeActiveWindows(); | ||
|
|
||
| await api.createBlankNotebook({ defaultCellLanguage: 'powershell' }); | ||
|
|
||
| await waitForCondition(async () => !!vscodeNotebook.activeNotebookEditor, 10_000, 'New Notebook not created'); | ||
| assert.strictEqual( | ||
| vscodeNotebook.activeNotebookEditor!.document.cellAt(0).document.languageId.toLowerCase(), | ||
| 'powershell' | ||
| ); | ||
| }); | ||
| }); |