@dxos/rpc 0.8.4-main.406dc2a → 0.8.4-main.422d1c7879

package/README.md

@@ -4,8 +4,8 @@ A lightweight, transport-agnostic RPC implementation.
 
 ## Features
 
-* Performs a handshake to wait for the other side to be open.
-* Errors are serialized and transported with their stack intact.
-* Requests are terminated on close.
-* TODO: Request timeouts.
-* TODO: Data streams.
+- Performs a handshake to wait for the other side to be open.
+- Errors are serialized and transported with their stack intact.
+- Requests are terminated on close.
+- TODO: Request timeouts.
+- TODO: Data streams.

package/dist/lib/{browser → neutral}/index.mjs

@@ -12,25 +12,13 @@ var decodeRpcError = (err, rpcMethod) => decodeError(err, {
 // src/rpc.ts
 import { Trigger, asyncTimeout, synchronized } from "@dxos/async";
 import { Stream } from "@dxos/codec-protobuf";
+import { ContextRpcCodec } from "@dxos/context";
 import { StackTrace as StackTrace2 } from "@dxos/debug";
 import { invariant } from "@dxos/invariant";
 import { log } from "@dxos/log";
 import { RpcClosedError, RpcNotOpenError, encodeError } from "@dxos/protocols";
 import { schema } from "@dxos/protocols/proto";
 import { exponentialBackoffInterval } from "@dxos/util";
-function _define_property(obj, key, value) {
-  if (key in obj) {
-    Object.defineProperty(obj, key, {
-      value,
-      enumerable: true,
-      configurable: true,
-      writable: true
-    });
-  } else {
-    obj[key] = value;
-  }
-  return obj;
-}
 function _ts_decorate(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -38,23 +26,47 @@ function _ts_decorate(decorators, target, key, desc) {
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
 var __dxlog_file = "/__w/dxos/dxos/packages/core/mesh/rpc/src/rpc.ts";
-var DEFAULT_TIMEOUT = 3e3;
+var DEFAULT_TIMEOUT = 3e4;
 var BYE_SEND_TIMEOUT = 2e3;
 var DEBUG_CALLS = true;
 var CLOSE_TIMEOUT = 3e3;
 var PendingRpcRequest = class {
+  resolve;
+  reject;
+  stream;
   constructor(resolve, reject, stream) {
-    _define_property(this, "resolve", void 0);
-    _define_property(this, "reject", void 0);
-    _define_property(this, "stream", void 0);
     this.resolve = resolve;
     this.reject = reject;
     this.stream = stream;
   }
 };
 var RpcMessageCodec;
-var getRpcMessageCodec = () => RpcMessageCodec ?? (RpcMessageCodec = schema.getCodecForType("dxos.rpc.RpcMessage"));
+var getRpcMessageCodec = () => RpcMessageCodec ??= schema.getCodecForType("dxos.rpc.RpcMessage");
 var RpcPeer = class {
+  _params;
+  _outgoingRequests = /* @__PURE__ */ new Map();
+  _localStreams = /* @__PURE__ */ new Map();
+  _remoteOpenTrigger = new Trigger();
+  /**
+  * Triggered when the peer starts closing.
+  */
+  _closingTrigger = new Trigger();
+  /**
+  * Triggered when peer receives a bye message.
+  */
+  _byeTrigger = new Trigger();
+  _nextId = 0;
+  _state = "INITIAL";
+  _unsubscribeFromPort = void 0;
+  _clearOpenInterval = void 0;
+  constructor(params) {
+    this._params = {
+      timeout: void 0,
+      streamHandler: void 0,
+      noHandshake: false,
+      ...params
+    };
+  }
   /**
   * Open the peer. Required before making any calls.
   *
@@ -70,7 +82,7 @@ var RpcPeer = class {
       } catch (err) {
         log.catch(err, void 0, {
           F: __dxlog_file,
-          L: 156,
+          L: 157,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -86,7 +98,7 @@ var RpcPeer = class {
       state: this._state
     }, {
       F: __dxlog_file,
-      L: 168,
+      L: 169,
       S: this,
       C: (f, a) => f(...a)
     });
@@ -101,7 +113,7 @@ var RpcPeer = class {
         open: true
       }).catch((err) => log.warn(err, void 0, {
         F: __dxlog_file,
-        L: 177,
+        L: 178,
         S: this,
         C: (f, a) => f(...a)
       }));
@@ -118,7 +130,7 @@ var RpcPeer = class {
       state: this._state
     }, {
       F: __dxlog_file,
-      L: 191,
+      L: 192,
       S: this,
       C: (f, a) => f(...a)
     });
@@ -148,7 +160,7 @@ var RpcPeer = class {
           err
         }, {
           F: __dxlog_file,
-          L: 213,
+          L: 214,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -156,7 +168,7 @@ var RpcPeer = class {
       try {
         log("closing waiting on bye", void 0, {
           F: __dxlog_file,
-          L: 216,
+          L: 217,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -168,7 +180,7 @@ var RpcPeer = class {
           err
         }, {
           F: __dxlog_file,
-          L: 219,
+          L: 220,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -212,7 +224,7 @@ var RpcPeer = class {
       type: Object.keys(decoded)[0]
     }, {
       F: __dxlog_file,
-      L: 263,
+      L: 264,
       S: this,
       C: (f, a) => f(...a)
     });
@@ -220,7 +232,7 @@ var RpcPeer = class {
       if (this._state !== "OPENED" && this._state !== "OPENING") {
         log("received request while closed", void 0, {
           F: __dxlog_file,
-          L: 267,
+          L: 268,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -238,7 +250,7 @@ var RpcPeer = class {
           method: req.method
         }, {
           F: __dxlog_file,
-          L: 279,
+          L: 280,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -250,7 +262,7 @@ var RpcPeer = class {
             close: response.close
           }, {
             F: __dxlog_file,
-            L: 281,
+            L: 282,
             S: this,
             C: (f, a) => f(...a)
           });
@@ -259,7 +271,7 @@ var RpcPeer = class {
           }).catch((err) => {
             log.warn("failed during close", err, {
               F: __dxlog_file,
-              L: 289,
+              L: 290,
               S: this,
               C: (f, a) => f(...a)
             });
@@ -270,7 +282,7 @@ var RpcPeer = class {
           method: req.method
         }, {
           F: __dxlog_file,
-          L: 293,
+          L: 294,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -281,7 +293,7 @@ var RpcPeer = class {
           error: response.error
         }, {
           F: __dxlog_file,
-          L: 296,
+          L: 297,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -293,7 +305,7 @@ var RpcPeer = class {
       if (this._state !== "OPENED") {
         log("received response while closed", void 0, {
           F: __dxlog_file,
-          L: 305,
+          L: 306,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -302,7 +314,7 @@ var RpcPeer = class {
       const responseId = decoded.response.id;
       invariant(typeof responseId === "number", void 0, {
         F: __dxlog_file,
-        L: 310,
+        L: 311,
         S: this,
         A: [
           "typeof responseId === 'number'",
@@ -314,7 +326,7 @@ var RpcPeer = class {
           responseId
         }, {
           F: __dxlog_file,
-          L: 312,
+          L: 313,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -328,7 +340,7 @@ var RpcPeer = class {
         type_url: decoded.response.payload?.type_url
       }, {
         F: __dxlog_file,
-        L: 322,
+        L: 323,
         S: this,
         C: (f, a) => f(...a)
       });
@@ -338,7 +350,7 @@ var RpcPeer = class {
         state: this._state
       }, {
         F: __dxlog_file,
-        L: 325,
+        L: 326,
         S: this,
         C: (f, a) => f(...a)
       });
@@ -353,7 +365,7 @@ var RpcPeer = class {
         state: this._state
       }, {
         F: __dxlog_file,
-        L: 332,
+        L: 333,
         S: this,
         C: (f, a) => f(...a)
       });
@@ -366,7 +378,7 @@ var RpcPeer = class {
       if (this._state !== "OPENED") {
         log("received stream close while closed", void 0, {
           F: __dxlog_file,
-          L: 341,
+          L: 342,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -376,13 +388,13 @@ var RpcPeer = class {
         id: decoded.streamClose.id
       }, {
         F: __dxlog_file,
-        L: 345,
+        L: 346,
         S: this,
         C: (f, a) => f(...a)
       });
       invariant(typeof decoded.streamClose.id === "number", void 0, {
         F: __dxlog_file,
-        L: 346,
+        L: 347,
         S: this,
         A: [
           "typeof decoded.streamClose.id === 'number'",
@@ -395,7 +407,7 @@ var RpcPeer = class {
           id: decoded.streamClose.id
         }, {
           F: __dxlog_file,
-          L: 349,
+          L: 350,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -408,7 +420,7 @@ var RpcPeer = class {
       if (this._state !== "CLOSING" && this._state !== "CLOSED") {
         log("replying to bye", void 0, {
           F: __dxlog_file,
-          L: 359,
+          L: 360,
           S: this,
           C: (f, a) => f(...a)
         });
@@ -424,7 +436,7 @@ var RpcPeer = class {
         msg
       }, {
         F: __dxlog_file,
-        L: 367,
+        L: 368,
         S: this,
         C: (f, a) => f(...a)
       });
@@ -440,7 +452,7 @@ var RpcPeer = class {
       method
     }, {
       F: __dxlog_file,
-      L: 377,
+      L: 378,
       S: this,
       C: (f, a) => f(...a)
     });
@@ -451,12 +463,28 @@ var RpcPeer = class {
       const responseReceived = new Promise((resolve, reject) => {
         this._outgoingRequests.set(id, new PendingRpcRequest(resolve, reject, false));
       });
+      let traceContext;
+      try {
+        traceContext = options?.ctx ? ContextRpcCodec.encode(options.ctx) : void 0;
+      } catch (err) {
+        log.warn("failed to encode trace context", {
+          err
+        }, {
+          F: __dxlog_file,
+          L: 393,
+          S: this,
+          C: (f, a) => f(...a)
+        });
+      }
       const sending = this._sendMessage({
         request: {
           id,
           method,
           payload: request,
-          stream: false
+          stream: false,
+          ...traceContext ? {
+            traceContext
+          } : {}
         }
       });
       const timeout = options?.timeout ?? this._params.timeout;
@@ -468,7 +496,7 @@ var RpcPeer = class {
       response = await waiting;
       invariant(response.id === id, void 0, {
         F: __dxlog_file,
-        L: 405,
+        L: 414,
         S: this,
         A: [
           "response.id === id",
@@ -529,16 +557,38 @@ ${stack.getStack()}`;
         }
       };
       this._outgoingRequests.set(id, new PendingRpcRequest(onResponse, closeStream, true));
-      this._sendMessage({
-        request: {
-          id,
-          method,
-          payload: request,
-          stream: true
-        }
-      }).catch((err) => {
-        close(err);
-      });
+      let traceContext;
+      try {
+        traceContext = options?.ctx ? ContextRpcCodec.encode(options.ctx) : void 0;
+      } catch (err) {
+        log.warn("failed to encode trace context", {
+          err
+        }, {
+          F: __dxlog_file,
+          L: 476,
+          S: this,
+          C: (f, a) => f(...a)
+        });
+      }
+      try {
+        this._sendMessage({
+          request: {
+            id,
+            method,
+            payload: request,
+            stream: true,
+            ...traceContext ? {
+              traceContext
+            } : {}
+          }
+        }).catch((err) => {
+          this._outgoingRequests.delete(id);
+          close(err);
+        });
+      } catch (err) {
+        this._outgoingRequests.delete(id);
+        throw err;
+      }
       return () => {
         this._sendMessage({
           streamClose: {
@@ -547,7 +597,7 @@ ${stack.getStack()}`;
         }).catch((err) => {
           log.catch(err, void 0, {
             F: __dxlog_file,
-            L: 478,
+            L: 501,
             S: this,
             C: (f, a) => f(...a)
           });
@@ -561,7 +611,7 @@ ${stack.getStack()}`;
       type: Object.keys(message)[0]
     }, {
       F: __dxlog_file,
-      L: 486,
+      L: 509,
       S: this,
       C: (f, a) => f(...a)
     });
@@ -569,11 +619,38 @@ ${stack.getStack()}`;
       preserveAny: true
     }), timeout);
   }
+  _getHandlerRpcOptions(req) {
+    let traceCtx;
+    if (req.traceContext) {
+      try {
+        traceCtx = ContextRpcCodec.decode(req.traceContext);
+      } catch (err) {
+        log.warn("failed to decode trace context", {
+          traceContext: req.traceContext,
+          err
+        }, {
+          F: __dxlog_file,
+          L: 519,
+          S: this,
+          C: (f, a) => f(...a)
+        });
+      }
+    }
+    if (!traceCtx && !this._params.handlerRpcOptions) {
+      return void 0;
+    }
+    return {
+      ...this._params.handlerRpcOptions,
+      ...traceCtx ? {
+        ctx: traceCtx
+      } : {}
+    };
+  }
   async _callHandler(req) {
     try {
       invariant(typeof req.id === "number", void 0, {
         F: __dxlog_file,
-        L: 492,
+        L: 530,
         S: this,
         A: [
           "typeof req.id === 'number'",
@@ -582,7 +659,7 @@ ${stack.getStack()}`;
       });
       invariant(req.payload, void 0, {
         F: __dxlog_file,
-        L: 493,
+        L: 531,
         S: this,
         A: [
           "req.payload",
@@ -591,14 +668,14 @@ ${stack.getStack()}`;
       });
       invariant(req.method, void 0, {
         F: __dxlog_file,
-        L: 494,
+        L: 532,
         S: this,
         A: [
           "req.method",
           ""
         ]
       });
-      const response = await this._params.callHandler(req.method, req.payload, this._params.handlerRpcOptions);
+      const response = await this._params.callHandler(req.method, req.payload, this._getHandlerRpcOptions(req));
       return {
         id: req.id,
         payload: response
@@ -614,7 +691,7 @@ ${stack.getStack()}`;
     try {
       invariant(this._params.streamHandler, "Requests with streaming responses are not supported.", {
         F: __dxlog_file,
-        L: 511,
+        L: 549,
         S: this,
         A: [
           "this._params.streamHandler",
@@ -623,7 +700,7 @@ ${stack.getStack()}`;
       });
       invariant(typeof req.id === "number", void 0, {
         F: __dxlog_file,
-        L: 512,
+        L: 550,
         S: this,
         A: [
           "typeof req.id === 'number'",
@@ -632,7 +709,7 @@ ${stack.getStack()}`;
       });
       invariant(req.payload, void 0, {
         F: __dxlog_file,
-        L: 513,
+        L: 551,
         S: this,
         A: [
           "req.payload",
@@ -641,14 +718,14 @@ ${stack.getStack()}`;
       });
       invariant(req.method, void 0, {
         F: __dxlog_file,
-        L: 514,
+        L: 552,
         S: this,
         A: [
           "req.method",
           ""
         ]
       });
-      const responseStream = this._params.streamHandler(req.method, req.payload, this._params.handlerRpcOptions);
+      const responseStream = this._params.streamHandler(req.method, req.payload, this._getHandlerRpcOptions(req));
       responseStream.onReady(() => {
         callback({
           id: req.id,
@@ -681,24 +758,6 @@ ${stack.getStack()}`;
       });
     }
   }
-  constructor(params) {
-    _define_property(this, "_params", void 0);
-    _define_property(this, "_outgoingRequests", /* @__PURE__ */ new Map());
-    _define_property(this, "_localStreams", /* @__PURE__ */ new Map());
-    _define_property(this, "_remoteOpenTrigger", new Trigger());
-    _define_property(this, "_closingTrigger", new Trigger());
-    _define_property(this, "_byeTrigger", new Trigger());
-    _define_property(this, "_nextId", 0);
-    _define_property(this, "_state", "INITIAL");
-    _define_property(this, "_unsubscribeFromPort", void 0);
-    _define_property(this, "_clearOpenInterval", void 0);
-    this._params = {
-      timeout: void 0,
-      streamHandler: void 0,
-      noHandshake: false,
-      ...params
-    };
-  }
 };
 _ts_decorate([
   synchronized
@@ -719,22 +778,15 @@ var throwIfNotOpen = (state) => {
 
 // src/service.ts
 import { invariant as invariant2 } from "@dxos/invariant";
-function _define_property2(obj, key, value) {
-  if (key in obj) {
-    Object.defineProperty(obj, key, {
-      value,
-      enumerable: true,
-      configurable: true,
-      writable: true
-    });
-  } else {
-    obj[key] = value;
-  }
-  return obj;
-}
 var __dxlog_file2 = "/__w/dxos/dxos/packages/core/mesh/rpc/src/service.ts";
 var createServiceBundle = (services) => services;
 var ProtoRpcPeer = class {
+  rpc;
+  _peer;
+  constructor(rpc, _peer) {
+    this.rpc = rpc;
+    this._peer = _peer;
+  }
   async open() {
     await this._peer.open();
   }
@@ -744,12 +796,6 @@ var ProtoRpcPeer = class {
   async abort() {
     await this._peer.abort();
   }
-  constructor(rpc, _peer) {
-    _define_property2(this, "rpc", void 0);
-    _define_property2(this, "_peer", void 0);
-    this.rpc = rpc;
-    this._peer = _peer;
-  }
 };
 var createProtoRpcPeer = ({ requested, exposed, handlers, encodingOptions, ...rest }) => {
   const exposedRpcs = {};
@@ -896,29 +942,12 @@ var encodeMessage = (msg) => isNode() ? Buffer.from(msg) : new TextEncoder().enc
 // src/trace.ts
 import { Event } from "@dxos/async";
 import { MessageTrace } from "@dxos/protocols/proto/dxos/rpc";
-function _define_property3(obj, key, value) {
-  if (key in obj) {
-    Object.defineProperty(obj, key, {
-      value,
-      enumerable: true,
-      configurable: true,
-      writable: true
-    });
-  } else {
-    obj[key] = value;
-  }
-  return obj;
-}
 var PortTracer = class {
-  get port() {
-    return this._port;
-  }
+  _wrappedPort;
+  message = new Event();
+  _port;
   constructor(_wrappedPort) {
-    _define_property3(this, "_wrappedPort", void 0);
-    _define_property3(this, "message", void 0);
-    _define_property3(this, "_port", void 0);
     this._wrappedPort = _wrappedPort;
-    this.message = new Event();
     this._port = {
       send: (msg) => {
         this.message.emit({
@@ -938,6 +967,9 @@ var PortTracer = class {
       }
     };
   }
+  get port() {
+    return this._port;
+  }
 };
 export {
   PortTracer,