v1.37 client library coverage + CI improvements by g-despot · Pull Request #417 · weaviate/docs

g-despot · 2026-05-06T13:35:27Z

What's being changed:

Type of change:

Documentation content updates (non-breaking change to fix/update documentation )
Bug fix (non-breaking change to fixes an issue with the site)
Feature or enhancements (non-breaking change to add functionality)

How has this been tested?

Local build - the site works as expected when running yarn start

v1.37 client coverage + CI improvements

orca-security-eu

Orca Security Scan Summary

Status	Check	Issues by priority
Passed	Infrastructure as Code	0 0 0 0	View in Orca
Passed	SAST	0 0 0 0	View in Orca
Passed	Secrets	0 0 0 0	View in Orca
Failed	Vulnerabilities	2 0 0 0	View in Orca

☢️ The following Vulnerabilities (CVEs) have been detected

	PACKAGE	FILE	CVE ID	INSTALLED VERSION	FIXED VERSION
	tar	./yarn.lock	CVE-2026-24842	6.2.1	7.5.7	View in code
	tar	./yarn.lock	CVE-2026-26960	6.2.1	7.5.8	View in code

orca-security-eu

Orca Security Scan Summary

Status	Check	Issues by priority
Passed	Infrastructure as Code	0 0 0 0	View in Orca
Passed	SAST	0 0 0 0	View in Orca
Passed	Secrets	0 0 0 0	View in Orca
Passed	Vulnerabilities	0 0 0 0	View in Orca

- conftest's autouse oidc_env fixture was clobbering WEAVIATE_HTTP_HOST/GRPC_HOST with localhost:8580/50551 for the entire session, breaking the WCD-targeting connect_to_custom snippets (Invalid port: 8580:443). After the OIDC snippets were updated to hardcode localhost, the env-var override is no longer needed. - search.generative.ts now reads the koala image from disk instead of fetching from Wikipedia (transient ETIMEDOUT in CI). Image bundled at _includes/code/howto/koala.jpg.

- Workflow: add '127.0.0.1 keycloak' to /etc/hosts in all 4 'Configure Keycloak' steps so OIDC clients on the runner host can reach the metadata endpoint at the docker-internal hostname (the iss claim). - query_agent.py / query_agent.mts: fix suggest_queries call referencing non-existent 'IRPAPERS' collection; use 'ArxivPapers' (which exists in WCD per repopulate.py). - personalization_agent.py: bump fetch limit (20 -> 200) so that contains_any over the 10 listed movie titles reliably has all of them in the result set; the 9k-movie dataset means the previous cap of 20 truncated before 'Avatar 2' showed up.

Copilot

Pull request overview

This PR updates the docs repo’s pinned Weaviate/client-library versions and expands/reshapes the snippet test harness (plus CI workflow) to improve v1.37 coverage—especially for tokenization and query profiling—while addressing CI flakiness around OIDC/token usage and some agent/indexability tests.

Changes:

Bump pinned Weaviate + client library versions (Node + Python) and refresh lockfiles.
Add new v1.37 code samples/tests (TypeScript, Java v6, C#) for tokenization + query profiling, plus C# export coverage.
CI/test-harness tweaks: yarn-based Node install, optional client-branch overrides, Keycloak issuer alignment, and xfails for known flaky tests.

Reviewed changes

Copilot reviewed 52 out of 56 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
yarn.lock	Updates Node dependency lockfile for new/added packages and version bumps.
versions-config.json	Bumps pinned component/client versions used by builds.
uv.lock	Updates Python dependency lockfile (agents + demo datasets).
tests/utils.py	Adjusts OIDC env handling to avoid clobbering host vars; adds clearer docstring.
tests/test_typescript.py	Enhances TS harness replacement support; adds v1.37 TS snippet coverage.
tests/test_python.py	Marks a flaky Python snippet as xfail in CI.
tests/test_java.py	Reorders Java suite to run OIDC connection earlier; adds new v1.37 Java tests.
tests/test_docs_indexability.py	Marks flaky ChatGPT web-search test as xfail.
tests/test_csharp.py	Reorders C# suite to run OIDC connection earlier; adds new v1.37 C# tests.
tests/README.md	Updates local setup guidance (Node/yarn) and adds TS-specific instructions.
tests/package.json	Keeps only ESM module setting for tsx execution (no dependencies).
tests/docker-compose.yml	Bumps Weaviate image to 1.37.2.
tests/docker-compose-three-nodes.yml	Bumps Weaviate images to 1.37.2.
tests/docker-compose-rbac.yml	Bumps Weaviate image; aligns Keycloak issuer hostname settings for OIDC.
tests/docker-compose-anon.yml	Bumps Weaviate image to 1.37.2.
tests/docker-compose-anon-offload.yml	Bumps Weaviate image to 1.37.2.
tests/docker-compose-anon-clip.yml	Bumps Weaviate image to 1.37.2.
tests/docker-compose-anon-bind.yml	Bumps Weaviate image to 1.37.2.
tests/docker-compose-anon-2.yml	Bumps Weaviate image to 1.37.2.
pytest.ini	Adds a `wcd` marker for remote WCD tests.
pyproject.toml	Bumps Python deps (agents + demo datasets).
package.json	Adds deps needed for TS embedded/export tooling; adds a tar resolution; bumps agents.
docs/weaviate/tutorials/tokenization.md	Adds TS/Java/C# tabs/snippets for v1.37 tokenization tutorial.
docs/weaviate/starter-guides/custom-vectors.mdx	Switches Java version placeholder to `java_client_version`.
docs/weaviate/search/query-profile.md	Adds TS/Java/C# tabs/snippets for query profiling docs.
docs/weaviate/client-libraries/java/index.mdx	Switches Java version placeholder to `java_client_version`.
docs/deploy/configuration/export.md	Adds C# snippets for export operations.
docs/agents/_includes/query_agent.py	Uses legacy single-vectorizer config; fixes collection name in suggest queries.
docs/agents/_includes/query_agent.mts	Adds targetVector config for named-vector collections; fixes collection name.
docs/agents/_includes/personalization_agent.py	Increases fetch limit for personalization sample.
CLAUDE.md	Updates package-manager guidance to “yarn only” and clarifies npm usage.
.github/workflows/docs_tests.yml	Adds workflow_dispatch inputs for client-branch overrides; improves Keycloak/OIDC setup.
.github/actions/setup-test-env/action.yml	Switches Node caching/install to yarn with frozen lockfile.
_includes/release-history.md	Adds v1.37 client-library coverage entries (TS/Go/Java/C#).
_includes/code/tutorials/tokenization/tokenize_endpoint.ts	Adds TS tokenize-endpoint examples and assertions.
_includes/code/tutorials/tokenization/custom_stopwords.ts	Adds TS custom stopwords examples and assertions.
_includes/code/tutorials/tokenization/accent_folding.ts	Adds TS accent folding examples and assertions.
_includes/code/quickstart/clients.install.new.mdx	Switches Java version placeholder to `java_client_version`.
_includes/code/quickstart/clients.install.mdx	Switches Java version placeholder to `java_client_version`.
_includes/code/package.json	Removes nested Node package manifest under `_includes/code/`.
_includes/code/java-v6/src/test/java/TokenizationTest.java	Adds Java v6 tokenization examples/tests for v1.37 features.
_includes/code/java-v6/src/test/java/SearchProfileTest.java	Adds Java v6 query-profile examples/tests.
_includes/code/java-v6/src/test/java/ConnectionTest.java	Updates OIDC connect snippet to hardcoded RBAC localhost ports.
_includes/code/java-v6/pom.xml	Bumps Java client dependency to 6.2.1-SNAPSHOT for tests.
_includes/code/howto/search.profile.ts	Adds TS query-profile how-to sample with assertions and setup/cleanup.
_includes/code/howto/search.generative.ts	Switches image loading from remote fetch to local file read for test stability.
_includes/code/howto/search.bm25.py	Updates BM25 query example text.
_includes/code/csharp/TokenizationTest.cs	Adds C# tokenization examples/tests for v1.37 features.
_includes/code/csharp/SearchProfileTest.cs	Adds C# query-profile examples/tests.
_includes/code/csharp/ManageDataExportTest.cs	Adds C# export examples/tests for v1.37 export preview API.
_includes/code/csharp/GetStartedTest.cs	Adds a hidden indexing delay between insert and query for stability.
_includes/code/csharp/ConnectionTest.cs	Updates OIDC connect snippet to hardcoded RBAC localhost ports.
_includes/code/connections/connect-ts-v3.ts	Updates OIDC connect snippet to hardcoded RBAC localhost ports.
_includes/code/connections/connect-python-v4.py	Updates OIDC connect snippet to hardcoded RBAC localhost ports.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+        client = await Connect.Local();
+    }
+
+    public Task DisposeAsync() => Task.CompletedTask;


    movie.properties["title"]: movie
    for movie in movies_collection.query.fetch_objects(
-        filters=Filter.by_property("title").contains_any(movie_titles), limit=20
+        filters=Filter.by_property("title").contains_any(movie_titles), limit=200


 # Connect to a self-hosted Weaviate instance configured with OIDC.
 # Obtain the access token from your identity provider before connecting.
-http_host, http_port = os.environ["WEAVIATE_HTTP_HOST"].split(":")
-grpc_host, grpc_port = os.environ["WEAVIATE_GRPC_HOST"].split(":")
-
 client = weaviate.connect_to_custom(
-    http_host=http_host,
-    http_port=int(http_port),
+    http_host="localhost",
+    http_port=8580,
    http_secure=False,
-    grpc_host=grpc_host,
-    grpc_port=int(grpc_port),
+    grpc_host="localhost",
+    grpc_port=50551,
    grpc_secure=False,
    auth_credentials=Auth.bearer_token(


 // Connect to a self-hosted Weaviate instance configured with OIDC.
 // Obtain the access token from your identity provider before connecting.
-const httpParts = process.env.WEAVIATE_HTTP_HOST!.split(':');
-const grpcParts = process.env.WEAVIATE_GRPC_HOST!.split(':');
-
 const client = await weaviate.connectToCustom({
-  httpHost: httpParts[0],
-  httpPort: Number(httpParts[1]),
+  httpHost: 'localhost',
+  httpPort: 8580,
  httpSecure: false,
-  grpcHost: grpcParts[0],
-  grpcPort: Number(grpcParts[1]),
+  grpcHost: 'localhost',
+  grpcPort: 50551,
  grpcSecure: false,


    String accessToken = System.getenv("WEAVIATE_OIDC_ACCESS_TOKEN");
    String refreshToken = System.getenv("WEAVIATE_OIDC_REFRESH_TOKEN");
    long expiresIn = Long.parseLong(
        System.getenv().getOrDefault("WEAVIATE_OIDC_EXPIRES_IN", "60"));

    WeaviateClient client = WeaviateClient.connectToCustom(config -> config
        .scheme("http")
-        .httpHost(httpParts[0])
-        .httpPort(Integer.parseInt(httpParts[1]))
-        .grpcHost(grpcParts[0])
-        .grpcPort(Integer.parseInt(grpcParts[1]))
+        .httpHost("localhost")
+        .httpPort(8580)
+        .grpcHost("localhost")
+        .grpcPort(50551)
        .authentication(Authentication.bearerToken(accessToken, refreshToken, expiresIn)));


        // Connect to a self-hosted Weaviate instance configured with OIDC.
        // Obtain the access token from your identity provider before connecting.
-        var httpParts = Environment.GetEnvironmentVariable("WEAVIATE_HTTP_HOST")!.Split(':');
-        var grpcParts = Environment.GetEnvironmentVariable("WEAVIATE_GRPC_HOST")!.Split(':');
        var accessToken = Environment.GetEnvironmentVariable("WEAVIATE_OIDC_ACCESS_TOKEN")!;
        var refreshToken = Environment.GetEnvironmentVariable("WEAVIATE_OIDC_REFRESH_TOKEN") ?? "";
        var expiresIn = int.Parse(Environment.GetEnvironmentVariable("WEAVIATE_OIDC_EXPIRES_IN") ?? "60");

        WeaviateClient client = await WeaviateClientBuilder
            .Custom(
-                restEndpoint: httpParts[0],
-                restPort: httpParts[1],
-                grpcEndpoint: grpcParts[0],
-                grpcPort: grpcParts[1],
+                restEndpoint: "localhost",
+                restPort: "8580",
+                grpcEndpoint: "localhost",
+                grpcPort: "50551",
                useSsl: false,
                credentials: Auth.BearerToken(accessToken, expiresIn, refreshToken)


+  "weaviate_agents_version": "1.4.0",
+  "python_client_version": "4.21.0",
+  "go_client_version": "5.7.2",
+  "java_client_version": "6.2.0",
+  "typescript_client_version": "3.13.0",


g-despot added 7 commits April 30, 2026 13:52

Missing Java and TS snippets

e3e10d3

Refactoring + C# snippets

b2a0c78

Merge branch 'main' into 1-37/ramining

9e2df53

Add C# changes

607e701

Add more C# examples

99b69d1

Trigger workflow

9dae75f

Merge pull request #416 from weaviate/1-37/ramining

d913933

v1.37 client coverage + CI improvements

orca-security-eu Bot reviewed May 6, 2026

View reviewed changes

g-despot added 5 commits May 6, 2026 16:34

Fix failing tests

0574cf9

Update dependencies

32bc4fc

Retrigger workflow

5bcf153

Fix TS dependency

ff66e75

Debug: temporary workflow to inspect secret values

14dc81a

github-advanced-security AI found potential problems May 7, 2026

View reviewed changes

Comment thread .github/workflows/debug-secrets.yml Fixed

g-despot added 2 commits May 7, 2026 13:52

Remove debug workflow

06da07c

Re-apply tar CVE resolution (^7.5.8)

b873d4a

orca-security-eu Bot reviewed May 7, 2026

View reviewed changes

g-despot added 10 commits May 7, 2026 14:01

Update yarn.lock for weaviate-agents 1.4.0

608ad59

Fix OIDC tests

f0d96f7

Fix failing

79b3449

Use legacy vectorizer for Weather agent collection

ffab90a

Merge branch 'main' into testing-ci

cf1b736

Run tests

3a2bc5f

Fix CI loop

864532b

Fix tests

39db60e

g-despot requested a review from Copilot May 20, 2026 06:10

Copilot started reviewing on behalf of g-despot May 20, 2026 06:10 View session

Copilot AI reviewed May 20, 2026

View reviewed changes

g-despot merged commit 308cdfa into main May 21, 2026
20 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v1.37 client library coverage + CI improvements#417

v1.37 client library coverage + CI improvements#417
g-despot merged 24 commits into
mainfrom
testing-ci

g-despot commented May 6, 2026

Uh oh!

orca-security-eu Bot left a comment •

edited

Loading

Uh oh!

Uh oh!

orca-security-eu Bot left a comment •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

g-despot commented May 6, 2026

What's being changed:

Type of change:

How has this been tested?

Uh oh!

orca-security-eu Bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Orca Security Scan Summary

Uh oh!

Uh oh!

orca-security-eu Bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Orca Security Scan Summary

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

orca-security-eu Bot left a comment •

edited

Loading

orca-security-eu Bot left a comment •

edited

Loading