Feat/introduce web client by tsmith023 · Pull Request #307 · weaviate/typescript-client

tsmith023 · 2025-06-20T13:48:19Z

Refactor into a monorepo composed for four packages:
- @weaviate/core: shared functionality
- @weaviate/node: Node-client that uses nice-grpc and fs
- @weaviate/web: Browser-client that uses nice-grpc-web and FileReader
- @weaviate/test: Tests the public APIs of the core/node pkgs
Use pnpm for managing the monorepo
Use dependency injection to pipe node/browser deps into the common functionality of the client
- This will allow a @weaviate/deno package too with its own deno-specific libs injected in to close
  Can't connect by Deno #309
Depends on on core: feat: introduce /grpc-web endpoint weaviate#12024
Closes weaviate-client fails to bundle on Cloudflare Workers due to http2 dependency #145

…ipt-client into web/split-nice-grpc-connection

- Refactor into a monorepo composed for four packages: - @weaviate/core: shared functionality - @weaviate/node: Node-client that uses `grpc-js` and `fs` - @weaviate/web: Browser-client that uses `nice-grpc` and `FileReader` - @weaviate/test: Tests the public APIs of the core/node pkgs - Replace `jest` with `vitest` - Use `pnpm` for managing the monorepo - Use dependency injection to pipe node/browser deps into the common functionality of the client

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

…into feat/introduce-web-client

weaviate-git-bot · 2025-06-21T10:01:43Z

Great to see you again! Thanks for the contribution.

beep boop - the Weaviate bot 👋🤖

PS:
Are you already a member of the Weaviate Slack channel?

…into feat/introduce-web-client

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 1 0 0	View in Orca

☢️ The following Vulnerabilities (CVEs) have been detected

	PACKAGE	FILE	CVE ID	INSTALLED VERSION	FIXED VERSION
	ws	./pnpm-lock.yaml	CVE-2026-48779	8.18.2	5.2.5, 6.2.4, 7.5.11, 8.21.0	View in code

… in the schema

…s rest

…ve-node-https-from-web chore(agent): remove node https module from web bundle

…y imported

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	1 1 0 0	View in Orca

☢️ The following Vulnerabilities (CVEs) have been detected

	PACKAGE	FILE	CVE ID	INSTALLED VERSION	FIXED VERSION
	ws	./pnpm-lock.yaml	CVE-2026-48779	8.18.2	5.2.5, 6.2.4, 7.5.11, 8.21.0	View in code
	ws	./pnpm-lock.yaml	CVE-2026-45736	8.18.2	8.20.1	View in code

…into feat/introduce-web-client

bevzzz · 2026-07-17T09:38:28Z

-          'username and password, so this method is not supported by this client'
-      );
-    }
-    this.openidConfig.scopes.push('offline_access');


issue: this is a breaking change, client should continue to add offline_access scope.

Sneaky having that at the end of something called "validate config" 😅
I missed it too while cherry-picking the commit but good thing the tests caught it.

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
	ws	./pnpm-lock.yaml	CVE-2026-48779	8.18.2	5.2.5, 6.2.4, 7.5.11, 8.21.0	View in code
	ws	./pnpm-lock.yaml	CVE-2026-45736	8.18.2	8.20.1	View in code

bevzzz · 2026-08-12T15:13:17Z

  (name.charAt(0).toUpperCase() + name.slice(1)) as N;

-const collection = <T, N, V>(
+const collection = <T, N, V, M>(


nit/suggestion: if renaming generic parameters and formatting changes were their own PR(s) it'd be easier to focus on the key areas of the diff in this one

Having went through the whole PR I want to emphasize much easier :)

bevzzz · 2026-08-12T15:19:37Z

-  private constructor(params: GrpcConnectionParams & { grpcMaxMessageLength: number }) {
+  private constructor(
+    transports: Transports,
+    params: GrpcConnectionParams & { grpcMaxMessageLength: number }


question: Can grpcMaxMessageLength be included in the GrpcConnectionParams definition above on line 19?

bevzzz · 2026-08-12T15:23:34Z

+    if (!params.skipInitChecks) {
+      grpcMaxMessageLength = await Promise.all([
        (rest.get('/meta', true) as Promise<Meta>).then(
          (res: Meta) => res.grpcMaxMessageSize || MAX_GRPC_MESSAGE_LENGTH


issue: it feels wrong that skipInitChecks can also make the client ignore the server's gRPC message size limit; perhaps it should only control compatibility checks?

I understand that calling /meta with skipInitChecks: false will effectively perform an init check despite their having been disabled. At the same time, respecting the server's transport configuration seems more important (?)

WDYT?

bevzzz · 2026-08-13T12:43:13Z

        tenant
      ),
-    close: () => channel.close(),
+    close: () => {},


question: why is close a no-op now?

bevzzz · 2026-08-13T12:54:30Z

-      return health
+      return transports.health
        .check(
          { service: '/grpc.health.v1.Health/Check' },


It's quite surprising that HealthClient from Google's gRPC package doesn't have the name of the service "baked in", what?

bevzzz · 2026-08-13T16:37:02Z

+  const agent = context.agentMaker?.(httpSecure);
+
+  const { connection, dbVersionProvider, dbVersionSupport } = await ConnectionGRPC.use(
+    context.transportsMaker,


tl;dr: I find the fact that ConnectionGRPC satisfies ConnectionREST so confusing.

Initially I wanted to ask this:

question: if agentMaker "Creates the HTTP(S) keep-alive agent for the REST/GraphQL connection", then why is it a part of the top-level Context and not some internal component of ConnectionREST?

Before posting that, I decided to look around and answer this for myself. But I couldn't find ConnectionREST mentioned anywhere here, and instead I saw connection returned by ConnectionGRPC.use() passed to alias(connection) which expects ConnectionREST (!).

I was rather surprised to learn that ConnectionGRPC extended ConnectionGQL even though they use completely different transports, and that ConnectionGQL was a thing separate from ConnectionREST even though both use the same transport / connection.

suggestion (wrt agentMaker): I see from it's description that web/ and node/ inject different agent makers. Perhaps each could instead provide a complete ConnectionREST object and make the injection "privately"?

bevzzz · 2026-08-13T16:41:33Z

+      host: `${scheme}://${httpHost}:${httpPort}${httpPath || ''}`,
+      scheme: scheme,
+      headers: params.headers,
+      grpcAddress: `${isGrpcWeb ? (grpcSecure ? 'https://' : 'http://') : ''}${grpcHost}:${grpcPort}${


question: why are there both httpSecure and grpcSecure parameters? Is there a real use-case for having one connection be secured and the other one not?

Suggested change

grpcAddress: `${isGrpcWeb ? (grpcSecure ? 'https://' : 'http://') : ''}${grpcHost}:${grpcPort}${

grpcAddress: `${isGrpcWeb ? (grpcSecure ? 'https' : 'http') : ''}://${grpcHost}:${grpcPort}${

nit: simplify the expression

bevzzz · 2026-08-13T16:45:33Z

  public static tenants<T, M>(tenants: T[], mapper: (tenant: T) => M): M[][] {
-    const mapped = [];
+    const mapped: M[][] = [];
    const batches = Math.ceil(tenants.length / 100);
    for (let i = 0; i < batches; i++) {
      const batch = tenants.slice(i * 100, (i + 1) * 100);


question: why does this method split the tenants array into batches or 100?

bevzzz · 2026-08-13T17:06:10Z


  it('should be able to create a simple collection with a generic using a schema var with type', async () => {
    const collectionName = 'TestCollectionSimpleGenericVarType';
+    afters.push(() => contextionary.collections.delete(collectionName));


suggestion: would it make sense to add a test util for creating collections that would "schedule" the deletion automatically?

It's exactly as what you have with afters here, but packaged so that it's easier to reuse across tests and a tad more succinct. Just something I've thought about doing every time I had to create a collection in a test :)

// testutil.ts export class Collectioner { private client WeaviateClient; private collections: []string; public create(c: CollectionConfig): Promise<CollectionHandle> { this.collections.push(c.name); return this.client.collections.create(c); } public cleanup(): Promise<void> { return Promise.all(this.collections.map(c => this.client.collections.delete(c))); } }

Then use it in a test:

describe('stuff', async () => { const client = new WeaviateClient(...); const collections = new Collectioner(client); afterAll(() => collections.cleanup()); ... })

bevzzz · 2026-08-13T17:17:21Z

+  params.connectionParams.grpc = {
+    host: params.connectionParams.http.host,
+    port: params.connectionParams.http.port,
+    secure: params.connectionParams.http.secure,
+    path: '/v1/grpc-web',
+  };


question: could host, port, and secure be mapped in helpers? Seems like something that'd be common to both node and web, as opposed to path: /v1/grpc-web which is clearly specific to web/ package.

parkerduckworth · 2026-08-13T17:54:24Z

Let's go @tsmith023 !! The time for a TS web client has finally come ✨

tsmith023 added 3 commits June 10, 2025 10:01

Split grpc connection out into node and web impls

1fc0d78

Merge branch 'feat/web-client' of https://github.com/weaviate/typescr…

589a0ab

…ipt-client into web/split-nice-grpc-connection

tsmith023 requested a review from a team as a code owner June 20, 2025 13:48

orca-security-eu Bot reviewed Jun 20, 2025

View reviewed changes

tsmith023 added 13 commits June 20, 2025 14:52

Correct typos in CI

3cfe9cd

Build core in checks step

f088194

Add pnpm to steps, improve npm run ci cmd

487e301

Change order of pnpm and node installs in CI

69075cb

Remove ellipsis from intsall cmds

920e09b

Remove install script from package.json root

fa6fe74

Fix build:all typo in CI

8950c1c

Split npm run ci script into step-specific cmds

7109d89

Fix ci:test script

9ecdd69

Add missing dev deps to @weaviate/test

6362c4c

Add missing curveball deps to @weaviate/test

b1bab4b

Remove it.only from config test

350a694

Merge branch 'main' of https://github.com/weaviate/typescript-client …

49a0ce1

…into feat/introduce-web-client

tsmith023 mentioned this pull request Aug 4, 2025

Can't connect by Deno #309

Open

Merge branch 'main' of https://github.com/weaviate/typescript-client …

641c620

…into feat/introduce-web-client

orca-security-eu Bot reviewed Jun 23, 2026

View reviewed changes

tsmith023 added 8 commits June 23, 2026 17:45

Fix issues during merge conflict resolution

4c3ac42

Fix packaging

b645a28

Remove erroneous build:core cmd from ci:checks

e911864

Update nice-grpc deps

68be4c5

Add back build:core to ci:checks script

91799d4

Revert changes to npm run build too

e4c49a0

Update pkgs, fix build errors in tests

60b5557

More testing fixes

da2934a

tsmith023 and others added 13 commits June 24, 2026 14:16

Change tests to delete collections specific to theirs rather than all…

1ff4dba

… in the schema

Fix more tests

603d773

Fix more tests

e59c05a

Change connection helpers to allow grpc-web over the same host/port a…

12ec0af

…s rest

Add simple test of grpc-web working with proposed server impl

b6993f4

Fix protocl prefix in grpcAddress for !isGrpcWeb

cdb9928

Only run web tests with >=1.39.0

cada864

Fix mistaken imports in tests

39c322a

Fix import in web tests

adbcca5

Fix asyncEnabled assertion in >=1.38.0

c9ae473

chore(agent): remove node https module from web bundle

c01511b

chore(): appease the linter

f033271

chore(): fix version import

848dc23

This was referenced Jun 30, 2026

chore(agent): remove node https module from web bundle #451

Merged

feat(hackday): use grpc-web for direct web to cluster communication #437

Closed

tsmith023 added 4 commits June 30, 2026 11:35

Remove outdated openId validation

df2c91f

Add back missing offline_access scope to AuthUserPasswordCredentials

f388619

Merge pull request #451 from weaviate/feat/introduce-web-client--remo…

bb42b5e

…ve-node-https-from-web chore(agent): remove node https module from web bundle

Add check to web pkg using esbuild to verify no node-deps accidentall…

96d4c60

…y imported

orca-security-eu Bot reviewed Jul 14, 2026

View reviewed changes

tsmith023 added 2 commits July 14, 2026 11:01

Merge branch 'main' of https://github.com/weaviate/typescript-client …

9399bf8

…into feat/introduce-web-client

Move browser-compat check into build script so that dist is available

aae2a6c

bevzzz reviewed Jul 17, 2026

View reviewed changes

chore(web): add /v1 path prefix

fb2075c

orca-security-eu Bot reviewed Jul 23, 2026

View reviewed changes

tsmith023 added 3 commits July 23, 2026 10:55

Bump CI image to latest 1.39-rc

6448fe6

Fix generic defaults in published web types

0409ef6

Add simple search test of web pkg verifying usage

7572c60

bevzzz reviewed Aug 13, 2026

View reviewed changes

	grpcAddress: `${isGrpcWeb ? (grpcSecure ? 'https://' : 'http://') : ''}${grpcHost}:${grpcPort}${
	grpcAddress: `${isGrpcWeb ? (grpcSecure ? 'https' : 'http') : ''}://${grpcHost}:${grpcPort}${

Uh oh!

Conversation

tsmith023 commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

weaviate-git-bot commented Jun 21, 2025

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!

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!

Choose a reason for hiding this comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

parkerduckworth commented Aug 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tsmith023 commented Jun 20, 2025 •

edited

Loading

orca-security-eu Bot left a comment •

edited

Loading

orca-security-eu Bot left a comment •

edited

Loading

orca-security-eu Bot left a comment •

edited

Loading

orca-security-eu Bot left a comment •

edited

Loading