crank4go-core

README

Crank4go API Gateway

Brief Introduction

It is a Golang implementation of Crank4j, which derived from Cranker. the follow introduction is quoted from the origin project:

It consists of 2 executables that together act as a reverse proxy. What it allows is for cases where there is a firewall between your inside network and a DMZ zone.

For a normal reverse proxy, a port would need to be open allowing traffic from the DMZ to the internal network. Crank4j allows you to reverse this: Just open a port from the internal network to the DMZ, and Crank4j will tunnel HTTP traffic over the opened network.

So there are two pieces:

• The router that faces the internet, and accepts client HTTP requests
• The connector that opens connections to the router, and then passes tunneled requests to target servers.

The connections look like this:

Browser      |   DMZ        |    Internal Network
 GET   --------> router <-------- connector ---> HTTP Service
             |              |

But from the point of view of the browser, and your HTTP service, it just looks like a normal reverse proxy.

Dive deeper

this 2 picture are quoted from Cranker

HTTP requests with cranker:

Websockets with cranker:

Running locally for test

Running from a IDE

1. go mod tidy
2. open test/e2etest/dryrun_router_test.go run the test and a router will be started
3. open test/e2etest/connector_manual_test.go, a connector and a web-service will be started and connector to the router
4. open https://localhost:9000 in your browser , it is the side facing to users
   • https://localhost:9070/api/registrations shows the registration status of router
   • http://0.0.0.0:12438/health shows the health status of router

Use it in your project

connector usage

1. create a web-service with a path prefix (context-path concept in java) e.g. /my-service/...
2. start the web-service listening on a random port
3. register your web server with one or more routers:

package main
import (
    "fmt"
    "net/http"
    "net/url"
    "github.com/torchcc/crank4go-core/crank4go-connector-embedded"
)
func HelloHandler(w http.ResponseWriter, r *http.Request) {
   fmt.Fprintf(w, "Hello World")
}

func main() {
	targetURI, _ := url.Parse("http://localhost:5000")
	routerURI, _ := url.Parse("wss://localhost:9070") // should be the port which your Router Registration server listens on 
  
   	connectorConfig := NewConnectorConfig2(targetURI, "my-service", []*url.URL{routerURI}, "my-service-component-name", nil).
   		SetSlidingWindowSize(2)
	connector := CreateAndStartConnector(connectorConfig)
   
    http.HandleFunc("/my-service", HelloHandler)
   http.ListenAndServe(":5000", nil)
}

router usage

1. please refer to crank4go/test/e2etest/dryrun_router_test.go

Advantages

1. Less dependencies: only use 4 (all of which are quite small and light ): google/uuid, gorilla/websocket, julienschmidt/httprouter, op/go-logging

2. Horizontally scalable architecture:
   we can deploy multiple Router instance on the loadBalancer side. Each web-service can be registered to multiple router

3. Multi-language supported: communication between router and connector is through websocket, so apart from crank4go-connector, other connectors written by other language can also be registered to Go-router. such as

   1. java
   2. python (making it convenient to play micro-service with python)
   3. java script

4. Hooks supported: hooks are preset in the form of plugin and interceptor to monitor the connection activity of router and connector.

TODO

1. add request rate control plugin.