[BLD] Add test for JS client to check for drift in generated openapi spec (#4298)

## Description of changes

This PR prettifies the JS client and adds a test in integration tests to
ensure that the openapi spec generated code has not differed from the
committed version.

## Test plan
*How are these changes tested?*

- [ ] Tests pass locally with `pytest` for python, `yarn test` for js,
`cargo test` for rust

## Documentation Changes
*Are all docstrings for user-facing APIs updated if required? Do we need
to make documentation changes in the [docs
repository](https://github.com/chroma-core/docs)?*

Author: jairad26

bin/ts-integration-test.sh

@@ -45,17 +45,25 @@ wait_for_server
 
 # Install dependencies
 cd clients/js
-echo "Installing dependencies..."
-pnpm i -g openapi-generator-plus @openapi-generator-plus/typescript-fetch-client-generator
 
 # Generate the JS client
 echo "Generating JS client..."
-chmod +x genapi.sh
-./genapi.sh
+pnpm genapi
 
 # Cleanup: kill the server process
 kill $SERVER_PID
 
+pnpm prettier
+
+# run git diff and check if packages/chromadb-core/src/generated/ has changed
+echo "Checking for changes in generated client..."
+if ! git diff --quiet --exit-code packages/chromadb-core/src/generated/; then
+    echo "Error: Generated JS client has changed. Please commit the changes."
+    git diff packages/chromadb-core/src/generated/ | cat
+    exit 1
+fi
+echo "No changes detected in generated client."
+
 # Install dependencies and run tests
 echo "Running tests..."
 pnpm -r test --verbose

clients/js/README.md

@@ -16,6 +16,7 @@ This package gives you a JS/TS interface to talk to a backend Chroma DB over RES
 There are two packages available for using ChromaDB in your JavaScript/TypeScript projects:
 
 1. **chromadb**: Includes all embedding libraries as bundled dependencies.
+
    - Use this if you want a simple installation without worrying about dependency management.
    - Install with: `npm install chromadb` or `pnpm add chromadb`
 

clients/js/examples/README.md

@@ -46,4 +46,4 @@ pnpm dev:client
 - The **bundled package** (`chromadb`) includes all embedding libraries as dependencies, making it easier to get started.
 - The **client package** (`chromadb-client`) uses peer dependencies, giving you more control over which versions of embedding libraries you use. It also keeps your dependency tree leaner if you only need specific embedding libraries.
 
-Both packages offer identical functionality and API.
+Both packages offer identical functionality and API.

clients/js/examples/node/README.md

@@ -17,6 +17,7 @@ This is an example of how to use ChromaDB with Node.js.
 This example demonstrates both ChromaDB package options:
 
 1. **chromadb** (Bundled Package): Includes all embedding libraries as dependencies.
+
    - Good for simple projects or when you want everything included.
    - Import with: `const chroma = require("chromadb");`
 

clients/js/examples/node/app-bundled.js

@@ -55,5 +55,7 @@ app.get("/", async (req, res) => {
   res.send(query);
 });
 app.listen(3000, function () {
-  console.log("Example app using bundled chromadb package listening on port 3000!");
-});
+  console.log(
+    "Example app using bundled chromadb package listening on port 3000!",
+  );
+});

clients/js/examples/node/app-client.js

@@ -56,5 +56,7 @@ app.get("/", async (req, res) => {
   res.send(query);
 });
 app.listen(3001, function () {
-  console.log("Example app using chromadb-client package listening on port 3001!");
-});
+  console.log(
+    "Example app using chromadb-client package listening on port 3001!",
+  );
+});

clients/js/examples/node/app.js

@@ -8,7 +8,9 @@ var chroma = require("chromadb");
 console.log("Using standard app.js with the bundled chromadb package");
 console.log("To try the different variants, run:");
 console.log("  - pnpm dev:bundled - Uses the bundled chromadb package");
-console.log("  - pnpm dev:client - Uses the chromadb-client package with peer dependencies");
+console.log(
+  "  - pnpm dev:client - Uses the chromadb-client package with peer dependencies",
+);
 
 var app = express();
 app.get("/", async (req, res) => {

clients/js/packages/chromadb-client/README.md

@@ -53,7 +53,10 @@ const collection = await chroma.createCollection({ name: "my-collection" });
 // Add documents to the collection
 await collection.add({
   ids: ["id1", "id2"],
-  embeddings: [[1.1, 2.3, 3.2], [4.5, 6.9, 4.4]],
+  embeddings: [
+    [1.1, 2.3, 3.2],
+    [4.5, 6.9, 4.4],
+  ],
   metadatas: [{ source: "doc1" }, { source: "doc2" }],
   documents: ["Document 1 content", "Document 2 content"],
 });
@@ -75,13 +78,13 @@ import { ChromaClient, OpenAIEmbeddingFunction } from "chromadb-client";
 
 const embedder = new OpenAIEmbeddingFunction({
   openai_api_key: "your-api-key",
-  model_name: "text-embedding-ada-002"
+  model_name: "text-embedding-ada-002",
 });
 
 const chroma = new ChromaClient({ path: "http://localhost:8000" });
 const collection = await chroma.createCollection({
   name: "my-collection",
-  embeddingFunction: embedder
+  embeddingFunction: embedder,
 });
 
 // Now you can add documents without providing embeddings
@@ -125,4 +128,4 @@ This package supports multiple embedding providers as peer dependencies:
 
 ## License
 
-Apache 2.0
+Apache 2.0

clients/js/packages/chromadb-client/jest.config.ts

@@ -5,16 +5,19 @@ export default {
   collectCoverage: false,
   testTimeout: 15000,
   transform: {
-    "^.+\\.(ts|tsx)$": ["ts-jest", {
-      tsconfig: "tsconfig.json"
-    }]
+    "^.+\\.(ts|tsx)$": [
+      "ts-jest",
+      {
+        tsconfig: "tsconfig.json",
+      },
+    ],
   },
   collectCoverageFrom: [
     "./src/**/*.{js,ts}",
     "!**/node_modules/**",
     "!**/vendor/**",
   ],
   moduleNameMapper: {
-    "@internal/chromadb-core": "<rootDir>/../chromadb-core/src"
-  }
-};
+    "@internal/chromadb-core": "<rootDir>/../chromadb-core/src",
+  },
+};

clients/js/packages/chromadb-client/package.json

@@ -76,4 +76,4 @@
   "engines": {
     "node": ">=14.17.0"
   }
-}
+}

clients/js/packages/chromadb-client/src/browser-entry.js

@@ -1,4 +1,3 @@
-
-import * as punycode from 'punycode';
+import * as punycode from "punycode";
 globalThis.punycode = punycode;
-export * from './index';
+export * from "./index";

clients/js/packages/chromadb-client/src/index.ts

@@ -1,4 +1,4 @@
 /**
  * Re-exports all functionality from the core package
  */
-export * from '@internal/chromadb-core';
+export * from "@internal/chromadb-core";

clients/js/packages/chromadb-client/src/punycode-shim.js

@@ -1,8 +1,8 @@
 // This shim provides punycode functionality to prevent dynamic require errors
-import punycode from 'punycode';
+import punycode from "punycode";
 
 // Add to globalThis to make it available for dynamic requires
 globalThis.punycode = punycode;
 
 // Export punycode directly
-export default punycode;
+export default punycode;

clients/js/packages/chromadb-client/test/basic.test.ts

@@ -1,7 +1,6 @@
 import { describe, it, expect } from "@jest/globals";
 import { ChromaClient } from "../src";
 
-
 describe("ChromaDB Client Integration", () => {
   it("should properly import and instantiate ChromaClient", () => {
     const client = new ChromaClient();
@@ -15,4 +14,4 @@ describe("ChromaDB Client Integration", () => {
     // We're just verifying the client initializes correctly with options
     expect(client).toBeDefined();
   });
-});
+});

clients/js/packages/chromadb-client/tsup.config.ts

@@ -10,16 +10,16 @@ export default defineConfig((options: Options) => {
     dts: true,
     target: "es2020",
     // Only bundle the core, keep embedding packages as external
-    noExternal: ['@internal/chromadb-core', 'isomorphic-fetch', 'cliui'],
+    noExternal: ["@internal/chromadb-core", "isomorphic-fetch", "cliui"],
     // Ensure all embedding packages remain external
     external: [
-      '@google/generative-ai',
-      '@xenova/transformers',
-      'chromadb-default-embed',
-      'cohere-ai',
-      'openai',
-      'voyageai',
-      'ollama'
+      "@google/generative-ai",
+      "@xenova/transformers",
+      "chromadb-default-embed",
+      "cohere-ai",
+      "openai",
+      "voyageai",
+      "ollama",
     ],
     ...options,
   };
@@ -32,7 +32,10 @@ export default defineConfig((options: Options) => {
       clean: true,
       async onSuccess() {
         // Support Webpack 4 by pointing `"module"` to a file with a `.js` extension
-        fs.copyFileSync("dist/chromadb-client.mjs", "dist/chromadb-client.legacy-esm.js");
+        fs.copyFileSync(
+          "dist/chromadb-client.mjs",
+          "dist/chromadb-client.legacy-esm.js",
+        );
       },
     },
     {
@@ -42,4 +45,4 @@ export default defineConfig((options: Options) => {
       outExtension: () => ({ js: ".cjs" }),
     },
   ];
-});
+});

clients/js/packages/chromadb-core/jest.config.ts

@@ -10,9 +10,12 @@ export default {
   coverageDirectory: "./test/coverage",
   coverageReporters: ["json", "html", "lcov"],
   transform: {
-    "^.+\\.(ts|tsx)$": ["ts-jest", {
-      tsconfig: "tsconfig.json"
-    }]
+    "^.+\\.(ts|tsx)$": [
+      "ts-jest",
+      {
+        tsconfig: "tsconfig.json",
+      },
+    ],
   },
   collectCoverageFrom: [
     "./src/**/*.{js,ts}",
@@ -21,9 +24,7 @@ export default {
   ],
   // Make tests find the src modules
   moduleNameMapper: {
-    "^@src/(.*)$": "<rootDir>/src/$1"
+    "^@src/(.*)$": "<rootDir>/src/$1",
   },
-  testPathIgnorePatterns: [
-    "node_modules/"
-  ]
-};
+  testPathIgnorePatterns: ["node_modules/"],
+};

clients/js/packages/chromadb-core/src/ChromaFetch.ts

@@ -15,9 +15,9 @@ import { FetchAPI } from "./generated";
 function isOfflineError(error: any): boolean {
   return Boolean(
     (error?.name === "TypeError" || error?.name === "FetchError") &&
-    (error.message?.includes("fetch failed") ||
-      error.message?.includes("Failed to fetch") ||
-      error.message?.includes("ENOTFOUND")),
+      (error.message?.includes("fetch failed") ||
+        error.message?.includes("Failed to fetch") ||
+        error.message?.includes("ENOTFOUND")),
   );
 }
 

clients/js/packages/chromadb-core/src/generated/README.md

@@ -3,31 +3,35 @@
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
 Environment
-* Node.js
-* Webpack
-* Browserify
+
+- Node.js
+- Webpack
+- Browserify
 
 Language level
-* ES5 - you must have a Promises/A+ library installed
-* ES6
+
+- ES5 - you must have a Promises/A+ library installed
+- ES6
 
 Module system
-* CommonJS
-* ES6 module system
+
+- CommonJS
+- ES6 module system
 
 It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
 
 ### Building
 
 To build an compile the typescript sources to javascript use:
+
 ```
 npm install
 npm run build
 ```
 
 ### Publishing
 
-First build the package then run ```npm publish```
+First build the package then run `npm publish`
 
 ### Consuming
 

clients/js/packages/chromadb-core/src/schemas/schemaUtils.ts

@@ -126,7 +126,9 @@ export function getSchemaVersion(schemaName: keyof typeof schemaMap): string {
  * @returns A list of schema names (without .json extension)
  */
 export function getAvailableSchemas(): (keyof typeof schemaMap)[] {
-  return Object.keys(schemaMap).filter((name) => name !== "base_schema") as (keyof typeof schemaMap)[];
+  return Object.keys(schemaMap).filter(
+    (name) => name !== "base_schema",
+  ) as (keyof typeof schemaMap)[];
 }
 
 /**

clients/js/packages/chromadb-core/src/types.ts

@@ -32,8 +32,8 @@ type WhereOperator = "$gt" | "$gte" | "$lt" | "$lte" | "$ne" | "$eq";
 
 type OperatorExpression = {
   [key in WhereOperator | InclusionOperator | LogicalOperator]?:
-  | LiteralValue
-  | ListLiteralValue;
+    | LiteralValue
+    | ListLiteralValue;
 };
 
 type BaseWhere = {
@@ -50,9 +50,9 @@ type WhereDocumentOperator = "$contains" | "$not_contains" | LogicalOperator;
 
 export type WhereDocument = {
   [key in WhereDocumentOperator]?:
-  | LiteralValue
-  | LiteralNumber
-  | WhereDocument[];
+    | LiteralValue
+    | LiteralNumber
+    | WhereDocument[];
 };
 
 export type MultiGetResponse = {

clients/js/packages/chromadb-core/src/utils.ts

@@ -23,7 +23,7 @@ export function toArray<T>(obj: T | T[]): Array<T> {
 
 // a function to convert an array to array of arrays
 export function toArrayOfArrays<T>(
-  obj: Array<Array<T>> | Array<T>
+  obj: Array<Array<T>> | Array<T>,
 ): Array<Array<T>> {
   if (obj.length === 0) {
     return [];
@@ -33,8 +33,8 @@ export function toArrayOfArrays<T>(
     return obj as Array<Array<T>>;
   }
 
-  if (obj[0] && typeof (obj[0] as any)[Symbol.iterator] === 'function') {
-    return (obj as unknown as Array<Iterable<T>>).map(el => Array.from(el));
+  if (obj[0] && typeof (obj[0] as any)[Symbol.iterator] === "function") {
+    return (obj as unknown as Array<Iterable<T>>).map((el) => Array.from(el));
   }
 
   return [obj] as Array<Array<T>>;

clients/js/packages/chromadb-core/test/delete.collection.test.ts

@@ -1,9 +1,4 @@
-import {
-  beforeEach,
-  describe,
-  expect,
-  test,
-} from "@jest/globals";
+import { beforeEach, describe, expect, test } from "@jest/globals";
 import { EMBEDDINGS, IDS, METADATAS } from "./data";
 import { ChromaClient } from "../src/ChromaClient";
 import { ChromaNotFoundError } from "../src/Errors";