Merge pull request #26 from speakeasy-api/ad/devex

update: devex

Author: alexadrake

.gitignore

@@ -11,3 +11,4 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+.idea

README.md

@@ -55,10 +55,20 @@ func main() {
 }
 ```
 
+**Note:** Additional middlewares are provided for different routers.
+
 Build and deploy your app and that's it. Your API is being tracked in the Speakeasy workspace you just created
 and will be visible on the dashboard next time you log in. Visit our [docs site](https://docs.speakeasyapi.dev/) to
 learn more.
 
+#### Mux-based routers
+
+For middlewares based on the net/http `ServeMux` interface, use `speakeasy.MiddlewareWithMux`.
+
+#### Gin
+
+For the [gin](https://github.com/gin-gonic/gin) framework, use `speakeasy.GinMiddlware`.
+
 ### Advanced configuration
 
 The Speakeasy SDK provides both a global and per Api configuration option. If you want to use the SDK to track multiple Apis or Versions from the same service you can configure individual instances of the SDK, like so:
@@ -118,9 +128,10 @@ To help the SDK in these situations you can provide path hints per request handl
 ```go
 func MyHandler(w http.ResponseWriter, r *http.Request) {
 	// Provide a path hint for the request using the OpenAPI Path Templating format: https://swagger.io/specification/#path-templating-matching
-	ctrl := speakeasy.MiddlewareController(req)
-	ctrl.PathHint("/v1/users/{id}")
-	
+	ctrl, ok := speakeasy.MiddlewareController(req)
+	if ok {
+	    ctrl.PathHint("/v1/users/{id}")
+    }
 	// the rest of your handlers code
 }
 ```
@@ -138,9 +149,10 @@ To help associate requests with customers/users of your APIs you can provide a c
 
 ```go
 func MyHandler(w http.ResponseWriter, r *http.Request) {
-	ctrl := speakeasy.MiddlewareController(req)
-	ctrl.CustomerID("a-customers-id") // This customer ID will be used to associate this instance of a request with your customers/users
-	
+	ctrl, ok := speakeasy.MiddlewareController(req)
+    if ok {
+        ctrl.CustomerID("a-customers-id") // This customer ID will be used to associate this instance of a request with your customers/users
+    }
 	// the rest of your handlers code
 }
 ```
@@ -157,7 +169,7 @@ But if you would like to be more selective you can mask certain sensitive data u
 
 ```go
 func MyHandler(w http.ResponseWriter, r *http.Request) {
-	ctrl := speakeasy.MiddlewareController(req)
+	ctrl, _ := speakeasy.MiddlewareController(req)
 	ctrl.Masking(speakeasy.WithRequestHeaderMask("Authorization")) // Mask the Authorization header in the request
 
 	// the rest of your handlers code
@@ -190,7 +202,7 @@ r.Use(speakeasy.Middleware)
 r.Use(func (next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		// Mask the Authorization header in the request for all requests served by this middleware
-		ctrl := speakeasy.MiddlewareController(req)
+		ctrl, _ := speakeasy.MiddlewareController(req)
 		ctrl.Masking(speakeasy.WithRequestHeaderMask("Authorization"))
 	})
 })
@@ -233,7 +245,7 @@ accessToken, err := storeSDKInstance.GetEmbedAccessToken(ctx, &embedaccesstoken.
 
 // Or finally if you have a handler that you would like to generate an access token from, you can get the SDK instance for that handler from the middleware controller and use the `GetEmbedAccessToken` function it.
 func MyHandler(w http.ResponseWriter, r *http.Request) {
-	ctrl := speakeasy.MiddlewareController(req)
+	ctrl, _ := speakeasy.MiddlewareController(req)
 	accessToken, err := ctrl.GetSDKInstance().GetEmbedAccessToken(ctx, &embedaccesstoken.EmbedAccessTokenRequest{
 		Filters: []*embedaccesstoken.EmbedAccessTokenRequest_Filter{
 			{

controller.go

@@ -224,9 +224,9 @@ type controller struct {
 
 // MiddlewareController will return the speakeasy middleware controller from the current request,
 // if the current request is monitored by the speakeasy middleware.
-func MiddlewareController(r *http.Request) *controller {
+func MiddlewareController(r *http.Request) (*controller, bool) {
 	c, _ := r.Context().Value(controllerKey).(*controller)
-	return c
+	return c, c != nil
 }
 
 // PathHint will allow you to provide a path hint for the current request.

middleware_test.go

@@ -72,7 +72,7 @@ type test struct {
 	Name    string `json:"name"`
 	Fields  fields `json:"fields"`
 	Args    args   `json:"args"`
-	WantHAR string
+	WantHAR string `json:"want_har"`
 }
 
 const (
@@ -159,7 +159,7 @@ func TestSpeakeasy_Middleware_Capture_Success(t *testing.T) {
 			})
 
 			h := sdkInstance.Middleware(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
-				ctrl := speakeasy.MiddlewareController(req)
+				ctrl, _ := speakeasy.MiddlewareController(req)
 
 				if tt.Args.QueryStringMasks != nil {
 					for k, v := range tt.Args.QueryStringMasks {
@@ -457,7 +457,7 @@ func TestSpeakeasy_Middleware_GorillaMux_PathHint_Success(t *testing.T) {
 
 			r.Methods(http.MethodGet).Path(tt.args.path).HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 				if tt.args.devHint != "" {
-					ctrl := speakeasy.MiddlewareController(req)
+					ctrl, _ := speakeasy.MiddlewareController(req)
 					require.NotNil(t, ctrl)
 					ctrl.PathHint(tt.args.devHint)
 				}
@@ -657,7 +657,7 @@ func TestSpeakeasy_GinMiddleware_Success(t *testing.T) {
 			r.Use(sdkInstance.GinMiddleware)
 
 			r.Any("/*path", func(ctx *gin.Context) {
-				ctrl := speakeasy.MiddlewareController(ctx.Request)
+				ctrl, _ := speakeasy.MiddlewareController(ctx.Request)
 
 				if tt.Args.QueryStringMasks != nil {
 					for k, v := range tt.Args.QueryStringMasks {
@@ -834,7 +834,7 @@ func TestSpeakeasy_GinMiddleware_PathHint_Success(t *testing.T) {
 
 			r.Handle(http.MethodGet, tt.args.path, func(ctx *gin.Context) {
 				if tt.args.devHint != "" {
-					ctrl := speakeasy.MiddlewareController(ctx.Request)
+					ctrl, _ := speakeasy.MiddlewareController(ctx.Request)
 					require.NotNil(t, ctrl)
 					ctrl.PathHint(tt.args.devHint)
 				}
@@ -897,7 +897,7 @@ func TestSpeakeasy_EchoMiddleware_Success(t *testing.T) {
 			r.Use(sdkInstance.EchoMiddleware)
 
 			r.Any("/*", func(c echo.Context) error {
-				ctrl := speakeasy.MiddlewareController(c.Request())
+				ctrl, _ := speakeasy.MiddlewareController(c.Request())
 
 				if tt.Args.QueryStringMasks != nil {
 					for k, v := range tt.Args.QueryStringMasks {
@@ -1075,7 +1075,7 @@ func TestSpeakeasy_EchoMiddleware_PathHint_Success(t *testing.T) {
 			r.Use(sdkInstance.EchoMiddleware)
 			r.Match([]string{http.MethodGet}, tt.args.path, func(c echo.Context) error {
 				if tt.args.devHint != "" {
-					ctrl := speakeasy.MiddlewareController(c.Request())
+					ctrl, _ := speakeasy.MiddlewareController(c.Request())
 					require.NotNil(t, ctrl)
 					ctrl.PathHint(tt.args.devHint)
 				}
@@ -1149,7 +1149,7 @@ func TestSpeakeasy_Middleware_Capture_CustomerID_Success(t *testing.T) {
 			assert.NoError(t, err)
 
 			sdkInstance.Middleware(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
-				ctrl := speakeasy.MiddlewareController(req)
+				ctrl, _ := speakeasy.MiddlewareController(req)
 				require.NotNil(t, ctrl)
 				ctrl.CustomerID(tt.args.customerID)