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.

Sign up for GitHub

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

IAM 829 #269

Closed
wants to merge 6 commits into from
Closed

IAM 829 #269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
074a5c7
fix: add page tokens to the response
shipperizer Apr 5, 2024
e2b0069
feat: parse and expose link header from hydra
shipperizer Apr 5, 2024
f596fbe
feat: adjust identity api to accept page token
shipperizer Apr 5, 2024
018774c
feat: adjust pagination for schemas endpoints
shipperizer Apr 5, 2024
93e9d9b
fix: adjust page offset for oathkeeper apis
shipperizer Apr 8, 2024
baf20e7
feat: WIP use page token in rules API listRules
shipperizer Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/serve.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ func serve() {

schemasConfig := &schemas.Config{
K8s: k8sCoreV1,
Kratos: extCfg.KratosPublic().IdentityApi(),
Kratos: extCfg.KratosPublic().IdentityAPI(),
Name: specs.SchemasConfigMapName,
Namespace: specs.SchemasConfigMapNamespace,
}
Expand Down
3 changes: 2 additions & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ require (
github.com/openfga/go-sdk v0.3.4
github.com/openfga/language/pkg/go v0.0.0-20240122114256-aaa86ab89379
github.com/ory/hydra-client-go/v2 v2.1.1
github.com/ory/kratos-client-go v1.0.0
github.com/ory/kratos-client-go v1.1.0
github.com/ory/oathkeeper-client-go v0.40.6
github.com/prometheus/client_golang v1.17.0
github.com/spf13/cobra v1.8.0
github.com/stretchr/testify v1.8.4
github.com/tomnomnom/linkheader v0.0.0-20180905144013-02ca5825eb80
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.45.0
go.opentelemetry.io/contrib/propagators/jaeger v1.20.0
go.opentelemetry.io/otel v1.19.0
Expand Down
6 changes: 4 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ github.com/openfga/language/pkg/go v0.0.0-20240122114256-aaa86ab89379 h1:j42rKsj
github.com/openfga/language/pkg/go v0.0.0-20240122114256-aaa86ab89379/go.mod h1:dHJaJ7H5tViBCPidTsfl3IOd152FhYxWFQmZXOhZ2pw=
github.com/ory/hydra-client-go/v2 v2.1.1 h1:3JatU9uFbw5XhF3lgPCas1l1Kok2v5Mq1p26zZwGHNg=
github.com/ory/hydra-client-go/v2 v2.1.1/go.mod h1:IiIwChp/9wRvPoyFQblqPvg78uVishCCrV9+/M7Pl34=
github.com/ory/kratos-client-go v1.0.0 h1:mm32FMJrt4pBv2KEuhuNtiewJApc8c1Kmz0+WFHhOMA=
github.com/ory/kratos-client-go v1.0.0/go.mod h1:a2Tl4cgQAxsjR59w3EfnH5hengabjXUHiEVDzdqiZI0=
github.com/ory/kratos-client-go v1.1.0 h1:mCk5wxNTxjYq/sbZfoEY/JcxuBtuixStHD14Y0sU1E8=
github.com/ory/kratos-client-go v1.1.0/go.mod h1:ultwfjWsBxshnZgopqQ3DrKOe/t6SXsM+KKOd21PaTQ=
github.com/ory/oathkeeper-client-go v0.40.6 h1:Qm/odusPn6DTJ8mXXElNzfXYpcD5wqmb/k3dOYKUfTg=
github.com/ory/oathkeeper-client-go v0.40.6/go.mod h1:9JUPR04XPH3e53TYbfu+KveCnTIYtlSTJiQ23rEQLJI=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
Expand Down Expand Up @@ -147,6 +147,8 @@ github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
github.com/tomnomnom/linkheader v0.0.0-20180905144013-02ca5825eb80 h1:nrZ3ySNYwJbSpD6ce9duiP+QkD3JuLCcWkdaehUS/3Y=
github.com/tomnomnom/linkheader v0.0.0-20180905144013-02ca5825eb80/go.mod h1:iFyPdL66DjUD96XmzVL3ZntbzcflLnznH0fr99w5VqE=
github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
Expand Down
20 changes: 13 additions & 7 deletions internal/http/types/generic.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,19 @@ type Response struct {
}

type Pagination struct {
Page int64 `json:"page"`
Size int64 `json:"size"`
Page int64 `json:"page"`
PageToken string `json:"page_token"`
Size int64 `json:"size"`

Next string `json:"next,omitempty"`
Prev string `json:"prev,omitempty"`
First string `json:"first,omitempty"`
}

func NewPaginationWithDefaults() *Pagination {
p := new(Pagination)

p.Page = 1
p.PageToken = ""
p.Size = 100

return p
Expand All @@ -33,13 +38,14 @@ func ParsePagination(q url.Values) *Pagination {

p := NewPaginationWithDefaults()

if page, err := strconv.ParseInt(q.Get("page"), 10, 64); err == nil && page > 1 {
p.Page = page
}

// TODO @shipperizer introduce go-playground/validator
if size, err := strconv.ParseInt(q.Get("size"), 10, 64); err == nil && size > 0 {
p.Size = size
}

if token := q.Get("page_token"); token != "" {
p.PageToken = token
}

return p
}
4 changes: 2 additions & 2 deletions internal/kratos/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ type Client struct {
c *client.APIClient
}

func (c *Client) IdentityApi() client.IdentityApi {
return c.c.IdentityApi
func (c *Client) IdentityAPI() client.IdentityAPI {
return c.c.IdentityAPI
}

func NewClient(url string, debug bool) *Client {
Expand Down
7 changes: 6 additions & 1 deletion pkg/identities/handlers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ func (a *API) handleList(w http.ResponseWriter, r *http.Request) {

credID := r.URL.Query().Get("credID")

ids, err := a.service.ListIdentities(r.Context(), pagination.Page, pagination.Size, credID)
ids, err := a.service.ListIdentities(r.Context(), pagination.Size, pagination.PageToken, credID)

if err != nil {
rr := a.error(ids.Error)
Expand All @@ -75,6 +75,11 @@ func (a *API) handleList(w http.ResponseWriter, r *http.Request) {
return
}

// TODO @shipperizer improve on this, see if better to stick with link headers
pagination.Next = ids.Tokens.Next
pagination.Prev = ids.Tokens.Prev
pagination.First = ids.Tokens.First

w.WriteHeader(http.StatusOK)
json.NewEncoder(w).Encode(
types.Response{
Expand Down
49 changes: 29 additions & 20 deletions pkg/identities/handlers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import (
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/http/httptest"
"reflect"
Expand All @@ -19,14 +18,16 @@ import (

"github.com/canonical/identity-platform-admin-ui/internal/http/types"

"io"

kClient "github.com/ory/kratos-client-go"
)

//go:generate mockgen -build_flags=--mod=mod -package identities -destination ./mock_logger.go -source=../../internal/logging/interfaces.go
//go:generate mockgen -build_flags=--mod=mod -package identities -destination ./mock_interfaces.go -source=./interfaces.go
//go:generate mockgen -build_flags=--mod=mod -package identities -destination ./mock_monitor.go -source=../../internal/monitoring/interfaces.go
//go:generate mockgen -build_flags=--mod=mod -package identities -destination ./mock_tracing.go go.opentelemetry.io/otel/trace Tracer
//go:generate mockgen -build_flags=--mod=mod -package identities -destination ./mock_kratos.go github.com/ory/kratos-client-go IdentityApi
//go:generate mockgen -build_flags=--mod=mod -package identities -destination ./mock_kratos.go github.com/ory/kratos-client-go IdentityAPI

func TestHandleListSuccess(t *testing.T) {
ctrl := gomock.NewController(t)
Expand All @@ -43,11 +44,20 @@ func TestHandleListSuccess(t *testing.T) {

req := httptest.NewRequest(http.MethodGet, "/api/v0/identities", nil)
values := req.URL.Query()
values.Add("page", "1")
values.Add("size", "100")
req.URL.RawQuery = values.Encode()

mockService.EXPECT().ListIdentities(gomock.Any(), int64(1), int64(100), "").Return(&IdentityData{Identities: identities}, nil)
mockService.EXPECT().ListIdentities(gomock.Any(), int64(100), "", "").Return(
&IdentityData{
Identities: identities,
Tokens: PaginationTokens{
Next: "eyJvZmZzZXQiOiIyNTAiLCJ2IjoyfQ",
First: "eyJvZmZzZXQiOiIwIiwidiI6Mn0",
Prev: "eyJvZmZzZXQiOiItMjUwIiwidiI6Mn0",
},
},
nil,
)

w := httptest.NewRecorder()
mux := chi.NewMux()
Expand All @@ -57,7 +67,7 @@ func TestHandleListSuccess(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down Expand Up @@ -113,7 +123,6 @@ func TestHandleListFailAndPropagatesKratosError(t *testing.T) {

req := httptest.NewRequest(http.MethodGet, "/api/v0/identities", nil)
values := req.URL.Query()
values.Add("page", "1")
values.Add("size", "100")
req.URL.RawQuery = values.Encode()

Expand All @@ -122,7 +131,7 @@ func TestHandleListFailAndPropagatesKratosError(t *testing.T) {
gerr.SetMessage("teapot error")
gerr.SetReason("teapot is broken")

mockService.EXPECT().ListIdentities(gomock.Any(), int64(1), int64(100), "").Return(&IdentityData{Identities: make([]kClient.Identity, 0), Error: gerr}, fmt.Errorf("error"))
mockService.EXPECT().ListIdentities(gomock.Any(), int64(100), "", "").Return(&IdentityData{Identities: make([]kClient.Identity, 0), Error: gerr}, fmt.Errorf("error"))

w := httptest.NewRecorder()
mux := chi.NewMux()
Expand All @@ -132,7 +141,7 @@ func TestHandleListFailAndPropagatesKratosError(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down Expand Up @@ -178,7 +187,7 @@ func TestHandleDetailSuccess(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down Expand Up @@ -254,7 +263,7 @@ func TestHandleDetailFailAndPropagatesKratosError(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down Expand Up @@ -304,7 +313,7 @@ func TestHandleCreateSuccess(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down Expand Up @@ -385,7 +394,7 @@ func TestHandleCreateFailAndPropagatesKratosError(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down Expand Up @@ -426,7 +435,7 @@ func TestHandleCreateFailBadRequest(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down Expand Up @@ -457,7 +466,7 @@ func TestHandleUpdateSuccess(t *testing.T) {
identity := kClient.NewIdentity(credID, "test.json", "https://test.com/test.json", map[string]string{"name": "name"})
identityBody := kClient.NewUpdateIdentityBodyWithDefaults()
identityBody.SchemaId = identity.SchemaId
identityBody.SetState(kClient.IDENTITYSTATE_ACTIVE)
identityBody.SetState("active")
identityBody.Traits = map[string]interface{}{"name": "name"}
identityBody.AdditionalProperties = map[string]interface{}{"name": "name"}

Expand All @@ -475,7 +484,7 @@ func TestHandleUpdateSuccess(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down Expand Up @@ -536,7 +545,7 @@ func TestHandleUpdateFailAndPropagatesKratosError(t *testing.T) {
identityBody := kClient.NewUpdateIdentityBodyWithDefaults()
identityBody.SchemaId = "test.json"
identityBody.Traits = map[string]interface{}{"name": "name"}
identityBody.SetState(kClient.IDENTITYSTATE_ACTIVE)
identityBody.SetState("active")
identityBody.AdditionalProperties = map[string]interface{}{"name": "name"}

payload, err := json.Marshal(identityBody)
Expand All @@ -557,7 +566,7 @@ func TestHandleUpdateFailAndPropagatesKratosError(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down Expand Up @@ -598,7 +607,7 @@ func TestHandleUpdateFailBadRequest(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down Expand Up @@ -639,7 +648,7 @@ func TestHandleRemoveSuccess(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down Expand Up @@ -687,7 +696,7 @@ func TestHandleRemoveFailAndPropagatesKratosError(t *testing.T) {

res := w.Result()
defer res.Body.Close()
data, err := ioutil.ReadAll(res.Body)
data, err := io.ReadAll(io.Reader(res.Body))

if err != nil {
t.Errorf("expected error to be nil got %v", err)
Expand Down
2 changes: 1 addition & 1 deletion pkg/identities/interfaces.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
)

type ServiceInterface interface {
ListIdentities(context.Context, int64, int64, string) (*IdentityData, error)
ListIdentities(context.Context, int64, string, string) (*IdentityData, error)
GetIdentity(context.Context, string) (*IdentityData, error)
CreateIdentity(context.Context, *kClient.CreateIdentityBody) (*IdentityData, error)
UpdateIdentity(context.Context, string, *kClient.UpdateIdentityBody) (*IdentityData, error)
Expand Down
Loading
Loading