Allow users to open VSC notebook even when using our own Notebook Editors (microsoft#12402)

For #12400 * Side by side nb editors

Author: DonJayamanne

build/ci/templates/steps/compile.yml

@@ -8,11 +8,6 @@ steps:
  compile: 'false'
  installVSCEorNPX: 'false'
 
- - task: Gulp@0
- displayName: 'Validate package.json'
- inputs:
- targets: 'validate-packagejson'
-
  - task: Gulp@0
  displayName: 'Compile and check for errors'
  inputs:

gulpfile.js

@@ -113,23 +113,10 @@ gulp.task('checkNativeDependencies', (done) => {
  done();
 });
 
-gulp.task('validate-packagejson', () => validatePackageJson());
 gulp.task('compile-ipywidgets', () => buildIPyWidgets());
 
 const webpackEnv = { NODE_OPTIONS: '--max_old_space_size=9096' };
 
-async function validatePackageJson() {
- const json = require('./package.json');
- if (json.enableProposedApi) {
- throw new Error('package.json has enableProposedApi setting enabled');
- }
- if (json.contributes.notebookOutputRenderer) {
- throw new Error('Package.json contains entry for contributes.notebookOutputRenderer');
- }
- if (json.contributes.notebookProvider) {
- throw new Error('Package.json contains entry for contributes.notebookProvider');
- }
-}
 
 async function buildIPyWidgets() {
  // if the output ipywidgest file exists, then no need to re-build.

package.json

@@ -8,7 +8,7 @@
  },
  "languageServerVersion": "0.5.30",
  "publisher": "ms-python",
- "enableProposedApi": false,
+ "enableProposedApi": true,
  "author": {
  "name": "Microsoft Corporation"
  },
@@ -3028,7 +3028,43 @@
  "when": "testsDiscovered"
  }
  ]
- }
+ },
+ "notebookOutputRenderer": [
+ {
+ "viewType": "jupyter-notebook-renderer",
+ "displayName": "Jupyter Notebook Renderer",
+ "mimeTypes": [
+ "application/geo+json",
+ "application/vdom.v1+json",
+ "application/vnd.dataresource+json",
+ "application/vnd.plotly.v1+json",
+ "application/vnd.vega.v2+json",
+ "application/vnd.vega.v3+json",
+ "application/vnd.vega.v4+json",
+ "application/vnd.vega.v5+json",
+ "application/vnd.vegalite.v1+json",
+ "application/vnd.vegalite.v2+json",
+ "application/vnd.vegalite.v3+json",
+ "application/vnd.vegalite.v4+json",
+ "application/x-nteract-model-debug+json",
+ "image/gif",
+ "text/latex",
+ "text/vnd.plotly.v1+html"
+ ]
+ }
+ ],
+ "notebookProvider": [
+ {
+ "viewType": "jupyter-notebook",
+ "displayName": "Jupyter Notebook (preview)",
+ "selector": [
+ {
+ "filenamePattern": "*.ipynb"
+ }
+ ],
+ "priority": "option"
+ }
+ ]
  },
  "scripts": {
  "package": "gulp clean && gulp prePublishBundle && vsce package -o ms-python-insiders.vsix",

package.nls.json

@@ -529,5 +529,7 @@
  "DataScience.rawKernelSessionFailed": "Unable to start session for kernel {0}. Select another kernel to launch with.",
  "DataScience.rawKernelConnectingSession": "Connecting to kernel.",
  "DataScience.reloadCustomEditor": "Please reload VS Code to use the custom editor API",
- "DataScience.step": "Run next line (F10)"
+ "DataScience.reloadVSCodeNotebookEditor": "Please reload VS Code to use the Notebook Editor",
+ "DataScience.step": "Run next line (F10)",
+ "DataScience.usingPreviewNotebookWithOtherNotebookWarning": "Using the Preview Notebook Editor along with the stable Notebook Editor is not recommended. Doing so could result in data loss or corruption of notebooks."
 }

src/client/common/constants.ts

@@ -111,7 +111,7 @@ export function isUnitTestExecution(): boolean {
 
 // Temporary constant, used to indicate whether we're using custom editor api or not.
 export const UseCustomEditorApi = Symbol('USE_CUSTOM_EDITOR');
-export const UseNativeEditorApi = Symbol('USE_NATIVEEDITOR');
+export const UseVSCodeNotebookEditorApi = Symbol('USE_NATIVEEDITOR');
 export const UseProposedApi = Symbol('USE_VSC_PROPOSED_API');
 
 export * from '../constants';

src/client/common/utils/localize.ts

@@ -973,6 +973,14 @@ export namespace DataScience {
  'DataScience.reloadCustomEditor',
  'Please reload VS Code to use the custom editor API'
  );
+ export const reloadVSCodeNotebookEditor = localize(
+ 'DataScience.reloadVSCodeNotebookEditor',
+ 'Please reload VS Code to use the Notebook Editor'
+ );
+ export const usingPreviewNotebookWithOtherNotebookWarning = localize(
+ 'DataScience.usingPreviewNotebookWithOtherNotebookWarning',
+ 'Using the Preview Notebook Editor along with the stable Notebook Editor is not recommended. Doing so could result in data loss or corruption of notebooks.'
+ );
 }
 
 export namespace StartPage {

src/client/datascience/constants.ts

@@ -495,3 +495,6 @@ export namespace LiveShareCommands {
  export const rawKernelSupported = 'rawKernelSupported';
  export const createRawNotebook = 'createRawNotebook';
 }
+
+export const VSCodeNotebookProvider = 'VSCodeNotebookProvider';
+export const OurNotebookProvider = 'OurNotebookProvider';

src/client/datascience/context/activeEditorContext.ts

@@ -6,7 +6,7 @@
 import { inject, injectable } from 'inversify';
 import { TextEditor } from 'vscode';
 import { IExtensionSingleActivationService } from '../../activation/types';
-import { ICommandManager, IDocumentManager, IVSCodeNotebook } from '../../common/application/types';
+import { ICommandManager, IDocumentManager } from '../../common/application/types';
 import { PYTHON_LANGUAGE } from '../../common/constants';
 import { ContextKey } from '../../common/contextKey';
 import { NotebookEditorSupport } from '../../common/experiments/groups';
@@ -31,7 +31,6 @@ export class ActiveEditorContextService implements IExtensionSingleActivationSer
  @inject(IDocumentManager) private readonly docManager: IDocumentManager,
  @inject(ICommandManager) private readonly commandManager: ICommandManager,
  @inject(IDisposableRegistry) disposables: IDisposableRegistry,
- @inject(IVSCodeNotebook) private readonly vscodeNotebook: IVSCodeNotebook,
  @inject(IExperimentsManager) private readonly experiments: IExperimentsManager
  ) {
  disposables.push(this);
@@ -72,28 +71,16 @@ export class ActiveEditorContextService implements IExtensionSingleActivationSer
  if (this.docManager.activeTextEditor?.document.languageId === PYTHON_LANGUAGE) {
  this.onDidChangeActiveTextEditor(this.docManager.activeTextEditor);
  }
- if (this.experiments.inExperiment(NotebookEditorSupport.nativeNotebookExperiment)) {
- this.vscodeNotebook.onDidChangeNotebookDocument(this.onDidChangeVSCodeNotebook, this, this.disposables);
- this.vscodeNotebook.onDidCloseNotebookDocument(this.onDidChangeVSCodeNotebook, this, this.disposables);
- this.vscodeNotebook.onDidOpenNotebookDocument(this.onDidChangeVSCodeNotebook, this, this.disposables);
- this.docManager.onDidChangeActiveTextEditor(this.onDidChangeVSCodeNotebook, this, this.disposables);
- }
  }
 
  private udpateNativeNotebookCellContext() {
  if (!this.experiments.inExperiment(NotebookEditorSupport.nativeNotebookExperiment)) {
  return;
  }
  this.hasNativeNotebookCells
- .set((this.vscodeNotebook.activeNotebookEditor?.document?.cells?.length || 0) > 0)
+ .set((this.notebookEditorProvider.activeEditor?.model?.cells?.length || 0) > 0)
  .ignoreErrors();
  }
- private onDidChangeVSCodeNotebook() {
- this.isPythonFileActive = !this.vscodeNotebook.activeNotebookEditor;
- this.nativeContext.set(!!this.vscodeNotebook.activeNotebookEditor).ignoreErrors();
- this.udpateNativeNotebookCellContext();
- this.updateMergedContexts();
- }
  private onDidChangeActiveInteractiveWindow(e?: IInteractiveWindow) {
  this.interactiveContext.set(!!e).ignoreErrors();
  this.updateMergedContexts();
@@ -104,7 +91,7 @@ export class ActiveEditorContextService implements IExtensionSingleActivationSer
  }
  private onDidChangeActiveTextEditor(e?: TextEditor) {
  this.isPythonFileActive =
- e?.document.languageId === PYTHON_LANGUAGE && !this.vscodeNotebook.activeNotebookEditor;
+ e?.document.languageId === PYTHON_LANGUAGE && !this.notebookEditorProvider.activeEditor;
  this.udpateNativeNotebookCellContext();
  this.updateMergedContexts();
  }

src/client/datascience/interactive-ipynb/nativeEditorStorage.ts

@@ -21,7 +21,7 @@ import { CellState, ICell, IJupyterExecution, IJupyterKernelSpec, INotebookModel
 import detectIndent = require('detect-indent');
 // tslint:disable-next-line:no-require-imports no-var-requires
 import cloneDeep = require('lodash/cloneDeep');
-import { UseNativeEditorApi } from '../../common/constants';
+import { UseVSCodeNotebookEditorApi } from '../../common/constants';
 import { isFileNotFoundError } from '../../common/platform/errors';
 import { sendTelemetryEvent } from '../../telemetry';
 import { pruneCell } from '../common';
@@ -107,7 +107,7 @@ export class NativeEditorNotebookModel implements INotebookModel {
  private _id = uuid();
 
  constructor(
- private readonly useNativeEditorApi: boolean,
+ public useNativeEditorApi: boolean,
  file: Uri,
  cells: ICell[],
  json: Partial<nbformat.INotebookContent> = {},
@@ -494,6 +494,17 @@ export class NativeEditorNotebookModel implements INotebookModel {
  }
 }
 
+/**
+ * Temporary hack to ensure we can use VS Code notebooks along with our standard notbooked editors.
+ */
+export function updateModelForUseWithVSCodeNotebook(model: INotebookModel) {
+ if (!(model instanceof NativeEditorNotebookModel)) {
+ throw new Error('Unsupported NotebookModel');
+ }
+ const rawModel = model as NativeEditorNotebookModel;
+ rawModel.useNativeEditorApi = true;
+}
+
 @injectable()
 export class NativeEditorStorage implements INotebookStorage {
  public get onSavedAs(): Event<{ new: Uri; old: Uri }> {
@@ -513,7 +524,7 @@ export class NativeEditorStorage implements INotebookStorage {
  @inject(IExtensionContext) private context: IExtensionContext,
  @inject(IMemento) @named(GLOBAL_MEMENTO) private globalStorage: Memento,
  @inject(IMemento) @named(WORKSPACE_MEMENTO) private localStorage: Memento,
- @inject(UseNativeEditorApi) private readonly useNativeEditorApi: boolean
+ @inject(UseVSCodeNotebookEditorApi) private readonly useNativeEditorApi: boolean
  ) {}
  private static isUntitledFile(file: Uri) {
  return isUntitledFile(file);

src/client/datascience/notebook/cellEditSyncService.ts

@@ -7,8 +7,7 @@ import type { NotebookCell, NotebookDocument } from '../../../../typings/vscode-
 import { splitMultilineString } from '../../../datascience-ui/common';
 import { IExtensionSingleActivationService } from '../../activation/types';
 import { IDocumentManager, IVSCodeNotebook } from '../../common/application/types';
-import { NotebookEditorSupport } from '../../common/experiments/groups';
-import { IDisposable, IDisposableRegistry, IExperimentsManager } from '../../common/types';
+import { IDisposable, IDisposableRegistry } from '../../common/types';
 import { isNotebookCell } from '../../common/utils/misc';
 import { traceError } from '../../logging';
 import { INotebookEditorProvider, INotebookModel } from '../types';
@@ -23,8 +22,7 @@ export class CellEditSyncService implements IExtensionSingleActivationService, I
  @inject(IDocumentManager) private readonly documentManager: IDocumentManager,
  @inject(IDisposableRegistry) disposableRegistry: IDisposableRegistry,
  @inject(IVSCodeNotebook) private readonly vscNotebook: IVSCodeNotebook,
- @inject(INotebookEditorProvider) private readonly editorProvider: INotebookEditorProvider,
- @inject(IExperimentsManager) private readonly experiment: IExperimentsManager
+ @inject(INotebookEditorProvider) private readonly editorProvider: INotebookEditorProvider
  ) {
  disposableRegistry.push(this);
  }
@@ -34,9 +32,6 @@ export class CellEditSyncService implements IExtensionSingleActivationService, I
  }
  }
  public async activate(): Promise<void> {
- if (!this.experiment.inExperiment(NotebookEditorSupport.nativeNotebookExperiment)) {
- return;
- }
  this.documentManager.onDidChangeTextDocument(this.onDidChangeTextDocument, this, this.disposables);
  }