Prototype protobuf-es usage #70

tstirrat15 · 2025-05-23T16:05:37Z

Fixes #38

Description

protobuf-es is a more modern take on a TS-based implementation of protobuf and clients. I'm considering using it for authzed-node, but I wanted to test it out in the real world; this library seems like a good place to do that.

Notes

This adds about 100kb of bundle size, which isn't ideal, but we're also already at 5mb.

Changes

Will annotate

Testing

Review. See that tests pass and that playground functionality still works as expected.

vercel · 2025-05-23T16:05:41Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 25, 2025 1:59pm

tstirrat15 · 2025-05-23T16:36:51Z

There's something funky with check watches. Wasm isn't working in development, which would be necessary to debug it. I'll work on that later.

tstirrat15

See comment

tstirrat15 · 2025-05-23T16:09:31Z

buf.gen.yaml

 version: "v2"
 plugins:
-  - remote: "buf.build/community/timostamm-protobuf-ts:v2.9.1"
+  - remote: "buf.build/bufbuild/es:v2.4.0"


This swaps in the new codegen.

tstirrat15 · 2025-05-23T16:10:21Z

src/components/CheckDebugTraceView.tsx

-import {
-  Struct,
-  Value,
-} from "../spicedb-common/protodefs/google/protobuf/struct";


There's lots of places where we were using Struct that we no longer need to, because protobuf-es automatically converts a normal JS object to Structs and Values where needed. This is one of the big ergonomic benefits.

tstirrat15 · 2025-05-23T16:10:58Z

src/components/CheckDebugTraceView.tsx

+    if (t.resolution.case === "subProblems") {
+      t.resolution.value.traces.forEach(appendExpanded);


This is the difference in how protobuf-es represents oneOfKind fields.

tstirrat15 · 2025-05-23T16:11:44Z

src/components/CheckDebugTraceView.tsx

 }

-function ContextTreeView(context: Struct | undefined) {
+function ContextTreeView(context: JsonObject | undefined) {


The value of a Struct on a message is just a JsonObject as far as client code is concerned, so we convert these functions to handle them.

tstirrat15 · 2025-05-23T16:12:12Z

src/components/CheckDebugTraceView.tsx

-        }),
-        true,
-      ];
+function ContextTreeValue(value: JsonValue) {


This function needed to change a bit - rather than switching on a string field, we switch on the type of the value itself.

tstirrat15 · 2025-05-23T16:13:34Z

src/components/EmbeddedPlayground.tsx

+    let checkResult: CheckOperationsResult = create(
+      CheckOperationsResultSchema,
      {
+        membership: CheckOperationsResult_Membership.UNKNOWN,
+      },
+    );
+    request?.check(
+      create(CheckOperationParametersSchema, {
        resource: relationship.resourceAndRelation!,
        subject: relationship.subject!,
-      },
+      }),


Rather than the message types having their own constructors, you have a Schema object that you hand to a create function. It's a little more verbose in some ways, but the create function lets you pass in normal JS objects and it Just Works, which is nifty.

tstirrat15 · 2025-05-23T16:13:52Z

src/components/ShareLoader.tsx

        if (
-          status.code ===
-          LookupShareResponse_LookupStatus.FAILED_TO_LOOKUP.toString()
+          response.status === LookupShareResponse_LookupStatus.FAILED_TO_LOOKUP


Shape change - status is on the object.

tstirrat15 · 2025-05-23T16:14:34Z

src/spicedb-common/components/relationshipeditor/data.ts

      : "",
    expiration: rel.optionalExpirationTime
-      ? new Date(parseFloat(rel.optionalExpirationTime.seconds) * 1000)
+      ? timestampDate(rel.optionalExpirationTime)


This is another nicety - there are some utility functions around well-known types, so we don't have to manually parse out the representations of Timestamps.

tstirrat15 · 2025-05-23T16:15:03Z

src/spicedb-common/parsing.test.ts

    expect(parsed?.caveat?.caveatName).toBe("somecaveat");
-    expect(parsed?.caveat?.context).toHaveProperty("fields");
-    expect(parsed?.caveat?.context).toEqual({
-      fields: {
-        hi: {
-          kind: {
-            oneofKind: "stringValue",
-            stringValue: "there",
-          },
-        },
-      },
-    });
-    assert(parsed?.caveat?.context);
-    expect(Struct.toJson(parsed?.caveat?.context)).toEqual({ hi: "there" });
+    expect(parsed?.caveat?.context).toEqual({ hi: "there" });
  });


This is a concrete illustration of how Structs changed.

tstirrat15 · 2025-05-25T13:54:52Z

src/spicedb-common/services/developerservice.ts

-    const encodedResponse: string = window[ENTRYPOINT_FUNCTION](
-      DeveloperRequest.toJsonString(request),
+    const developerRequest = JSON.stringify(
+      toJson(DeveloperRequestSchema, request),


Somewhat confusingly, toJson returns a JS object, not a JSON string.

alecmerdler

Very cool

vercel bot deployed to Preview May 23, 2025 16:06 View deployment

tstirrat15 force-pushed the prototype-protobuf-es-usage branch from 96cdfc2 to 759cfcc Compare May 23, 2025 16:22

vercel bot deployed to Preview May 23, 2025 16:22 View deployment

tstirrat15 marked this pull request as draft May 23, 2025 16:36

tstirrat15 force-pushed the prototype-protobuf-es-usage branch from 759cfcc to b9577de Compare May 25, 2025 13:53

vercel bot deployed to Preview May 25, 2025 13:54 View deployment

tstirrat15 commented May 25, 2025

View reviewed changes

tstirrat15 marked this pull request as ready for review May 25, 2025 13:55

Prototype protobuf-es usage

0fbf524

tstirrat15 force-pushed the prototype-protobuf-es-usage branch from b9577de to 0fbf524 Compare May 25, 2025 13:58

vercel bot deployed to Preview May 25, 2025 13:59 View deployment

alecmerdler approved these changes May 27, 2025

View reviewed changes

tstirrat15 merged commit c1c5768 into main May 27, 2025
5 checks passed

github-actions bot locked and limited conversation to collaborators May 27, 2025

		if (t.resolution.case === "subProblems") {
		t.resolution.value.traces.forEach(appendExpanded);

Prototype protobuf-es usage #70

Prototype protobuf-es usage #70

Uh oh!

Conversation

tstirrat15 commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Notes

Changes

Testing

Uh oh!

vercel bot commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tstirrat15 commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tstirrat15 left a comment

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!

alecmerdler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tstirrat15 commented May 23, 2025 •

edited

Loading

vercel bot commented May 23, 2025 •

edited

Loading

tstirrat15 commented May 23, 2025 •

edited

Loading