From d4d5514427bf7e09208eb6176e56b5fe7fa50016 Mon Sep 17 00:00:00 2001 From: Jareth Gomes Date: Sun, 19 Jun 2022 21:10:15 -0500 Subject: [PATCH 1/5] Added websocket proxy support --- go.mod | 13 +++-- go.sum | 110 ++++++++++++++++++++++++++++++++++++++++- proxy.go | 16 ++++++ proxy/proxy.go | 9 +++- proxy/proxy_request.go | 44 +++++++++++++++-- server/logger.go | 11 +++++ 6 files changed, 194 insertions(+), 9 deletions(-) diff --git a/go.mod b/go.mod index a4ef738..4bc4ee4 100644 --- a/go.mod +++ b/go.mod @@ -1,11 +1,18 @@ module github.com/arbor-dev/arbor require ( - github.com/golang/snappy v0.0.0-20170215233205-553a64147049 // indirect - github.com/gorilla/context v0.0.0-20160226214623-1ea25387ff6f // indirect github.com/gorilla/mux v0.0.0-20170922205414-3f19343c7d9c github.com/kennygrant/sanitize v1.2.3 + github.com/koding/websocketproxy v0.0.0-20181220232114-7ed82d81a28c github.com/syndtr/goleveldb v0.0.0-20170725064836-b89cc31ef797 - golang.org/x/net v0.0.0-20171004034648-a04bdaca5b32 // indirect gopkg.in/jarcoal/httpmock.v1 v1.0.0-20180719183105-8007e27cdb32 ) + +require ( + github.com/golang/snappy v0.0.0-20170215233205-553a64147049 // indirect + github.com/gorilla/context v0.0.0-20160226214623-1ea25387ff6f // indirect + github.com/gorilla/websocket v1.5.0 // indirect + github.com/onsi/ginkgo v1.16.5 // indirect + github.com/onsi/gomega v1.19.0 // indirect + golang.org/x/net v0.0.0-20220225172249-27dd8689420f // indirect +) diff --git a/go.sum b/go.sum index b5e4643..014e5b3 100644 --- a/go.sum +++ b/go.sum @@ -1,14 +1,120 @@ +github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI= +github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI= +github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= +github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4= +github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ= +github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0/go.mod h1:fyg7847qk6SyHyPtNmDHnmrv/HOrqktSC+C9fM+CJOE= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8= +github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA= +github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs= +github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w= +github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0= +github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= +github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= +github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= github.com/golang/snappy v0.0.0-20170215233205-553a64147049 h1:K9KHZbXKpGydfDN0aZrsoHpLJlZsBrGMFWbgLDGnPZk= github.com/golang/snappy v0.0.0-20170215233205-553a64147049/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= +github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/gorilla/context v0.0.0-20160226214623-1ea25387ff6f h1:9oNbS1z4rVpbnkHBdPZU4jo9bSmrLpII768arSyMFgk= github.com/gorilla/context v0.0.0-20160226214623-1ea25387ff6f/go.mod h1:kBGZzfjB9CEq2AlWe17Uuf7NDRt0dE0s8S51q0aT7Yg= github.com/gorilla/mux v0.0.0-20170922205414-3f19343c7d9c h1:nF3PgzS9upL7Iy1gqhCo1KV8FvEUbARdio1oHiiBqK8= github.com/gorilla/mux v0.0.0-20170922205414-3f19343c7d9c/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs= +github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc= +github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU= +github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/kennygrant/sanitize v1.2.3 h1:lMTHgebyLyRtvNyIAnsKyp0CO/zAS8+YmyWRDJ94WBw= github.com/kennygrant/sanitize v1.2.3/go.mod h1:LGsjYYtgxbetdg5owWB2mpgUL6e2nfw2eObZ0u0qvak= +github.com/koding/websocketproxy v0.0.0-20181220232114-7ed82d81a28c h1:N7A4JCA2G+j5fuFxCsJqjFU/sZe0mj8H0sSoSwbaikw= +github.com/koding/websocketproxy v0.0.0-20181220232114-7ed82d81a28c/go.mod h1:Nn5wlyECw3iJrzi0AhIWg+AJUb4PlRQVW4/3XHH1LZA= +github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A= +github.com/nxadm/tail v1.4.8 h1:nPr65rt6Y5JFSKQO7qToXr7pePgD6Gwiw05lkbyAQTE= +github.com/nxadm/tail v1.4.8/go.mod h1:+ncqLTQzXmGhMZNUePPaPqPvBxHAIsmXswZKocGu+AU= +github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.12.1/go.mod h1:zj2OWP4+oCPe1qIXoGWkgMRwljMUYCdkwsT2108oapk= +github.com/onsi/ginkgo v1.16.4/go.mod h1:dX+/inL/fNMqNlz0e9LfyB9TswhZpCVdJM/Z6Vvnwo0= +github.com/onsi/ginkgo v1.16.5 h1:8xi0RTUf59SOSfEtZMvwTvXYMzG4gV23XVHOZiXNtnE= +github.com/onsi/ginkgo v1.16.5/go.mod h1:+E8gABHa3K6zRBolWtd+ROzc/U5bkGt0FwiG042wbpU= +github.com/onsi/ginkgo/v2 v2.1.3/go.mod h1:vw5CSIxN1JObi/U8gcbwft7ZxR2dgaR70JSE3/PpL4c= +github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7JYyY= +github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1ybHNo= +github.com/onsi/gomega v1.17.0/go.mod h1:HnhC7FXeEQY45zxNK3PPoIUhzk/80Xly9PcubAlGdZY= +github.com/onsi/gomega v1.19.0 h1:4ieX6qQjPP/BfC3mpsAtIGGlxTWPeA3Inl/7DtXw1tw= +github.com/onsi/gomega v1.19.0/go.mod h1:LY+I3pBVzYsTBU1AnDwOSxaYi9WoWiqgwooUqq9yPro= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= github.com/syndtr/goleveldb v0.0.0-20170725064836-b89cc31ef797 h1:eDCldGfZxcrXnTnynVsYUmABi9pCd/fhhh6SpKAa2dA= github.com/syndtr/goleveldb v0.0.0-20170725064836-b89cc31ef797/go.mod h1:Z4AUp2Km+PwemOoO/VB5AOx9XSsIItzFjoJlOSiYmn0= -golang.org/x/net v0.0.0-20171004034648-a04bdaca5b32 h1:NjAulLPqFTaOxQu5S4qUMqscSu+mQdu+wMY0nfqSkuk= -golang.org/x/net v0.0.0-20171004034648-a04bdaca5b32/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= +golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/net v0.0.0-20210428140749-89ef3d95e781/go.mod h1:OJAsFXCWl8Ukc7SiCT/9KSuxbyM7479/AVlXFRxuMCk= +golang.org/x/net v0.0.0-20220225172249-27dd8689420f h1:oA4XRj0qtSt8Yo1Zms0CUlsT3KG69V2UGQWPBxujDmc= +golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk= +golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210112080510-489259a85091/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e h1:fLOSk5Q00efkSvAm+4xcoXD+RRmLmmulPn5I3Y9F2EM= +golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20201224043029-2b0845dc783e/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= +google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= +google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM= +google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE= +google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo= +google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys= gopkg.in/jarcoal/httpmock.v1 v1.0.0-20180719183105-8007e27cdb32 h1:30DLrQoRqdUHslVMzxuKUnY4GKJGk1/FJtKy3yx4TKE= gopkg.in/jarcoal/httpmock.v1 v1.0.0-20180719183105-8007e27cdb32/go.mod h1:d3R+NllX3X5e0zlG1Rful3uLvsGC/Q3OHut5464DEQw= +gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ= +gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= diff --git a/proxy.go b/proxy.go index d303d7b..d0e57df 100644 --- a/proxy.go +++ b/proxy.go @@ -80,3 +80,19 @@ func POST(w http.ResponseWriter, url string, format string, token string, r *htt func PUT(w http.ResponseWriter, url string, format string, token string, r *http.Request) { proxy.PUT(w, r, url, format, token) } + +// Establishes a websocket proxy between a client and a microservice +// +// Pass the http Request from the client and the ResponseWriter it expects. +// +// Pass the target url of the backend service (not the url the client called). +// +// Pass the format of the service. +// +// Pass a authorization token (optional). +// +// Will first attempt to establish a websocket connection on microservice, then upgrade the client connection. +// Returns once either websocket connection closes. +func ProxyWebsocket(w http.ResponseWriter, url string, format string, token string, r *http.Request) { + proxy.ProxyWebsocket(w, r, url, format, token) +} diff --git a/proxy/proxy.go b/proxy/proxy.go index 967310c..6474a07 100644 --- a/proxy/proxy.go +++ b/proxy/proxy.go @@ -2,6 +2,7 @@ package proxy import ( "net/http" + "github.com/arbor-dev/arbor/proxy/middleware" ) @@ -30,8 +31,14 @@ func PATCH(w http.ResponseWriter, r *http.Request, url string, format string, to ProxyRequest(w, r, url, format, token) } +func ProxyWebsocket(w http.ResponseWriter, r *http.Request, url string, format string, token string) { + middlewares := ProxyMiddlewaresFactory(format, token) + + ProxyWebsocketWithMiddlewares(w, r, url, middlewares) +} + // ProxyRequest proxies the caller's request based on the url, format, and token -func ProxyRequest(w http.ResponseWriter, r* http.Request, url string, format string, token string) { +func ProxyRequest(w http.ResponseWriter, r *http.Request, url string, format string, token string) { middlewares := ProxyMiddlewaresFactory(format, token) ProxyRequestWithMiddlewares(w, r, url, middlewares) diff --git a/proxy/proxy_request.go b/proxy/proxy_request.go index ef87a44..54e58e6 100644 --- a/proxy/proxy_request.go +++ b/proxy/proxy_request.go @@ -1,13 +1,16 @@ package proxy import ( - "net/http" - "io/ioutil" + "bytes" + "fmt" "io" + "io/ioutil" + "net/http" + "net/url" "time" - "bytes" "github.com/arbor-dev/arbor/proxy/constants" + "github.com/koding/websocketproxy" ) // MiddlewareSet contains the error handler and middlewares to use when proxying a request @@ -17,6 +20,41 @@ type MiddlewareSet struct { ResponseMiddlewares []http.Handler } +// ProxyWebsocketWithMiddlewares proxies the provided request using the given middlewares and upgrades the request to a websocket +func ProxyWebsocketWithMiddlewares(w http.ResponseWriter, r *http.Request, url_str string, proxyMiddlewares MiddlewareSet) { + for _, requestMiddleware := range proxyMiddlewares.RequestMiddlewares { + requestMiddleware.ServeHTTP(w, r) + } + + u, err := url.Parse(url_str) + + fmt.Println(url_str) + + if err != nil { + proxyMiddlewares.ErrorHandler.ServeHTTP(w, r) + return + } + + websocketproxy.NewProxy(u).ServeHTTP(w, r) +} + +func copyHeader(dst, src http.Header) { + for k, vv := range src { + for _, v := range vv { + dst.Add(k, v) + } + } +} + +func copyResponse(rw http.ResponseWriter, resp *http.Response) error { + copyHeader(rw.Header(), resp.Header) + rw.WriteHeader(resp.StatusCode) + defer resp.Body.Close() + + _, err := io.Copy(rw, resp.Body) + return err +} + // ProxyRequestWithMiddlewares proxies the provided request using the given middlewares func ProxyRequestWithMiddlewares(w http.ResponseWriter, r *http.Request, url string, proxyMiddlewares MiddlewareSet) { for _, requestMiddleware := range proxyMiddlewares.RequestMiddlewares { diff --git a/server/logger.go b/server/logger.go index 394ef14..8bbda64 100644 --- a/server/logger.go +++ b/server/logger.go @@ -11,7 +11,10 @@ package server import ( + "bufio" + "errors" "fmt" + "net" "net/http" "time" @@ -23,6 +26,14 @@ type StatusResponseWriter struct { status int } +func (w *StatusResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error) { + h, ok := w.ResponseWriter.(http.Hijacker) + if !ok { + return nil, nil, errors.New("hijack not supported") + } + return h.Hijack() +} + func (rec *StatusResponseWriter) WriteHeader(code int) { rec.status = code rec.ResponseWriter.WriteHeader(code) From ca5c7f8154111a25550cb3aabcf579f8ff83edda Mon Sep 17 00:00:00 2001 From: Jareth Gomes Date: Sun, 19 Jun 2022 21:12:04 -0500 Subject: [PATCH 2/5] Added tests for websocket proxy --- examples/gateway/product_service.go | 23 ++++++-- examples/products/service.go | 47 +++++++++++++++ tests/proxy_test.go | 88 +++++++++++++++++++++++++++-- 3 files changed, 147 insertions(+), 11 deletions(-) diff --git a/examples/gateway/product_service.go b/examples/gateway/product_service.go index e8c83a7..8559549 100644 --- a/examples/gateway/product_service.go +++ b/examples/gateway/product_service.go @@ -7,7 +7,8 @@ import ( ) //URL of the Product Service API -const productServiceURL string = "http://0.0.0.0:5000" +const productServiceHTTPURL string = "http://0.0.0.0:5000" +const prodcutServiceWSURL string = "ws://0.0.0.0:5000" //Data format of the API const productServiceFormat string = "JSON" @@ -45,25 +46,35 @@ var productServiceRoutes = arbor.RouteCollection{ Pattern: "/products/{id:[0-9]+}", Handler: deleteProduct, }, + arbor.Route{ + Name: "PriceUpdater", + Method: "GET", + Pattern: "/ws/{id:[0-9]+}", + Handler: websocketPriceUpdater, + }, } //Handlers func getProducts(w http.ResponseWriter, r *http.Request) { - arbor.GET(w, productServiceURL+r.URL.String(), productServiceFormat, "", r) + arbor.GET(w, productServiceHTTPURL+r.URL.String(), productServiceFormat, "", r) } func createProduct(w http.ResponseWriter, r *http.Request) { - arbor.POST(w, productServiceURL+r.URL.String(), productServiceFormat, "", r) + arbor.POST(w, productServiceHTTPURL+r.URL.String(), productServiceFormat, "", r) } func getProduct(w http.ResponseWriter, r *http.Request) { - arbor.GET(w, productServiceURL+r.URL.String(), productServiceFormat, "", r) + arbor.GET(w, productServiceHTTPURL+r.URL.String(), productServiceFormat, "", r) } func updateProduct(w http.ResponseWriter, r *http.Request) { - arbor.PUT(w, productServiceURL+r.URL.String(), productServiceFormat, "", r) + arbor.PUT(w, productServiceHTTPURL+r.URL.String(), productServiceFormat, "", r) } func deleteProduct(w http.ResponseWriter, r *http.Request) { - arbor.DELETE(w, productServiceURL+r.URL.String(), productServiceFormat, "", r) + arbor.DELETE(w, productServiceHTTPURL+r.URL.String(), productServiceFormat, "", r) +} + +func websocketPriceUpdater(w http.ResponseWriter, r *http.Request) { + arbor.ProxyWebsocket(w, prodcutServiceWSURL+r.URL.String(), productServiceFormat, "", r) } diff --git a/examples/products/service.go b/examples/products/service.go index 1f3fc19..3565b44 100644 --- a/examples/products/service.go +++ b/examples/products/service.go @@ -9,6 +9,7 @@ import ( "strconv" "github.com/gorilla/mux" + "github.com/gorilla/websocket" ) type App struct { @@ -49,6 +50,7 @@ func (a *App) initializeRoutes() { a.Router.HandleFunc("/products/{id:[0-9]+}", a.getProduct).Methods("GET") a.Router.HandleFunc("/products/{id:[0-9]+}", a.updateProduct).Methods("PUT") a.Router.HandleFunc("/products/{id:[0-9]+}", a.deleteProduct).Methods("DELETE") + a.Router.HandleFunc("/ws/{id:[0-9]+}", a.PriceUpdater).Methods("GET") } func (a *App) getProducts(w http.ResponseWriter, r *http.Request) { @@ -140,6 +142,51 @@ func (a *App) deleteProduct(w http.ResponseWriter, r *http.Request) { respondWithJSON(w, http.StatusOK, map[string]string{"result": "success"}) } +var upgrader = websocket.Upgrader{ + ReadBufferSize: 1024, + WriteBufferSize: 1024, +} + +func (a *App) PriceUpdater(w http.ResponseWriter, r *http.Request) { + vars := mux.Vars(r) + id, err := strconv.Atoi(vars["id"]) + if err != nil { + respondWithError(w, http.StatusBadRequest, "Invalid Product ID") + fmt.Println(err.Error()) + return + } + + p := product{ID: id} + p, err = a.Model.getProduct(p) + + if err != nil { + respondWithError(w, http.StatusNotFound, "Product not found") + fmt.Println(err.Error()) + return + } + + conn, err := upgrader.Upgrade(w, r, nil) + + if err != nil { + respondWithError(w, http.StatusBadRequest, err.Error()) + return + } + + conn.WriteMessage(websocket.TextMessage, []byte(strconv.FormatFloat((float64)(p.Price), 'f', 2, 32))) + + // This function basically would add the connection and its associated item id to a map (unique id + // for each connection) atomically and would spawn a goroutine in order to listen for incoming messages + // from the client + + // Given this example, the server should broadcast to all the connections in the array whenever + // a price is updated + // The goroutine would wait until the client sends back a close message, on which it will remove the + // connection from the array + + // Currently in this unimplemented version, the socket will get closed by this server and behaves + // similarly to a normal HTTP request +} + func respondWithError(w http.ResponseWriter, code int, message string) { respondWithJSON(w, code, map[string]string{"error": message}) } diff --git a/tests/proxy_test.go b/tests/proxy_test.go index e83b808..b605f2b 100644 --- a/tests/proxy_test.go +++ b/tests/proxy_test.go @@ -10,17 +10,18 @@ import ( "net/http/httptest" "os" "reflect" - "testing" "strconv" + "testing" "time" "gopkg.in/jarcoal/httpmock.v1" + "github.com/arbor-dev/arbor" "github.com/arbor-dev/arbor/examples/gateway" "github.com/arbor-dev/arbor/examples/products" - "github.com/arbor-dev/arbor" - "github.com/arbor-dev/arbor/server" "github.com/arbor-dev/arbor/logger" + "github.com/arbor-dev/arbor/server" + "github.com/gorilla/websocket" ) const url string = "http://0.0.0.0:8000" @@ -429,11 +430,11 @@ func TestProxyPUTRaw(t *testing.T) { logLevel := logger.LogLevel logger.LogLevel = logger.FATAL - sendingBytes := make([]byte, 8 * 1024 * 1024) + sendingBytes := make([]byte, 8*1024*1024) rand.Read(sendingBytes) httpmock.RegisterResponder("PUT", "http://test.local/upload", - func (req *http.Request) (*http.Response, error) { + func(req *http.Request) (*http.Response, error) { receivedBytes, err := ioutil.ReadAll(req.Body) if err != nil { @@ -479,3 +480,80 @@ func TestProxyPUTRaw(t *testing.T) { logger.LogLevel = logLevel } + +func TestProxyWebsocket(t *testing.T) { + os.Args = []string{"tests", "-u"} + testSrvs := newTestingServices() + defer testSrvs.killTestingServices() + + p := &product{ + ID: 0, + Name: "Test Product", + Price: 9.99, + } + + b := new(bytes.Buffer) + json.NewEncoder(b).Encode(p) + + res, err := http.Post(url+"/product", "application/json; charset=utf-8", b) + if err != nil { + log.Fatal(err) + } + + if res.StatusCode != http.StatusCreated { + t.Error( + "For", res, + "expected", http.StatusCreated, + "got", res.StatusCode, + ) + } + + body, readErr := ioutil.ReadAll(res.Body) + if readErr != nil { + testSrvs.killTestingServices() + t.Error(readErr) + return + } + + serverP := new(product) + jsonErr := json.Unmarshal(body, &serverP) + if jsonErr != nil { + testSrvs.killTestingServices() + t.Error(readErr) + return + } + + if !reflect.DeepEqual(p, serverP) { + t.Error( + "For", serverP, + "expected", p, + "got", serverP, + ) + } + + conn, _, err := websocket.DefaultDialer.Dial("ws://0.0.0.0:8000/ws/0", nil) + + if err != nil { + log.Fatal(err) + } + + defer conn.Close() + + msg_type, msg, err := conn.ReadMessage() + + if msg_type != websocket.TextMessage { + t.Error( + "For message type", + "expected", websocket.TextMessage, + "got", msg_type, + ) + } + + if !reflect.DeepEqual(msg, []byte("9.99")) { + t.Error( + "For message content", + "expected", []byte("9.99"), + "got", msg, + ) + } +} From 02f4e40915a076443de81a0f8d9ba6d32d28c4ed Mon Sep 17 00:00:00 2001 From: Jareth Gomes Date: Sun, 19 Jun 2022 21:27:10 -0500 Subject: [PATCH 3/5] Updated docs to include ProxyWebsocket --- docs/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/README.md b/docs/README.md index b6344b3..75bcad9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -134,6 +134,23 @@ Pass a authorization token (optional). Will call the service and return the result to the client. +#### func ProxyWebsocket +```go +func ProxyWebsocket(w http.ResponseWriter, url string, format string, token string, r *http.Request) +``` +Establishes a websocket proxy between a client and a microservice + +Pass the http Request from the client and the ResponseWriter it expects. + +Pass the target url of the backend service (not the url the client called). + +Pass the format of the service. + +Pass a authorization token (optional). + +Will first attempt to establish a websocket connection on microservice, then upgrade the client connection. +Returns once the websocket connection closes. + #### func RegisterClient ```go From dcdbcd7dbb7f457db367ab741596319c2b99af02 Mon Sep 17 00:00:00 2001 From: Jareth Gomes Date: Sat, 25 Jun 2022 15:52:00 -0500 Subject: [PATCH 4/5] Changed websocketproxy to forked repo --- go.mod | 7 +++++-- go.sum | 10 ++++++++-- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/go.mod b/go.mod index 4bc4ee4..cfd81af 100644 --- a/go.mod +++ b/go.mod @@ -1,7 +1,12 @@ module github.com/arbor-dev/arbor +go 1.13 + +replace github.com/koding/websocketproxy => github.com/Nydauron/websocketproxy v0.0.0-20220622003505-9c247a147a15 + require ( github.com/gorilla/mux v0.0.0-20170922205414-3f19343c7d9c + github.com/gorilla/websocket v1.5.0 github.com/kennygrant/sanitize v1.2.3 github.com/koding/websocketproxy v0.0.0-20181220232114-7ed82d81a28c github.com/syndtr/goleveldb v0.0.0-20170725064836-b89cc31ef797 @@ -11,8 +16,6 @@ require ( require ( github.com/golang/snappy v0.0.0-20170215233205-553a64147049 // indirect github.com/gorilla/context v0.0.0-20160226214623-1ea25387ff6f // indirect - github.com/gorilla/websocket v1.5.0 // indirect github.com/onsi/ginkgo v1.16.5 // indirect github.com/onsi/gomega v1.19.0 // indirect - golang.org/x/net v0.0.0-20220225172249-27dd8689420f // indirect ) diff --git a/go.sum b/go.sum index 014e5b3..fa66dd5 100644 --- a/go.sum +++ b/go.sum @@ -1,3 +1,5 @@ +github.com/Nydauron/websocketproxy v0.0.0-20220622003505-9c247a147a15 h1:bYJ/ooVU9EjCzRwKtFMUNOQ/9L6w2qWg5zxjnjBpDxM= +github.com/Nydauron/websocketproxy v0.0.0-20220622003505-9c247a147a15/go.mod h1:9A6FrdPcvAGG5HpSGaem+YQKLsA4+BHkyrd0SRFBr+M= github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI= github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI= github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU= @@ -15,12 +17,14 @@ github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:W github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0= github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= +github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= github.com/golang/snappy v0.0.0-20170215233205-553a64147049 h1:K9KHZbXKpGydfDN0aZrsoHpLJlZsBrGMFWbgLDGnPZk= github.com/golang/snappy v0.0.0-20170215233205-553a64147049/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/gorilla/context v0.0.0-20160226214623-1ea25387ff6f h1:9oNbS1z4rVpbnkHBdPZU4jo9bSmrLpII768arSyMFgk= @@ -33,8 +37,6 @@ github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpO github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/kennygrant/sanitize v1.2.3 h1:lMTHgebyLyRtvNyIAnsKyp0CO/zAS8+YmyWRDJ94WBw= github.com/kennygrant/sanitize v1.2.3/go.mod h1:LGsjYYtgxbetdg5owWB2mpgUL6e2nfw2eObZ0u0qvak= -github.com/koding/websocketproxy v0.0.0-20181220232114-7ed82d81a28c h1:N7A4JCA2G+j5fuFxCsJqjFU/sZe0mj8H0sSoSwbaikw= -github.com/koding/websocketproxy v0.0.0-20181220232114-7ed82d81a28c/go.mod h1:Nn5wlyECw3iJrzi0AhIWg+AJUb4PlRQVW4/3XHH1LZA= github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A= github.com/nxadm/tail v1.4.8 h1:nPr65rt6Y5JFSKQO7qToXr7pePgD6Gwiw05lkbyAQTE= github.com/nxadm/tail v1.4.8/go.mod h1:+ncqLTQzXmGhMZNUePPaPqPvBxHAIsmXswZKocGu+AU= @@ -43,6 +45,7 @@ github.com/onsi/ginkgo v1.12.1/go.mod h1:zj2OWP4+oCPe1qIXoGWkgMRwljMUYCdkwsT2108 github.com/onsi/ginkgo v1.16.4/go.mod h1:dX+/inL/fNMqNlz0e9LfyB9TswhZpCVdJM/Z6Vvnwo0= github.com/onsi/ginkgo v1.16.5 h1:8xi0RTUf59SOSfEtZMvwTvXYMzG4gV23XVHOZiXNtnE= github.com/onsi/ginkgo v1.16.5/go.mod h1:+E8gABHa3K6zRBolWtd+ROzc/U5bkGt0FwiG042wbpU= +github.com/onsi/ginkgo/v2 v2.1.3 h1:e/3Cwtogj0HA+25nMP1jCMDIf8RtRYbGwGGuBIFztkc= github.com/onsi/ginkgo/v2 v2.1.3/go.mod h1:vw5CSIxN1JObi/U8gcbwft7ZxR2dgaR70JSE3/PpL4c= github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7JYyY= github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1ybHNo= @@ -98,6 +101,7 @@ golang.org/x/tools v0.0.0-20201224043029-2b0845dc783e/go.mod h1:emZCQorbCU4vsT4f golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= @@ -106,7 +110,9 @@ google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miE google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo= google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.26.0 h1:bxAC2xTBsZGibn2RTntX0oH50xLsqy1OxA9tTL3p/lk= google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys= gopkg.in/jarcoal/httpmock.v1 v1.0.0-20180719183105-8007e27cdb32 h1:30DLrQoRqdUHslVMzxuKUnY4GKJGk1/FJtKy3yx4TKE= From 96b56633f2e3c282d741ce59b27aa499c2a386b1 Mon Sep 17 00:00:00 2001 From: Jareth Gomes Date: Sat, 25 Jun 2022 16:47:46 -0500 Subject: [PATCH 5/5] Updated README --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 24b0836..84fab39 100644 --- a/README.md +++ b/README.md @@ -65,11 +65,22 @@ AS OF 10/28/15 **/ func DELETE(w http.ResponseWriter, url string, format string, token string, r *http.Request) ``` +```go +/** + * Pass the http Request from the client and the ResponseWriter it expects. + * Pass the target url of the backend service (not the url the client called). + * Pass a authorization token (optional). + * Will first attempt to establish a websocket connection on microservice, then + * upgrade the client connection. + * Returns once either websocket connection closes. + **/ +func ProxyWebsocket(w http.ResponseWriter, url string, format string, token string, r *http.Request) +``` All secret data should be kept in a file called config.go in the config directory ### Install -> Minimum supported version is Go 1.8 +> Minimum supported version is Go 1.13 ```sh go get -u github.com/arbor-dev/arbor/...