feat: Ruff Python formatter and linter (#2233)

Fixes #1255 (This might not actually be breaking, it's more just notes for implementing in DHE) BREAKING CHANGE: The app should call `MonacoUtils.init` with a `getWorker` function that uses the JSON worker in addition to the general fallback worker when adding support for configuring ruff.
deephaven · Sep 26, 2024 · 4839d72 · 4839d72
1 parent a24dc8c
commit 4839d72
Show file tree

Hide file tree

Showing 32 changed files with 4,877 additions and 131 deletions.
diff --git a/jest.config.base.cjs b/jest.config.base.cjs
@@ -34,6 +34,7 @@ const nodeModulesToTransform = [
   'web-namespaces',
   'hastscript',
   'nanoid',
+  '@astral-sh/ruff-wasm-web',
 ];
 
 module.exports = {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -86,6 +86,7 @@
     "@types/lodash.clamp": "^4.0.6",
     "@types/lodash.debounce": "^4.0.6",
     "@types/lodash.flatten": "^4.4.0",
+    "@types/lodash.merge": "^4.6.9",
     "@types/lodash.set": "^4.3.7",
     "@types/lodash.throttle": "^4.1.1",
     "@types/memoizee": "^0.4.5",

diff --git a/packages/app-utils/package.json b/packages/app-utils/package.json
@@ -56,6 +56,7 @@
     "@paciolan/remote-module-loader": "^3.0.2",
     "classnames": "^2.5.1",
     "lodash.debounce": "^4.0.8",
+    "lodash.merge": "^4.6.2",
     "lodash.throttle": "^4.1.1"
   },
   "peerDependencies": {

diff --git a/packages/app-utils/src/storage/LocalWorkspaceStorage.ts b/packages/app-utils/src/storage/LocalWorkspaceStorage.ts
@@ -12,6 +12,7 @@ import {
   DecimalColumnFormatter,
   IntegerColumnFormatter,
 } from '@deephaven/jsapi-utils';
+import merge from 'lodash.merge';
 import UserLayoutUtils from './UserLayoutUtils';
 import type LayoutStorage from './LayoutStorage';
 
@@ -36,6 +37,26 @@ export class LocalWorkspaceStorage implements WorkspaceStorage {
     return undefined;
   }
 
+  static getJSONServerConfig(
+    serverConfigValues: Map<string, string> | undefined,
+    key: string
+  ): Record<string, unknown> | undefined {
+    const value = serverConfigValues?.get(key);
+
+    if (value == null) {
+      return undefined;
+    }
+
+    try {
+      return JSON.parse(value);
+    } catch (e) {
+      log.error(
+        `Unable to parse JSON server config for key ${key}. Value: ${value}`
+      );
+      return undefined;
+    }
+  }
+
   static makeDefaultWorkspaceSettings(
     serverConfigValues: ServerConfigValues
   ): WorkspaceSettings {
@@ -57,13 +78,20 @@ export class LocalWorkspaceStorage implements WorkspaceStorage {
       showEmptyStrings: true,
       showNullStrings: true,
       showExtraGroupColumn: true,
-      defaultNotebookSettings: {
+      notebookSettings: {
         isMinimapEnabled: false,
+        formatOnSave: false,
+        python: {
+          linter: {
+            isEnabled: true,
+            // Omit default config so default settings are used if the user never changes them
+          },
+        },
       },
       webgl: true,
       webglEditable: true,
-      gridDensity: 'regular' as const,
-    };
+      gridDensity: 'regular',
+    } satisfies WorkspaceSettings;
     const serverSettings = {
       defaultDateTimeFormat: serverConfigValues?.get('dateTimeFormat'),
       formatter: [],
@@ -108,15 +136,28 @@ export class LocalWorkspaceStorage implements WorkspaceStorage {
         serverConfigValues,
         'showExtraGroupColumn'
       ),
-      defaultNotebookSettings:
-        serverConfigValues?.get('isMinimapEnabled') !== undefined
-          ? {
-              isMinimapEnabled: LocalWorkspaceStorage.getBooleanServerConfig(
-                serverConfigValues,
-                'isMinimapEnabled'
-              ) as boolean,
-            }
-          : undefined,
+      notebookSettings: {
+        isMinimapEnabled: LocalWorkspaceStorage.getBooleanServerConfig(
+          serverConfigValues,
+          'web.user.notebookSettings.isMinimapEnabled'
+        ),
+        formatOnSave: LocalWorkspaceStorage.getBooleanServerConfig(
+          serverConfigValues,
+          'web.user.notebookSettings.formatOnSave'
+        ),
+        python: {
+          linter: {
+            isEnabled: LocalWorkspaceStorage.getBooleanServerConfig(
+              serverConfigValues,
+              'web.user.notebookSettings.python.linter.isEnabled'
+            ),
+            config: LocalWorkspaceStorage.getJSONServerConfig(
+              serverConfigValues,
+              'web.user.notebookSettings.python.linter.config'
+            ),
+          },
+        },
+      },
       webgl: LocalWorkspaceStorage.getBooleanServerConfig(
         serverConfigValues,
         'web.webgl'
@@ -125,19 +166,9 @@ export class LocalWorkspaceStorage implements WorkspaceStorage {
         serverConfigValues,
         'web.webgl.editable'
       ),
-    };
+    } satisfies Partial<WorkspaceSettings>;
 
-    const keys = Object.keys(serverSettings) as Array<
-      keyof typeof serverSettings
-    >;
-    for (let i = 0; i < keys.length; i += 1) {
-      const key = keys[i];
-      if (serverSettings[key] !== undefined) {
-        // @ts-expect-error override default for defined server settings
-        settings[key] = serverSettings[key];
-      }
-    }
-    return settings;
+    return merge({}, settings, serverSettings);
   }
 
   static async makeWorkspaceData(

diff --git a/packages/code-studio/package.json b/packages/code-studio/package.json
@@ -47,7 +47,7 @@
     "lodash.throttle": "^4.1.1",
     "memoize-one": "^5.1.1",
     "memoizee": "^0.4.15",
-    "monaco-editor": "^0.41.0",
+    "monaco-editor": "^0.43.0",
     "nanoid": "^5.0.7",
     "pouchdb-browser": "^7.2.2",
     "pouchdb-find": "^7.2.2",

diff --git a/packages/code-studio/src/AppRoot.tsx b/packages/code-studio/src/AppRoot.tsx
@@ -2,6 +2,7 @@ import React from 'react';
 import { MonacoUtils } from '@deephaven/console';
 import { DownloadServiceWorkerUtils } from '@deephaven/iris-grid';
 import MonacoWorker from 'monaco-editor/esm/vs/editor/editor.worker?worker';
+import MonacoJsonWorker from 'monaco-editor/esm/vs/language/json/json.worker?worker';
 import AppRouter from './main/AppRouter';
 
 // load addional css for playwright docker tests
@@ -16,7 +17,14 @@ export function AppRoot(): JSX.Element {
       window.location.href
     )
   );
-  MonacoUtils.init({ getWorker: () => new MonacoWorker() });
+  MonacoUtils.init({
+    getWorker: (id: string, label: string) => {
+      if (label === 'json') {
+        return new MonacoJsonWorker();
+      }
+      return new MonacoWorker();
+    },
+  });
 
   // disable annoying dnd-react warnings
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment