Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 43 additions & 7 deletions core/membership/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
patmodels "github.com/raystack/frontier/core/userpat/models"
"github.com/raystack/frontier/internal/bootstrap/schema"
pkgAuditRecord "github.com/raystack/frontier/pkg/auditrecord"
"github.com/raystack/frontier/pkg/server/consts"
"github.com/raystack/frontier/pkg/utils"
)

Expand Down Expand Up @@ -801,14 +802,49 @@ func (s *Service) createRelation(ctx context.Context, resourceID, resourceType,
return nil
}

// createAuditRecord writes the audit record and, when the write fails, logs
// every detail of the record so it can be recreated manually.
func (s *Service) createAuditRecord(ctx context.Context, record auditrecord.AuditRecord) {
if _, err := s.auditRecordRepository.Create(ctx, record); err != nil {
args := []any{
"error", err,
"event", record.Event,
"org_id", record.OrgID,
"resource_id", record.Resource.ID,
"resource_type", record.Resource.Type,
"resource_name", record.Resource.Name,
"occurred_at", record.OccurredAt,
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
if record.Target != nil {
args = append(args,
"target_id", record.Target.ID,
"target_type", record.Target.Type,
"target_name", record.Target.Name,
"target_metadata", record.Target.Metadata,
)
}
Comment thread
AmanGIT07 marked this conversation as resolved.
// The actor is enriched from the context by the repository, so the
// failed record carries none; read it from the same place.
if actorMap, ok := ctx.Value(consts.AuditRecordActorContextKey).(map[string]interface{}); ok {
if id, ok := actorMap["id"].(string); ok {
args = append(args, "actor_id", id)
}
if actorType, ok := actorMap["type"].(string); ok {
args = append(args, "actor_type", actorType)
}
}
s.log.WarnContext(ctx, "failed to create audit record", args...)
}
}

func (s *Service) auditOrgMemberRoleChanged(ctx context.Context, org organization.Organization, p principalInfo, roleID string) {
targetType, _ := principalTypeToAuditType(p.Type)
meta := map[string]any{"role_id": roleID}
if p.Email != "" {
meta["email"] = p.Email
}

s.auditRecordRepository.Create(ctx, auditrecord.AuditRecord{
s.createAuditRecord(ctx, auditrecord.AuditRecord{
Event: pkgAuditRecord.OrganizationMemberRoleChangedEvent,
Resource: auditrecord.Resource{
ID: org.ID,
Expand Down Expand Up @@ -840,7 +876,7 @@ func (s *Service) auditOrgMemberAdded(ctx context.Context, org organization.Orga
meta["email"] = p.Email
}

s.auditRecordRepository.Create(ctx, auditrecord.AuditRecord{
s.createAuditRecord(ctx, auditrecord.AuditRecord{
Event: pkgAuditRecord.OrganizationMemberAddedEvent,
Resource: auditrecord.Resource{
ID: org.ID,
Expand All @@ -866,7 +902,7 @@ func (s *Service) auditOrgMemberAdded(ctx context.Context, org organization.Orga
}

func (s *Service) auditOrgMemberRemoved(ctx context.Context, org organization.Organization, targetID string, targetType pkgAuditRecord.EntityType) {
s.auditRecordRepository.Create(ctx, auditrecord.AuditRecord{
s.createAuditRecord(ctx, auditrecord.AuditRecord{
Event: pkgAuditRecord.OrganizationMemberRemovedEvent,
Resource: auditrecord.Resource{
ID: org.ID,
Expand Down Expand Up @@ -1103,7 +1139,7 @@ func (s *Service) auditProjectMember(ctx context.Context, event pkgAuditRecord.E
meta = map[string]any{}
}
meta["principal_type"] = principalType
s.auditRecordRepository.Create(ctx, auditrecord.AuditRecord{
s.createAuditRecord(ctx, auditrecord.AuditRecord{
Event: event,
Resource: auditrecord.Resource{
ID: prj.ID,
Expand Down Expand Up @@ -1708,7 +1744,7 @@ func (s *Service) auditGroupMemberAdded(ctx context.Context, grp group.Group, p
meta["email"] = p.Email
}

s.auditRecordRepository.Create(ctx, auditrecord.AuditRecord{
s.createAuditRecord(ctx, auditrecord.AuditRecord{
Event: pkgAuditRecord.GroupMemberAddedEvent,
Resource: auditrecord.Resource{
ID: grp.ID,
Expand Down Expand Up @@ -1741,7 +1777,7 @@ func (s *Service) auditGroupMemberRoleChanged(ctx context.Context, grp group.Gro
meta["email"] = p.Email
}

s.auditRecordRepository.Create(ctx, auditrecord.AuditRecord{
s.createAuditRecord(ctx, auditrecord.AuditRecord{
Event: pkgAuditRecord.GroupMemberRoleChangedEvent,
Resource: auditrecord.Resource{
ID: grp.ID,
Expand Down Expand Up @@ -1774,7 +1810,7 @@ func (s *Service) auditGroupMemberRemoved(ctx context.Context, grp group.Group,
meta["email"] = p.Email
}

s.auditRecordRepository.Create(ctx, auditrecord.AuditRecord{
s.createAuditRecord(ctx, auditrecord.AuditRecord{
Event: pkgAuditRecord.GroupMemberRemovedEvent,
Resource: auditrecord.Resource{
ID: grp.ID,
Expand Down
16 changes: 16 additions & 0 deletions core/membership/service_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,22 @@ func TestService_AddOrganizationMember(t *testing.T) {
roleID: viewerRoleID,
wantErr: nil,
},
{
name: "should succeed even when the audit record write fails",
setup: func(policySvc *mocks.PolicyService, relSvc *mocks.RelationService, roleSvc *mocks.RoleService, orgSvc *mocks.OrgService, userSvc *mocks.UserService, auditRepo *mocks.AuditRecordRepository) {
orgSvc.EXPECT().Get(ctx, orgID).Return(enabledOrg, nil)
userSvc.EXPECT().GetByID(ctx, userID).Return(enabledUser, nil)
roleSvc.EXPECT().Get(ctx, viewerRoleID).Return(role.Role{ID: viewerRoleID, Scopes: []string{schema.OrganizationNamespace}}, nil)
policySvc.EXPECT().List(ctx, policy.Filter{OrgID: orgID, PrincipalID: userID, PrincipalType: schema.UserPrincipal}).Return([]policy.Policy{}, nil)
policySvc.EXPECT().Create(ctx, mock.Anything).Return(policy.Policy{}, nil)
relSvc.EXPECT().Create(ctx, mock.Anything).Return(relation.Relation{}, nil)
auditRepo.EXPECT().Create(ctx, mock.Anything).Return(auditrecord.AuditRecord{}, errors.New("audit store unavailable"))
},
orgID: orgID,
userID: userID,
roleID: viewerRoleID,
wantErr: nil,
},
{
name: "should succeed adding a new member with owner role and create owner relation",
setup: func(policySvc *mocks.PolicyService, relSvc *mocks.RelationService, roleSvc *mocks.RoleService, orgSvc *mocks.OrgService, userSvc *mocks.UserService, auditRepo *mocks.AuditRecordRepository) {
Expand Down
Loading