[CHORE] JS client CI update #5371

itaismith · 2025-08-27T22:42:17Z

Description of changes

Updating the CI for JS to test the new JS client on PRs. The integration script for JS (bin/ts-integration-test.sh) will now correctly generate types from the server on every PR, and will fail if changes were not committed. It will also use the updated tests and code from clients/new-js. The API generation script and tests now have the ability to skip spinning up the server if one is already available (set up by the integration test in this case).

Test plan

How are these changes tested?

Tests pass locally with pytest for python, yarn test for js, cargo test for rust

github-actions · 2025-08-27T22:42:25Z

propel-code-bot · 2025-08-27T22:43:04Z

JS Client CI & Integration Improvements and Migration to clients/new-js

This PR rewires the CI pipeline and development scripts for the Chroma JavaScript client, switching focus to the new JS implementation in clients/new-js. It updates the JavaScript integration test and API generation scripts to reliably spin up the server, generate TypeScript types, check for uncommitted generated changes, and run tests against the updated codebase. The PR also refreshes test setup logic, modifies workspace-wide configuration files, and ensures all new JS-related jobs, scripts, and documentation now reference the correct paths and npm workspace.

Key Changes

• Replaces JS client testing and generation flows from clients/js to clients/new-js in CI and development scripts.
• Updates bin/ts-integration-test.sh to reliably build, start, and cleanup the server, generate types, enforce up-to-date generation, and run tests.
• Adds flexibility to API/types generation (gen-api.ts) to use an existing server if available to avoid redundant server starts.
• Converts test suite bootstrap code to prefer using an externally started server (suitable for CI/integration-run environments).
• Ensures .github/workflows/pr.yml and reusable actions reference clients/new-js; fixes jobs, directory globs, and job dependencies accordingly.
• Bumps native optional dependency versions in pnpm-lock.yaml and package.json.
• Applies various test file updates to use new host/port environment variable idioms.
• Introduces a simple YAML config for integration server config (bin/ts-integration-test-fe-config.yml).

Affected Areas

• CI workflows: PR workflows, reusable JS test workflow
• Integration test and API generation bash and Node scripts
• JS client test wrappers, test setup, and all test files
• JS package management (pnpm, package.json, lock files)
• TypeScript auto-generated API/types files and codegen logic

This summary was automatically generated by @propel-code-bot

blacksmith-sh · 2025-08-27T22:45:27Z

2 Jobs Failed:

PR checks / all-required-pr-checks-passed

Step "Decide whether the needed jobs succeeded or failed" from job "all-required-pr-checks-passed" is failing. The last 20 log lines are:

[...]
}
EOM
)"
shell: /usr/bin/bash --noprofile --norc -e -o pipefail {0}
env:
  GITHUB_REPO_NAME: chroma-core/chroma
  PYTHONPATH: /home/runner/_work/_actions/re-actors/alls-green/release/v1/src
# ❌ Some of the required to succeed jobs failed 😢😢😢

📝 Job statuses:
📝 python-tests → ✓ success [required to succeed or be skipped]
📝 python-vulnerability-scan → ✓ success [required to succeed or be skipped]
📝 javascript-client-tests → ❌ failure [required to succeed or be skipped]
📝 rust-tests → ✓ success [required to succeed or be skipped]
📝 go-tests → ✓ success [required to succeed or be skipped]
📝 lint → ✓ success [required to succeed]
📝 check-helm-version-bump → ⬜ skipped [required to succeed or be skipped]
📝 delete-helm-comment → ✓ success [required to succeed or be skipped]
Error: Process completed with exit code 1.

PR checks / JavaScript client tests / test

Step "Test" from job "JavaScript client tests / test" is failing. The last 20 log lines are:

[...]

> [email protected] genapi /home/runner/_work/chroma/chroma/clients/new-js/packages/chromadb
> node --loader ts-node/esm scripts/gen-api.ts -- --use-localhost

(node:5566) ExperimentalWarning: `--experimental-loader` may be removed in the future; instead use `register()`:
--import 'data:text/javascript,import { register } from "node:module"; import { pathToFileURL } from "node:url"; register("ts-node/esm", pathToFileURL("./"));'
(Use `node --trace-warnings ...` to show where the warning was created)
⏳ Generating from http://localhost:8000/openapi.json
🔥 Unexpected error occurred. Log saved to /home/runner/_work/chroma/chroma/clients/new-js/packages/chromadb/openapi-ts-error-1756509561054.log
🔥 Unexpected error occurred. Request failed with status 200: 
Server stopped
✅ Cleaned up ./chroma directory
Error: Request failed with status 200: 
    at re (file:///home/runner/_work/chroma/chroma/clients/new-js/node_modules/.pnpm/@[email protected][email protected]/node_modules/@hey-api/openapi-ts/dist/index.js:8:3788)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async Promise.all (index 0)
    at async oi (file:///home/runner/_work/chroma/chroma/clients/new-js/node_modules/.pnpm/@[email protected][email protected]/node_modules/@hey-api/openapi-ts/dist/index.js:1304:3066)
    at async main (file:///home/runner/_work/chroma/chroma/clients/new-js/packages/chromadb/scripts/gen-api.ts:26:9)
 ELIFECYCLE  Command failed with exit code 1.
Error: Process completed with exit code 1.

Summary: 1 successful workflow, 1 failed workflow

❌ PR checks (53 jobs succeeded, 2 jobs failed)
✅ Check PR Title (1 job succeeded)

Last updated: 2025-08-29 23:38:00 UTC

bin/ts-integration-test.sh

clients/new-js/packages/chromadb/scripts/gen-api.ts

propel-code-bot · 2025-08-29T21:02:01Z

clients/new-js/packages/chromadb/src/api/client.gen.ts

+export const client = createClient(
+  createConfig<ClientOptions>({


[CriticalError]

Consider validating the default port configuration. The client defaults to 'http://localhost:8000' but the server starts on '127.0.0.1:8000'. This inconsistency could cause connection failures.

export const client = createClient( createConfig<ClientOptions>({ baseUrl: "http://127.0.0.1:8000", // Match server host throwOnError: true, }), );

Alternatively, ensure both use the same host consistently throughout the codebase.

propel-code-bot · 2025-08-29T21:02:02Z

bin/ts-integration-test.sh

 # Start the Chroma server in the background
 echo "Building and starting Chroma server..."
 cargo build --bin chroma
 cargo run --bin chroma run &
 SERVER_PID=$!
+
 # Wait for the server to be ready
 wait_for_server

-# Install dependencies
-cd clients/js
-
-# Generate the JS client
+# Generate API
 echo "Generating JS client..."
-pnpm genapi
+cd clients/new-js/packages/chromadb
+pnpm genapi -- --use-localhost

-# Cleanup: kill the server process
-kill $SERVER_PID
-
-pnpm prettier
-
-# run git diff and check if packages/chromadb-core/src/generated/ has changed
+# run git diff and check if packages/chromadb/src/api/ has changed
 echo "Checking for changes in generated client..."
-if ! git diff --quiet --exit-code packages/chromadb-core/src/generated/; then
+if ! git diff --quiet --exit-code src/api/; then
    echo "Error: Generated JS client has changed. Please commit the changes."
-    git diff packages/chromadb-core/src/generated/ | cat
+    git diff src/api/ | cat
    exit 1
 fi
 echo "No changes detected in generated client."

-# Install dependencies and run tests
+# Run tests
+export DEFAULT_CHROMA_INSTANCE_URL="http://localhost:8000"
+export DEFAULT_CHROMA_INSTANCE_HOST="127.0.0.1"
+
 echo "Running tests..."
-pnpm -r test --verbose
+pnpm -r test
+
+# Cleanup: kill the server process
+kill $SERVER_PID


[BestPractice]

The server process is started in the background, but the kill $SERVER_PID command is at the very end of the script. Since set -e is active, if any command fails before the end of the script (e.g., pnpm genapi, git diff, or pnpm test), the script will exit immediately, leaving the server process running. This could cause issues in CI environments by consuming resources.

Using a trap will ensure the server process is cleaned up regardless of how the script exits.

propel-code-bot · 2025-08-29T21:11:45Z

bin/ts-integration-test.sh

+pnpm -r test
+
+# Cleanup: kill the server process
+kill $SERVER_PID


[BestPractice]

For a more robust cleanup, consider killing the entire process group instead of just the single process. The cargo run command can spawn child processes that might be orphaned if only the parent process is killed, which could lead to resource leaks on the CI runner.

Using kill -- -$SERVER_PID sends the signal to all processes in the process group, ensuring a cleaner shutdown.

Suggested change

kill $SERVER_PID

kill -- -$SERVER_PID

⚡ Committable suggestion

Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

propel-code-bot · 2025-08-29T21:18:43Z

bin/ts-integration-test.sh

 # Function to check if server is ready
 check_server() {
    curl -s http://localhost:8000/openapi.json > /dev/null
    return $?
 }


[BestPractice]

To improve consistency and avoid potential issues with localhost resolving to IPv6 addresses in some environments, it would be better to use variables for the host and port and use 127.0.0.1 consistently. This also makes the script easier to configure if the port needs to be changed in the future.

propel-code-bot · 2025-08-29T21:18:44Z

bin/ts-integration-test.sh

+export DEFAULT_CHROMA_INSTANCE_URL="http://localhost:8000"
+export DEFAULT_CHROMA_INSTANCE_HOST="127.0.0.1"


[BestPractice]

Using the variables defined at the top of the script will ensure consistency.

propel-code-bot · 2025-08-29T23:22:06Z

clients/new-js/packages/chromadb/scripts/gen-api.ts

+      await rm("../../../../chroma_integration_test_tmp_dir/", {
+        recursive: true,
+        force: true,
+      });


[BestPractice]

Using a relative path with ../../../../ to locate a directory from the project root can be brittle. If this script's location changes in the future, this path will break. A more robust approach is to construct the path programmatically using path.join and __dirname.

itaismith added 2 commits August 27, 2025 11:53

[CHORE] Update JS CI

cd1399f

Update JS CI for PRs

6f7dd74

propel-code-bot bot reviewed Aug 27, 2025

View reviewed changes

bin/ts-integration-test.sh Outdated Show resolved Hide resolved

propel-code-bot bot reviewed Aug 27, 2025

View reviewed changes

clients/new-js/packages/chromadb/scripts/gen-api.ts Show resolved Hide resolved

itaismith added 4 commits August 27, 2025 16:25

Add prettier to genapi

60544cd

Fix env vars typo

cef9767

Update genapi

70f003a

Fix diff paths

5c8cdb2

propel-code-bot bot reviewed Aug 29, 2025

View reviewed changes

Build packages

d55cf10

propel-code-bot bot reviewed Aug 29, 2025

View reviewed changes

Fix paths

4bd914c

propel-code-bot bot reviewed Aug 29, 2025

View reviewed changes

itaismith added 3 commits August 29, 2025 15:06

Fix test failures

e27ddd2

Allow server reset for tests

a5dae05

Fix genapi host

6047f67

propel-code-bot bot reviewed Aug 29, 2025

View reviewed changes

itaismith closed this Sep 2, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[CHORE] JS client CI update #5371

[CHORE] JS client CI update #5371

Uh oh!

itaismith commented Aug 27, 2025

Uh oh!

github-actions bot commented Aug 27, 2025

Uh oh!

propel-code-bot bot commented Aug 27, 2025 •

edited

Loading

Uh oh!

blacksmith-sh bot commented Aug 27, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

propel-code-bot bot Aug 29, 2025

Uh oh!

propel-code-bot bot Aug 29, 2025

Uh oh!

propel-code-bot bot Aug 29, 2025

Uh oh!

propel-code-bot bot Aug 29, 2025

Uh oh!

propel-code-bot bot Aug 29, 2025

Uh oh!

propel-code-bot bot Aug 29, 2025

Uh oh!

Uh oh!

		export const client = createClient(
		createConfig<ClientOptions>({

		export DEFAULT_CHROMA_INSTANCE_URL="http://localhost:8000"
		export DEFAULT_CHROMA_INSTANCE_HOST="127.0.0.1"

[CHORE] JS client CI update #5371

[CHORE] JS client CI update #5371

Uh oh!

Conversation

itaismith commented Aug 27, 2025

Description of changes

Test plan

Uh oh!

github-actions bot commented Aug 27, 2025

Reviewer Checklist

Testing, Bugs, Errors, Logs, Documentation

System Compatibility

Quality

Uh oh!

propel-code-bot bot commented Aug 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

blacksmith-sh bot commented Aug 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

propel-code-bot bot Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

propel-code-bot bot Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

propel-code-bot bot Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

propel-code-bot bot Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

propel-code-bot bot Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

propel-code-bot bot Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

propel-code-bot bot commented Aug 27, 2025 •

edited

Loading

blacksmith-sh bot commented Aug 27, 2025 •

edited

Loading