Warn when using qgrid > 1.1.1 (microsoft#11280)

For #11245 * Warn when using qgrid version > 1.1.1 * For now hardcoded to check only qgrid version 1.1.1. * Should be easy enough to add others, didn't want to make it too generic.

Author: DonJayamanne

news/2 Fixes/11245.md

@@ -0,0 +1 @@
+Warn when using a version of the widget `qgrid` greater than `1.1.1` with the recommendation to downgrade to `1.1.1`.

package.nls.json

@@ -474,5 +474,6 @@
  "DataScience.loadThirdPartyWidgetScriptsPostEnabled": "Please restart the Kernel when changing the setting 'python.dataScience.widgetScriptSources'.",
  "DataScience.enableCDNForWidgetsSetting": "Widgets require us to download supporting files from a 3rd party website. Click <a href='https://command:python.datascience.enableLoadingWidgetScriptsFromThirdPartySource'>here</a> to enable this or click <a href='https://aka.ms/PVSCIPyWidgets'>here</a> for more information. (Error loading {0}:{1}).",
  "DataScience.widgetScriptNotFoundOnCDNWidgetMightNotWork": "Unable to load a compatible version of the widget '{0}'. Expected behavior may be affected.",
- "DataScience.unhandledMessage": "Unhandled kernel message from a widget: {0} : {1}"
+ "DataScience.unhandledMessage": "Unhandled kernel message from a widget: {0} : {1}",
+ "DataScience.qgridWidgetScriptVersionCompatibilityWarning": "Unable to load a compatible version of the widget 'qgrid'. Consider downgrading to version 1.1.1."
 }

src/client/common/utils/localize.ts

@@ -876,6 +876,10 @@ export namespace DataScience {
  'DataScience.widgetScriptNotFoundOnCDNWidgetMightNotWork',
  "Unable to load a compatible version of the widget '{0}'. Expected behavior may be affected."
  );
+ export const qgridWidgetScriptVersionCompatibilityWarning = localize(
+ 'DataScience.qgridWidgetScriptVersionCompatibilityWarning',
+ "Unable to load a compatible version of the widget 'qgrid'. Consider downgrading to version 1.1.1."
+ );
 }
 
 export namespace DebugConfigStrings {

src/client/datascience/constants.ts

@@ -290,6 +290,7 @@ export enum Telemetry {
  ZMQNotSupported = 'DATASCIENCE.ZMQ_NATIVE_BINARIES_NOT_LOADING',
  IPyWidgetLoadSuccess = 'DS_INTERNAL.IPYWIDGET_LOAD_SUCCESS',
  IPyWidgetLoadFailure = 'DS_INTERNAL.IPYWIDGET_LOAD_FAILURE',
+ IPyWidgetWidgetVersionNotSupportedLoadFailure = 'DS_INTERNAL.IPYWIDGET_WIDGET_VERSION_NOT_SUPPORTED_LOAD_FAILURE',
  IPyWidgetLoadDisabled = 'DS_INTERNAL.IPYWIDGET_LOAD_DISABLED',
  HashedIPyWidgetNameUsed = 'DS_INTERNAL.IPYWIDGET_USED_BY_USER',
  HashedIPyWidgetNameDiscovered = 'DS_INTERNAL.IPYWIDGET_DISCOVERED',

src/client/datascience/interactive-common/interactiveWindowTypes.ts

@@ -10,7 +10,8 @@ import {
  CommonActionType,
  IAddCellAction,
  ILoadIPyWidgetClassFailureAction,
- LoadIPyWidgetClassLoadAction
+ LoadIPyWidgetClassLoadAction,
+ NotifyIPyWidgeWidgetVersionNotSupportedAction
 } from '../../../datascience-ui/interactive-common/redux/reducers/types';
 import { PythonInterpreter } from '../../interpreter/contracts';
 import { NativeKeyboardCommandTelemetry, NativeMouseCommandTelemetry } from '../constants';
@@ -117,7 +118,8 @@ export enum InteractiveWindowMessages {
  IPyWidgetLoadSuccess = 'ipywidget_load_success',
  IPyWidgetLoadFailure = 'ipywidget_load_failure',
  IPyWidgetRenderFailure = 'ipywidget_render_failure',
- IPyWidgetUnhandledKernelMessage = 'ipywidget_unhandled_kernel_message'
+ IPyWidgetUnhandledKernelMessage = 'ipywidget_unhandled_kernel_message',
+ IPyWidgetWidgetVersionNotSupported = 'ipywidget_widget_version_not_supported'
 }
 
 export enum IPyWidgetMessages {
@@ -580,6 +582,7 @@ export class IInteractiveWindowMapping {
  public [InteractiveWindowMessages.UpdateDisplayData]: KernelMessage.IUpdateDisplayDataMsg;
  public [InteractiveWindowMessages.IPyWidgetLoadSuccess]: LoadIPyWidgetClassLoadAction;
  public [InteractiveWindowMessages.IPyWidgetLoadFailure]: ILoadIPyWidgetClassFailureAction;
+ public [InteractiveWindowMessages.IPyWidgetWidgetVersionNotSupported]: NotifyIPyWidgeWidgetVersionNotSupportedAction;
  public [InteractiveWindowMessages.ConvertUriForUseInWebViewRequest]: Uri;
  public [InteractiveWindowMessages.ConvertUriForUseInWebViewResponse]: { request: Uri; response: Uri };
  public [InteractiveWindowMessages.IPyWidgetRenderFailure]: Error;

src/client/datascience/interactive-common/synchronization.ts

@@ -88,6 +88,7 @@ const messageWithMessageTypes: MessageMapping<IInteractiveWindowMapping> & Messa
  [CommonActionType.FOCUS_INPUT]: MessageType.other,
  [CommonActionType.LOAD_IPYWIDGET_CLASS_SUCCESS]: MessageType.other,
  [CommonActionType.LOAD_IPYWIDGET_CLASS_FAILURE]: MessageType.other,
+ [CommonActionType.IPYWIDGET_WIDGET_VERSION_NOT_SUPPORTED]: MessageType.other,
  [CommonActionType.IPYWIDGET_RENDER_FAILURE]: MessageType.other,
 
  // Types from InteractiveWindowMessages
@@ -119,6 +120,7 @@ const messageWithMessageTypes: MessageMapping<IInteractiveWindowMapping> & Messa
  [InteractiveWindowMessages.IPyWidgetLoadFailure]: MessageType.other,
  [InteractiveWindowMessages.IPyWidgetRenderFailure]: MessageType.other,
  [InteractiveWindowMessages.IPyWidgetUnhandledKernelMessage]: MessageType.other,
+ [InteractiveWindowMessages.IPyWidgetWidgetVersionNotSupported]: MessageType.other,
  [InteractiveWindowMessages.LoadAllCells]: MessageType.other,
  [InteractiveWindowMessages.LoadAllCellsComplete]: MessageType.other,
  [InteractiveWindowMessages.LoadOnigasmAssemblyRequest]: MessageType.other,

src/client/datascience/ipywidgets/ipywidgetHandler.ts

@@ -9,7 +9,8 @@ import stripAnsi from 'strip-ansi';
 import { Event, EventEmitter, Uri } from 'vscode';
 import {
  ILoadIPyWidgetClassFailureAction,
- LoadIPyWidgetClassLoadAction
+ LoadIPyWidgetClassLoadAction,
+ NotifyIPyWidgeWidgetVersionNotSupportedAction
 } from '../../../datascience-ui/interactive-common/redux/reducers/types';
 import { EnableIPyWidgets } from '../../common/experimentGroups';
 import { traceError, traceInfo } from '../../common/logger';
@@ -75,6 +76,8 @@ export class IPyWidgetHandler implements IInteractiveWindowListener {
  this.sendLoadSucceededTelemetry(payload);
  } else if (message === InteractiveWindowMessages.IPyWidgetLoadFailure) {
  this.sendLoadFailureTelemetry(payload);
+ } else if (message === InteractiveWindowMessages.IPyWidgetWidgetVersionNotSupported) {
+ this.sendUnsupportedWidgetVersionFailureTelemetry(payload);
  } else if (message === InteractiveWindowMessages.IPyWidgetRenderFailure) {
  this.sendRenderFailureTelemetry(payload);
  } else if (message === InteractiveWindowMessages.IPyWidgetUnhandledKernelMessage) {
@@ -111,6 +114,16 @@ export class IPyWidgetHandler implements IInteractiveWindowListener {
  // do nothing on failure
  }
  }
+ private sendUnsupportedWidgetVersionFailureTelemetry(payload: NotifyIPyWidgeWidgetVersionNotSupportedAction) {
+ try {
+ sendTelemetryEvent(Telemetry.IPyWidgetWidgetVersionNotSupportedLoadFailure, 0, {
+ moduleHash: this.hash(payload.moduleName),
+ moduleVersion: payload.moduleVersion
+ });
+ } catch {
+ // do nothing on failure
+ }
+ }
  private sendRenderFailureTelemetry(payload: Error) {
  try {
  traceError('Error rendering a widget: ', payload);

src/client/telemetry/index.ts

@@ -1974,6 +1974,10 @@ export interface IEventNamePropertyMapping {
  // Whether we timedout getting the source of the script (fetching script source in extension code).
  timedout: boolean;
  };
+ /**
+ * Telemetry event sent when an ipywidget version that is not supported is used & we have trapped this and warned the user abou it.
+ */
+ [Telemetry.IPyWidgetWidgetVersionNotSupportedLoadFailure]: { moduleHash: string; moduleVersion: string };
  /**
  * Telemetry event sent when an loading of 3rd party ipywidget JS scripts from 3rd party source has been disabled.
  */

src/datascience-ui/history-react/redux/reducers/index.ts

@@ -43,6 +43,7 @@ export const reducerMap: Partial<IInteractiveActionMapping> = {
  [CommonActionType.FOCUS_INPUT]: CommonEffects.focusInput,
  [CommonActionType.LOAD_IPYWIDGET_CLASS_SUCCESS]: CommonEffects.handleLoadIPyWidgetClassSuccess,
  [CommonActionType.LOAD_IPYWIDGET_CLASS_FAILURE]: CommonEffects.handleLoadIPyWidgetClassFailure,
+ [CommonActionType.IPYWIDGET_WIDGET_VERSION_NOT_SUPPORTED]: CommonEffects.notifyAboutUnsupportedWidgetVersions,
  [CommonActionType.IPYWIDGET_RENDER_FAILURE]: CommonEffects.handleIPyWidgetRenderFailure,
 
  // Messages from the webview (some are ignored)

src/datascience-ui/interactive-common/redux/reducers/commonEffects.ts

@@ -18,7 +18,8 @@ import {
  CommonReducerArg,
  ILoadIPyWidgetClassFailureAction,
  IOpenSettingsAction,
- LoadIPyWidgetClassLoadAction
+ LoadIPyWidgetClassLoadAction,
+ NotifyIPyWidgeWidgetVersionNotSupportedAction
 } from './types';
 
 export namespace CommonEffects {
@@ -258,6 +259,42 @@ export namespace CommonEffects {
  return arg.prevState;
  }
  }
+ export function notifyAboutUnsupportedWidgetVersions(
+ arg: CommonReducerArg<CommonActionType, NotifyIPyWidgeWidgetVersionNotSupportedAction>
+ ): IMainState {
+ // Find the first currently executing cell and add an error to its output
+ let index = arg.prevState.cellVMs.findIndex((c) => c.cell.state === CellState.executing);
+
+ // If there isn't one, then find the latest that matches the current execution count.
+ if (index < 0) {
+ index = arg.prevState.cellVMs.findIndex(
+ (c) => c.cell.data.execution_count === arg.prevState.currentExecutionCount
+ );
+ }
+ if (index >= 0 && arg.prevState.cellVMs[index].cell.data.cell_type === 'code') {
+ const newVMs = [...arg.prevState.cellVMs];
+ const current = arg.prevState.cellVMs[index];
+
+ const errorMessage = getLocString(
+ 'DataScience.qgridWidgetScriptVersionCompatibilityWarning',
+ "Unable to load a compatible version of the widget 'qgrid'. Consider downgrading to version 1.1.1."
+ );
+ newVMs[index] = Helpers.asCellViewModel({
+ ...current,
+ uiSideError: errorMessage
+ });
+
+ // Make sure to tell the extension so it can log telemetry.
+ postActionToExtension(arg, InteractiveWindowMessages.IPyWidgetWidgetVersionNotSupported, arg.payload.data);
+
+ return {
+ ...arg.prevState,
+ cellVMs: newVMs
+ };
+ } else {
+ return arg.prevState;
+ }
+ }
  export function handleIPyWidgetRenderFailure(arg: CommonReducerArg<CommonActionType, Error>): IMainState {
  // Make sure to tell the extension so it can log telemetry.
  postActionToExtension(arg, InteractiveWindowMessages.IPyWidgetRenderFailure, arg.payload.data);