Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Widgetsnbextension: throw error on failure to render #3280

Merged
merged 1 commit into from
Sep 28, 2021
Merged

Widgetsnbextension: throw error on failure to render #3280

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions widgetsnbextension/src/extension.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ require('./embed_widgets');
var LuminoWidget = require('@lumino/widgets');
var LuminoMessaging = require('@lumino/messaging');

var NOTEBOOK_VERSION_INFO = Jupyter.version.split('.');
var NOTEBOOK_MAJOR = parseInt(NOTEBOOK_VERSION_INFO[0]);
var NOTEBOOK_MINOR = parseInt(NOTEBOOK_VERSION_INFO[1]);
var NOTEBOOK_PATCH = parseInt(NOTEBOOK_VERSION_INFO[2]);

var RENDER_SHOULD_THROW =
NOTEBOOK_MAJOR > 6 ||
(NOTEBOOK_MAJOR == 6 && NOTEBOOK_MINOR > 4) ||
(NOTEBOOK_MAJOR == 6 && NOTEBOOK_MINOR == 4 && NOTEBOOK_PATCH > 4);

/**
* Create a widget manager for a kernel instance.
*/
Expand Down Expand Up @@ -123,13 +133,19 @@ function register_events(Jupyter, events, outputarea) {
Jupyter.notebook.kernel &&
Jupyter.notebook.kernel.widget_manager;
if (!manager) {
node.textContent =
'Error rendering Jupyter widget: missing widget manager';
var msg = 'Error rendering Jupyter widget: missing widget manager';
if (RENDER_SHOULD_THROW) {
throw new Error(msg);
}
node.textContent = msg;
return;
}

// Missing model id means the view was removed. Hide this element.
if (data.model_id === '') {
if (RENDER_SHOULD_THROW) {
throw new Error('Jupyter Widgets model not found');
}
node.style.display = 'none';
return;
}
Expand All @@ -156,8 +172,13 @@ function register_events(Jupyter, events, outputarea) {
});
});
} else {
node.textContent =
var msg =
'A Jupyter widget could not be displayed because the widget state could not be found. This could happen if the kernel storing the widget is no longer available, or if the widget state was not saved in the notebook. You may be able to create the widget by running the appropriate cells.';
if (RENDER_SHOULD_THROW) {
throw new Error(msg);
}
node.textContent = msg;
return;
}
}

Expand All @@ -169,6 +190,7 @@ function register_events(Jupyter, events, outputarea) {
element.append(toinsert);
return toinsert;
};

// Register mime type with the output area
outputarea.OutputArea.prototype.register_mime_type(MIME_TYPE, append_mime, {
// An output widget could contain arbitrary user javascript
Expand Down