starpc 0.11.2 → 0.12.0

package/echo/echo_srpc.pb.go

@@ -41,7 +41,7 @@ func (c *srpcEchoerClient) SRPCClient() srpc.Client { return c.cc }
 
 func (c *srpcEchoerClient) Echo(ctx context.Context, in *EchoMsg) (*EchoMsg, error) {
 	out := new(EchoMsg)
-	err := c.cc.Invoke(ctx, c.serviceID, "Echo", in, out)
+	err := c.cc.ExecCall(ctx, c.serviceID, "Echo", in, out)
 	if err != nil {
 		return nil, err
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starpc",
-  "version": "0.11.2",
+  "version": "0.12.0",
   "description": "Streaming protobuf RPC service protocol over any two-way channel.",
   "license": "MIT",
   "author": {

package/srpc/client-prefix.go

@@ -0,0 +1,58 @@
+package srpc
+
+import "context"
+
+// PrefixClient checks for and strips a set of prefixes from a Client.
+type PrefixClient struct {
+	// client is the underlying client
+	client Client
+	// serviceIDPrefixes is the list of service id prefixes to match.
+	serviceIDPrefixes []string
+}
+
+// NewPrefixClient constructs a new PrefixClient.
+//
+// serviceIDPrefixes is the list of service id prefixes to match.
+// strips the prefix before calling the underlying Invoke function.
+// if none of the prefixes match, returns unimplemented.
+// if empty: forwards all services w/o stripping any prefix.
+func NewPrefixClient(client Client, serviceIDPrefixes []string) *PrefixClient {
+	return &PrefixClient{
+		client:            client,
+		serviceIDPrefixes: serviceIDPrefixes,
+	}
+}
+
+// ExecCall executes a request/reply RPC with the remote.
+func (i *PrefixClient) ExecCall(ctx context.Context, service, method string, in, out Message) error {
+	service, err := i.stripCheckServiceIDPrefix(service)
+	if err != nil {
+		return err
+	}
+	return i.client.ExecCall(ctx, service, method, in, out)
+}
+
+// NewStream starts a streaming RPC with the remote & returns the stream.
+// firstMsg is optional.
+func (i *PrefixClient) NewStream(ctx context.Context, service, method string, firstMsg Message) (Stream, error) {
+	service, err := i.stripCheckServiceIDPrefix(service)
+	if err != nil {
+		return nil, err
+	}
+	return i.client.NewStream(ctx, service, method, firstMsg)
+}
+
+// stripCheckServiceIDPrefix strips the prefix & returns unimplemented if necessary.
+func (i *PrefixClient) stripCheckServiceIDPrefix(service string) (string, error) {
+	if len(i.serviceIDPrefixes) != 0 {
+		strippedID, matchedPrefix := CheckStripPrefix(service, i.serviceIDPrefixes)
+		if len(matchedPrefix) == 0 {
+			return service, ErrUnimplemented
+		}
+		return strippedID, nil
+	}
+	return service, nil
+}
+
+// _ is a type assertion
+var _ Client = ((*PrefixClient)(nil))

package/srpc/client.go

@@ -8,8 +8,8 @@ import (
 
 // Client implements a SRPC client which can initiate RPC streams.
 type Client interface {
-	// Invoke executes a unary RPC with the remote.
-	Invoke(ctx context.Context, service, method string, in, out Message) error
+	// ExecCall executes a request/reply RPC with the remote.
+	ExecCall(ctx context.Context, service, method string, in, out Message) error
 
 	// NewStream starts a streaming RPC with the remote & returns the stream.
 	// firstMsg is optional.
@@ -37,8 +37,8 @@ func NewClient(openStream OpenStreamFunc) Client {
 	}
 }
 
-// Invoke executes a unary RPC with the remote.
-func (c *client) Invoke(rctx context.Context, service, method string, in, out Message) error {
+// ExecCall executes a request/reply RPC with the remote.
+func (c *client) ExecCall(rctx context.Context, service, method string, in, out Message) error {
 	ctx, ctxCancel := context.WithCancel(rctx)
 	defer ctxCancel()
 

package/srpc/handler.go

@@ -1,13 +1,5 @@
 package srpc
 
-// Invoker describes a SRPC service invoker.
-type Invoker interface {
-	// InvokeMethod invokes the method matching the service & method ID.
-	// Returns false, nil if not found.
-	// If service string is empty, ignore it.
-	InvokeMethod(serviceID, methodID string, strm Stream) (bool, error)
-}
-
 // Handler describes a SRPC call handler implementation.
 type Handler interface {
 	// Invoker invokes the methods.

package/srpc/invoker-prefix.go

@@ -0,0 +1,40 @@
+package srpc
+
+// PrefixInvoker checks for and strips a set of prefixes from a Invoker.
+type PrefixInvoker struct {
+	// inv is the underlying invoker
+	inv Invoker
+	// serviceIDPrefixes is the list of service id prefixes to match.
+	serviceIDPrefixes []string
+}
+
+// NewPrefixInvoker constructs a new PrefixInvoker.
+//
+// serviceIDPrefixes is the list of service id prefixes to match.
+// strips the prefix before calling the underlying Invoke function.
+// if none of the prefixes match, returns unimplemented.
+// if empty: forwards all services w/o stripping any prefix.
+func NewPrefixInvoker(inv Invoker, serviceIDPrefixes []string) *PrefixInvoker {
+	return &PrefixInvoker{
+		inv:               inv,
+		serviceIDPrefixes: serviceIDPrefixes,
+	}
+}
+
+// InvokeMethod invokes the method matching the service & method ID.
+// Returns false, nil if not found.
+// If service string is empty, ignore it.
+func (i *PrefixInvoker) InvokeMethod(serviceID, methodID string, strm Stream) (bool, error) {
+	if len(i.serviceIDPrefixes) != 0 {
+		strippedID, matchedPrefix := CheckStripPrefix(serviceID, i.serviceIDPrefixes)
+		if len(matchedPrefix) == 0 {
+			return false, nil
+		}
+		serviceID = strippedID
+	}
+
+	return i.inv.InvokeMethod(serviceID, methodID, strm)
+}
+
+// _ is a type assertion
+var _ Invoker = ((*PrefixInvoker)(nil))

package/srpc/invoker.go

@@ -0,0 +1,9 @@
+package srpc
+
+// Invoker is a function for invoking SRPC service methods.
+type Invoker interface {
+	// InvokeMethod invokes the method matching the service & method ID.
+	// Returns false, nil if not found.
+	// If service string is empty, ignore it.
+	InvokeMethod(serviceID, methodID string, strm Stream) (bool, error)
+}

package/srpc/strip-prefix.go

@@ -0,0 +1,26 @@
+package srpc
+
+import "strings"
+
+// CheckStripPrefix checks if the string has any of the given prefixes and
+// strips the matched prefix if any.
+//
+// if len(matchPrefixes) == 0 returns the ID without changing it.
+func CheckStripPrefix(id string, matchPrefixes []string) (strippedID string, matchedPrefix string) {
+	if len(matchPrefixes) == 0 {
+		return id, ""
+	}
+
+	var matched bool
+	for _, prefix := range matchPrefixes {
+		matched = strings.HasPrefix(id, prefix)
+		if matched {
+			matchedPrefix = prefix
+			break
+		}
+	}
+	if !matched {
+		return id, ""
+	}
+	return id[len(matchedPrefix):], matchedPrefix
+}