https://github.com/mashiike/elevate
elevate is a package that bridges AWS WebSocket API events to the Golang http.Handler interface, for AWS Lambda Function
https://github.com/mashiike/elevate
Last synced: 3 months ago
JSON representation
elevate is a package that bridges AWS WebSocket API events to the Golang http.Handler interface, for AWS Lambda Function
- Host: GitHub
- URL: https://github.com/mashiike/elevate
- Owner: mashiike
- License: mit
- Created: 2023-12-27T09:06:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-01T20:17:10.000Z (about 1 year ago)
- Last Synced: 2024-05-01T16:15:21.864Z (about 1 year ago)
- Language: Go
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# elevate
AWS Lambda Websocket API Proxy integration event bridge to Go net/http.
## Usage
elevate is a bridge to convert API Gateway Websocket API with AWS Lambda Proxy integration event request/response and net/http.Request and net/http.ResponseWriter.
```go
package main
import (
"encoding/json"
"net/http"
"github.com/mashiike/elevate"
)
func handler(w http.ResponseWriter, req *http.Request) {
connectionID := elevate.ConnectionID(req)
switch elevate.RouteKey(req) {
case "$connect":
// do something on connect websocket, for example, store connection id to database.
w.WriteHeader(http.StatusOK) // return 200 OK, success to connect.
case "$disconnect":
// do something on disconnect websocket, for example, delete connection id from database.
w.WriteHeader(http.StatusOK) // return 200 OK, success to disconnect.
case "$default":
// do something on default route
w.WriteHeader(http.StatusOK)
w.Write([]byte(connectionID))
case "notify":
// default RouteKeySelector emulates $request.body.action
var data struct {
Action string `json:"action"`
Targets []string `json:"targets"`
Message string `json:"message"`
}
if err := json.NewDecoder(req.Body).Decode(&data); err != nil {
w.WriteHeader(http.StatusBadRequest)
w.Write([]byte(http.StatusText(http.StatusBadRequest)))
return
}
for _, target := range data.Targets {
if err := elevate.PostToConnection(req.Context(), target, []byte(data.Message)); err != nil {
if elevate.ConnectionIsGone(err) {
continue
}
w.WriteHeader(http.StatusInternalServerError)
w.Write([]byte(http.StatusText(http.StatusInternalServerError)))
return
}
}
w.WriteHeader(http.StatusOK)
w.Write([]byte("ok"))
}
}
func main() {
elevate.Run(http.HandlerFunc(handler))
}
```
## `elevate.Run(http.Handler)` and `elevate.RunWithOptions(http.Handler, ...elevate.Options)`
`elevate.Run(http.Handler)` and `elevate.RunWithOptions(http.Handler, ...elevate.Options)` works as below.
- if running on AWS Lambda(defined `AWS_LAMBDA_FUNCTION_NAME` or `AWS_EXECUTION_ENV` environment variable)
- Call `lambda.StartWithOptions()`
- otherwise, run as net/http server with websocket handler.
- default address `ws://localhost:8080/` , you can change `elevate.WithLocalAddress(address)` option.
- default route key selector emulates `$request.body.action` , you can change `elevate.WithRouteKeySelector(selector)` option.
## `@connections API`
`elevate.NewManagementAPIClient()` returns `github.com/aws/aws-sdk-go-v2/service/apigatewaymanagementapi/apigatewaymanagementapiiface.Client`.
you can use `@connections API` with this client.
and elevate provides suger methods.
- `elevate.PostToConnection(ctx context.Context, connectionID string, data []byte) error`
- `elevate.DeleteConnection(ctx context.Context, connectionID string) error`
- `elevate.GetConnection(ctx context.Context, connectionID string) (*apigatewaymanagementapi.GetConnectionOutput, error)`
if connection not found, this client return err `GoneException`.
suger methods of check this error and return `true` if connection is not found.
## ConnectionID and RouteKey, API Gateway Proxy Request Context
In handler, you can get `ConnectionID` and `RouteKey` from `*http.Request`.
```go
connectionID := elevate.ConnectionID(req)
routeKey := elevate.RouteKey(req)
```
this is suger interface of `elevate.ProxyRequestContext(req).ConnectionID` and `elevate.ProxyRequestContext(req).RouteKey`.
## License
MIT