Version 1.2 (#14)

* Add pointer receiver for initializing ProxyServer and add Teardown function
* Rename receiver variable to p from proxyServer
* Make config available as a struct
* Define Proxy interface and implement it on ProxyServer
* Fix metric exports
* Add MIT license badge to README
* Return if ctx has error
* Add build pipeline with GitHub Actions (#15)

Author: msquee

.github/workflows/build-binary.yml

@@ -0,0 +1,46 @@
+name: Build Binary
+
+on:
+  pull_request:
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        platforms: [ 'linux-amd64', 'darwin-amd64', 'linux-arm64' ]
+        go: [ '1.15.5' ]
+        os: [ 'ubuntu-20.04' ]
+
+    name: Build ${{ matrix.platforms }}
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Setup Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go }}
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/go/pkg/mod
+            ~/.cache/go-build
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Build Go WebSockify
+        run: |
+          make PLATFORM=${{ matrix.platforms }}
+
+      - name: Upload binary
+        uses: actions/upload-artifact@v2
+        with:
+          name: go-websockify-${{ matrix.platforms }}
+          path: |
+            ./bin/go-websockify-${{ matrix.platforms }}

Makefile

@@ -3,12 +3,21 @@
 # make
 # make clean
 
+
+PLATFORM=linux-amd64
+
+parseOS=$(firstword $(subst -, ,$1))
+parseArch=$(or $(word 2,$(subst -, ,$1)),$(value 2))
+
+OS=$(call parseOS, ${PLATFORM})
+ARCH=$(call parseArch, ${PLATFORM})
+
 .PHONY: all
 
 all: build
 
 build:
-	GOOS=linux GOARCH=amd64 go build -ldflags="-w -s -X main.versionString=$$(git describe --tags --first-parent --abbrev=6 --long --dirty --always) -X main.buildTime=$(date)" -o ./bin/go-websockify
+	GOOS=${OS} GOARCH=${ARCH} go build -a -ldflags="-w -s -X main.versionString=$$(git describe --tags --first-parent --abbrev=6 --long --dirty --always) -X main.buildTime=$(date)" -o ./bin/go-websockify-${OS}-${ARCH}
 
 clean:
 	rm -rf bin/

README.md

@@ -1,4 +1,5 @@
 # Go WebSockify
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
 > RFC 6455 compliant TCP to WebSocket proxy.
 
 Go WebSockify is a pure Go implementation of [novnc/websockify](https://github.com/novnc/websockify) TCP to WebSocket proxy with improved connection handling. Runs on Linux, Windows and MacOS.

docker-compose.yml

@@ -1,10 +1,10 @@
-version: '3.8'
+version: '3.3'
 
 networks:
   lan:
 
 volumes:
-  data: {}
+  data:
 
 services:
   # Prometheus
@@ -53,8 +53,8 @@ services:
     build: ./client
     command: yarn run dev
     volumes:
-      - ./client:/usr/client/
-      - /usr/client/node_modules
+      - ./client:/opt/frontend/
+      - /opt/frontend/node_modules
     ports:
       - "1234:1234" # Parcel
       - "4321:4321" # HMR

http.go

@@ -16,12 +16,11 @@ import (
 
 var (
 	upgrader = websocket.Upgrader{
-		ReadBufferSize:  bufferSize,
-		WriteBufferSize: bufferSize,
+		ReadBufferSize:  config.bufferSize,
+		WriteBufferSize: config.bufferSize,
 		CheckOrigin:     authenticateOrigin,
 		Subprotocols:    []string{"binary"},
 	}
-	proxyServer   *ProxyServer
 	ctx, stopHTTP = context.WithCancel(context.Background())
 	server        = &http.Server{}
 )
@@ -35,24 +34,24 @@ func StartHTTP() {
 		prometheus.DefaultGatherer,
 		promhttp.HandlerOpts{},
 	))
-
-	router.HandleFunc(httpPath, webSocketHandler)
+	router.HandleFunc(config.httpPath, webSocketHandler)
 
 	server = &http.Server{
 		ReadHeaderTimeout: 5 * time.Second,
 		ReadTimeout:       5 * time.Second,
 		WriteTimeout:      5 * time.Second,
 		IdleTimeout:       60 * time.Second,
-		Addr:              bindAddr,
+		Addr:              config.bindAddr,
 		Handler:           router,
 	}
 
-	listening := fmt.Sprintf("Listening at address %s", bindAddr)
+	listening := fmt.Sprintf("Listening at address %s", config.bindAddr)
 	log.Println(listening)
 	log.Fatal(server.ListenAndServe())
 
 	if ctx.Err() != nil {
 		log.Fatalln(ctx.Err())
+		return
 	}
 }
 
@@ -65,33 +64,33 @@ func webSocketHandler(w http.ResponseWriter, r *http.Request) {
 	wsConn, err := upgrader.Upgrade(w, r, nil)
 
 	if err != nil {
-		log.Println("Failed to upgrade websocket request: ", err)
+		log.Println("failed to upgrade websocket request: ", err)
 		return
 	}
-
 	wsConnCounter.Inc()
 
-	host, port, err := net.SplitHostPort(remoteAddr)
+	host, port, err := net.SplitHostPort(config.remoteAddr)
 	if err != nil {
-		log.Println("Failed to parse remote address")
+		log.Println("failed to parse remote address")
 		return
 	}
 	addr := fmt.Sprintf("%s:%s", host, port)
 
 	tcpAddr, err := net.ResolveTCPAddr("tcp", addr)
 	if err != nil {
-		message := "Failed to resolve destination: " + err.Error()
+		message := "failed to resolve destination: " + err.Error()
 		log.Println(message)
 		_ = wsConn.WriteMessage(websocket.CloseMessage, []byte(message))
 		return
 	}
 
-	proxyServer = NewWebSocketProxy(wsConn, tcpAddr)
+	var p Proxy = new(ProxyServer)
+	p.Initialize(wsConn, tcpAddr)
 
-	if err := proxyServer.Dial(); err != nil {
+	if err := p.Dial(); err != nil {
 		log.Println(err)
 		return
 	}
 
-	go proxyServer.Start()
+	go p.Start()
 }

main.go

@@ -11,32 +11,32 @@ import (
 	"github.com/msquee/go-websockify/util"
 )
 
-var (
+var config struct {
 	bindAddr   string
 	remoteAddr string
 	bufferSize int
 	httpPath   string
 
-	runAsDaemon   bool
-	showVersion   bool
-	echoServer    bool
+	runAsDaemon bool
+	showVersion bool
+	echoServer  bool
+
 	versionString string
 	buildTime     string
-
-	daemonContext daemon.Context
-)
+}
+var daemonContext daemon.Context
 
 func init() {
 	SetupInterruptHandler()
 
-	rootCmd.PersistentFlags().StringVar(&bindAddr, "bind-addr", "0.0.0.0:8080", "bind address")
-	rootCmd.PersistentFlags().StringVar(&remoteAddr, "remote-addr", "127.0.0.1:1984", "remote address")
-	rootCmd.PersistentFlags().IntVar(&bufferSize, "buffer", 65536, "buffer size")
-	rootCmd.PersistentFlags().BoolVar(&echoServer, "echo", false, "sidecar echo server")
-	rootCmd.PersistentFlags().StringVar(&httpPath, "path", "/websockify", "url path clients connect to")
+	rootCmd.PersistentFlags().StringVar(&config.bindAddr, "bind-addr", "0.0.0.0:8080", "bind address")
+	rootCmd.PersistentFlags().StringVar(&config.remoteAddr, "remote-addr", "127.0.0.1:1984", "remote address")
+	rootCmd.PersistentFlags().IntVar(&config.bufferSize, "buffer", 65536, "buffer size")
+	rootCmd.PersistentFlags().BoolVar(&config.echoServer, "echo", false, "sidecar echo server")
+	rootCmd.PersistentFlags().StringVar(&config.httpPath, "path", "/websockify", "url path clients connect to")
 
-	rootCmd.Flags().BoolVarP(&runAsDaemon, "daemon", "D", false, "run as daemon")
-	rootCmd.Flags().BoolVarP(&showVersion, "version", "v", false, "print version")
+	rootCmd.Flags().BoolVarP(&config.runAsDaemon, "daemon", "D", false, "run as daemon")
+	rootCmd.Flags().BoolVarP(&config.showVersion, "version", "v", false, "print version")
 }
 
 func main() {
@@ -50,18 +50,18 @@ var rootCmd = &cobra.Command{
 	Use:              "go-websockify",
 	Long:             `Starts a TCP to WebSocket proxy.`,
 	Run: func(cmd *cobra.Command, args []string) {
-		if showVersion {
-			fmt.Println(fmt.Sprintf("Go WebSockify version %s built on %s", versionString, buildTime))
+		if config.showVersion {
+			fmt.Println(fmt.Sprintf("Go WebSockify version %s built on %s", config.versionString, config.buildTime))
 			os.Exit(0)
 		}
 
 		log.Println("Starting Go WebSockify")
 
-		if echoServer {
+		if config.echoServer {
 			go util.StartEchoTCPServer()
 		}
 
-		if runAsDaemon {
+		if config.runAsDaemon {
 			log.Println("Running Go WebSockify as daemon")
 
 			daemonContext := &daemon.Context{
@@ -84,6 +84,7 @@ var rootCmd = &cobra.Command{
 			daemonMessage := fmt.Sprintf("Daemon running under PID %d", os.Getpid())
 			log.Println(daemonMessage)
 		}
+
 		StartHTTP()
 	},
 }