Feat: ErrorWidget as fallback when widgets models or views fail. #2960

maartenbreddels · 2020-09-02T12:23:26Z

This makes sure that we always render something, with a descriptive
error message. This makes it easier for users to diagnose or report
issues.

JupyterLab screenshot:

Note that in all cases, the Button and Hbox are rendered.

This makes sure that we always render something, with a descriptive error message. This makes is easier for users to diagnose or report issues.

maartenbreddels · 2020-09-02T12:25:56Z

This replaces voila-dashboards/voila#667 but is a better version because we can distinguish between loading models and views.

packages/base-manager/src/manager-base.ts

packages/base/src/errorwidget.ts

vidartf · 2020-09-17T09:48:26Z

So previously we used to use the various other mimetypes in the bundle to present an error message (but we stopped doing that?). Would you mind mentioning why this is better?

martinRenou · 2020-09-17T09:54:24Z

So previously we used to use the various other mimetypes in the bundle to present an error message

I am really interested in this. Was it really what was happening? I feel like the widget mimetype was always rendered, only that this mimetype was showing Model not found or similar errors when the widget manager fails to render.
It would be really nice in ipympl to have a fallback image mimetype when the widget manager fails to render, but it does not seem to work.

vidartf · 2020-09-17T09:56:37Z

Context in #2007. We seemed to agree then that the best long term solution was "a short HTML entry with a link to an entry in the docs describing the possible causes of seeing the message". Doing something smarter on the JS side might also be a good thing, but I think there is also value in having a shared/similar way of doing things for various different errors that can occur. I.e. I don't think this PR will solve the error message if the user forgot to install the jupyter widget manager (or the install is broken).

tl;dr: not opposed to this, but if another solution solves more problems, we should at least compare them.

vidartf · 2020-09-17T10:00:18Z

Ugh, it seems the notebook issue that was preventing us from using html mimetype is still open: jupyter/notebook#2980

Xref: #2024 that is tracking the followup to that.

maartenbreddels · 2021-01-18T08:33:41Z

Would you mind mentioning why this is better?

The error in this PR give more information because they are aware of the issue (missing Model, missing View). The mimetype fallback msg will only give a general error msg, and not a stacktrace.

The errors given now in Jupyter Lab are:

and classical:

SylvainCorlay · 2021-02-04T09:51:53Z

I would like to get this in for 8.0 if possible.

SylvainCorlay · 2021-02-05T08:14:52Z

packages/base-manager/src/manager-base.ts

+        moduleVersion
+      ) as Promise<typeof WidgetModel>;
+      await promise;
+      return promise;


Why do you need to await the promise before returning it?

to catch a possible exception

davidbrochart · 2021-02-09T08:17:02Z

packages/base/src/errorwidget.ts

+
+export class ErrorWidgetView extends DOMWidgetView {
+  render() {
+    console.log('render');


davidbrochart · 2021-02-09T09:30:48Z

@maartenbreddels is it supposed to work with classical notebook? It prints:

Failed to load widget 'DOMWidgetModel' from module 'badwidget', error:
Error: Script error for "badwidget"
http://requirejs.org/docs/errors.html#scripterror
    at makeError (http://localhost:8888/static/components/requirejs/require.js?v=d37b48bb2137faa0ab98157e240c084dd5b1b5e74911723aa1d1f04c928c2a03dedf922d049e4815f7e5a369faa2e6b6a1000aae958b7953b5cc60411154f593:168:17)
    at HTMLScriptElement.onScriptError (http://localhost:8888/static/components/requirejs/require.js?v=d37b48bb2137faa0ab98157e240c084dd5b1b5e74911723aa1d1f04c928c2a03dedf922d049e4815f7e5a369faa2e6b6a1000aae958b7953b5cc60411154f593:1735:36)

maartenbreddels · 2021-02-09T09:31:50Z

I think I have tested this, is this the js console?

davidbrochart · 2021-02-09T09:32:37Z

No, the cell output.

maartenbreddels · 2021-02-09T09:39:43Z

That should be exactly what it does, or do you refer to the short stack trace?
Looking at voila-dashboards/voila#667 it seems to do the same as what I got.

davidbrochart · 2021-02-09T09:43:51Z

Yes, I was wondering why we don't have the same stack trace as in jlab.

maartenbreddels · 2021-02-09T09:48:59Z

might be due to the transpiling target, I think in the notebook we still use something older (ES5?) and we lose the stack trace, but not 100% sure.

davidbrochart · 2021-02-09T09:51:07Z

OK, thanks.
I tried your PR on jlab3 by rebasing it on #3086, it works fine.

jasongrout · 2021-07-06T17:14:16Z

We're pushing forward to ipywidgets 8. Is there someone that wants to either champion this for 8.0 very soon, or can we move it to 8.1?

jasongrout · 2021-08-10T17:15:11Z

Moving to 8.1 since a champion has not come forth.

trungleduc · 2021-10-21T08:52:41Z

Hello @maartenbreddels, I'm trying to finish this PR. How do you think about this behavior of failback widget?

ipy.mp4

Feat: ErrorWidget as fallback when widgets models or views fail.

3eeaaa1

This makes sure that we always render something, with a descriptive error message. This makes is easier for users to diagnose or report issues.

maartenbreddels requested a review from jasongrout September 2, 2020 12:23

martinRenou reviewed Sep 2, 2020

View reviewed changes

packages/base-manager/src/manager-base.ts Show resolved Hide resolved

martinRenou reviewed Sep 2, 2020

View reviewed changes

packages/base/src/errorwidget.ts Outdated Show resolved Hide resolved

packages/base/src/errorwidget.ts Outdated Show resolved Hide resolved

packages/base/src/errorwidget.ts Show resolved Hide resolved

ianhi mentioned this pull request Sep 5, 2020

Python Warning if ipycytoscape extension is not found? cytoscape/ipycytoscape#135

Open

maartenbreddels added 2 commits September 7, 2020 09:46

remove log statements

bc13bc8

make it work in the classical notebook

9c21086

SylvainCorlay reviewed Feb 5, 2021

View reviewed changes

SylvainCorlay added this to the 8.0 milestone Feb 5, 2021

davidbrochart reviewed Feb 9, 2021

View reviewed changes

jasongrout modified the milestones: 8.0, 8.1 Aug 10, 2021

maartenbreddels mentioned this pull request Oct 18, 2021

feat: when a widget fails, show a fallback error widget voila-dashboards/voila#667

Closed

trungleduc mentioned this pull request Oct 27, 2021

ErrorWidget as fallback when widgets models or views fail - Following up #3304

Merged

jtpio mentioned this pull request Oct 27, 2021

2021 Jupyter Widgets Dev Meetings jupyter-widgets/team-compass#1

Closed

ianhi mentioned this pull request Sep 21, 2023

Latest version of everything still causes the dreaded Error displaying widget: model not found matplotlib/ipympl#534

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: ErrorWidget as fallback when widgets models or views fail. #2960

Feat: ErrorWidget as fallback when widgets models or views fail. #2960

maartenbreddels commented Sep 2, 2020

maartenbreddels commented Sep 2, 2020

vidartf commented Sep 17, 2020 •

edited

Loading

martinRenou commented Sep 17, 2020

vidartf commented Sep 17, 2020 •

edited

Loading

vidartf commented Sep 17, 2020 •

edited

Loading

maartenbreddels commented Jan 18, 2021

SylvainCorlay commented Feb 4, 2021

SylvainCorlay Feb 5, 2021

maartenbreddels Feb 5, 2021

davidbrochart Feb 9, 2021

maartenbreddels Feb 9, 2021

davidbrochart commented Feb 9, 2021

maartenbreddels commented Feb 9, 2021

davidbrochart commented Feb 9, 2021

maartenbreddels commented Feb 9, 2021

davidbrochart commented Feb 9, 2021

maartenbreddels commented Feb 9, 2021

davidbrochart commented Feb 9, 2021

jasongrout commented Jul 6, 2021

jasongrout commented Aug 10, 2021

trungleduc commented Oct 21, 2021

Feat: ErrorWidget as fallback when widgets models or views fail. #2960

Are you sure you want to change the base?

Feat: ErrorWidget as fallback when widgets models or views fail. #2960

Conversation

maartenbreddels commented Sep 2, 2020

maartenbreddels commented Sep 2, 2020

vidartf commented Sep 17, 2020 • edited Loading

martinRenou commented Sep 17, 2020

vidartf commented Sep 17, 2020 • edited Loading

vidartf commented Sep 17, 2020 • edited Loading

maartenbreddels commented Jan 18, 2021

SylvainCorlay commented Feb 4, 2021

SylvainCorlay Feb 5, 2021

Choose a reason for hiding this comment

maartenbreddels Feb 5, 2021

Choose a reason for hiding this comment

davidbrochart Feb 9, 2021

Choose a reason for hiding this comment

maartenbreddels Feb 9, 2021

Choose a reason for hiding this comment

davidbrochart commented Feb 9, 2021

maartenbreddels commented Feb 9, 2021

davidbrochart commented Feb 9, 2021

maartenbreddels commented Feb 9, 2021

davidbrochart commented Feb 9, 2021

maartenbreddels commented Feb 9, 2021

davidbrochart commented Feb 9, 2021

jasongrout commented Jul 6, 2021

jasongrout commented Aug 10, 2021

trungleduc commented Oct 21, 2021

vidartf commented Sep 17, 2020 •

edited

Loading

vidartf commented Sep 17, 2020 •

edited

Loading

vidartf commented Sep 17, 2020 •

edited

Loading