Giter VIP home page Giter VIP logo

nats-proxy's Introduction

REST to NATS proxy.

REST API over NATS protocol.

Build Status GoReport GoDoc Coverage Status

The microframework for building the REST API on NATS messaging platform. As the part of the framework is proxy bridging HTTP protocol to NATS protocol.

Example usage

service connected to NATS via nats-proxy client:

	clientConn, _ := nats.Connect(nats.DefaultURL)
	natsClient, _ := NewNatsClient(clientConn)
	natsClient.GET("/test/:event/:session", func(c *Context) {
		reqEvent = c.PathVariable("event")
		reqSession = c.PathVariable("session")

		respStruct := struct {
			User string
		}{
			"Radek",
		}

		c.JSON(200, respStruct)
	})
	defer clientConn.Close()

nats-proxy gateway

	proxyConn, _ := nats.Connect(nats.DefaultURL)
	proxy, _ := NewNatsProxy(proxyConn)
	http.Handle("/", proxy)
	defer proxyConn.Close()

HTTP client

resp, err := http.Get("http://127.0.0.1:3000/test/12324/123")

WebSocket support

The web socket support is in early stage, but it is working. The proxy does not support close notifications for the client side and there is a lot of work to be done.

	clientConn, _ := nats.Connect(nats_url)
	natsClient, _ := NewNatsClient(clientConn)
	
	// Basic nats-proxy handler
	natsClient.GET("/ws/:token", func(c *Context) {
		
		// Test if the client 
		// contains websocket handshake
		if c.Request.IsWebSocket() {
			
			// If so, the DoUpgrade 
			// flag must be set to true, 
			// to notify proxy to do the websocket upgrade
			c.Response.DoUpgrade = true
			
			// Each websocket connection has its
			// unique id, which is practically 
			// the subject of NATS
			socketID, err := c.GetWebsocketID()
			
			// The handler for incoming 
			// messages could be set.
			natsClient.HandleWebsocket(socketID, func(m *nats.Msg) {
				
				// WriteWebsocket writes
				// the message directly to
				// NATS subject
				natsClient.WriteWebsocket(socketID, []byte("Hi there"))
			})
		}
	})

Advanced features

Proxy hook

Proxy hook is feature designed to change the response before it's written to http response. This feature could be used for example to enrich the header by special content or audit outgoing data.

multiProxy.AddHook("/login.*", loginHook)

func loginHook(resp *natsproxy.Response) {
    // Do something 
    // with the response
    // e.g change outgoing header.
	resp.Header.Set(TokenHeader, token.RefToken)
}

Client middleware

The client middleware feature is inspired by gin framework. Context could be processed before it is processed by specific handler. The example below shows how to use middleware to log all incoming requests.

natsClient.Use(logger)

func logger(c *natsproxy.Context) {
	log.Infof("%s:%s from %s", c.Request.Method, c.Request.URL)
}

nats-proxy's People

Contributors

sohlich avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

nats-proxy's Issues

bug: detect not connected nats connections

--- FAIL: TestGetSubscribe (0.00s)
panic: runtime error: invalid memory address or nil pointer dereference
panic: runtime error: invalid memory address or nil pointer dereference [recovered]
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x0 pc=0x11d687]

goroutine 5 [running]:
panic(0x3075a0, 0xc42000c0a0)
/Users/radek/Software/Go/1.7RC1/src/runtime/panic.go:500 +0x1a1
testing.tRunner.func1(0xc42008a180)
/Users/radek/Software/Go/1.7RC1/src/testing/testing.go:579 +0x25d
panic(0x3075a0, 0xc42000c0a0)
/Users/radek/Software/Go/1.7RC1/src/runtime/panic.go:458 +0x243
github.com/nats-io/nats.(_Conn).close(0x0, 0x2, 0xc4200d8101)
/Users/radek/Projects/Go/src/github.com/nats-io/nats/nats.go:2299 +0x37
github.com/nats-io/nats.(_Conn).Close(0x0)
/Users/radek/Projects/Go/src/github.com/nats-io/nats/nats.go:2366 +0x39
panic(0x3075a0, 0xc42000c0a0)
/Users/radek/Software/Go/1.7RC1/src/runtime/panic.go:458 +0x243
github.com/sohlich/nats-proxy.(_NatsClient).Subscribe(0x0, 0x365bd5, 0x3, 0x3660b8, 0x5, 0x392820)
/Users/radek/Projects/Go/src/github.com/sohlich/nats-proxy/client.go:105 +0xff
github.com/sohlich/nats-proxy.(_NatsClient).GET(0x0, 0x3660b8, 0x5, 0x392820)
/Users/radek/Projects/Go/src/github.com/sohlich/nats-proxy/client.go:78 +0x5e
github.com/sohlich/nats-proxy.TestGetSubscribe(0xc42008a180)
/Users/radek/Projects/Go/src/github.com/sohlich/nats-proxy/client_test.go:29 +0xe4
testing.tRunner(0xc42008a180, 0x392828)
/Users/radek/Software/Go/1.7RC1/src/testing/testing.go:610 +0x81
created by testing.(*T).Run
/Users/radek/Software/Go/1.7RC1/src/testing/testing.go:646 +0x2ec
exit status 2

Add license

I love this project as it's incredibly useful but sadly there's no license 😢

Would be awesome if you added one so the extent of how people can use this is clear.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.