More layering (#9111)

* move handling generated files to the serilization classes

* remove unneeded methods

* add more folders to strictire compile, add more strict compile options

* update ci

* wip

* add more layering and fix issues

* add more strictness

* remove unnecessary assertion

* add missing checks

* fix indentation

* wip

* remove jsdoc

* fix layering

* fix compile

* fix compile errors

* wip

* wip

* finish layering

* fix css

* more layering

* rip

* reworking results serializer

* move some files around

* move capabilities to platform wip

* implement capabilities register provider

* fix capabilities service

* fix usage of the regist4ry

* add contribution

* remove no longer good parts

* fix issues with startup

* another try

* fix startup

* fix imports

* fix tests

* fix tests

* fix more tests

* fix tests

* fix more tests

* fix broken test

* fix tabbing

* fix naming

src/sql/workbench/services/notebook/common/contracts.ts

@@ -0,0 +1,49 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+
+export type CellType = 'code' | 'markdown' | 'raw';
+
+export class CellTypes {
+	public static readonly Code = 'code';
+	public static readonly Markdown = 'markdown';
+}
+
+// to do: add all mime types
+export type MimeType = 'text/plain' | 'text/html';
+
+// to do: add all mime types
+export class MimeTypes {
+	public static readonly PlainText = 'text/plain';
+	public static readonly HTML = 'text/html';
+}
+
+export type OutputType =
+	| 'execute_result'
+	| 'display_data'
+	| 'stream'
+	| 'error'
+	| 'update_display_data';
+
+export class OutputTypes {
+	public static readonly ExecuteResult = 'execute_result';
+	public static readonly DisplayData = 'display_data';
+	public static readonly Stream = 'stream';
+	public static readonly Error = 'error';
+	public static readonly UpdateDisplayData = 'update_display_data';
+}
+
+export enum NotebookChangeType {
+	CellsModified,
+	CellSourceUpdated,
+	CellOutputUpdated,
+	DirtyStateChanged,
+	KernelChanged,
+	TrustChanged,
+	Saved,
+	CellExecuted,
+	CellInputVisibilityChanged,
+	CellOutputCleared
+}

src/sql/workbench/services/notebook/common/jsonext.ts

@@ -0,0 +1,53 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+/**
+ * A type alias for a JSON primitive.
+ */
+export declare type JSONPrimitive = boolean | number | string | null;
+/**
+ * A type alias for a JSON value.
+ */
+export declare type JSONValue = JSONPrimitive | JSONObject | JSONArray;
+/**
+ * A type definition for a JSON object.
+ */
+export interface JSONObject {
+	[key: string]: JSONValue;
+}
+/**
+ * A type definition for a JSON array.
+ */
+export interface JSONArray extends Array<JSONValue> {
+}
+/**
+ * A type definition for a readonly JSON object.
+ */
+export interface ReadonlyJSONObject {
+	readonly [key: string]: ReadonlyJSONValue;
+}
+/**
+ * A type definition for a readonly JSON array.
+ */
+export interface ReadonlyJSONArray extends ReadonlyArray<ReadonlyJSONValue> {
+}
+/**
+ * A type alias for a readonly JSON value.
+ */
+export declare type ReadonlyJSONValue = JSONPrimitive | ReadonlyJSONObject | ReadonlyJSONArray;
+/**
+ * Test whether a JSON value is a primitive.
+ *
+ * @param value - The JSON value of interest.
+ *
+ * @returns `true` if the value is a primitive,`false` otherwise.
+ */
+export function isPrimitive(value: any): boolean {
+	return (
+		value === null ||
+		typeof value === 'boolean' ||
+		typeof value === 'number' ||
+		typeof value === 'string'
+	);
+}

src/sql/workbench/services/notebook/common/localContentManager.ts

@@ -12,10 +12,10 @@ import { URI } from 'vs/base/common/uri';
 import { localize } from 'vs/nls';
 import { IFileService } from 'vs/platform/files/common/files';
 
-import { JSONObject } from 'sql/workbench/contrib/notebook/common/models/jsonext';
-import { OutputTypes } from 'sql/workbench/contrib/notebook/common/models/contracts';
-import { nbversion } from 'sql/workbench/contrib/notebook/common/models/notebookConstants';
-import { nbformat } from 'sql/workbench/contrib/notebook/common/models/nbformat';
+import { JSONObject } from 'sql/workbench/services/notebook/common/jsonext';
+import { OutputTypes } from 'sql/workbench/services/notebook/common/contracts';
+import { nbversion } from 'sql/workbench/services/notebook/common/notebookConstants';
+import { nbformat } from 'sql/workbench/services/notebook/common/nbformat';
 import { VSBuffer } from 'vs/base/common/buffer';
 
 type MimeBundle = { [key: string]: string | string[] | undefined };

src/sql/workbench/services/notebook/common/nbformat.ts

@@ -0,0 +1,494 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+// Notebook format interfaces
+// https://nbformat.readthedocs.io/en/latest/format_description.html
+// https://github.com/jupyter/nbformat/blob/master/nbformat/v4/nbformat.v4.schema.json
+
+
+import { JSONObject } from 'sql/workbench/services/notebook/common/jsonext';
+import { nb } from 'azdata';
+
+/**
+ * A namespace for nbformat interfaces.
+ */
+export namespace nbformat {
+	/**
+	 * The major version of the notebook format.
+	 */
+	export const MAJOR_VERSION: number = 4;
+
+	/**
+	 * The minor version of the notebook format.
+	 */
+	export const MINOR_VERSION: number = 2;
+
+	/**
+	 * The kernelspec metadata.
+	 */
+	export interface IKernelspecMetadata extends JSONObject {
+		name: string;
+		display_name: string;
+	}
+
+	/**
+	 * The language info metatda
+	 */
+	export interface ILanguageInfoMetadata extends JSONObject {
+		name: string;
+		codemirror_mode?: string | JSONObject;
+		file_extension?: string;
+		mimetype?: string;
+		pygments_lexer?: string;
+	}
+
+	/**
+	 * The default metadata for the notebook.
+	 */
+	export interface INotebookMetadata extends JSONObject {
+		kernelspec?: IKernelspecMetadata;
+		language_info?: ILanguageInfoMetadata;
+		orig_nbformat: number;
+	}
+
+	/**
+	 * The notebook content.
+	 */
+	export interface INotebookContent {
+		metadata: INotebookMetadata;
+		nbformat_minor: number;
+		nbformat: number;
+		cells: ICell[];
+	}
+
+	/**
+	 * A multiline string.
+	 */
+	export type MultilineString = string | string[];
+
+	/**
+	 * A mime-type keyed dictionary of data.
+	 */
+	export interface IMimeBundle extends JSONObject {
+		[key: string]: MultilineString | JSONObject;
+	}
+
+	/**
+	 * Media attachments (e.g. inline images).
+	 */
+	export interface IAttachments {
+		[key: string]: IMimeBundle;
+	}
+
+	/**
+	 * The code cell's prompt number. Will be null if the cell has not been run.
+	 */
+	export type ExecutionCount = number | null;
+
+	/**
+	 * Cell output metadata.
+	 */
+	export type OutputMetadata = JSONObject;
+
+	/**
+	 * Validate a mime type/value pair.
+	 *
+	 * @param type - The mimetype name.
+	 *
+	 * @param value - The value associated with the type.
+	 *
+	 * @returns Whether the type/value pair are valid.
+	 */
+	export function validateMimeValue(
+		type: string,
+		value: MultilineString | JSONObject
+	): boolean {
+		// Check if "application/json" or "application/foo+json"
+		const jsonTest = /^application\/(.*?)+\+json$/;
+		const isJSONType = type === 'application/json' || jsonTest.test(type);
+
+		let isString = (x: any) => {
+			return Object.prototype.toString.call(x) === '[object String]';
+		};
+
+		// If it is an array, make sure if is not a JSON type and it is an
+		// array of strings.
+		if (Array.isArray(value)) {
+			if (isJSONType) {
+				return false;
+			}
+			let valid = true;
+			(value as string[]).forEach(v => {
+				if (!isString(v)) {
+					valid = false;
+				}
+			});
+			return valid;
+		}
+
+		// If it is a string, make sure we are not a JSON type.
+		if (isString(value)) {
+			return !isJSONType;
+		}
+
+		// It is not a string, make sure it is a JSON type.
+		if (!isJSONType) {
+			return false;
+		}
+
+		// It is a JSON type, make sure it is a valid JSON object.
+		// return JSONExt.isObject(value);
+		return true;
+	}
+
+	/**
+	 * Cell-level metadata.
+	 */
+	export interface IBaseCellMetadata extends JSONObject {
+		/**
+		 * Whether the cell is trusted.
+		 *
+		 * #### Notes
+		 * This is not strictly part of the nbformat spec, but it is added by
+		 * the contents manager.
+		 *
+		 * See https://jupyter-notebook.readthedocs.io/en/latest/security.html.
+		 */
+		trusted: boolean;
+
+		/**
+		 * The cell's name. If present, must be a non-empty string.
+		 */
+		name: string;
+
+		/**
+		 * The cell's tags. Tags must be unique, and must not contain commas.
+		 */
+		tags: string[];
+	}
+
+	/**
+	 * The base cell interface.
+	 */
+	export interface IBaseCell {
+		/**
+		 * String identifying the type of cell.
+		 */
+		cell_type: string;
+
+		/**
+		 * Contents of the cell, represented as an array of lines.
+		 */
+		source: MultilineString;
+
+		/**
+		 * Cell-level metadata.
+		 */
+		metadata: Partial<ICellMetadata>;
+	}
+
+	/**
+	 * Metadata for the raw cell.
+	 */
+	export interface IRawCellMetadata extends IBaseCellMetadata {
+		/**
+		 * Raw cell metadata format for nbconvert.
+		 */
+		format: string;
+	}
+
+	/**
+	 * A raw cell.
+	 */
+	export interface IRawCell extends IBaseCell {
+		/**
+		 * String identifying the type of cell.
+		 */
+		cell_type: 'raw';
+
+		/**
+		 * Cell-level metadata.
+		 */
+		metadata: Partial<IRawCellMetadata>;
+
+		/**
+		 * Cell attachments.
+		 */
+		attachments?: IAttachments;
+	}
+
+	/**
+	 * A markdown cell.
+	 */
+	export interface IMarkdownCell extends IBaseCell {
+		/**
+		 * String identifying the type of cell.
+		 */
+		cell_type: 'markdown';
+
+		/**
+		 * Cell attachments.
+		 */
+		attachments?: IAttachments;
+	}
+
+	/**
+	 * Metadata for a code cell.
+	 */
+	export interface ICodeCellMetadata extends IBaseCellMetadata {
+		/**
+		 * Whether the cell is collapsed/expanded.
+		 */
+		collapsed: boolean;
+
+		/**
+		 * Whether the cell's output is scrolled, unscrolled, or autoscrolled.
+		 */
+		scrolled: boolean | 'auto';
+	}
+
+	/**
+	 * A code cell.
+	 */
+	export interface ICodeCell extends IBaseCell {
+		/**
+		 * String identifying the type of cell.
+		 */
+		cell_type: 'code';
+
+		/**
+		 * Cell-level metadata.
+		 */
+		metadata: Partial<ICodeCellMetadata>;
+
+		/**
+		 * Execution, display, or stream outputs.
+		 */
+		outputs: IOutput[];
+
+		/**
+		 * The code cell's prompt number. Will be null if the cell has not been run.
+		 */
+		execution_count: ExecutionCount;
+	}
+
+	/**
+	 * An unrecognized cell.
+	 */
+	export interface IUnrecognizedCell extends IBaseCell { }
+
+	/**
+	 * A cell union type.
+	 */
+	export type ICell = IRawCell | IMarkdownCell | ICodeCell | IUnrecognizedCell;
+
+	/**
+	 * Test whether a cell is a raw cell.
+	 */
+	export function isRaw(cell: ICell): cell is IRawCell {
+		return cell.cell_type === 'raw';
+	}
+
+	/**
+	 * Test whether a cell is a markdown cell.
+	 */
+	export function isMarkdown(cell: ICell): cell is IMarkdownCell {
+		return cell.cell_type === 'markdown';
+	}
+
+	/**
+	 * Test whether a cell is a code cell.
+	 */
+	export function isCode(cell: ICell): cell is ICodeCell {
+		return cell.cell_type === 'code';
+	}
+
+	/**
+	 * A union metadata type.
+	 */
+	export type ICellMetadata =
+		| IBaseCellMetadata
+		| IRawCellMetadata
+		| ICodeCellMetadata;
+
+	/**
+	 * The valid output types.
+	 */
+	export type OutputType =
+		| 'execute_result'
+		| 'display_data'
+		| 'stream'
+		| 'error'
+		| 'update_display_data';
+
+
+	/**
+	 * Result of executing a code cell.
+	 */
+	export interface IExecuteResult extends nb.ICellOutput {
+		/**
+		 * Type of cell output.
+		 */
+		output_type: 'execute_result';
+
+		/**
+		 * A result's prompt number.
+		 */
+		execution_count: ExecutionCount;
+
+		/**
+		 * A mime-type keyed dictionary of data.
+		 */
+		data: IMimeBundle;
+
+		/**
+		 * Cell output metadata.
+		 */
+		metadata: OutputMetadata;
+	}
+
+	/**
+	 * Data displayed as a result of code cell execution.
+	 */
+	export interface IDisplayData extends nb.ICellOutput {
+		/**
+		 * Type of cell output.
+		 */
+		output_type: 'display_data';
+
+		/**
+		 * A mime-type keyed dictionary of data.
+		 */
+		data: IMimeBundle;
+
+		/**
+		 * Cell output metadata.
+		 */
+		metadata: OutputMetadata;
+	}
+
+	/**
+	 * Data displayed as an update to existing display data.
+	 */
+	export interface IDisplayUpdate extends nb.ICellOutput {
+		/**
+		 * Type of cell output.
+		 */
+		output_type: 'update_display_data';
+
+		/**
+		 * A mime-type keyed dictionary of data.
+		 */
+		data: IMimeBundle;
+
+		/**
+		 * Cell output metadata.
+		 */
+		metadata: OutputMetadata;
+	}
+
+	/**
+	 * Stream output from a code cell.
+	 */
+	export interface IStream extends nb.ICellOutput {
+		/**
+		 * Type of cell output.
+		 */
+		output_type: 'stream';
+
+		/**
+		 * The name of the stream.
+		 */
+		name: StreamType;
+
+		/**
+		 * The stream's text output.
+		 */
+		text: MultilineString;
+	}
+
+	/**
+	 * An alias for a stream type.
+	 */
+	export type StreamType = 'stdout' | 'stderr';
+
+	/**
+	 * Output of an error that occurred during code cell execution.
+	 */
+	export interface IError extends nb.ICellOutput {
+		/**
+		 * Type of cell output.
+		 */
+		output_type: 'error';
+
+		/**
+		 * The name of the error.
+		 */
+		ename: string;
+
+		/**
+		 * The value, or message, of the error.
+		 */
+		evalue: string;
+
+		/**
+		 * The error's traceback.
+		 */
+		traceback: string[];
+	}
+
+	/**
+	 * Unrecognized output.
+	 */
+	export interface IUnrecognizedOutput extends nb.ICellOutput { }
+
+	/**
+	 * Test whether an output is an execute result.
+	 */
+	export function isExecuteResult(output: IOutput): output is IExecuteResult {
+		return output.output_type === 'execute_result';
+	}
+
+	/**
+	 * Test whether an output is from display data.
+	 */
+	export function isDisplayData(output: IOutput): output is IDisplayData {
+		return output.output_type === 'display_data';
+	}
+
+	/**
+	 * Test whether an output is from updated display data.
+	 */
+	export function isDisplayUpdate(output: IOutput): output is IDisplayUpdate {
+		return output.output_type === 'update_display_data';
+	}
+
+	/**
+	 * Test whether an output is from a stream.
+	 */
+	export function isStream(output: IOutput): output is IStream {
+		return output.output_type === 'stream';
+	}
+
+	/**
+	 * Test whether an output is from a stream.
+	 */
+	export function isError(output: IOutput): output is IError {
+		return output.output_type === 'error';
+	}
+
+	/**
+	 * An output union type.
+	 */
+	export type IOutput =
+		| IUnrecognizedOutput
+		| IExecuteResult
+		| IDisplayData
+		| IStream
+		| IError;
+}
+
+export interface ICellOutputWithIdAndTrust extends nb.ICellOutput {
+	id: number;
+	trusted: boolean;
+}

src/sql/workbench/services/notebook/common/notebookConstants.ts

@@ -0,0 +1,16 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+export namespace nbversion {
+	/**
+	 * The major version of the notebook format.
+	 */
+	export const MAJOR_VERSION: number = 4;
+
+	/**
+	 * The minor version of the notebook format.
+	 */
+	export const MINOR_VERSION: number = 2;
+}