Rendermime Refactor #2555

blink1073 · 2017-06-30T12:35:45Z

Refactors rendermime with the following top level ideas:

What we called IRenderers are now IRendererFactories, and the returned widgets have a renderModel(model): Promise method. This allows us to re-render by updating the model and calling that method.
Handle mime extensions in the application object by creating plugins for each of the mime renderers.
The application gains rendermime, docregistry, and commandLinker properties, which were already being considered singletons.
Removes the now unused rendermime-extension and docregistry-extension packages as well as the command linker plugin in apputils-extension.
Removes the markdownviewer extension in favor of using the MimeRenderer in DocumentRegistry.
Fixes a bug where renaming a file did not update the layout restorer, leaving it unrestored.

sccolbert · 2017-06-30T13:02:53Z

packages/docregistry/src/default.ts

-    if (layout.widgets.length === 2) {
-      // The toolbar is layout.widgets[0]
-      layout.widgets[1].dispose();
+      this._mimeModel.data.set(this._mimeType, model.toJSON());


Not of a fan of this mutation here, then passing the same mime model back into the renderer. If the renderer is expecting the model to be immutable, it might not re-render.

sccolbert

This looks pretty good to me, modulo a few likely oversights during the refactoring.

sccolbert · 2017-06-30T13:15:05Z

packages/rendermime/src/widgets.ts

+    if (!this.trusted) {
+      source = this.sanitizer.sanitize(source);
+    }
+    Private.appendHtml(this.node, source);


need to clear the node content first?

sccolbert · 2017-06-30T13:15:23Z

packages/rendermime/src/widgets.ts

+        if (!this.trusted) {
+          content = this.sanitizer.sanitize(content);
+        }
+        Private.appendHtml(this.node, content);


need to clear the node content first?

sccolbert · 2017-07-03T13:50:11Z

packages/rendermime-interfaces/src/index.ts

   * The options used to initialize a document widget factory.
   */
  export
-  interface IWidgetFactoryOptions {
+  interface IDocumentWidgetFactoryOptions {


Why the name "document widget" here?

Added this:

* These are options used to open a rendered view of a given file type * using a rendermime factory.

sccolbert · 2017-07-03T14:15:17Z

packages/rendermime/src/rendermime.ts

+   * Add the default renderer factories to a rendermime instance.
+   */
+  export
+  function addDefaultFactories(rendermime: RenderMime): void {


I thought we were not going to do this, and have the app add the default factories?

This was needed for outside uses of the rendermime (such as our standalone notebook example).

ellisonbg

Looks good, some minor comments/changes inline.

ellisonbg · 2017-07-04T00:47:18Z

packages/rendermime/src/outputmodel.ts

@@ -24,6 +28,11 @@ import {
 export
 interface IOutputModel extends IRenderMime.IMimeModel {


@sccolbert will this IOutputModel class get moved to the outputarea in your work?

ellisonbg · 2017-07-04T00:51:01Z

packages/rendermime/src/rendermime.ts

-   * Negative indices count from the end, so -1 refers to the last index.
-   * Use the index of `.order.length` to add to the end of the render precedence list,
-   * which would make the new renderer the last choice.
+   * @param rank - The rank of the renderer. Defaults to 100.


Better note indicating what low/high rank means.

ellisonbg · 2017-07-04T00:51:35Z

packages/rendermime/src/rendermime.ts

-    this._renderers[mimeType] = renderer;
-    ArrayExt.insert(this._order, index, mimeType);
+  addFactory(factory: IRenderMime.IRendererFactory, mimeType: string, rank?: number): void {
+    this._addFactory(factory, mimeType, rank);


Is this indirection needed?

Both are needed so we don't call a public method in the constructor.

ellisonbg · 2017-07-04T00:51:42Z

packages/rendermime/src/rendermime.ts

-    delete this._renderers[mimeType];
-    ArrayExt.removeFirstOf(this._order, mimeType);
+  removeFactory(mimeType: string): void {
+    this._removeFactory(mimeType);


Is this indirection needed?

ellisonbg · 2017-07-04T01:00:19Z

packages/cells/src/widget.ts

@@ -166,7 +170,7 @@ const RENDER_TIMEOUT = 1000;
 * A base cell widget.
 */
 export
-class Cell extends Widget implements IRenderMime.IReadyWidget {
+class Cell extends Widget implements DocumentRegistry.IReadyWidget {


I am a bit surprised that cell depends on the document registry. At least conceptually, cells shouldnn't know anything about documents. The IReadyWidget is really simply, can we put it somewhere else that cell can depend on?

We don't need this to implement the interface explicitly, I'll just remove it.

ellisonbg · 2017-07-04T01:02:42Z

packages/docregistry/src/default.ts

@@ -451,6 +452,11 @@ class MimeRenderer extends Widget implements IRenderMime.IReadyWidget {
  }

  /**
+   * The renderime instance associated with the widget.


ellisonbg · 2017-07-04T01:05:42Z

packages/markdownviewer/style/index.css

-}
-
-
-.jp-MarkdownViewer .jp-Toolbar {


Does the new widget we are using for rendering MIME based documents have the micro toolbar at the top?

ellisonbg · 2017-07-04T01:15:53Z

packages/markdownviewer/style/index.css

-    z-index: 1;
-}
-
-.jp-MarkdownViewer .jp-RenderedMarkdown {


All of this CSS is missing now. We probably have the CSS classes needed to keep it, but we will need to add it as something like jp-Document.jp-MimeRenderer jp.RenderedMarkdown.

ellisonbg · 2017-07-04T01:18:27Z

packages/markdownviewer/style/index.css

-
-.jp-MarkdownViewer {
-  border-top: var(--jp-border-width) solid var(--jp-border-color2);
-  outline: none;


We will need to make sure the overflow is working properly so that it wraps/scrolls as expected.

In this branch, the markdown won't scroll at all.

ellisonbg · 2017-07-04T01:23:39Z

I have tried this locally and things seem to be mostly working. I have added a few more comments based on those tests. Given the size of this, we should probably merge soon and continue to iterate.

ellisonbg · 2017-07-04T01:34:39Z

Looks like real test failures

ellisonbg · 2017-07-04T01:35:28Z

@blink1073 I can clean up the markdown preview CSS later so we can merge this once the tests are passing.

sccolbert · 2017-07-04T02:41:57Z

Merging and iterating.

blink1073 added pkg:rendermime maintenance labels Jun 30, 2017

blink1073 added this to the Beta milestone Jun 30, 2017

blink1073 added the in progress label Jun 30, 2017

sccolbert reviewed Jun 30, 2017

View reviewed changes

sccolbert suggested changes Jun 30, 2017

View reviewed changes

blink1073 removed the in progress label Jun 30, 2017

sccolbert reviewed Jul 3, 2017

View reviewed changes

blink1073 added 21 commits July 3, 2017 11:15

wip rendermime refactor

8f95ec3

wip refactor mime renderer extensions

e8f56ad

Remove docregistry and rendermime extensions

a91b054

clean up

d27aa2b

Finish the mime extensions refactor

7a0b1d1

Fix handling of layout widget name changes

bdd40d9

Refactor the rendermime interface

db0e9de

Refactory document registry and vega extension

afa4621

Move trusted to options

54a0c19

Update the command name

51c015f

Add a static method to populate the default factories

e0e16bf

wip update tests

8a9c295

Update addFactory behavior

b439137

Update tests

c757d0e

Remove markdownviewer tests

c5d0426

Remove markdownviewer from package.json

bd7ed12

whitespace

aca964b

Update class name

bc1ff8a

update tests

29f9340

Remove stale test

aee5e16

more rendermime api adjustments

582e7e1

blink1073 added 7 commits July 3, 2017 15:19

Update tests

e400ac8

Update the html test

04f5098

Add intial factories to app

55f99d4

Fix test

a10d3de

Rename irendererwidget -> irenderer

8eaf880

Update test

9fc73aa

Simplify preferredMimeType handler

a3c7c4a

sccolbert mentioned this pull request Jul 4, 2017

Feature redux #2569

Merged

ellisonbg requested changes Jul 4, 2017

View reviewed changes

Address review comments

6fa8ae6

ellisonbg reviewed Jul 4, 2017

View reviewed changes

Fix syntax

8f232a8

ellisonbg approved these changes Jul 4, 2017

View reviewed changes

sccolbert approved these changes Jul 4, 2017

View reviewed changes

sccolbert merged commit 43b8c77 into jupyterlab:master Jul 4, 2017

ellisonbg mentioned this pull request Jul 4, 2017

Fix markdownviewer CSS #2576

Merged

gnestor added a commit to gnestor/jupyterlab that referenced this pull request Jul 5, 2017

Adapt to jupyterlab#2555

cbe3935

gnestor mentioned this pull request Jul 5, 2017

Allow MIME based output renderers to be used as default file viewers #421

Closed

gnestor added a commit to jupyterlab/jupyter-renderers that referenced this pull request Jul 5, 2017

Adapt to jupyterlab/jupyterlab#2555

b3b57fe

gnestor mentioned this pull request Jul 5, 2017

Adapt to rendermime refactor jupyterlab/jupyter-renderers#2

Merged

blink1073 mentioned this pull request Jul 7, 2017

Release 0.25 #2621

Closed

vidartf mentioned this pull request Jul 10, 2017

Update document widget extensions tutorial #2651

Closed

blink1073 deleted the rendermime-refactor branch July 10, 2017 17:58

lock bot added the status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Aug 10, 2019

lock bot locked as resolved and limited conversation to collaborators Aug 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rendermime Refactor #2555

Rendermime Refactor #2555

blink1073 commented Jun 30, 2017 •

edited by sccolbert

Loading

sccolbert Jun 30, 2017

sccolbert left a comment

sccolbert Jun 30, 2017

sccolbert Jun 30, 2017

sccolbert Jul 3, 2017

blink1073 Jul 3, 2017

sccolbert Jul 3, 2017

blink1073 Jul 3, 2017

ellisonbg left a comment

ellisonbg Jul 4, 2017

blink1073 Jul 4, 2017

ellisonbg Jul 4, 2017

blink1073 Jul 4, 2017

ellisonbg Jul 4, 2017

blink1073 Jul 4, 2017

ellisonbg Jul 4, 2017

ellisonbg Jul 4, 2017

blink1073 Jul 4, 2017

ellisonbg Jul 4, 2017

blink1073 Jul 4, 2017

ellisonbg Jul 4, 2017

blink1073 Jul 4, 2017

ellisonbg Jul 4, 2017

ellisonbg Jul 4, 2017

ellisonbg Jul 4, 2017

ellisonbg commented Jul 4, 2017

ellisonbg commented Jul 4, 2017

ellisonbg commented Jul 4, 2017

sccolbert commented Jul 4, 2017

		@@ -24,6 +28,11 @@ import {
		export
		interface IOutputModel extends IRenderMime.IMimeModel {

		}


		.jp-MarkdownViewer .jp-Toolbar {

Rendermime Refactor #2555

Rendermime Refactor #2555

Conversation

blink1073 commented Jun 30, 2017 • edited by sccolbert Loading

Choose a reason for hiding this comment

sccolbert left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ellisonbg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ellisonbg commented Jul 4, 2017

ellisonbg commented Jul 4, 2017

ellisonbg commented Jul 4, 2017

sccolbert commented Jul 4, 2017

blink1073 commented Jun 30, 2017 •

edited by sccolbert

Loading