Merge pull request #514 from Kitware/improved-error-reporting

Improved error reporting

Author: floryst

src/composables/useWebGLWatchdog.ts

@@ -1,3 +1,4 @@
+import { captureException, captureMessage } from '@sentry/vue';
 import vtkViewProxy from '@kitware/vtk.js/Proxy/Core/ViewProxy';
 import { useEventListener, useThrottleFn } from '@vueuse/core';
 import { Messages } from '../constants';
@@ -7,9 +8,14 @@ import { onProxyManagerEvent, ProxyManagerEvent } from './onProxyManagerEvent';
 export function useWebGLWatchdog() {
   const watchdogs = new Map<string, () => void>();
 
-  const reportError = useThrottleFn(() => {
+  const reportError = useThrottleFn((event) => {
     const messageStore = useMessageStore();
     messageStore.addError(Messages.WebGLLost.title, Messages.WebGLLost.details);
+    if (event) {
+      captureException(event);
+    } else {
+      captureMessage('WebGL2 context was lost');
+    }
   }, 100);
 
   onProxyManagerEvent(ProxyManagerEvent.ProxyCreated, (id, obj) => {

src/utils/errorReporting.ts

@@ -1,3 +1,4 @@
+import { getGPUInfo } from '@/src/utils/gpuInfo';
 import * as Sentry from '@sentry/vue';
 import { useLocalStorage } from '@vueuse/core';
 import { defineStore } from 'pinia';
@@ -16,6 +17,8 @@ export const init = (app: App<Element>) => {
       app,
       dsn: VITE_SENTRY_DSN,
     });
+
+  Sentry.setContext('gpu', getGPUInfo());
 };
 
 const setEnabled = (enabled: boolean) => {

src/utils/gpuInfo.ts

@@ -0,0 +1,37 @@
+import { Maybe } from '@/src/types';
+
+/**
+ * Retrieves the GPU renderer and vendor info.
+ * @returns
+ */
+export function getGPUInfo() {
+  let canvas: Maybe<OffscreenCanvas | HTMLCanvasElement> = null;
+  if (typeof OffscreenCanvas !== 'undefined') {
+    canvas = new OffscreenCanvas(1, 1);
+  } else if (typeof document !== 'undefined') {
+    canvas = document.createElement('canvas');
+  } else {
+    throw new Error('Cannot init a canvas');
+  }
+
+  const gl = canvas.getContext('webgl2') as WebGL2RenderingContext;
+  if (!gl) {
+    throw new Error('Cannot get a WebGL2 context');
+  }
+
+  const info = {
+    renderer: '',
+    vendor: '',
+  };
+
+  const dbg = gl.getExtension('WEBGL_debug_renderer_info');
+  if (dbg) {
+    info.renderer = gl.getParameter(dbg.UNMASKED_RENDERER_WEBGL);
+    info.vendor = gl.getParameter(dbg.UNMASKED_VENDOR_WEBGL);
+  } else {
+    info.renderer = gl.getParameter(gl.RENDERER);
+    info.vendor = gl.getParameter(gl.VENDOR);
+  }
+
+  return info;
+}