Add a jest test on settings

Author: brichet

.gitignore

@@ -130,3 +130,6 @@ Untitled*.ipynb
 # Integration tests
 ui-tests/test-results/
 ui-tests/playwright-report/
+
+# jest test reports
+junit.xml

babel.config.js

@@ -0,0 +1,6 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+module.exports = require('@jupyterlab/testing/lib/babel-config');

jest.config.js

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+const jestJupyterLab = require('@jupyterlab/testing/lib/jest-config');
+
+const esModules = [
+  '@codemirror',
+  '@jupyterlab/',
+  'exenv-es6',
+  'lib0',
+  'nanoid',
+  'vscode-ws-jsonrpc',
+].join('|');
+
+const baseConfig = jestJupyterLab(__dirname);
+
+module.exports = {
+  ...baseConfig,
+  automock: false,
+  collectCoverageFrom: [
+    'src/**/*.{ts,tsx}',
+    '!src/**/*.d.ts',
+    '!src/**/.ipynb_checkpoints/*'
+  ],
+  coverageReporters: ['lcov', 'text'],
+  testRegex: 'src/.*/.*.spec.ts[x]?$',
+  transformIgnorePatterns: [`/node_modules/(?!${esModules}).+`]
+};

package.json

@@ -51,6 +51,7 @@
         "settings:check": "node ./scripts/settings-checker.js",
         "stylelint": "jlpm stylelint:check --fix",
         "stylelint:check": "stylelint --cache \"style/**/*.css\"",
+        "test": "jest --coverage",
         "watch": "run-p watch:src watch:labextension",
         "watch:src": "tsc -w --sourceMap",
         "watch:labextension": "jupyter labextension watch ."
@@ -90,8 +91,10 @@
     },
     "devDependencies": {
         "@jupyterlab/builder": "^4.4.0",
+        "@jupyterlab/testing": "^4.4.0",
         "@stylistic/eslint-plugin": "^3.0.1",
         "@types/chrome": "^0.0.304",
+        "@types/jest": "^29.2.0",
         "@types/json-schema": "^7.0.11",
         "@types/react": "^18.0.26",
         "@types/react-addons-linked-state-mixin": "^0.14.22",
@@ -102,6 +105,8 @@
         "eslint": "^8.36.0",
         "eslint-config-prettier": "^8.8.0",
         "eslint-plugin-prettier": "^5.0.0",
+        "jest": "^29.2.0",
+        "json-schema-library": "^10.1.2",
         "npm-run-all": "^4.1.5",
         "prettier": "^3.0.0",
         "rimraf": "^5.0.1",

src/__tests__/provider-settings.spec.ts

@@ -0,0 +1,97 @@
+import { compileSchema, SchemaNode } from 'json-schema-library';
+import { ReadableStream } from 'web-streams-polyfill';
+// @ts-expect-error
+globalThis.ReadableStream = ReadableStream;
+// if (typeof global.ReadableStream === undefined) {
+//   global.ReadableStream = ReadableStream;
+// }
+
+import { ChatAnthropic } from '@langchain/anthropic';
+// import { ChatWebLLM } from '@langchain/community/chat_models/webllm';
+import { ChromeAI } from '@langchain/community/experimental/llms/chrome_ai';
+import { ChatGoogleGenerativeAI } from '@langchain/google-genai';
+import { ChatMistralAI } from '@langchain/mistralai';
+import { ChatOllama } from '@langchain/ollama';
+import { ChatOpenAI } from '@langchain/openai';
+
+// Import Settings
+import AnthropicSettings from '../default-providers/Anthropic/settings-schema.json';
+import ChromeAISettings from '../default-providers/ChromeAI/settings-schema.json';
+import GeminiSettings from '../default-providers/Gemini/settings-schema.json';
+import MistralAISettings from '../default-providers/MistralAI/settings-schema.json';
+import OllamaAISettings from '../default-providers/Ollama/settings-schema.json';
+import OpenAISettings from '../default-providers/OpenAI/settings-schema.json';
+// import WebLLMSettings from '../default-providers/WebLLM/settings-schema.json';
+import { IAIProvider, IType } from '../tokens';
+import { BaseChatModel, BaseChatModelCallOptions } from '@langchain/core/language_models/chat_models';
+import { AIMessageChunk } from '@langchain/core/messages';
+
+interface IAIProviderWithChat extends IAIProvider {
+  chat: IType<BaseChatModel<BaseChatModelCallOptions, AIMessageChunk>>;
+}
+const AIProviders: IAIProviderWithChat[] = [
+  {
+    name: 'Anthropic',
+    chat: ChatAnthropic,
+    settingsSchema: AnthropicSettings,
+  },
+  {
+    name: 'ChromeAI',
+    // TODO: fix
+    // @ts-expect-error: missing properties
+    chat: ChromeAI,
+    settingsSchema: ChromeAISettings,
+  },
+  {
+    name: 'MistralAI',
+    chat: ChatMistralAI,
+    settingsSchema: MistralAISettings
+  },
+  {
+    name: 'Ollama',
+    chat: ChatOllama,
+    settingsSchema: OllamaAISettings
+  },
+  {
+    name: 'Gemini',
+    chat: ChatGoogleGenerativeAI,
+    settingsSchema: GeminiSettings
+  },
+  {
+    name: 'OpenAI',
+    chat: ChatOpenAI,
+    settingsSchema: OpenAISettings
+  },
+  // {
+  //   name: 'WebLLM',
+  //   chat: ChatWebLLM,
+  //   settingsSchema: WebLLMSettings
+  // }
+];
+
+it('test provider settings', () => {
+  AIProviders.forEach(provider => {
+    console.log(`PROVIDER: ${provider.name}`);
+    const schema: SchemaNode = compileSchema(provider.settingsSchema);
+    const defaultSettings = schema.getData(undefined, { addOptionalProps: true });
+
+    // Set a value for apiKey to avoid errors at instantiation.
+    if (defaultSettings.apiKey !== undefined) {
+      defaultSettings.apiKey = 'abc';
+    }
+    defaultSettings.bnla = 'ble';
+    const model = new provider.chat(defaultSettings);
+
+    Object.entries(defaultSettings).forEach(([key, value]) => {
+      try {
+        // @ts-expect-error
+        expect(JSON.stringify(model[key])).toEqual(JSON.stringify(value));
+      } catch (err) {
+        // @ts-expect-error
+        err.message = `${err.message}\nproperty: ${key}\n`;
+        throw err;  // throw the error so test fails as expected
+      }
+
+    });
+  });
+});

tsconfig.test.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig",
+  "compilerOptions": {
+    "types": ["jest"]
+  }
+}