Files
probo/pkg/probo/measure_service.go
Bryan Frimin 6c96590332 Add measures totalCount support
Signed-off-by: Bryan Frimin <bryan@getprobo.com>
2025-06-09 20:31:14 -07:00

502 lines
12 KiB
Go

// Copyright (c) 2025 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package probo
import (
"context"
"fmt"
"time"
"github.com/getprobo/probo/pkg/coredata"
"github.com/getprobo/probo/pkg/gid"
"github.com/getprobo/probo/pkg/page"
"go.gearno.de/crypto/uuid"
"go.gearno.de/kit/pg"
)
type (
MeasureService struct {
svc *TenantService
}
CreateMeasureRequest struct {
OrganizationID gid.GID
Name string
Description string
Category string
}
UpdateMeasureRequest struct {
ID gid.GID
Name *string
Description *string
Category *string
State *coredata.MeasureState
}
ImportMeasureRequest struct {
Measures []struct {
Name string `json:"name"`
Category string `json:"category"`
ReferenceID string `json:"reference-id"`
Standards []struct {
Framework string `json:"framework"`
Control string `json:"control"`
} `json:"standards"`
Tasks []struct {
Name string `json:"name"`
Description string `json:"description"`
ReferenceID string `json:"reference-id"`
RequestedEvidences []struct {
ReferenceID string `json:"reference-id"`
Type coredata.EvidenceType `json:"type"`
Name string `json:"name"`
} `json:"requested-evidences"`
} `json:"tasks"`
} `json:"measures"`
}
)
func (s MeasureService) CountForRiskID(
ctx context.Context,
riskID gid.GID,
filter *coredata.MeasureFilter,
) (int, error) {
var count int
err := s.svc.pg.WithConn(
ctx,
func(conn pg.Conn) (err error) {
measures := &coredata.Measures{}
count, err = measures.CountByRiskID(ctx, conn, s.svc.scope, riskID, filter)
if err != nil {
return fmt.Errorf("cannot count measures: %w", err)
}
return nil
},
)
if err != nil {
return 0, err
}
return count, nil
}
func (s MeasureService) ListForRiskID(
ctx context.Context,
riskID gid.GID,
cursor *page.Cursor[coredata.MeasureOrderField],
filter *coredata.MeasureFilter,
) (*page.Page[*coredata.Measure, coredata.MeasureOrderField], error) {
var measures coredata.Measures
risk := &coredata.Risk{}
err := s.svc.pg.WithConn(
ctx,
func(conn pg.Conn) error {
if err := risk.LoadByID(ctx, conn, s.svc.scope, riskID); err != nil {
return fmt.Errorf("cannot load risk: %w", err)
}
err := measures.LoadByRiskID(ctx, conn, s.svc.scope, risk.ID, cursor, filter)
if err != nil {
return fmt.Errorf("cannot load measures: %w", err)
}
return nil
},
)
if err != nil {
return nil, err
}
return page.NewPage(measures, cursor), nil
}
func (s MeasureService) CountForControlID(
ctx context.Context,
controlID gid.GID,
filter *coredata.MeasureFilter,
) (int, error) {
var count int
err := s.svc.pg.WithConn(
ctx,
func(conn pg.Conn) (err error) {
measures := &coredata.Measures{}
count, err = measures.CountByControlID(ctx, conn, s.svc.scope, controlID, filter)
if err != nil {
return fmt.Errorf("cannot count measures: %w", err)
}
return nil
},
)
if err != nil {
return 0, err
}
return count, nil
}
func (s MeasureService) ListForControlID(
ctx context.Context,
controlID gid.GID,
cursor *page.Cursor[coredata.MeasureOrderField],
filter *coredata.MeasureFilter,
) (*page.Page[*coredata.Measure, coredata.MeasureOrderField], error) {
var measures coredata.Measures
control := &coredata.Control{}
err := s.svc.pg.WithConn(
ctx,
func(conn pg.Conn) error {
if err := control.LoadByID(ctx, conn, s.svc.scope, controlID); err != nil {
return fmt.Errorf("cannot load control: %w", err)
}
err := measures.LoadByControlID(ctx, conn, s.svc.scope, control.ID, cursor, filter)
if err != nil {
return fmt.Errorf("cannot load measures: %w", err)
}
return nil
},
)
if err != nil {
return nil, err
}
return page.NewPage(measures, cursor), nil
}
func (s MeasureService) CountForOrganizationID(
ctx context.Context,
organizationID gid.GID,
filter *coredata.MeasureFilter,
) (int, error) {
var count int
err := s.svc.pg.WithConn(
ctx,
func(conn pg.Conn) (err error) {
measures := &coredata.Measures{}
count, err = measures.CountByOrganizationID(ctx, conn, s.svc.scope, organizationID, filter)
if err != nil {
return fmt.Errorf("cannot count measures: %w", err)
}
return nil
},
)
if err != nil {
return 0, err
}
return count, nil
}
func (s MeasureService) ListForOrganizationID(
ctx context.Context,
organizationID gid.GID,
cursor *page.Cursor[coredata.MeasureOrderField],
filter *coredata.MeasureFilter,
) (*page.Page[*coredata.Measure, coredata.MeasureOrderField], error) {
var measures coredata.Measures
organization := &coredata.Organization{}
err := s.svc.pg.WithConn(
ctx,
func(conn pg.Conn) error {
if err := organization.LoadByID(ctx, conn, s.svc.scope, organizationID); err != nil {
return fmt.Errorf("cannot load organization: %w", err)
}
err := measures.LoadByOrganizationID(
ctx,
conn,
s.svc.scope,
organization.ID,
cursor,
filter,
)
if err != nil {
return fmt.Errorf("cannot load measures: %w", err)
}
return nil
},
)
if err != nil {
return nil, err
}
return page.NewPage(measures, cursor), nil
}
func (s MeasureService) Get(
ctx context.Context,
measureID gid.GID,
) (*coredata.Measure, error) {
measure := &coredata.Measure{}
err := s.svc.pg.WithConn(
ctx,
func(conn pg.Conn) error {
return measure.LoadByID(ctx, conn, s.svc.scope, measureID)
},
)
if err != nil {
return nil, err
}
return measure, nil
}
func (s MeasureService) Import(
ctx context.Context,
organizationID gid.GID,
req ImportMeasureRequest,
) (*page.Page[*coredata.Measure, coredata.MeasureOrderField], error) {
importedMeasures := coredata.Measures{}
organization := &coredata.Organization{}
err := s.svc.pg.WithTx(
ctx,
func(tx pg.Conn) error {
if err := organization.LoadByID(ctx, tx, s.svc.scope, organizationID); err != nil {
return fmt.Errorf("cannot load organization: %w", err)
}
for i := range req.Measures {
now := time.Now()
measureID := gid.New(organization.ID.TenantID(), coredata.MeasureEntityType)
measure := &coredata.Measure{
ID: measureID,
OrganizationID: organization.ID,
Name: req.Measures[i].Name,
Description: "",
Category: req.Measures[i].Category,
State: coredata.MeasureStateNotStarted,
ReferenceID: req.Measures[i].ReferenceID,
CreatedAt: now,
UpdatedAt: now,
}
importedMeasures = append(importedMeasures, measure)
if err := measure.Upsert(ctx, tx, s.svc.scope); err != nil {
return fmt.Errorf("cannot upsert measure: %w", err)
}
for j := range req.Measures[i].Tasks {
taskID := gid.New(organization.ID.TenantID(), coredata.TaskEntityType)
task := &coredata.Task{
ID: taskID,
OrganizationID: organizationID,
MeasureID: &measure.ID,
Name: req.Measures[i].Tasks[j].Name,
Description: req.Measures[i].Tasks[j].Description,
ReferenceID: req.Measures[i].Tasks[j].ReferenceID,
State: coredata.TaskStateTodo,
CreatedAt: now,
UpdatedAt: now,
}
if err := task.Upsert(ctx, tx, s.svc.scope); err != nil {
return fmt.Errorf("cannot upsert task: %w", err)
}
for k := range req.Measures[i].Tasks[j].RequestedEvidences {
evidenceID := gid.New(organizationID.TenantID(), coredata.EvidenceEntityType)
evidence := &coredata.Evidence{
State: coredata.EvidenceStateRequested,
ID: evidenceID,
TaskID: &task.ID,
ReferenceID: req.Measures[i].Tasks[j].RequestedEvidences[k].ReferenceID,
Type: req.Measures[i].Tasks[j].RequestedEvidences[k].Type,
Description: req.Measures[i].Tasks[j].RequestedEvidences[k].Name,
CreatedAt: now,
UpdatedAt: now,
}
if err := evidence.Upsert(ctx, tx, s.svc.scope); err != nil {
return fmt.Errorf("cannot upsert evidence: %w", err)
}
}
}
for _, standard := range req.Measures[i].Standards {
framework := &coredata.Framework{}
if err := framework.LoadByReferenceID(ctx, tx, s.svc.scope, standard.Framework); err != nil {
continue
}
control := &coredata.Control{}
if err := control.LoadByFrameworkIDAndSectionTitle(ctx, tx, s.svc.scope, framework.ID, standard.Control); err != nil {
continue
}
controlMeasure := &coredata.ControlMeasure{
ControlID: control.ID,
MeasureID: measure.ID,
CreatedAt: now,
}
if err := controlMeasure.Upsert(ctx, tx, s.svc.scope); err != nil {
return fmt.Errorf("cannot insert control measure: %w", err)
}
}
}
return nil
},
)
if err != nil {
return nil, fmt.Errorf("cannot import measures: %w", err)
}
cursor := page.NewCursor(
len(importedMeasures),
nil,
page.Head,
page.OrderBy[coredata.MeasureOrderField]{
Field: coredata.MeasureOrderFieldCreatedAt,
Direction: page.OrderDirectionAsc,
},
)
return page.NewPage(importedMeasures, cursor), nil
}
func (s MeasureService) Update(
ctx context.Context,
req UpdateMeasureRequest,
) (*coredata.Measure, error) {
measure := &coredata.Measure{ID: req.ID}
err := s.svc.pg.WithTx(
ctx,
func(conn pg.Conn) error {
if err := measure.LoadByID(ctx, conn, s.svc.scope, req.ID); err != nil {
return fmt.Errorf("cannot load measure: %w", err)
}
if req.Name != nil {
measure.Name = *req.Name
}
if req.Description != nil {
measure.Description = *req.Description
}
if req.Category != nil {
measure.Category = *req.Category
}
if req.State != nil {
measure.State = *req.State
}
measure.UpdatedAt = time.Now()
if err := measure.Update(ctx, conn, s.svc.scope); err != nil {
return fmt.Errorf("cannot update measure: %w", err)
}
return nil
},
)
if err != nil {
return nil, err
}
return measure, nil
}
func (s MeasureService) Create(
ctx context.Context,
req CreateMeasureRequest,
) (*coredata.Measure, error) {
now := time.Now()
var measure *coredata.Measure
organization := &coredata.Organization{}
referenceID, err := uuid.NewV4()
if err != nil {
return nil, fmt.Errorf("cannot generate reference id: %w", err)
}
err = s.svc.pg.WithTx(
ctx,
func(conn pg.Conn) error {
if err := organization.LoadByID(ctx, conn, s.svc.scope, req.OrganizationID); err != nil {
return fmt.Errorf("cannot load organization: %w", err)
}
measure = &coredata.Measure{
ID: gid.New(organization.ID.TenantID(), coredata.MeasureEntityType),
OrganizationID: organization.ID,
Name: req.Name,
Description: req.Description,
Category: req.Category,
ReferenceID: "custom-measure-" + referenceID.String(),
State: coredata.MeasureStateNotStarted,
CreatedAt: now,
UpdatedAt: now,
}
if err := measure.Insert(ctx, conn, s.svc.scope); err != nil {
return fmt.Errorf("cannot insert measure: %w", err)
}
return nil
},
)
if err != nil {
return nil, err
}
return measure, nil
}
func (s MeasureService) Delete(
ctx context.Context,
measureID gid.GID,
) error {
return s.svc.pg.WithTx(ctx, func(conn pg.Conn) error {
measure := &coredata.Measure{}
if err := measure.Delete(ctx, conn, s.svc.scope, measureID); err != nil {
return fmt.Errorf("cannot delete measure: %w", err)
}
return nil
})
}