From 890c2862327e959411671001c8cc59b319ea57c0 Mon Sep 17 00:00:00 2001 From: Ollie Phillips Date: Fri, 29 Mar 2019 10:36:20 +0000 Subject: api before/after response hooks --- system/api/handlers.go | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++ system/item/item.go | 27 ++++++++++++++----- 2 files changed, 93 insertions(+), 7 deletions(-) diff --git a/system/api/handlers.go b/system/api/handlers.go index 20356e9..29707fe 100644 --- a/system/api/handlers.go +++ b/system/api/handlers.go @@ -100,7 +100,31 @@ func contentsHandler(res http.ResponseWriter, req *http.Request) { return } + // assert hookable + get := it() + hook, ok := get.(item.Hookable) + if !ok { + log.Println("[Response] error: Type", t, "does not implement item.Hookable or embed item.Item.") + res.WriteHeader(http.StatusBadRequest) + return + } + + // hook before response + err = hook.BeforeAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling BeforeAPIResponse:", err) + res.WriteHeader(http.StatusInternalServerError) + return + } + sendData(res, req, j) + + // hook after response + err = hook.AfterAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling AfterAPIResponse:", err) + return + } } func contentHandler(res http.ResponseWriter, req *http.Request) { @@ -156,7 +180,31 @@ func contentHandler(res http.ResponseWriter, req *http.Request) { return } + // assert hookable + get := p + hook, ok := get.(item.Hookable) + if !ok { + log.Println("[Response] error: Type", t, "does not implement item.Hookable or embed item.Item.") + res.WriteHeader(http.StatusBadRequest) + return + } + + // hook before response + err = hook.BeforeAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling BeforeAPIResponse:", err) + res.WriteHeader(http.StatusInternalServerError) + return + } + sendData(res, req, j) + + // hook after response + err = hook.AfterAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling AfterAPIResponse:", err) + return + } } func contentHandlerBySlug(res http.ResponseWriter, req *http.Request) { @@ -206,7 +254,32 @@ func contentHandlerBySlug(res http.ResponseWriter, req *http.Request) { return } + // assert hookable + get := p + hook, ok := get.(item.Hookable) + if !ok { + log.Println("[Response] error: Type", t, "does not implement item.Hookable or embed item.Item.") + res.WriteHeader(http.StatusBadRequest) + return + } + + // hook before response + err = hook.BeforeAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling BeforeAPIResponse:", err) + res.WriteHeader(http.StatusInternalServerError) + return + } + sendData(res, req, j) + + // hook after response + err = hook.AfterAPIResponse(res, req) + if err != nil { + log.Println("[Response] error calling AfterAPIResponse:", err) + return + } + } func uploadsHandler(res http.ResponseWriter, req *http.Request) { diff --git a/system/item/item.go b/system/item/item.go index 1108ae0..51ac2a9 100644 --- a/system/item/item.go +++ b/system/item/item.go @@ -24,13 +24,13 @@ func init() { // We store the compiled regex as the key // and assign the replacement as the map's value. rxList = map[*regexp.Regexp][]byte{ - regexp.MustCompile("`[-]+`"): []byte("-"), - regexp.MustCompile("[[:space:]]"): []byte("-"), - regexp.MustCompile("[[:blank:]]"): []byte(""), - regexp.MustCompile("`[^a-z0-9]`i"): []byte("-"), - regexp.MustCompile("[!/:-@[-`{-~]"): []byte(""), - regexp.MustCompile("/[^\x20-\x7F]/"): []byte(""), - regexp.MustCompile("`&(amp;)?#?[a-z0-9]+;`i"): []byte("-"), + regexp.MustCompile("`[-]+`"): []byte("-"), + regexp.MustCompile("[[:space:]]"): []byte("-"), + regexp.MustCompile("[[:blank:]]"): []byte(""), + regexp.MustCompile("`[^a-z0-9]`i"): []byte("-"), + regexp.MustCompile("[!/:-@[-`{-~]"): []byte(""), + regexp.MustCompile("/[^\x20-\x7F]/"): []byte(""), + regexp.MustCompile("`&(amp;)?#?[a-z0-9]+;`i"): []byte("-"), regexp.MustCompile("`&([a-z])(acute|uml|circ|grave|ring|cedil|slash|tilde|caron|lig|quot|rsquo);`i"): []byte("\\1"), } } @@ -65,6 +65,9 @@ type Sortable interface { // to the different lifecycles/events a struct may encounter. Item implements // Hookable with no-ops so our user can override only whichever ones necessary. type Hookable interface { + BeforeAPIResponse(http.ResponseWriter, *http.Request) error + AfterAPIResponse(http.ResponseWriter, *http.Request) error + BeforeAPICreate(http.ResponseWriter, *http.Request) error AfterAPICreate(http.ResponseWriter, *http.Request) error @@ -177,6 +180,16 @@ func (i Item) String() string { return fmt.Sprintf("Item ID: %s", i.UniqueID()) } +// BeforeAPIResponse is a no-op to ensure structs which embed Item implement Hookable +func (i Item) BeforeAPIResponse(res http.ResponseWriter, req *http.Request) error { + return nil +} + +// AfterAPIResponse is a no-op to ensure structs which embed Item implement Hookable +func (i Item) AfterAPIResponse(res http.ResponseWriter, req *http.Request) error { + return nil +} + // BeforeAPICreate is a no-op to ensure structs which embed Item implement Hookable func (i Item) BeforeAPICreate(res http.ResponseWriter, req *http.Request) error { return nil -- cgit v1.2.3 From 7063494d6c82e784878b6fca79e9442c43578954 Mon Sep 17 00:00:00 2001 From: Ollie Phillips Date: Fri, 29 Mar 2019 12:05:42 +0000 Subject: passing data to hooks --- system/api/handlers.go | 12 ++++++------ system/item/item.go | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/system/api/handlers.go b/system/api/handlers.go index 29707fe..41c7ee5 100644 --- a/system/api/handlers.go +++ b/system/api/handlers.go @@ -110,7 +110,7 @@ func contentsHandler(res http.ResponseWriter, req *http.Request) { } // hook before response - err = hook.BeforeAPIResponse(res, req) + j, err = hook.BeforeAPIResponse(res, req, j) if err != nil { log.Println("[Response] error calling BeforeAPIResponse:", err) res.WriteHeader(http.StatusInternalServerError) @@ -120,7 +120,7 @@ func contentsHandler(res http.ResponseWriter, req *http.Request) { sendData(res, req, j) // hook after response - err = hook.AfterAPIResponse(res, req) + _, err = hook.AfterAPIResponse(res, req, j) if err != nil { log.Println("[Response] error calling AfterAPIResponse:", err) return @@ -190,7 +190,7 @@ func contentHandler(res http.ResponseWriter, req *http.Request) { } // hook before response - err = hook.BeforeAPIResponse(res, req) + j, err = hook.BeforeAPIResponse(res, req, j) if err != nil { log.Println("[Response] error calling BeforeAPIResponse:", err) res.WriteHeader(http.StatusInternalServerError) @@ -200,7 +200,7 @@ func contentHandler(res http.ResponseWriter, req *http.Request) { sendData(res, req, j) // hook after response - err = hook.AfterAPIResponse(res, req) + _, err = hook.AfterAPIResponse(res, req, j) if err != nil { log.Println("[Response] error calling AfterAPIResponse:", err) return @@ -264,7 +264,7 @@ func contentHandlerBySlug(res http.ResponseWriter, req *http.Request) { } // hook before response - err = hook.BeforeAPIResponse(res, req) + j, err = hook.BeforeAPIResponse(res, req, j) if err != nil { log.Println("[Response] error calling BeforeAPIResponse:", err) res.WriteHeader(http.StatusInternalServerError) @@ -274,7 +274,7 @@ func contentHandlerBySlug(res http.ResponseWriter, req *http.Request) { sendData(res, req, j) // hook after response - err = hook.AfterAPIResponse(res, req) + _, err = hook.AfterAPIResponse(res, req, j) if err != nil { log.Println("[Response] error calling AfterAPIResponse:", err) return diff --git a/system/item/item.go b/system/item/item.go index 51ac2a9..8be21ae 100644 --- a/system/item/item.go +++ b/system/item/item.go @@ -65,8 +65,8 @@ type Sortable interface { // to the different lifecycles/events a struct may encounter. Item implements // Hookable with no-ops so our user can override only whichever ones necessary. type Hookable interface { - BeforeAPIResponse(http.ResponseWriter, *http.Request) error - AfterAPIResponse(http.ResponseWriter, *http.Request) error + BeforeAPIResponse(http.ResponseWriter, *http.Request, []byte) ([]byte, error) + AfterAPIResponse(http.ResponseWriter, *http.Request, []byte) ([]byte, error) BeforeAPICreate(http.ResponseWriter, *http.Request) error AfterAPICreate(http.ResponseWriter, *http.Request) error @@ -181,13 +181,13 @@ func (i Item) String() string { } // BeforeAPIResponse is a no-op to ensure structs which embed Item implement Hookable -func (i Item) BeforeAPIResponse(res http.ResponseWriter, req *http.Request) error { - return nil +func (i Item) BeforeAPIResponse(res http.ResponseWriter, req *http.Request, data []byte) ([]byte, error) { + return data, nil } // AfterAPIResponse is a no-op to ensure structs which embed Item implement Hookable -func (i Item) AfterAPIResponse(res http.ResponseWriter, req *http.Request) error { - return nil +func (i Item) AfterAPIResponse(res http.ResponseWriter, req *http.Request, data []byte) ([]byte, error) { + return data, nil } // BeforeAPICreate is a no-op to ensure structs which embed Item implement Hookable -- cgit v1.2.3 From 878d593ef5da1435c83bf7bb229f8619c1cab9ff Mon Sep 17 00:00:00 2001 From: Ollie Phillips Date: Thu, 4 Apr 2019 15:30:15 +0100 Subject: removed []byte return on AfterAPIResponse, not needed) --- system/api/handlers.go | 6 +++--- system/item/item.go | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/system/api/handlers.go b/system/api/handlers.go index 41c7ee5..99db799 100644 --- a/system/api/handlers.go +++ b/system/api/handlers.go @@ -120,7 +120,7 @@ func contentsHandler(res http.ResponseWriter, req *http.Request) { sendData(res, req, j) // hook after response - _, err = hook.AfterAPIResponse(res, req, j) + err = hook.AfterAPIResponse(res, req, j) if err != nil { log.Println("[Response] error calling AfterAPIResponse:", err) return @@ -200,7 +200,7 @@ func contentHandler(res http.ResponseWriter, req *http.Request) { sendData(res, req, j) // hook after response - _, err = hook.AfterAPIResponse(res, req, j) + err = hook.AfterAPIResponse(res, req, j) if err != nil { log.Println("[Response] error calling AfterAPIResponse:", err) return @@ -274,7 +274,7 @@ func contentHandlerBySlug(res http.ResponseWriter, req *http.Request) { sendData(res, req, j) // hook after response - _, err = hook.AfterAPIResponse(res, req, j) + err = hook.AfterAPIResponse(res, req, j) if err != nil { log.Println("[Response] error calling AfterAPIResponse:", err) return diff --git a/system/item/item.go b/system/item/item.go index 8be21ae..34ced58 100644 --- a/system/item/item.go +++ b/system/item/item.go @@ -66,7 +66,7 @@ type Sortable interface { // Hookable with no-ops so our user can override only whichever ones necessary. type Hookable interface { BeforeAPIResponse(http.ResponseWriter, *http.Request, []byte) ([]byte, error) - AfterAPIResponse(http.ResponseWriter, *http.Request, []byte) ([]byte, error) + AfterAPIResponse(http.ResponseWriter, *http.Request, []byte) error BeforeAPICreate(http.ResponseWriter, *http.Request) error AfterAPICreate(http.ResponseWriter, *http.Request) error @@ -186,8 +186,8 @@ func (i Item) BeforeAPIResponse(res http.ResponseWriter, req *http.Request, data } // AfterAPIResponse is a no-op to ensure structs which embed Item implement Hookable -func (i Item) AfterAPIResponse(res http.ResponseWriter, req *http.Request, data []byte) ([]byte, error) { - return data, nil +func (i Item) AfterAPIResponse(res http.ResponseWriter, req *http.Request, data []byte) error { + return nil } // BeforeAPICreate is a no-op to ensure structs which embed Item implement Hookable -- cgit v1.2.3 From 7b26b49f616e7581a274a7344ba376353a6bd6a5 Mon Sep 17 00:00:00 2001 From: Ollie Phillips Date: Thu, 9 May 2019 11:24:09 +0100 Subject: amending repo docs for addition of BeforeAPIResponse and AfterAPIResponse event hooks --- docs/src/Interfaces/Item.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/docs/src/Interfaces/Item.md b/docs/src/Interfaces/Item.md index 00971aa..9b06cc6 100644 --- a/docs/src/Interfaces/Item.md +++ b/docs/src/Interfaces/Item.md @@ -107,13 +107,16 @@ func (p *Post) Omit(res http.ResponseWriter, req *http.Request) ([]string, error ### [item.Hookable](https://godoc.org/github.com/ponzu-cms/ponzu/system/item#Hookable) Hookable provides lifecycle hooks into the http handlers which manage Save, Delete, -Approve, and Reject routines. All methods in its set take an -`http.ResponseWriter, *http.Request` and return an `error`. +Approve, Reject routines, and API response routines. All methods in its set take an +`http.ResponseWriter, *http.Request` and return an `error`. Hooks which relate to the API response, additionally take data of type `[]byte`, and may provide a return of the same type. ##### Method Set ```go type Hookable interface { + BeforeAPIResponse(http.ResponseWriter, *http.Request, []byte) ([]byte, error) + AfterAPIResponse(http.ResponseWriter, *http.Request, []byte) error + BeforeAPICreate(http.ResponseWriter, *http.Request) error AfterAPICreate(http.ResponseWriter, *http.Request) error @@ -155,6 +158,28 @@ type Hookable interface { ##### Implementations +#### BeforeAPIResponse +BeforeAPIResponse is called before content is sent over the Ponzu API, and +provides an opportunity to modify the response data. If a non-nil `error` value +is returned, a 500 Internal Server Error is sent instead of the response. + +```go +func (p *Post) BeforeAPIResponse(res http.ResponseWriter, req *http.Request, data []byte) ([]byte, error) { + return data, nil +} +``` + +#### AfterAPIResponse +AfterAPIResponse is called after content is sent over the Ponzu API, whether +modified or not. The sent response data is available to the hook. A non-nil +`error` return will simply generate a log message. + +```go +func (p *Post) AfterAPIResponse(res http.ResponseWriter, req *http.Request, data []byte) error { + return nil +} +``` + #### BeforeAPICreate BeforeAPICreate is called before an item is created via a 3rd-party client. If a non-nil `error` value is returned, the item will not be created/saved. -- cgit v1.2.3 From d337a2251d087e2d9bfc96ae130688a4dab6348f Mon Sep 17 00:00:00 2001 From: Ollie Phillips Date: Thu, 9 May 2019 11:30:49 +0100 Subject: spaces in place of tabs --- docs/src/Interfaces/Item.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/Interfaces/Item.md b/docs/src/Interfaces/Item.md index 9b06cc6..9f805b8 100644 --- a/docs/src/Interfaces/Item.md +++ b/docs/src/Interfaces/Item.md @@ -115,7 +115,7 @@ Approve, Reject routines, and API response routines. All methods in its set take ```go type Hookable interface { BeforeAPIResponse(http.ResponseWriter, *http.Request, []byte) ([]byte, error) - AfterAPIResponse(http.ResponseWriter, *http.Request, []byte) error + AfterAPIResponse(http.ResponseWriter, *http.Request, []byte) error BeforeAPICreate(http.ResponseWriter, *http.Request) error AfterAPICreate(http.ResponseWriter, *http.Request) error -- cgit v1.2.3