Skip to content

Fix container timeout from firing unnecessarily #11336

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.

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

Merged
merged 3 commits into from
Apr 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions news/2 Fixes/11334.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Error: Timeout is shown after running any widget more than once.
64 changes: 39 additions & 25 deletions src/datascience-ui/ipywidgets/container.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,10 @@ type Props = {

export class WidgetManagerComponent extends React.Component<Props> {
private readonly widgetManager: WidgetManager;
private readonly widgetSourceRequests = new Map<string, Deferred<void>>();
private readonly widgetSourceRequests = new Map<
string,
{ deferred: Deferred<void>; timer: NodeJS.Timeout | number | undefined }
>();
private readonly registeredWidgetSources = new Map<string, WidgetScriptSource>();
private timedoutWaitingForWidgetsToGetLoaded?: boolean;
private widgetsCanLoadFromCDN: boolean = false;
Expand Down Expand Up @@ -112,12 +115,19 @@ export class WidgetManagerComponent extends React.Component<Props> {
this.registeredWidgetSources.set(source.moduleName, source);
// We have fetched the script sources for all of these modules.
// In some cases we might not have the source, meaning we don't have it or couldn't find it.
let deferred = this.widgetSourceRequests.get(source.moduleName);
if (!deferred) {
deferred = createDeferred();
this.widgetSourceRequests.set(source.moduleName, deferred);
let request = this.widgetSourceRequests.get(source.moduleName);
if (!request) {
request = {
deferred: createDeferred(),
timer: undefined
};
this.widgetSourceRequests.set(source.moduleName, request);
}
request.deferred.resolve();
if (request.timer !== undefined) {
// tslint:disable-next-line: no-any
clearTimeout(request.timer as any); // This is to make this work on Node and Browser
}
deferred.resolve();
});
}
private registerScriptSourceInRequirejs(source?: WidgetScriptSource) {
Expand Down Expand Up @@ -200,10 +210,12 @@ export class WidgetManagerComponent extends React.Component<Props> {
private loadWidgetScript(moduleName: string, moduleVersion: string): Promise<void> {
// tslint:disable-next-line: no-console
console.log(`Fetch IPyWidget source for ${moduleName}`);
let deferred = this.widgetSourceRequests.get(moduleName);
if (!deferred) {
deferred = createDeferred<void>();
this.widgetSourceRequests.set(moduleName, deferred);
let request = this.widgetSourceRequests.get(moduleName);
if (!request) {
request = {
deferred: createDeferred<void>(),
timer: undefined
};

// If we timeout, then resolve this promise.
// We don't want the calling code to unnecessary wait for too long.
Expand All @@ -213,24 +225,26 @@ export class WidgetManagerComponent extends React.Component<Props> {
// Possible user has ignored some UI prompt and things are now in a state of limbo.
// This way thigns will fall over sooner due to missing widget sources.
const timeoutTime = this.timedoutWaitingForWidgetsToGetLoaded
? 10_000
? 5_000
: this.loaderSettings.timeoutWaitingForScriptToLoad;

setTimeout(() => {
// tslint:disable-next-line: no-console
console.error(`Timeout waiting to get widget source for ${moduleName}, ${moduleVersion}`);
this.handleLoadError(
'<class>',
moduleName,
moduleVersion,
new Error(`Timeout getting ${moduleName}:${moduleVersion}`),
true
).ignoreErrors();
if (deferred) {
deferred.resolve();
request.timer = setTimeout(() => {
if (request && !request.deferred.resolved) {
// tslint:disable-next-line: no-console
console.error(`Timeout waiting to get widget source for ${moduleName}, ${moduleVersion}`);
this.handleLoadError(
'<class>',
moduleName,
moduleVersion,
new Error(`Timeout getting source for ${moduleName}:${moduleVersion}`),
true
).ignoreErrors();
request.deferred.resolve();
this.timedoutWaitingForWidgetsToGetLoaded = true;
}
this.timedoutWaitingForWidgetsToGetLoaded = true;
}, timeoutTime);

this.widgetSourceRequests.set(moduleName, request);
}
// Whether we have the scripts or not, send message to extension.
// Useful telemetry and also we know it was explicity requestd by ipywidgest.
Expand All @@ -239,7 +253,7 @@ export class WidgetManagerComponent extends React.Component<Props> {
{ moduleName, moduleVersion }
);

return deferred.promise
return request.deferred.promise
.then(() => {
const widgetSource = this.registeredWidgetSources.get(moduleName);
if (widgetSource) {
Expand Down