More Layering (#9139)

* 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

* wip

* wip

* wip

* remove no longer good parts

* fix strict-nulls

* 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

* wip

* finished layering

* fix imports

* fix valid layers

* fix layers

src/sql/workbench/contrib/notebook/browser/outputs/factories.ts

@@ -1,105 +0,0 @@
-/*-----------------------------------------------------------------------------
-| Copyright (c) Jupyter Development Team.
-| Distributed under the terms of the Modified BSD License.
-|----------------------------------------------------------------------------*/
-
-import * as widgets from './widgets';
-import { IRenderMime } from '../models/renderMimeInterfaces';
-
-/**
- * A mime renderer factory for raw html.
- */
-export const htmlRendererFactory: IRenderMime.IRendererFactory = {
-	safe: true,
-	mimeTypes: ['text/html'],
-	defaultRank: 50,
-	createRenderer: options => new widgets.RenderedHTML(options)
-};
-
-/**
- * A mime renderer factory for images.
- */
-export const imageRendererFactory: IRenderMime.IRendererFactory = {
-	safe: true,
-	mimeTypes: ['image/bmp', 'image/png', 'image/jpeg', 'image/gif'],
-	defaultRank: 90,
-	createRenderer: options => new widgets.RenderedImage(options)
-};
-
-// /**
-//  * A mime renderer factory for LaTeX.
-//  */
-// export const latexRendererFactory: IRenderMime.IRendererFactory = {
-//   safe: true,
-//   mimeTypes: ['text/latex'],
-//   defaultRank: 70,
-//   createRenderer: options => new widgets.RenderedLatex(options)
-// };
-
-/**
- * A mime renderer factory for svg.
- */
-export const svgRendererFactory: IRenderMime.IRendererFactory = {
-	safe: false,
-	mimeTypes: ['image/svg+xml'],
-	defaultRank: 80,
-	createRenderer: options => new widgets.RenderedSVG(options)
-};
-
-/**
- * A mime renderer factory for plain and jupyter console text data.
- */
-export const textRendererFactory: IRenderMime.IRendererFactory = {
-	safe: true,
-	mimeTypes: [
-		'text/plain',
-		'application/vnd.jupyter.stdout',
-		'application/vnd.jupyter.stderr'
-	],
-	defaultRank: 120,
-	createRenderer: options => new widgets.RenderedText(options)
-};
-
-/**
- * A placeholder factory for deprecated rendered JavaScript.
- */
-export const javaScriptRendererFactory: IRenderMime.IRendererFactory = {
-	safe: false,
-	mimeTypes: ['text/javascript', 'application/javascript'],
-	defaultRank: 110,
-	createRenderer: options => new widgets.RenderedJavaScript(options)
-};
-
-export const dataResourceRendererFactory: IRenderMime.IRendererFactory = {
-	safe: true,
-	mimeTypes: [
-		'application/vnd.dataresource+json',
-		'application/vnd.dataresource'
-	],
-	defaultRank: 40,
-	createRenderer: options => new widgets.RenderedDataResource(options)
-};
-
-export const ipywidgetFactory: IRenderMime.IRendererFactory = {
-	safe: false,
-	mimeTypes: [
-		'application/vnd.jupyter.widget-view',
-		'application/vnd.jupyter.widget-view+json'
-	],
-	defaultRank: 45,
-	createRenderer: options => new widgets.RenderedIPyWidget(options)
-};
-
-/**
- * The standard factories provided by the rendermime package.
- */
-export const standardRendererFactories: ReadonlyArray<IRenderMime.IRendererFactory> = [
-	htmlRendererFactory,
-	// latexRendererFactory,
-	svgRendererFactory,
-	imageRendererFactory,
-	javaScriptRendererFactory,
-	textRendererFactory,
-	dataResourceRendererFactory,
-	ipywidgetFactory
-];

src/sql/workbench/contrib/notebook/browser/outputs/gridOutput.component.ts

@@ -22,9 +22,9 @@ import { localize } from 'vs/nls';
 import { IAction } from 'vs/base/common/actions';
 import { AngularDisposable } from 'sql/base/browser/lifecycle';
 import { IMimeComponent } from 'sql/workbench/contrib/notebook/browser/outputs/mimeRegistry';
-import { ICellModel } from 'sql/workbench/contrib/notebook/browser/models/modelInterfaces';
-import { MimeModel } from 'sql/workbench/contrib/notebook/browser/models/mimemodel';
-import { GridTableState } from 'sql/workbench/contrib/query/common/gridPanelState';
+import { ICellModel } from 'sql/workbench/services/notebook/browser/models/modelInterfaces';
+import { MimeModel } from 'sql/workbench/services/notebook/browser/outputs/mimemodel';
+import { GridTableState } from 'sql/workbench/common/editor/query/gridPanelState';
 import { GridTableBase } from 'sql/workbench/contrib/query/browser/gridPanel';
 import { getErrorMessage } from 'vs/base/common/errors';
 import { ISerializationService, SerializeDataParams } from 'sql/platform/serialization/common/serializationService';

src/sql/workbench/contrib/notebook/browser/outputs/markdownOutput.component.ts

@@ -12,8 +12,8 @@ import { AngularDisposable } from 'sql/base/browser/lifecycle';
 import { IMimeComponent } from 'sql/workbench/contrib/notebook/browser/outputs/mimeRegistry';
 import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
 import { NotebookMarkdownRenderer } from 'sql/workbench/contrib/notebook/browser/outputs/notebookMarkdown';
-import { MimeModel } from 'sql/workbench/contrib/notebook/browser/models/mimemodel';
-import { ICellModel } from 'sql/workbench/contrib/notebook/browser/models/modelInterfaces';
+import { MimeModel } from 'sql/workbench/services/notebook/browser/outputs/mimemodel';
+import { ICellModel } from 'sql/workbench/services/notebook/browser/models/modelInterfaces';
 import { URI } from 'vs/base/common/uri';
 
 @Component({

src/sql/workbench/contrib/notebook/browser/outputs/mimeRegistry.ts

@@ -6,9 +6,9 @@ import { Type } from '@angular/core';
 
 import * as platform from 'vs/platform/registry/common/platform';
 import { ReadonlyJSONObject } from 'sql/workbench/services/notebook/common/jsonext';
-import { MimeModel } from 'sql/workbench/contrib/notebook/browser/models/mimemodel';
+import { MimeModel } from 'sql/workbench/services/notebook/browser/outputs/mimemodel';
 import * as types from 'vs/base/common/types';
-import { ICellModel } from 'sql/workbench/contrib/notebook/browser/models/modelInterfaces';
+import { ICellModel } from 'sql/workbench/services/notebook/browser/models/modelInterfaces';
 import { values } from 'vs/base/common/collections';
 
 export type FactoryIdentifier = string;

src/sql/workbench/contrib/notebook/browser/outputs/mimeRenderer.component.ts

@@ -6,9 +6,9 @@
 import { IMimeComponent } from 'sql/workbench/contrib/notebook/browser/outputs/mimeRegistry';
 import { AngularDisposable } from 'sql/base/browser/lifecycle';
 import { ElementRef, forwardRef, Inject, Component, OnInit, Input } from '@angular/core';
-import { MimeModel } from 'sql/workbench/contrib/notebook/browser/models/mimemodel';
+import { MimeModel } from 'sql/workbench/services/notebook/browser/outputs/mimemodel';
 import { INotebookService } from 'sql/workbench/services/notebook/browser/notebookService';
-import { RenderMimeRegistry } from 'sql/workbench/contrib/notebook/browser/outputs/registry';
+import { RenderMimeRegistry } from 'sql/workbench/services/notebook/browser/outputs/registry';
 import { localize } from 'vs/nls';
 
 @Component({

src/sql/workbench/contrib/notebook/browser/outputs/plotlyOutput.component.ts

@@ -9,8 +9,8 @@ import { localize } from 'vs/nls';
 import * as types from 'vs/base/common/types';
 import { AngularDisposable } from 'sql/base/browser/lifecycle';
 import { IMimeComponent } from 'sql/workbench/contrib/notebook/browser/outputs/mimeRegistry';
-import { ICellModel } from 'sql/workbench/contrib/notebook/browser/models/modelInterfaces';
-import { MimeModel } from 'sql/workbench/contrib/notebook/browser/models/mimemodel';
+import { ICellModel } from 'sql/workbench/services/notebook/browser/models/modelInterfaces';
+import { MimeModel } from 'sql/workbench/services/notebook/browser/outputs/mimemodel';
 import { getErrorMessage } from 'vs/base/common/errors';
 
 type ObjectType = object;

src/sql/workbench/contrib/notebook/browser/outputs/registry.ts

@@ -1,353 +0,0 @@
-
-/*-----------------------------------------------------------------------------
-| Copyright (c) Jupyter Development Team.
-| Distributed under the terms of the Modified BSD License.
-|----------------------------------------------------------------------------*/
-
-import { defaultSanitizer } from './sanitizer';
-import type { IRenderMime } from 'sql/workbench/contrib/notebook/browser/models/renderMimeInterfaces';
-import type { ReadonlyJSONObject } from 'sql/workbench/services/notebook/common/jsonext';
-import { MimeModel } from 'sql/workbench/contrib/notebook/browser/models/mimemodel';
-
-/**
- * An object which manages mime renderer factories.
- *
- * This object is used to render mime models using registered mime
- * renderers, selecting the preferred mime renderer to render the
- * model into a widget.
- *
- * #### Notes
- * This class is not intended to be subclassed.
- */
-export class RenderMimeRegistry {
-	/**
-	 * Construct a new rendermime.
-	 *
-	 * @param options - The options for initializing the instance.
-	 */
-	constructor(options: RenderMimeRegistry.IOptions = {}) {
-		// Parse the options.
-		this.resolver = options.resolver || null;
-		this.linkHandler = options.linkHandler || null;
-		this.latexTypesetter = options.latexTypesetter || null;
-		this.sanitizer = options.sanitizer || defaultSanitizer;
-
-		// Add the initial factories.
-		if (options.initialFactories) {
-			for (let factory of options.initialFactories) {
-				this.addFactory(factory);
-			}
-		}
-	}
-
-	/**
-	 * The sanitizer used by the rendermime instance.
-	 */
-	readonly sanitizer: IRenderMime.ISanitizer;
-
-	/**
-	 * The object used to resolve relative urls for the rendermime instance.
-	 */
-	readonly resolver: IRenderMime.IResolver | null;
-
-	/**
-	 * The object used to handle path opening links.
-	 */
-	readonly linkHandler: IRenderMime.ILinkHandler | null;
-
-	/**
-	 * The LaTeX typesetter for the rendermime.
-	 */
-	readonly latexTypesetter: IRenderMime.ILatexTypesetter | null;
-
-	/**
-	 * The ordered list of mimeTypes.
-	 */
-	get mimeTypes(): ReadonlyArray<string> {
-		return this._types || (this._types = Private.sortedTypes(this._ranks));
-	}
-
-	/**
-	 * Find the preferred mime type for a mime bundle.
-	 *
-	 * @param bundle - The bundle of mime data.
-	 *
-	 * @param safe - How to consider safe/unsafe factories. If 'ensure',
-	 *   it will only consider safe factories. If 'any', any factory will be
-	 *   considered. If 'prefer', unsafe factories will be considered, but
-	 *   only after the safe options have been exhausted.
-	 *
-	 * @returns The preferred mime type from the available factories,
-	 *   or `undefined` if the mime type cannot be rendered.
-	 */
-	preferredMimeType(
-		bundle: ReadonlyJSONObject,
-		safe: 'ensure' | 'prefer' | 'any' = 'ensure'
-	): string | undefined {
-		// Try to find a safe factory first, if preferred.
-		if (safe === 'ensure' || safe === 'prefer') {
-			for (let mt of this.mimeTypes) {
-				if (mt in bundle && this._factories[mt].safe) {
-					return mt;
-				}
-			}
-		}
-
-		if (safe !== 'ensure') {
-			// Otherwise, search for the best factory among all factories.
-			for (let mt of this.mimeTypes) {
-				if (mt in bundle) {
-					return mt;
-				}
-			}
-		}
-
-		// Otherwise, no matching mime type exists.
-		return undefined;
-	}
-
-	/**
-	 * Create a renderer for a mime type.
-	 *
-	 * @param mimeType - The mime type of interest.
-	 *
-	 * @returns A new renderer for the given mime type.
-	 *
-	 * @throws An error if no factory exists for the mime type.
-	 */
-	createRenderer(mimeType: string): IRenderMime.IRenderer {
-		// Throw an error if no factory exists for the mime type.
-		if (!(mimeType in this._factories)) {
-			throw new Error(`No factory for mime type: '${mimeType}'`);
-		}
-
-		// Invoke the best factory for the given mime type.
-		return this._factories[mimeType].createRenderer({
-			mimeType,
-			resolver: this.resolver,
-			sanitizer: this.sanitizer,
-			linkHandler: this.linkHandler,
-			latexTypesetter: this.latexTypesetter
-		});
-	}
-
-	/**
-	 * Create a new mime model.  This is a convenience method.
-	 *
-	 * @options - The options used to create the model.
-	 *
-	 * @returns A new mime model.
-	 */
-	createModel(options: MimeModel.IOptions = {}): MimeModel {
-		return new MimeModel(options);
-	}
-
-	/**
-	 * Create a clone of this rendermime instance.
-	 *
-	 * @param options - The options for configuring the clone.
-	 *
-	 * @returns A new independent clone of the rendermime.
-	 */
-	clone(options: RenderMimeRegistry.ICloneOptions = {}): RenderMimeRegistry {
-		// Create the clone.
-		let clone = new RenderMimeRegistry({
-			resolver: options.resolver || this.resolver || undefined,
-			sanitizer: options.sanitizer || this.sanitizer || undefined,
-			linkHandler: options.linkHandler || this.linkHandler || undefined,
-			latexTypesetter: options.latexTypesetter || this.latexTypesetter
-		});
-
-		// Clone the internal state.
-		clone._factories = { ...this._factories };
-		clone._ranks = { ...this._ranks };
-		clone._id = this._id;
-
-		// Return the cloned object.
-		return clone;
-	}
-
-	/**
-	 * Get the renderer factory registered for a mime type.
-	 *
-	 * @param mimeType - The mime type of interest.
-	 *
-	 * @returns The factory for the mime type, or `undefined`.
-	 */
-	getFactory(mimeType: string): IRenderMime.IRendererFactory | undefined {
-		return this._factories[mimeType];
-	}
-
-	/**
-	 * Add a renderer factory to the rendermime.
-	 *
-	 * @param factory - The renderer factory of interest.
-	 *
-	 * @param rank - The rank of the renderer. A lower rank indicates
-	 *   a higher priority for rendering. If not given, the rank will
-	 *   defer to the `defaultRank` of the factory.  If no `defaultRank`
-	 *   is given, it will default to 100.
-	 *
-	 * #### Notes
-	 * The renderer will replace an existing renderer for the given
-	 * mimeType.
-	 */
-	addFactory(factory: IRenderMime.IRendererFactory, rank?: number): void {
-		if (rank === undefined) {
-			rank = factory.defaultRank;
-			if (rank === undefined) {
-				rank = 100;
-			}
-		}
-		for (let mt of factory.mimeTypes) {
-			this._factories[mt] = factory;
-			this._ranks[mt] = { rank, id: this._id++ };
-		}
-		this._types = null;
-	}
-
-	/**
-	 * Remove a mime type.
-	 *
-	 * @param mimeType - The mime type of interest.
-	 */
-	removeMimeType(mimeType: string): void {
-		delete this._factories[mimeType];
-		delete this._ranks[mimeType];
-		this._types = null;
-	}
-
-	/**
-	 * Get the rank for a given mime type.
-	 *
-	 * @param mimeType - The mime type of interest.
-	 *
-	 * @returns The rank of the mime type or undefined.
-	 */
-	getRank(mimeType: string): number | undefined {
-		let rank = this._ranks[mimeType];
-		return rank && rank.rank;
-	}
-
-	/**
-	 * Set the rank of a given mime type.
-	 *
-	 * @param mimeType - The mime type of interest.
-	 *
-	 * @param rank - The new rank to assign.
-	 *
-	 * #### Notes
-	 * This is a no-op if the mime type is not registered.
-	 */
-	setRank(mimeType: string, rank: number): void {
-		if (!this._ranks[mimeType]) {
-			return;
-		}
-		let id = this._id++;
-		this._ranks[mimeType] = { rank, id };
-		this._types = null;
-	}
-
-	private _id = 0;
-	private _ranks: Private.RankMap = {};
-	private _types: string[] | null = null;
-	private _factories: Private.FactoryMap = {};
-}
-
-/**
- * The namespace for `RenderMimeRegistry` class statics.
- */
-export namespace RenderMimeRegistry {
-	/**
-	 * The options used to initialize a rendermime instance.
-	 */
-	export interface IOptions {
-		/**
-		 * Initial factories to add to the rendermime instance.
-		 */
-		initialFactories?: ReadonlyArray<IRenderMime.IRendererFactory>;
-
-		/**
-		 * The sanitizer used to sanitize untrusted html inputs.
-		 *
-		 * If not given, a default sanitizer will be used.
-		 */
-		sanitizer?: IRenderMime.ISanitizer;
-
-		/**
-		 * The initial resolver object.
-		 *
-		 * The default is `null`.
-		 */
-		resolver?: IRenderMime.IResolver;
-
-		/**
-		 * An optional path handler.
-		 */
-		linkHandler?: IRenderMime.ILinkHandler;
-
-		/**
-		 * An optional LaTeX typesetter.
-		 */
-		latexTypesetter?: IRenderMime.ILatexTypesetter;
-	}
-
-	/**
-	 * The options used to clone a rendermime instance.
-	 */
-	export interface ICloneOptions {
-		/**
-		 * The new sanitizer used to sanitize untrusted html inputs.
-		 */
-		sanitizer?: IRenderMime.ISanitizer;
-
-		/**
-		 * The new resolver object.
-		 */
-		resolver?: IRenderMime.IResolver;
-
-		/**
-		 * The new path handler.
-		 */
-		linkHandler?: IRenderMime.ILinkHandler;
-
-		/**
-		 * The new LaTeX typesetter.
-		 */
-		latexTypesetter?: IRenderMime.ILatexTypesetter;
-	}
-}
-
-/**
- * The namespace for the module implementation details.
- */
-namespace Private {
-	/**
-	 * A type alias for a mime rank and tie-breaking id.
-	 */
-	export type RankPair = { readonly id: number; readonly rank: number };
-
-	/**
-	 * A type alias for a mapping of mime type -> rank pair.
-	 */
-	export type RankMap = { [key: string]: RankPair };
-
-	/**
-	 * A type alias for a mapping of mime type -> ordered factories.
-	 */
-	export type FactoryMap = { [key: string]: IRenderMime.IRendererFactory };
-
-	/**
-	 * Get the mime types in the map, ordered by rank.
-	 */
-	export function sortedTypes(map: RankMap): string[] {
-		return Object.keys(map).sort((a, b) => {
-			let p1 = map[a];
-			let p2 = map[b];
-			if (p1.rank !== p2.rank) {
-				return p1.rank - p2.rank;
-			}
-			return p1.id - p2.id;
-		});
-	}
-}

src/sql/workbench/contrib/notebook/browser/outputs/renderers.ts

@@ -4,7 +4,7 @@
 |----------------------------------------------------------------------------*/
 
 import { default as AnsiUp } from 'ansi_up';
-import { IRenderMime } from '../models/renderMimeInterfaces';
+import { IRenderMime } from 'sql/workbench/services/notebook/browser/outputs/renderMimeInterfaces';
 import { URLExt } from '../../common/models/url';
 import { URI } from 'vs/base/common/uri';
 

src/sql/workbench/contrib/notebook/browser/outputs/widgets.ts

@@ -5,9 +5,9 @@
 
 import * as renderers from './renderers';
 import { Deferred } from 'sql/base/common/promise';
-import { IRenderMime } from 'sql/workbench/contrib/notebook/browser/models/renderMimeInterfaces';
 import { ReadonlyJSONObject } from 'sql/workbench/services/notebook/common/jsonext';
 import * as tableRenderers from 'sql/workbench/contrib/notebook/browser/outputs/tableRenderers';
+import type { IRenderMime } from 'sql/workbench/services/notebook/browser/outputs/renderMimeInterfaces';
 
 /**
  * A common base class for mime renderers.