wip

interceptors/README.md

@@ -24,16 +24,14 @@ type InterceptorInfo struct {
     Method string
     Endpoint Endpoint
     Payload any
-    Result any // Only set for server-side result interceptors and client-side response interceptors
-    Error error // Only set for server-side result interceptors and client-side response interceptors
 }
 ```
 
 Example Server-side request interceptor:
 
 Design:
 ```go
-var DecodeTenant = ServerRequestInterceptor("DecodeTenant", func() {
+var DecodeTenant = Interceptor("DecodeTenant", func() {
    Description("Server-side interceptor which extracts the tenant ID from the JWT contained in the request Authorization header.")
    Read("auth")
    Write("tenantID")
@@ -55,7 +53,7 @@ Example Client-side response interceptor:
 
 Design:
 ```go
-var Retry = ClientResponseInterceptor("Retry", func() {
+var Retry = Interceptor("Retry", func() {
 	Description("Client-side interceptor which retries the request if it fails in a retryable manner")
 })
 ```

interceptors/design/design.go

@@ -4,30 +4,45 @@ import (
 	. "goa.design/goa/v3/dsl"
 )
 
-// var EncodeTenant = Interceptor("EncodeTenant", func() {
-// 	Description("Client-side interceptor which writes the tenant ID to the JWT contained in the Authorization header")
-// 	Read("tenantID")
-// 	Write("auth")
-// })
-
-// var DecodeTenant = Interceptor("DecodeTenant", func() {
-// 	Description("Server-side interceptor which extracts the tenant ID from the JWT contained in the request Authorization header.")
-// 	Read("auth")
-// 	Write("tenantID")
-// })
-
-// var Cache = Interceptor("Cache", func() {
-// 	Description("Server-side interceptor which implements a transparent cache for the loaded records")
-// 	Read("id")
-// })
-
-// var SetDeadline = Interceptor("SetDeadline", func() {
-// 	Description("Server-side interceptor which sets the context deadline for the request")
-// })
-
-// var Retry = Interceptor("Retry", func() {
-// 	Description("Client-side interceptor which retries the request if it fails in a retryable manner")
-// })
+var EncodeTenant = Interceptor("EncodeTenant", func() {
+	Description("Client-side interceptor which writes the tenant ID to the signed JWT contained in the Authorization header")
+
+	ReadPayload(func() {
+		Attribute("tenantID", String, "Tenant ID to encode")
+	})
+
+	WritePayload(func() {
+		Attribute("auth", String, "Generated JWT auth token")
+	})
+})
+
+var ValidateTenant = Interceptor("ValidateTenant", func() {
+	Description("Server-side interceptor which extracts the tenant ID from the signed JWT contained in the request Authorization header and validates that it matches the tenant ID in the request payload")
+
+	ReadPayload(func() {
+		Attribute("auth", String, "JWT auth token")
+	})
+})
+
+var Cache = Interceptor("Cache", func() {
+	Description("Server-side interceptor which implements a transparent cache for the loaded records")
+
+	ReadPayload(func() {
+		Attribute("id", String, "Record ID to cache")
+	})
+
+	WriteResult(func() {
+		Attribute("cachedAt", String, "Time at which the record was cached in RFC3339 format")
+	})
+})
+
+var SetDeadline = Interceptor("SetDeadline", func() {
+	Description("Server-side interceptor which sets the context deadline for the request")
+})
+
+var Retry = Interceptor("Retry", func() {
+	Description("Client-side interceptor which retries the request if it fails in a retryable manner")
+})
 
 var _ = Service("example", func() {
 	Description(`The example service demonstrates how to use interceptors. In this example we assume 
@@ -36,8 +51,9 @@ The example uses interceptors to extract the tenant ID from the JWT and add it t
 interceptors to implement a transparent cache for the loaded records.`)
 
 	Method("get_record", func() {
-		// ClientInterceptorChain(EncodeTenant, Retry)
-		// ServerInterceptorChain(SetDeadline, DecodeTenant, Cache)
+		ClientInterceptor(EncodeTenant, Retry)
+		ServerInterceptor(SetDeadline, ValidateTenant, Cache)
+
 		Payload(GetRecordPayload)
 
 		Result(Record)
@@ -62,5 +78,8 @@ var Record = Type("Record", func() {
 	Field(1, "tenantID", String, "The ID of the tenant where the record is located extracted from the JWT contained in the Authorization header")
 	Field(2, "recordID", String, "The ID of the record to fetch extracted from the JWT contained in the Authorization header")
 	Field(3, "fullName", String, "Record full name")
-	Required("tenantID", "recordID", "fullName")
+	Field(4, "cachedAt", String, "Time at which the record was cached in RFC3339 format", func() {
+		Format(FormatDateTime)
+	})
+	Required("tenantID", "recordID", "fullName", "cachedAt")
 })