Skip to content

refactor(api)!: replace session record methods with generic operations #5163

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

Merged
merged 1 commit into from
Aug 18, 2025
Merged

refactor(api)!: replace session record methods with generic operations #5163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions api/services/namespace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,19 @@ func (s *service) EditNamespace(ctx context.Context, req *requests.NamespaceEdit
//
// It receives a context, used to "control" the request flow, a boolean to define if the sessions will be recorded and
// the tenant ID from models.Namespace.
//
// This method is deprecated, use [NamespaceService#EditNamespace] instead.
func (s *service) EditSessionRecordStatus(ctx context.Context, sessionRecord bool, tenantID string) error {
return s.store.NamespaceSetSessionRecord(ctx, sessionRecord, tenantID)
if err := s.store.NamespaceEdit(ctx, tenantID, &models.NamespaceChanges{SessionRecord: &sessionRecord}); err != nil {
switch {
case errors.Is(err, store.ErrNoDocuments):
return NewErrNamespaceNotFound(tenantID, err)
default:
return err
}
}

return nil
}

// GetSessionRecord gets the session record data.
Expand All @@ -183,9 +194,10 @@ func (s *service) EditSessionRecordStatus(ctx context.Context, sessionRecord boo
// GetSessionRecord returns a boolean indicating the session record status and an error. When error is not nil,
// the boolean is false.
func (s *service) GetSessionRecord(ctx context.Context, tenantID string) (bool, error) {
if _, err := s.store.NamespaceResolve(ctx, store.NamespaceTenantIDResolver, tenantID); err != nil {
n, err := s.store.NamespaceResolve(ctx, store.NamespaceTenantIDResolver, tenantID)
if err != nil {
return false, NewErrNamespaceNotFound(tenantID, err)
}

return s.store.NamespaceGetSessionRecord(ctx, tenantID)
return n.Settings.SessionRecord, nil
}
216 changes: 89 additions & 127 deletions api/services/namespace_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1256,171 +1256,133 @@ func TestDeleteNamespace(t *testing.T) {
storeMock.AssertExpectations(t)
}

func TestGetSessionRecord(t *testing.T) {
func TestEditSessionRecord(t *testing.T) {
storeMock := new(storemock.Store)

ctx := context.TODO()

type Expected struct {
status bool
err error
}

cases := []struct {
description string
requiredMocks func(namespace *models.Namespace)
namespace *models.Namespace
name string
sessionRecord bool
tenantID string
expected Expected
mocks func(context.Context)
expected error
}{
{
description: "fails when the namespace document is not found",
namespace: &models.Namespace{Name: "group1", Owner: "hash1", TenantID: "a736a52b-5777-4f92-b0b8-e359bf484713", Settings: &models.NamespaceSettings{SessionRecord: true}},
requiredMocks: func(namespace *models.Namespace) {
storeMock.On("NamespaceResolve", ctx, store.NamespaceTenantIDResolver, namespace.TenantID).Return(namespace, store.ErrNoDocuments).Once()
},
expected: Expected{false, NewErrNamespaceNotFound("a736a52b-5777-4f92-b0b8-e359bf484713", store.ErrNoDocuments)},
},
{
description: "fails when store namespace get fails",
namespace: &models.Namespace{Name: "group1", Owner: "hash1", TenantID: "a736a52b-5777-4f92-b0b8-e359bf484713", Settings: &models.NamespaceSettings{SessionRecord: true}},
requiredMocks: func(namespace *models.Namespace) {
storeMock.On("NamespaceResolve", ctx, store.NamespaceTenantIDResolver, namespace.TenantID).Return(nil, errors.New("error")).Once()
name: "fails when namespace edit fails",
sessionRecord: true,
tenantID: "xxxx",
mocks: func(ctx context.Context) {
sessionRecord := true
storeMock.
On("NamespaceEdit", ctx, "xxxx", &models.NamespaceChanges{SessionRecord: &sessionRecord}).
Return(errors.New("error")).
Once()
},
tenantID: "a736a52b-5777-4f92-b0b8-e359bf484713",
expected: Expected{false, NewErrNamespaceNotFound("a736a52b-5777-4f92-b0b8-e359bf484713", errors.New("error"))},
expected: errors.New("error"),
},
{
description: "fails when store namespace get session record fails",
namespace: &models.Namespace{Name: "group1", Owner: "hash1", TenantID: "a736a52b-5777-4f92-b0b8-e359bf484713", Settings: &models.NamespaceSettings{SessionRecord: true}},
requiredMocks: func(namespace *models.Namespace) {
storeMock.On("NamespaceResolve", ctx, store.NamespaceTenantIDResolver, namespace.TenantID).Return(namespace, nil).Once()
storeMock.On("NamespaceGetSessionRecord", ctx, namespace.TenantID).Return(false, errors.New("error")).Once()
name: "fails when namespace not found",
sessionRecord: true,
tenantID: "xxxx",
mocks: func(ctx context.Context) {
sessionRecord := true
storeMock.
On("NamespaceEdit", ctx, "xxxx", &models.NamespaceChanges{SessionRecord: &sessionRecord}).
Return(store.ErrNoDocuments).
Once()
},
tenantID: "a736a52b-5777-4f92-b0b8-e359bf484713",
expected: Expected{false, errors.New("error")},
expected: NewErrNamespaceNotFound("xxxx", store.ErrNoDocuments),
},
{
description: "succeeds",
namespace: &models.Namespace{Name: "group1", Owner: "hash1", TenantID: "a736a52b-5777-4f92-b0b8-e359bf484713", Settings: &models.NamespaceSettings{SessionRecord: true}},
requiredMocks: func(namespace *models.Namespace) {
storeMock.On("NamespaceResolve", ctx, store.NamespaceTenantIDResolver, namespace.TenantID).Return(namespace, nil).Once()
storeMock.On("NamespaceGetSessionRecord", ctx, namespace.TenantID).Return(true, nil).Once()
name: "succeeds",
sessionRecord: true,
tenantID: "xxxx",
mocks: func(ctx context.Context) {
sessionRecord := true
storeMock.
On("NamespaceEdit", ctx, "xxxx", &models.NamespaceChanges{SessionRecord: &sessionRecord}).
Return(nil).
Once()
},
tenantID: "a736a52b-5777-4f92-b0b8-e359bf484713",
expected: Expected{true, nil},
expected: nil,
},
}

for _, tc := range cases {
t.Run(tc.description, func(t *testing.T) {
tc.requiredMocks(tc.namespace)
s := NewService(store.Store(storeMock), privateKey, publicKey, storecache.NewNullCache(), clientMock)

service := NewService(store.Store(storeMock), privateKey, publicKey, storecache.NewNullCache(), clientMock)
returnedUserSecurity, err := service.GetSessionRecord(ctx, tc.namespace.TenantID)
assert.Equal(t, tc.expected, Expected{returnedUserSecurity, err})
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
ctx := context.Background()
tc.mocks(ctx)
err := s.EditSessionRecordStatus(ctx, tc.sessionRecord, tc.tenantID)
assert.Equal(t, tc.expected, err)
})
}

storeMock.AssertExpectations(t)
}

func TestEditSessionRecord(t *testing.T) {
func TestGetSessionRecord(t *testing.T) {
storeMock := new(storemock.Store)

ctx := context.TODO()
type Expected struct {
status bool
err error
}

cases := []struct {
description string
namespace *models.Namespace
requiredMocks func()
sessionRecord bool
tenantID string
expected error
name string
tenantID string
mocks func(context.Context)
expected Expected
}{
{
description: "fails when namespace set session record fails",
namespace: &models.Namespace{
Name: "group1",
Owner: "hash1",
TenantID: "xxxx",
Settings: &models.NamespaceSettings{SessionRecord: true},
Members: []models.Member{
{
ID: "hash1",
Role: authorizer.RoleOwner,
},
{
ID: "hash2",
Role: authorizer.RoleObserver,
},
},
name: "fails when namespace not found",
tenantID: "a736a52b-5777-4f92-b0b8-e359bf484713",
mocks: func(ctx context.Context) {
storeMock.On("NamespaceResolve", ctx, store.NamespaceTenantIDResolver, "a736a52b-5777-4f92-b0b8-e359bf484713").Return(nil, store.ErrNoDocuments).Once()
},
requiredMocks: func() {
namespace := &models.Namespace{
Name: "group1",
Owner: "hash1",
TenantID: "xxxx",
Settings: &models.NamespaceSettings{SessionRecord: true},
Members: []models.Member{
{
ID: "hash1",
Role: authorizer.RoleOwner,
},
{
ID: "hash2",
Role: authorizer.RoleObserver,
},
},
}

status := true
storeMock.On("NamespaceSetSessionRecord", ctx, status, namespace.TenantID).Return(errors.New("error")).Once()
expected: Expected{false, NewErrNamespaceNotFound("a736a52b-5777-4f92-b0b8-e359bf484713", store.ErrNoDocuments)},
},
{
name: "fails when store namespace resolve fails",
tenantID: "a736a52b-5777-4f92-b0b8-e359bf484713",
mocks: func(ctx context.Context) {
storeMock.
On("NamespaceResolve", ctx, store.NamespaceTenantIDResolver, "a736a52b-5777-4f92-b0b8-e359bf484713").
Return(nil, errors.New("error")).
Once()
},
tenantID: "xxxx",
sessionRecord: true,
expected: errors.New("error"),
expected: Expected{false, NewErrNamespaceNotFound("a736a52b-5777-4f92-b0b8-e359bf484713", errors.New("error"))},
},
{
description: "succeeds",
namespace: &models.Namespace{Name: "group1", Owner: "hash1", TenantID: "xxxx", Settings: &models.NamespaceSettings{SessionRecord: true}, Members: []models.Member{
{
ID: "hash1",
Role: authorizer.RoleOwner,
},
{
ID: "hash2",
Role: authorizer.RoleObserver,
},
}},
requiredMocks: func() {
namespace := &models.Namespace{Name: "group1", Owner: "hash1", TenantID: "xxxx", Settings: &models.NamespaceSettings{SessionRecord: true}, Members: []models.Member{
{
ID: "hash1",
Role: authorizer.RoleOwner,
},
{
ID: "hash2",
Role: authorizer.RoleObserver,
},
}}

status := true
storeMock.On("NamespaceSetSessionRecord", ctx, status, namespace.TenantID).Return(nil).Once()
name: "succeeds",
tenantID: "a736a52b-5777-4f92-b0b8-e359bf484713",
mocks: func(ctx context.Context) {
storeMock.
On("NamespaceResolve", ctx, store.NamespaceTenantIDResolver, "a736a52b-5777-4f92-b0b8-e359bf484713").
Return(
&models.Namespace{
Name: "group1",
Owner: "hash1",
TenantID: "a736a52b-5777-4f92-b0b8-e359bf484713",
Settings: &models.NamespaceSettings{SessionRecord: false},
},
nil,
).
Once()
},
tenantID: "xxxx",
sessionRecord: true,
expected: nil,
expected: Expected{false, nil},
},
}

for _, tc := range cases {
t.Run(tc.description, func(t *testing.T) {
tc.requiredMocks()
s := NewService(store.Store(storeMock), privateKey, publicKey, storecache.NewNullCache(), clientMock)

service := NewService(store.Store(storeMock), privateKey, publicKey, storecache.NewNullCache(), clientMock)
err := service.EditSessionRecordStatus(ctx, tc.sessionRecord, tc.tenantID)
assert.Equal(t, tc.expected, err)
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
ctx := context.Background()
tc.mocks(ctx)
status, err := s.GetSessionRecord(ctx, tc.tenantID)
assert.Equal(t, tc.expected, Expected{status, err})
})
}

Expand Down
46 changes: 0 additions & 46 deletions api/store/mocks/store.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 0 additions & 29 deletions api/store/mongo/namespace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,35 +492,6 @@ func (s *Store) NamespaceRemoveMember(ctx context.Context, tenantID string, memb
return nil
}

func (s *Store) NamespaceSetSessionRecord(ctx context.Context, sessionRecord bool, tenantID string) error {
ns, err := s.db.Collection("namespaces").UpdateOne(ctx, bson.M{"tenant_id": tenantID}, bson.M{"$set": bson.M{"settings.session_record": sessionRecord}})
if err != nil {
return FromMongoError(err)
}

if ns.MatchedCount < 1 {
return store.ErrNoDocuments
}

if err := s.cache.Delete(ctx, strings.Join([]string{"namespace", tenantID}, "/")); err != nil {
log.Error(err)
}

return nil
}

func (s *Store) NamespaceGetSessionRecord(ctx context.Context, tenantID string) (bool, error) {
var settings struct {
Settings *models.NamespaceSettings `json:"settings" bson:"settings"`
}

if err := s.db.Collection("namespaces").FindOne(ctx, bson.M{"tenant_id": tenantID}).Decode(&settings); err != nil {
return false, FromMongoError(err)
}

return settings.Settings.SessionRecord, nil
}

func (s *Store) NamespaceIncrementDeviceCount(ctx context.Context, tenantID string, status models.DeviceStatus, count int64) error {
update := bson.M{
"$inc": bson.M{
Expand Down
Loading
Loading