starpc 0.17.1 → 0.18.0

package/dist/rpcstream/rpcstream.d.ts

@@ -4,7 +4,7 @@ import { Pushable } from 'it-pushable';
 import { Source, Sink } from 'it-stream-types';
 import { Uint8ArrayList } from 'uint8arraylist';
 export type RpcStreamCaller = (request: AsyncIterable<RpcStreamPacket>) => AsyncIterable<RpcStreamPacket>;
-export declare function openRpcStream(componentId: string, caller: RpcStreamCaller): Promise<Stream>;
+export declare function openRpcStream(componentId: string, caller: RpcStreamCaller, waitAck?: boolean): Promise<Stream>;
 export declare function buildRpcStreamOpenStream(componentId: string, caller: RpcStreamCaller): OpenStreamFunc;
 export type RpcStreamHandler = (stream: Stream) => void;
 export type RpcStreamGetter = (componentId: string) => Promise<RpcStreamHandler | null>;

package/dist/rpcstream/rpcstream.js

@@ -1,7 +1,7 @@
 import { pushable } from 'it-pushable';
 // openRpcStream attempts to open a stream over a RPC call.
-// waits for the remote to ack the stream before returning.
-export async function openRpcStream(componentId, caller) {
+// if waitAck is set, waits for the remote to ack the stream before returning.
+export async function openRpcStream(componentId, caller, waitAck) {
     const packetSink = pushable({ objectMode: true });
     const packetSource = caller(packetSink);
     // write the component id
@@ -11,21 +11,24 @@ export async function openRpcStream(componentId, caller) {
             init: { componentId },
         },
     });
-    // wait for ack
+    // construct packet stream
     const packetIt = packetSource[Symbol.asyncIterator]();
-    const ackPacketIt = await packetIt.next();
-    if (ackPacketIt.done) {
-        throw new Error(`rpcstream: closed before ack packet`);
-    }
-    const ackPacket = ackPacketIt.value;
-    const ackBody = ackPacket?.body;
-    if (!ackBody || ackBody.$case !== 'ack') {
-        const msgType = ackBody?.$case || 'none';
-        throw new Error(`rpcstream: expected ack packet but got ${msgType}`);
-    }
-    const errStr = ackBody.ack?.error;
-    if (errStr) {
-        throw new Error(`rpcstream: remote: ${errStr}`);
+    // wait for ack, if set.
+    if (waitAck) {
+        const ackPacketIt = await packetIt.next();
+        if (ackPacketIt.done) {
+            throw new Error(`rpcstream: closed before ack packet`);
+        }
+        const ackPacket = ackPacketIt.value;
+        const ackBody = ackPacket?.body;
+        if (!ackBody || ackBody.$case !== 'ack') {
+            const msgType = ackBody?.$case || 'none';
+            throw new Error(`rpcstream: expected ack packet but got ${msgType}`);
+        }
+        const errStr = ackBody.ack?.error;
+        if (errStr) {
+            throw new Error(`rpcstream: remote: ${errStr}`);
+        }
     }
     // build & return the data stream
     return new RpcStream(packetSink, packetIt); // packetSource)
@@ -136,10 +139,19 @@ export class RpcStream {
                 }
                 const value = msgIt.value;
                 const body = value?.body;
-                if (!body || body.$case !== 'data') {
+                if (!body) {
                     continue;
                 }
-                yield* [body.data];
+                switch (body.$case) {
+                    case 'ack':
+                        if (body.ack?.error?.length) {
+                            throw new Error(body.ack.error);
+                        }
+                        break;
+                    case 'data':
+                        yield* [body.data];
+                        break;
+                }
             }
         })();
     }

package/e2e/e2e_test.go

@@ -227,7 +227,7 @@ func TestE2E_RpcStream(t *testing.T) {
 	RunE2E(t, func(client echo.SRPCEchoerClient) error {
 		openStreamFn := rpcstream.NewRpcStreamOpenStream(func(ctx context.Context) (rpcstream.RpcStream, error) {
 			return client.RpcStream(ctx)
-		}, "test")
+		}, "test", false)
 		proxiedClient := srpc.NewClient(openStreamFn)
 		proxiedSvc := echo.NewSRPCEchoerClient(proxiedClient)
 

package/go.mod

@@ -9,7 +9,7 @@ require (
 )
 
 require (
-	github.com/aperturerobotics/util v0.0.0-20230105015752-3e6dd02b20c6
+	github.com/aperturerobotics/util v1.0.3-0.20230130061818-dab10b56858b
 	github.com/libp2p/go-libp2p v0.24.2
 	github.com/libp2p/go-yamux/v4 v4.0.1-0.20220919134236-1c09f2ab3ec1
 	github.com/sirupsen/logrus v1.9.0

package/go.sum

@@ -1,5 +1,5 @@
-github.com/aperturerobotics/util v0.0.0-20230105015752-3e6dd02b20c6 h1:YCg1Eyh5M5SvWCpJmdM62iInd0yfZXSGFld10GQIIPA=
-github.com/aperturerobotics/util v0.0.0-20230105015752-3e6dd02b20c6/go.mod h1:up2AYcp62UgmFVTm7QhM4USXAKGv73gpb5dHraKmzxQ=
+github.com/aperturerobotics/util v1.0.3-0.20230130061818-dab10b56858b h1:E+riBVCoYAZL2ATHTlDZYZRZj/6FPb+UGHVTQdU03UU=
+github.com/aperturerobotics/util v1.0.3-0.20230130061818-dab10b56858b/go.mod h1:gFLdglkzXYEWP/iYrOGeJEKzfjarlMDPrLNLgwDHC1o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starpc",
-  "version": "0.17.1",
+  "version": "0.18.0",
   "description": "Streaming protobuf RPC service protocol over any two-way channel.",
   "license": "MIT",
   "author": {
@@ -71,7 +71,7 @@
     "prettier": "^2.8.3",
     "rimraf": "^4.1.0",
     "ts-proto": "^1.138.0",
-    "typescript": "^4.9.4",
+    "typescript": "^4.9.5",
     "utf-8-validate": "^6.0.0"
   },
   "dependencies": {