Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add support for get augmented #2469

Merged
merged 2 commits into from
May 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
48 changes: 48 additions & 0 deletions server/resourcemanager/operations.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ const (
OperationUpdate Operation = "update"
OperationGet Operation = "get"
OperationDelete Operation = "delete"

OperationGetAugmented Operation = "getAugmented"
OperationListAugmented Operation = "listAugmented"
)

var availableOperations = []Operation{
Expand Down Expand Up @@ -67,6 +70,14 @@ type Current[T ResourceSpec] interface {
Current(context.Context) (T, error)
}

type GetAugmented[T ResourceSpec] interface {
GetAugmented(context.Context, id.ID) (T, error)
}

type ListAugmented[T ResourceSpec] interface {
ListAugmented(_ context.Context, take, skip int, query, sortBy, sortDirection string) ([]T, error)
}

type resourceHandler[T ResourceSpec] struct {
SetID func(T, id.ID) T
List func(_ context.Context, take, skip int, query, sortBy, sortDirection string) ([]T, error)
Expand All @@ -77,6 +88,9 @@ type resourceHandler[T ResourceSpec] struct {
Get func(context.Context, id.ID) (T, error)
Delete func(context.Context, id.ID) error
Provision func(context.Context, T) error

GetAugmented func(context.Context, id.ID) (T, error)
ListAugmented func(_ context.Context, take, skip int, query, sortBy, sortDirection string) ([]T, error)
}

func (rh *resourceHandler[T]) bindOperations(enabledOperations []Operation, handler any) error {
Expand Down Expand Up @@ -119,6 +133,20 @@ func (rh *resourceHandler[T]) bindOperations(enabledOperations []Operation, hand
}
}

if slices.Contains(enabledOperations, OperationGetAugmented) {
err := rh.bindGetAugmented(handler)
if err != nil {
return err
}
}

if slices.Contains(enabledOperations, OperationListAugmented) {
err := rh.bindListAugmented(handler)
if err != nil {
return err
}
}

err := rh.bindProvisionOperation(handler)
if err != nil {
return err
Expand Down Expand Up @@ -192,3 +220,23 @@ func (rh *resourceHandler[T]) bindProvisionOperation(handler any) error {

return nil
}

func (rh *resourceHandler[T]) bindGetAugmented(handler any) error {
casted, ok := handler.(GetAugmented[T])
if !ok {
return fmt.Errorf("handler does not implement interface `GetAugmented[T]`")
}
rh.GetAugmented = casted.GetAugmented

return nil
}

func (rh *resourceHandler[T]) bindListAugmented(handler any) error {
casted, ok := handler.(ListAugmented[T])
if !ok {
return fmt.Errorf("handler does not implement interface `ListAugmented[T]`")
}
rh.ListAugmented = casted.ListAugmented

return nil
}
20 changes: 18 additions & 2 deletions server/resourcemanager/resource_manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,12 @@ func (m *manager[T]) list(w http.ResponseWriter, r *http.Request) {
return
}

items, err := m.rh.List(
listFn := m.rh.List
if isRequestForAugmented(r) {
listFn = m.rh.ListAugmented
}

items, err := listFn(
ctx,
take,
skip,
Expand Down Expand Up @@ -252,6 +257,12 @@ func (m *manager[T]) list(w http.ResponseWriter, r *http.Request) {
writeResponse(w, http.StatusOK, string(bytes))
}

const HeaderAugmented = "X-Tracetest-Augmented"

func isRequestForAugmented(r *http.Request) bool {
return r.Header.Get(HeaderAugmented) == "true"
}

func (m *manager[T]) get(w http.ResponseWriter, r *http.Request) {
encoder, err := encoderFromRequest(r)
if err != nil {
Expand All @@ -263,7 +274,12 @@ func (m *manager[T]) get(w http.ResponseWriter, r *http.Request) {
vars := mux.Vars(r)
id := id.ID(vars["id"])

item, err := m.rh.Get(r.Context(), id)
getterFn := m.rh.Get
if isRequestForAugmented(r) {
getterFn = m.rh.GetAugmented
}

item, err := getterFn(r.Context(), id)
if err != nil {
m.handleResourceHandlerError(w, "getting", err, encoder)
return
Expand Down