[web] Introduce types for identity service communication
ClosedPublic
Actions

Authored by ashoat on Apr 4 2023, 1:29 PM.

Details

Reviewers

varun
• jon
atul

Commits

rCOMMafc6a825b2f5: [web] Introduce types for identity service communication

Summary

I added the latest version of google-protobuf to web/package.json
I installed its Flow types via flow-typed install google-protobuf
I generated web/protobufs/identity-client.cjs and web/protobufs/identity-structs.cjs by running protoc -I=shared/protos/ identity_client.proto --js_out=import_style=commonjs:web/protobufs and then added the @generated line to hide them from Phabricator diffs
I wrote web/protobufs/identity-client.cjs.flow and web/protobufs/identity-structs.cjs.flow, which were inspired by TypeScript bindings generated with protoc -I=shared/protos/ identity_client.proto --grpc-web_out=import_style=commonjs+dts,mode=grpcwebtext:.
I wrote flow-typed/npm/grpc-web_v1.x.x.js, only typing the things that were needed for the last step

Test Plan

I tested the code and the Flow types with this patch: https://gist.github.com/Ashoat/7cf4a0fbdebc152d585884184bc0ac07

Diff Detail

Repository

rCOMM Comm

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

ashoat created this revision.Apr 4 2023, 1:29 PM

Herald added a subscriber: tomek. · View Herald TranscriptApr 4 2023, 1:29 PM

Harbormaster completed remote builds in B17989: Diff 24643.Apr 4 2023, 1:46 PM

ashoat requested review of this revision.Apr 4 2023, 1:46 PM

ashoat edited the test plan for this revision. (Show Details)Apr 4 2023, 4:38 PM

Gave it a very brief skim, but looks reasonable. Assuming we don't care about the 80char/line limit for these files.

which were inspired by TypeScript bindings generated with protoc -I=shared/protos/ identity_client.proto --grpc-web_out=import_style=commonjs+dts,mode=grpcwebtext:.

Might've been helpful to have a link to a Gist or something so I could quickly do a side-by-side, have caught minor discrepancies in the past that way.

This revision is now accepted and ready to land.Apr 5 2023, 6:45 AM

Might've been helpful to have a link to a Gist or something so I could quickly do a side-by-side, have caught minor discrepancies in the past that way.

Roger, will make sure to do that next time

Closed by commit rCOMMafc6a825b2f5: [web] Introduce types for identity service communication (authored by ashoat). · Explain WhyApr 5 2023, 6:52 AM

This revision was automatically updated to reflect the committed changes.

ashoat added a commit: rCOMMafc6a825b2f5: [web] Introduce types for identity service communication.

ashoat mentioned this in D9490: [web] Add protoc-gen-js dependency.Oct 13 2023, 12:58 PM

ashoat mentioned this in rCOMM6133bb39d238: [web] Add protoc-gen-js dependency.Oct 17 2023, 6:10 AM