Merge pull request #17 from speakeasy-api/feature/spe-369

feat: support getting embed access token

Author: TristanSpeakEasy

README.md

@@ -54,7 +54,6 @@ Build and deploy your app and that's it. Your API is being tracked in the Speake
 and will be visible on the dashboard next time you log in. Visit our [docs site](https://docs.speakeasyapi.dev/) to
 learn more.
 
-
 ### 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:
@@ -128,8 +127,6 @@ Wildcard path matching in Echo & Chi will end up with a OpenAPI path paramater c
 
 And in the above example a path like `/user/1/path/some/sub/path` won't match but `/user/1/path/somesubpathstring` will, as `/` characters are not matched in path paramters by the OpenAPI spec.
 
-
-
 ## Capturing Customer IDs
 
 To help associate requests with customers/users of your APIs you can provide a customer ID per request handler:
@@ -193,3 +190,55 @@ r.Use(func (next http.Handler) http.Handler {
 	})
 })
 ```
+
+## Embedded Request Viewer Access Tokens
+
+The Speakeasy SDK can generate access tokens for the [Embedded Request Viewer](https://docs.speakeasyapi.dev/speakeasy-user-guide/request-viewer/embedded-request-viewer) that can be used to view requests captured by the SDK.
+
+For documentation on how to configure filters, find that [HERE](https://docs.speakeasyapi.dev/speakeasy-user-guide/request-viewer/embedded-request-viewer).
+
+Below are some examples on how to generate access tokens:
+
+```go
+import "github.com/speakeasy-api/speakeasy-schemas/grpc/go/registry/embedaccesstoken"
+
+ctx := context.Background()
+
+// If the SDK is configured as a global instance, an access token can be generated using the `GenerateAccessToken` function on the speakeasy package.
+accessToken, err := speakeasy.GetEmbedAccessToken(ctx, &embedaccesstoken.EmbedAccessTokenRequest{
+	Filters: []*embedaccesstoken.EmbedAccessTokenRequest_Filter{
+		{
+			Key:   "customer_id",
+			Operator: "=",
+			Value: "a-customer-id",
+		},
+	},
+})
+
+// If you have followed the `Advanced Configuration` section above you can also generate an access token using the `GenerateAccessToken` function on the sdk instance.
+accessToken, err := storeSDKInstance.GetEmbedAccessToken(ctx, &embedaccesstoken.EmbedAccessTokenRequest{
+	Filters: []*embedaccesstoken.EmbedAccessTokenRequest_Filter{
+		{
+			Key:   "customer_id",
+			Operator: "=",
+			Value: "a-customer-id",
+		},
+	},
+})
+
+// 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)
+	accessToken, err := ctrl.GetSDKInstance().GetEmbedAccessToken(ctx, &embedaccesstoken.EmbedAccessTokenRequest{
+		Filters: []*embedaccesstoken.EmbedAccessTokenRequest_Filter{
+			{
+				Key:   "customer_id",
+				Operator: "=",
+				Value: "a-customer-id",
+			},
+		},
+	})
+	
+	// the rest of your handlers code
+}
+```

capture.go

@@ -49,7 +49,7 @@ func (s *Speakeasy) handleRequestResponseError(w http.ResponseWriter, r *http.Re
 		r.Body = ioutil.NopCloser(tee)
 	}
 
-	ctx, c := contextWithController(r.Context())
+	ctx, c := contextWithController(r.Context(), s)
 	r = r.WithContext(ctx)
 
 	err := next(cw.GetResponseWriter(), r)
@@ -83,7 +83,7 @@ func (s *Speakeasy) captureRequestResponse(cw *captureWriter, r *http.Request, s
 		return
 	}
 
-	s.sendToIngest(ctx, &ingest.IngestRequest{
+	s.grpcClient.SendToIngest(ctx, &ingest.IngestRequest{
 		Har:        string(harData),
 		PathHint:   pathHint,
 		ApiId:      s.config.ApiID,

controller.go

@@ -219,6 +219,7 @@ type controller struct {
 	responseCookieMasks      map[string]string
 	responseFieldMasksString map[string]string
 	responseFieldMasksNumber map[string]string
+	sdkInstance              *Speakeasy
 }
 
 // MiddlewareController will return the speakeasy middleware controller from the current request,
@@ -244,7 +245,11 @@ func (c *controller) Masking(opts ...MaskingOption) {
 	}
 }
 
-func contextWithController(ctx context.Context) (context.Context, *controller) {
+func (c *controller) GetSDKInstance() *Speakeasy {
+	return c.sdkInstance
+}
+
+func contextWithController(ctx context.Context, sdk *Speakeasy) (context.Context, *controller) {
 	c := &controller{
 		queryStringMasks:         make(map[string]string),
 		requestHeaderMasks:       make(map[string]string),
@@ -255,6 +260,7 @@ func contextWithController(ctx context.Context) (context.Context, *controller) {
 		responseCookieMasks:      make(map[string]string),
 		responseFieldMasksString: make(map[string]string),
 		responseFieldMasksNumber: make(map[string]string),
+		sdkInstance:              sdk,
 	}
 	return context.WithValue(ctx, controllerKey, c), c
 }

controller_test.go

@@ -89,7 +89,7 @@ func TestWithQueryStringMask(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			_, c := contextWithController(context.Background())
+			_, c := contextWithController(context.Background(), nil)
 			c.Masking(WithQueryStringMask(tt.args.keys, tt.args.masks...))
 			assert.Equal(t, tt.wantQueryStringMasks, c.queryStringMasks)
 		})

go.mod

@@ -13,7 +13,7 @@ require (
 	github.com/go-chi/chi/v5 v5.0.7
 	github.com/gorilla/mux v1.8.0
 	github.com/labstack/echo/v4 v4.7.2
-	github.com/speakeasy-api/speakeasy-schemas v1.2.0
+	github.com/speakeasy-api/speakeasy-schemas v1.3.0
 	go.uber.org/zap v1.21.0
 	google.golang.org/grpc v1.48.0
 )

go.sum

@@ -117,6 +117,8 @@ github.com/rogpeppe/go-internal v1.8.0 h1:FCbCCtXNOY3UtUuHUYaghJg4y7Fd14rXifAYUA
 github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE=
 github.com/speakeasy-api/speakeasy-schemas v1.2.0 h1:raBOAba2M3ll9Xdw8yuJohtukonm3r9NytQqMFCSlOY=
 github.com/speakeasy-api/speakeasy-schemas v1.2.0/go.mod h1:g6NfrOjYLCJZp81ZLY2ksF7afC9BW9bL4Bg1V1oAFlw=
+github.com/speakeasy-api/speakeasy-schemas v1.3.0 h1:7Arm2d0/K9owEBQPmNon1KPERmf58g0Eg/NmPgXaEY0=
+github.com/speakeasy-api/speakeasy-schemas v1.3.0/go.mod h1:g6NfrOjYLCJZp81ZLY2ksF7afC9BW9bL4Bg1V1oAFlw=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=

middleware.go

@@ -19,6 +19,8 @@ func Middleware(next http.Handler) http.Handler {
 // Middleware setups the current instance of the SDK to start capturing requests from routers that support http.Handlers.
 // Currently only gorilla/mux, go-chi/chi routers and the http.DefaultServerMux are supported for automatically
 // capturing path hints. Otherwise path hints can be supplied by a handler through the speakeasy MiddlewareController.
+//
+//nolint:contextcheck
 func (s *Speakeasy) Middleware(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		s.handleRequestResponse(w, r, next.ServeHTTP, func(r *http.Request) string {

speakeasy.go

@@ -7,6 +7,8 @@ import (
 	"net"
 	"os"
 	"regexp"
+
+	"github.com/speakeasy-api/speakeasy-schemas/grpc/go/registry/embedaccesstoken"
 )
 
 var (
@@ -27,7 +29,7 @@ const (
 )
 
 var (
-	speakeasyVersion = "1.2.0" // TODO get this from CI
+	speakeasyVersion = "1.3.0" // TODO get this from CI
 	serverURL        = "grpc.prod.speakeasyapi.dev:443"
 
 	defaultInstance *Speakeasy
@@ -55,9 +57,8 @@ type Config struct {
 // Don't instantiate this directly, use Configure() or New() instead.
 type Speakeasy struct {
 	config     Config
-	serverURL  string
-	secure     bool
 	harBuilder harBuilder
+	grpcClient *GRPCClient
 }
 
 // Configure allows you to configure the default instance of the Speakeasy SDK.
@@ -76,6 +77,14 @@ func New(config Config) *Speakeasy {
 	return s
 }
 
+func GetEmbedAccessToken(ctx context.Context, req *embedaccesstoken.EmbedAccessTokenRequest) (string, error) {
+	return defaultInstance.GetEmbedAccessToken(ctx, req)
+}
+
+func (s *Speakeasy) GetEmbedAccessToken(ctx context.Context, req *embedaccesstoken.EmbedAccessTokenRequest) (string, error) {
+	return s.grpcClient.GetEmbedAccessToken(ctx, req)
+}
+
 func (s *Speakeasy) configure(cfg Config) {
 	mustValidateConfig(cfg)
 
@@ -96,10 +105,9 @@ func (s *Speakeasy) configure(cfg Config) {
 		secure = false
 	}
 
-	s.serverURL = configuredServerURL
-	s.secure = secure
-
 	s.config = cfg
+
+	s.grpcClient = newGRPCClient(s.config.APIKey, configuredServerURL, secure, s.config.GRPCDialer)
 }
 
 func mustValidateConfig(cfg Config) {

speakeasy_exports_test.go

@@ -9,9 +9,9 @@ func (s *Speakeasy) ExportGetSpeakeasyConfig() Config {
 }
 
 func (s *Speakeasy) ExportGetSpeakeasyServerURL() string {
-	return s.serverURL
+	return s.grpcClient.serverURL
 }
 
 func (s *Speakeasy) ExportGetSpeakeasyServerSecure() bool {
-	return s.secure
+	return s.grpcClient.secure
 }

testdata/captures_basic_request_and_no_response_body_output.json

@@ -3,7 +3,7 @@
     "version": "1.2",
     "creator": {
       "name": "speakeasy-go-sdk",
-      "version": "1.2.0"
+      "version": "1.3.0"
     },
     "entries": [
       {