starpc 0.1.6 → 0.1.7

package/README.md

@@ -9,11 +9,11 @@ supported by any of the major RPC libraries.
 
 The [rpcproto](./srpc/rpcproto.proto) file describes the protocol.
 
-Uses any Stream multiplexer: defaults to [libp2p-mplex] over a WebSocket.
+Can use any Stream multiplexer: defaults to [libp2p-mplex] over a WebSocket.
 
 [libp2p-mplex]: https://github.com/libp2p/js-libp2p-mplex
 
-The server side has not yet been implemented in TypeScript.
+Note: the server has not yet been implemented in TypeScript.
 
 # Usage
 

package/dist/srpc/conn.d.ts

@@ -1,12 +1,16 @@
 import type { Stream } from '@libp2p/interface-connection';
+import type { StreamMuxerFactory } from '@libp2p/interface-stream-muxer';
 import type { Duplex } from 'it-stream-types';
 import type { Stream as SRPCStream } from './stream';
 import { Client } from './client';
+export interface ConnParams {
+    muxerFactory?: StreamMuxerFactory;
+}
 export declare class Conn implements Duplex<Uint8Array> {
     private muxer;
-    constructor();
+    constructor(connParams?: ConnParams);
     get sink(): import("it-stream-types").Sink<Uint8Array, Promise<void>>;
-    get source(): AsyncIterable<Uint8Array>;
+    get source(): import("it-stream-types").Source<Uint8Array>;
     get streams(): Stream[];
     buildClient(): Client;
     openStream(): Promise<SRPCStream>;

package/dist/srpc/conn.js

@@ -1,13 +1,15 @@
-import { Components } from '@libp2p/components';
-import { MplexStreamMuxer } from '@libp2p/mplex';
+import { Mplex } from '@libp2p/mplex';
 import { Client } from './client';
 // Conn implements a generic connection with a two-way stream.
 export class Conn {
     // muxer is the mplex stream muxer.
     muxer;
-    constructor() {
-        // see https://github.com/libp2p/js-libp2p-mplex/pull/179
-        this.muxer = new MplexStreamMuxer(new Components(), {
+    constructor(connParams) {
+        let muxerFactory = connParams?.muxerFactory;
+        if (!muxerFactory) {
+            muxerFactory = new Mplex();
+        }
+        this.muxer = muxerFactory.createStreamMuxer({
             onIncomingStream: this.handleIncomingStream.bind(this),
         });
     }

package/dist/srpc/websocket.js

@@ -1,12 +1,15 @@
 import { Conn } from './conn.js';
 import { duplex } from 'it-ws';
 import { pipe } from 'it-pipe';
+import { Mplex } from '@libp2p/mplex';
 // WebSocketConn implements a connection with a WebSocket.
 export class WebSocketConn extends Conn {
     // socket is the web socket
     socket;
     constructor(socket) {
-        super();
+        super({
+            muxerFactory: new Mplex(),
+        });
         this.socket = socket;
         const socketDuplex = duplex(socket);
         pipe(this.source, socketDuplex, this.sink);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starpc",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Streaming protobuf RPC service protocol over any two-way channel.",
   "license": "MIT",
   "author": {
@@ -42,6 +42,7 @@
     "gen": "make genproto",
     "test": "make test && npm run check",
     "test:integration": "make integration",
+    "integration": "npm run test:integration",
     "lint": "npm run lint:go && npm run lint:js",
     "lint:go": "make lint",
     "lint:js": "eslint -c .eslintrc.js --ext .ts ./{srpc,echo}/**/*.ts",

package/srpc/conn.ts

@@ -1,18 +1,27 @@
 import type { Stream } from '@libp2p/interface-connection'
+import type { StreamMuxer, StreamMuxerFactory } from '@libp2p/interface-stream-muxer'
 import type { Duplex } from 'it-stream-types'
-import { Components } from '@libp2p/components'
-import { MplexStreamMuxer } from '@libp2p/mplex'
+import { Mplex } from '@libp2p/mplex'
 import type { Stream as SRPCStream } from './stream'
 import { Client } from './client'
 
+// ConnParams are parameters that can be passed to the Conn constructor.
+export interface ConnParams {
+  // muxerFactory overrides using the default factory (@libp2p/mplex).
+  muxerFactory?: StreamMuxerFactory
+}
+
 // Conn implements a generic connection with a two-way stream.
 export class Conn implements Duplex<Uint8Array> {
   // muxer is the mplex stream muxer.
-  private muxer: MplexStreamMuxer
-
-  constructor() {
-    // see https://github.com/libp2p/js-libp2p-mplex/pull/179
-    this.muxer = new MplexStreamMuxer(new Components(), {
+  private muxer: StreamMuxer
+
+  constructor(connParams?: ConnParams) {
+    let muxerFactory = connParams?.muxerFactory
+    if (!muxerFactory) {
+      muxerFactory = new Mplex()
+    }
+    this.muxer = muxerFactory.createStreamMuxer({
       onIncomingStream: this.handleIncomingStream.bind(this),
     })
   }

package/srpc/websocket.ts

@@ -1,6 +1,7 @@
 import { Conn } from './conn.js'
 import { duplex } from 'it-ws'
 import { pipe } from 'it-pipe'
+import { Mplex } from '@libp2p/mplex'
 import type WebSocket from 'isomorphic-ws'
 
 // WebSocketConn implements a connection with a WebSocket.
@@ -9,7 +10,9 @@ export class WebSocketConn extends Conn {
   private socket: WebSocket
 
   constructor(socket: WebSocket) {
-    super()
+    super({
+      muxerFactory: new Mplex(),
+    })
     this.socket = socket
     const socketDuplex = duplex(socket)
     pipe(this.source, socketDuplex, this.sink)

package/patches/@libp2p+mplex+2.0.0.patch

@@ -1,23 +0,0 @@
-diff --git a/node_modules/@libp2p/mplex/dist/src/index.d.ts b/node_modules/@libp2p/mplex/dist/src/index.d.ts
-index 14c5f6e..32d0ee0 100644
---- a/node_modules/@libp2p/mplex/dist/src/index.d.ts
-+++ b/node_modules/@libp2p/mplex/dist/src/index.d.ts
-@@ -1,6 +1,7 @@
- import { Components, Initializable } from '@libp2p/components';
- import type { StreamMuxerFactory, StreamMuxerInit } from '@libp2p/interface-stream-muxer';
- import { MplexStreamMuxer } from './mplex.js';
-+export { MplexStreamMuxer } from './mplex.js';
- export interface MplexInit {
-     /**
-      * The maximum size of message that can be sent in one go in bytes.
-diff --git a/node_modules/@libp2p/mplex/dist/src/index.js b/node_modules/@libp2p/mplex/dist/src/index.js
-index 4d692df..7bf592c 100644
---- a/node_modules/@libp2p/mplex/dist/src/index.js
-+++ b/node_modules/@libp2p/mplex/dist/src/index.js
-@@ -1,5 +1,6 @@
- import { Components } from '@libp2p/components';
- import { MplexStreamMuxer } from './mplex.js';
-+export { MplexStreamMuxer } from './mplex.js';
- export class Mplex {
-     constructor(init = {}) {
-         this.protocol = '/mplex/6.7.0';