@livestore/webmesh 0.3.0-dev.2 → 0.3.0-dev.21

package/src/mesh-schema.ts

@@ -16,10 +16,24 @@ const defaultPacketFields = {
 
 const remainingHopsUndefined = Schema.Undefined.pipe(Schema.optional)
 
-// Needs to go through already existing MessageChannel connections, times out otherwise
+/**
+ * Needs to go through already existing MessageChannel connections, times out otherwise
+ *
+ * Can't yet contain the `port` because the request might be duplicated while forwarding to multiple nodes.
+ * We need a clear path back to the sender to avoid this, thus we respond with a separate
+ * `MessageChannelResponseSuccess` which contains the `port`.
+ */
 export class MessageChannelRequest extends Schema.TaggedStruct('MessageChannelRequest', {
   ...defaultPacketFields,
-  remainingHops: remainingHopsUndefined,
+  remainingHops: Schema.Array(Schema.String).pipe(Schema.optional),
+  channelVersion: Schema.Number,
+  /** Only set if the request is in response to an incoming request */
+  reqId: Schema.UndefinedOr(Schema.String),
+  /**
+   * Additionally to the `source` field, we use this field to track whether the instance of a
+   * source has changed.
+   */
+  sourceId: Schema.String,
 }) {}
 
 export class MessageChannelResponseSuccess extends Schema.TaggedStruct('MessageChannelResponseSuccess', {
@@ -28,6 +42,7 @@ export class MessageChannelResponseSuccess extends Schema.TaggedStruct('MessageC
   port: Transferable.MessagePort,
   // Since we can't copy this message, we need to follow the exact route back to the sender
   remainingHops: Schema.Array(Schema.String),
+  channelVersion: Schema.Number,
 }) {}
 
 export class MessageChannelResponseNoTransferables extends Schema.TaggedStruct(
@@ -71,13 +86,44 @@ export class ProxyChannelPayloadAck extends Schema.TaggedStruct('ProxyChannelPay
  * Broadcast to all nodes when a new connection is added.
  * Mostly used for auto-reconnect purposes.
  */
-// TODO actually use for this use case
 export class NetworkConnectionAdded extends Schema.TaggedStruct('NetworkConnectionAdded', {
   id,
   source: Schema.String,
   target: Schema.String,
 }) {}
 
+export class NetworkConnectionTopologyRequest extends Schema.TaggedStruct('NetworkConnectionTopologyRequest', {
+  id,
+  hops: Schema.Array(Schema.String),
+  /** Always fixed to who requested the topology */
+  source: Schema.String,
+  target: Schema.Literal('-'),
+}) {}
+
+export class NetworkConnectionTopologyResponse extends Schema.TaggedStruct('NetworkConnectionTopologyResponse', {
+  id,
+  reqId: Schema.String,
+  remainingHops: Schema.Array(Schema.String),
+  nodeName: Schema.String,
+  connections: Schema.Array(Schema.String),
+  /** Always fixed to who requested the topology */
+  source: Schema.String,
+  target: Schema.Literal('-'),
+}) {}
+
+export const BroadcastChannelPacket = Schema.TaggedStruct('BroadcastChannelPacket', {
+  id,
+  channelName: Schema.String,
+  /**
+   * The payload is expected to be encoded/decoded by the send/listen schema.
+   * Transferables are not supported.
+   */
+  payload: Schema.Any,
+  hops: Schema.Array(Schema.String),
+  source: Schema.String,
+  target: Schema.Literal('-'),
+})
+
 export class MessageChannelPacket extends Schema.Union(
   MessageChannelRequest,
   MessageChannelResponseSuccess,
@@ -91,4 +137,14 @@ export class ProxyChannelPacket extends Schema.Union(
   ProxyChannelPayloadAck,
 ) {}
 
-export class Packet extends Schema.Union(MessageChannelPacket, ProxyChannelPacket, NetworkConnectionAdded) {}
+export class Packet extends Schema.Union(
+  MessageChannelPacket,
+  ProxyChannelPacket,
+  NetworkConnectionAdded,
+  NetworkConnectionTopologyRequest,
+  NetworkConnectionTopologyResponse,
+  BroadcastChannelPacket,
+) {}
+
+export class MessageChannelPing extends Schema.TaggedStruct('MessageChannelPing', {}) {}
+export class MessageChannelPong extends Schema.TaggedStruct('MessageChannelPong', {}) {}