small refactor and cleanup

kit/bridge_north.go

@@ -13,17 +13,17 @@ type GatewayStartConfig struct {
 	ReusePort bool
 }
 
-// Gateway is main component of the EdgeServer. Without Gateway, the EdgeServer is not functional. You can use
+// Gateway is the main component of the EdgeServer. Without Gateway, the EdgeServer is not functional. You can use
 // some standard bundles in std/bundle path. However, if you need special handling of communication
-// between your server and the clients you are free to implement your own Gateway.
-// If you are a bundle developer need to work with interface otherwise you don't need to know
+// between your server and clients, you are free to implement your own Gateway.
+// If you are a bundle developer need to work with interface otherwise, you don't need to know
 // much about this interface.
 type Gateway interface {
 	// Start starts the gateway to accept connections.
 	Start(ctx context.Context, cfg GatewayStartConfig) error
 	// Shutdown shuts down the gateway gracefully.
 	Shutdown(ctx context.Context) error
-	// Register registers the route in the Bundle. This is how Bundle get information
+	// Register registers the route in the Bundle. This is how Bundle gets information
 	// about the services and their contracts.
 	Register(
 		serviceName, contractID string, enc Encoding, sel RouteSelector, input Message,
@@ -36,7 +36,7 @@ type Gateway interface {
 	Subscribe(d GatewayDelegate)
 	// Dispatch receives the messages from external clients and runs the execFunc with appropriate
 	// arguments. The user of the Gateway does not need to implement this. If you are using some
-	// standard bundles like std/gateway/fasthttp or std/gateway/fastws then all the implementation
+	// standard bundles like std/gateway/fasthttp or std/gateway/fastws, then all the implementation
 	// is taken care of.
 	Dispatch(ctx *Context, in []byte) (ExecuteArg, error)
 }

kit/bridge_south.go

@@ -246,6 +246,9 @@ func (sb *southBridge) genForwarderHandler(sel EdgeSelectorFunc) HandlerFunc {
 		)
 
 		ctx.Error(err)
+
+		// We should stop executing next handlers, since our request has been executed on
+		// a remote machine
 		ctx.StopExecution()
 	}
 }

kit/ctx.go

@@ -127,6 +127,7 @@ func (ctx *Context) executeRemote(arg executeRemoteArg) error {
 	you allow the processing flow to continue and pass control to the subsequent middleware functions
 	in the chain.
 */
+
 func (ctx *Context) Next() {
 	ctx.handlerIndex++
 	for ctx.handlerIndex <= len(ctx.handlers) {
@@ -252,7 +253,7 @@ func (ctx *Context) OutTo(c Conn) *Envelope {
 	return newEnvelope(ctx, c, true)
 }
 
-// Error is useful for some kind of errors which you are not going to return it to the connection,
+// Error is useful for some kind of errors that you are not going to return it to the connection,
 // or you want to use its side effect for logging, monitoring, etc. This will call your ErrHandlerFunc.
 // The boolean result indicates if 'err' was an actual error.
 func (ctx *Context) Error(err error) bool {
@@ -297,12 +298,6 @@ func (ctx *Context) reset() {
 	ctx.ctx = nil
 }
 
-func (ctx *Context) isREST() bool {
-	_, ok := ctx.Conn().(RESTConn)
-
-	return ok
-}
-
 type ctxPool struct {
 	sync.Pool
 	ls *localStore

kit/ctx_limited.go

@@ -32,6 +32,10 @@ func (ctx *LimitedContext) Conn() Conn {
 	return ctx.ctx.conn
 }
 
+func (ctx *LimitedContext) IsREST() bool {
+	return ctx.ctx.IsREST()
+}
+
 // SetHdr sets the common header key-value pairs, so in Out method we do not need to
 // repeatedly set those. If you only want to set the header for an envelope, you can
 // use Envelope.SetHdr method instead.

kit/envelope_carrier.go

@@ -31,7 +31,7 @@ type envelopeCarrier struct {
 func (ec *envelopeCarrier) FillWithContext(ctx *Context) *envelopeCarrier {
 	ec.Data = &carrierData{
 		EnvelopeID:  ctx.In().GetID(),
-		IsREST:      ctx.isREST(),
+		IsREST:      ctx.IsREST(),
 		MsgType:     reflect.TypeOf(ctx.In().GetMsg()).String(),
 		Msg:         marshalEnvelopeCarrier(ctx.In().GetMsg()),
 		ContractID:  ctx.ContractID(),
@@ -65,7 +65,7 @@ func (ec *envelopeCarrier) FillWithContext(ctx *Context) *envelopeCarrier {
 func (ec *envelopeCarrier) FillWithEnvelope(e *Envelope) *envelopeCarrier {
 	ec.Data = &carrierData{
 		EnvelopeID:  utils.B2S(e.id),
-		IsREST:      e.ctx.isREST(),
+		IsREST:      e.ctx.IsREST(),
 		MsgType:     reflect.TypeOf(e.GetMsg()).String(),
 		Msg:         marshalEnvelopeCarrier(e.GetMsg()),
 		ContractID:  e.ctx.ContractID(),