Files
hetty/pkg/proj/proj.go

399 lines
12 KiB
Go
Raw Permalink Normal View History

2020-10-11 17:09:39 +02:00
package proj
import (
2020-10-29 20:54:17 +01:00
"context"
2020-10-11 17:09:39 +02:00
"errors"
"fmt"
"regexp"
2020-10-29 20:54:17 +01:00
"sync"
2022-01-21 11:45:54 +01:00
connect "connectrpc.com/connect"
"github.com/oklog/ulid/v2"
2022-01-21 11:45:54 +01:00
"github.com/dstotijn/hetty/pkg/filter"
2022-03-23 14:31:27 +01:00
"github.com/dstotijn/hetty/pkg/proxy/intercept"
2022-01-21 11:45:54 +01:00
"github.com/dstotijn/hetty/pkg/reqlog"
"github.com/dstotijn/hetty/pkg/scope"
2022-02-22 14:10:39 +01:00
"github.com/dstotijn/hetty/pkg/sender"
2020-10-11 17:09:39 +02:00
)
type Service struct {
repo Repository
2022-03-23 14:31:27 +01:00
interceptSvc *intercept.Service
reqLogSvc *reqlog.Service
senderSvc *sender.Service
scope *scope.Scope
activeProjectID string
mu sync.RWMutex
2020-10-11 17:09:39 +02:00
}
2022-01-21 11:45:54 +01:00
type Settings struct {
2022-03-23 14:31:27 +01:00
// Request log settings
2022-01-21 11:45:54 +01:00
ReqLogBypassOutOfScope bool
ReqLogOnlyFindInScope bool
ReqLogSearchExpr filter.Expression
2022-02-22 14:10:39 +01:00
2022-03-23 14:31:27 +01:00
// Intercept settings
InterceptRequests bool
InterceptResponses bool
InterceptRequestFilter filter.Expression
InterceptResponseFilter filter.Expression
2022-03-23 14:31:27 +01:00
// Sender settings
2022-02-22 14:10:39 +01:00
SenderOnlyFindInScope bool
SenderSearchExpr filter.Expression
2022-02-22 14:10:39 +01:00
2022-03-23 14:31:27 +01:00
// Scope settings
2022-02-22 14:10:39 +01:00
ScopeRules []scope.Rule
2020-10-11 17:09:39 +02:00
}
var (
2022-01-21 11:45:54 +01:00
ErrProjectNotFound = errors.New("proj: project not found")
ErrNoProject = errors.New("proj: no open project")
ErrNoSettings = errors.New("proj: settings not found")
ErrInvalidName = errors.New("proj: invalid name, must be alphanumeric or whitespace chars")
2020-10-11 17:09:39 +02:00
)
var nameRegexp = regexp.MustCompile(`^[\w\d\s]+$`)
2022-01-21 11:45:54 +01:00
type Config struct {
2022-03-23 14:31:27 +01:00
Repository Repository
InterceptService *intercept.Service
ReqLogService *reqlog.Service
SenderService *sender.Service
2022-03-23 14:31:27 +01:00
Scope *scope.Scope
2022-01-21 11:45:54 +01:00
}
2020-10-11 17:09:39 +02:00
// NewService returns a new Service.
func NewService(cfg Config) (*Service, error) {
return &Service{
2022-03-23 14:31:27 +01:00
repo: cfg.Repository,
interceptSvc: cfg.InterceptService,
reqLogSvc: cfg.ReqLogService,
senderSvc: cfg.SenderService,
scope: cfg.Scope,
2020-10-11 17:09:39 +02:00
}, nil
}
func (svc *Service) CreateProject(ctx context.Context, req *connect.Request[CreateProjectRequest]) (*connect.Response[CreateProjectResponse], error) {
if !nameRegexp.MatchString(req.Msg.Name) {
return nil, ErrInvalidName
2022-01-21 11:45:54 +01:00
}
project := &Project{
Id: ulid.Make().String(),
Name: req.Msg.Name,
2022-01-21 11:45:54 +01:00
}
err := svc.repo.UpsertProject(ctx, project)
if err != nil {
return nil, fmt.Errorf("proj: could not create project: %w", err)
2022-01-21 11:45:54 +01:00
}
return &connect.Response[CreateProjectResponse]{
Msg: &CreateProjectResponse{
Project: project,
},
}, nil
2022-01-21 11:45:54 +01:00
}
// CloseProject closes the currently open project (if there is one).
func (svc *Service) CloseProject(ctx context.Context, _ *connect.Request[CloseProjectRequest]) (*connect.Response[CloseProjectResponse], error) {
2020-10-29 20:54:17 +01:00
svc.mu.Lock()
defer svc.mu.Unlock()
if svc.activeProjectID == "" {
return nil, connect.NewError(connect.CodeFailedPrecondition, ErrNoProject)
2020-10-11 17:09:39 +02:00
}
2020-10-29 20:54:17 +01:00
svc.activeProjectID = ""
svc.reqLogSvc.SetActiveProjectID("")
2022-02-22 14:10:39 +01:00
svc.reqLogSvc.SetBypassOutOfScopeRequests(false)
svc.reqLogSvc.SetRequestLogsFilter(nil)
2022-03-23 14:31:27 +01:00
svc.interceptSvc.UpdateSettings(intercept.Settings{
RequestsEnabled: false,
ResponsesEnabled: false,
RequestFilter: nil,
ResponseFilter: nil,
})
svc.senderSvc.SetActiveProjectID("")
2022-01-21 11:45:54 +01:00
svc.scope.SetRules(nil)
return &connect.Response[CloseProjectResponse]{}, nil
2020-10-11 17:09:39 +02:00
}
2022-01-21 11:45:54 +01:00
// DeleteProject removes a project from the repository.
func (svc *Service) DeleteProject(ctx context.Context, req *connect.Request[DeleteProjectRequest]) (*connect.Response[DeleteProjectResponse], error) {
if svc.activeProjectID == "" {
return nil, connect.NewError(connect.CodeFailedPrecondition, ErrNoProject)
2020-10-11 17:09:39 +02:00
}
if err := svc.repo.DeleteProject(ctx, req.Msg.ProjectId); err != nil {
return nil, fmt.Errorf("proj: could not delete project: %w", err)
2020-10-11 17:09:39 +02:00
}
return &connect.Response[DeleteProjectResponse]{}, nil
2020-10-11 17:09:39 +02:00
}
2022-01-21 11:45:54 +01:00
// OpenProject sets a project as the currently active project.
func (svc *Service) OpenProject(ctx context.Context, req *connect.Request[OpenProjectRequest]) (*connect.Response[OpenProjectResponse], error) {
2020-10-29 20:54:17 +01:00
svc.mu.Lock()
defer svc.mu.Unlock()
p, err := svc.repo.FindProjectByID(ctx, req.Msg.ProjectId)
if errors.Is(err, ErrProjectNotFound) {
return nil, connect.NewError(connect.CodeNotFound, ErrProjectNotFound)
}
2022-01-21 11:45:54 +01:00
if err != nil {
return nil, connect.NewError(connect.CodeInternal, fmt.Errorf("proj: failed to find project: %w", err))
}
svc.activeProjectID = p.Id
interceptSettings := intercept.Settings{
RequestsEnabled: p.InterceptRequests,
ResponsesEnabled: p.InterceptResponses,
2020-10-11 17:09:39 +02:00
}
if p.InterceptRequestFilterExpr != "" {
expr, err := filter.ParseQuery(p.InterceptRequestFilterExpr)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, fmt.Errorf("proj: failed to parse intercept request filter: %w", err))
}
interceptSettings.RequestFilter = expr
}
if p.InterceptResponseFilterExpr != "" {
expr, err := filter.ParseQuery(p.InterceptResponseFilterExpr)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, fmt.Errorf("proj: failed to parse intercept response filter: %w", err))
}
interceptSettings.ResponseFilter = expr
}
2022-02-22 14:10:39 +01:00
2022-03-23 14:31:27 +01:00
// Request log settings.
svc.reqLogSvc.SetActiveProjectID(p.Id)
svc.reqLogSvc.SetBypassOutOfScopeRequests(p.ReqLogBypassOutOfScope)
svc.reqLogSvc.SetRequestLogsFilter(p.ReqLogFilter)
2022-02-22 14:10:39 +01:00
2022-03-23 14:31:27 +01:00
// Intercept settings.
svc.interceptSvc.UpdateSettings(interceptSettings)
2022-03-23 14:31:27 +01:00
// Sender settings.
svc.senderSvc.SetActiveProjectID(p.Id)
svc.senderSvc.SetRequestsFilter(&sender.RequestsFilter{
OnlyInScope: p.SenderOnlyFindInScope,
SearchExpr: p.SenderSearchExpr,
2022-02-22 14:10:39 +01:00
})
2022-01-21 11:45:54 +01:00
2022-03-23 14:31:27 +01:00
// Scope settings.
scopeRules, err := p.ParseScopeRules()
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, fmt.Errorf("proj: failed to parse scope rules: %w", err))
}
svc.scope.SetRules(scopeRules)
2020-10-11 17:09:39 +02:00
p.IsActive = true
return &connect.Response[OpenProjectResponse]{
Msg: &OpenProjectResponse{
Project: p,
},
}, nil
2020-10-11 17:09:39 +02:00
}
func (svc *Service) GetActiveProject(ctx context.Context, _ *connect.Request[GetActiveProjectRequest]) (*connect.Response[GetActiveProjectResponse], error) {
project, err := svc.activeProject(ctx)
if errors.Is(err, ErrNoProject) {
return nil, connect.NewError(connect.CodeNotFound, err)
2020-10-11 17:09:39 +02:00
}
2022-01-21 11:45:54 +01:00
if err != nil {
return nil, connect.NewError(connect.CodeInternal, err)
2022-01-21 11:45:54 +01:00
}
project.IsActive = true
return &connect.Response[GetActiveProjectResponse]{
Msg: &GetActiveProjectResponse{
Project: project,
},
}, nil
}
func (svc *Service) activeProject(ctx context.Context) (*Project, error) {
if svc.activeProjectID == "" {
return nil, ErrNoProject
}
project, err := svc.repo.FindProjectByID(ctx, svc.activeProjectID)
if err != nil {
return nil, fmt.Errorf("proj: failed to get active project: %w", err)
}
2022-01-21 11:45:54 +01:00
return project, nil
2020-10-11 17:09:39 +02:00
}
func (svc *Service) ListProjects(ctx context.Context, _ *connect.Request[ListProjectsRequest]) (*connect.Response[ListProjectsResponse], error) {
2022-01-21 11:45:54 +01:00
projects, err := svc.repo.Projects(ctx)
2020-10-11 17:09:39 +02:00
if err != nil {
2021-04-25 16:23:53 +02:00
return nil, fmt.Errorf("proj: could not get projects: %w", err)
2020-10-11 17:09:39 +02:00
}
for _, project := range projects {
if svc.IsProjectActive(project.Id) {
project.IsActive = true
}
}
return &connect.Response[ListProjectsResponse]{
Msg: &ListProjectsResponse{
Projects: projects,
},
}, nil
2020-10-29 20:54:17 +01:00
}
func (svc *Service) Scope() *scope.Scope {
2022-01-21 11:45:54 +01:00
return svc.scope
}
func (svc *Service) SetScopeRules(ctx context.Context, req *connect.Request[SetScopeRulesRequest]) (*connect.Response[SetScopeRulesResponse], error) {
p, err := svc.activeProject(ctx)
if errors.Is(err, ErrNoProject) {
return nil, connect.NewError(connect.CodeFailedPrecondition, err)
}
2022-01-21 11:45:54 +01:00
if err != nil {
return nil, connect.NewError(connect.CodeInternal, err)
2022-01-21 11:45:54 +01:00
}
p.ScopeRules = req.Msg.Rules
2022-01-21 11:45:54 +01:00
err = svc.repo.UpsertProject(ctx, p)
2022-01-21 11:45:54 +01:00
if err != nil {
return nil, connect.NewError(connect.CodeInternal, fmt.Errorf("proj: failed to update project: %w", err))
}
scopeRules, err := p.ParseScopeRules()
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, fmt.Errorf("proj: failed to parse scope rules: %w", err))
2022-01-21 11:45:54 +01:00
}
svc.scope.SetRules(scopeRules)
2022-01-21 11:45:54 +01:00
return &connect.Response[SetScopeRulesResponse]{}, nil
2022-01-21 11:45:54 +01:00
}
func (p *Project) ParseScopeRules() ([]scope.Rule, error) {
var err error
scopeRules := make([]scope.Rule, len(p.ScopeRules))
for i, rule := range p.ScopeRules {
scopeRules[i] = scope.Rule{}
if rule.UrlRegexp != "" {
scopeRules[i].URL, err = regexp.Compile(rule.UrlRegexp)
if err != nil {
return nil, fmt.Errorf("failed to parse scope rule's URL field: %w", err)
}
}
if rule.HeaderKeyRegexp != "" {
scopeRules[i].Header.Key, err = regexp.Compile(rule.HeaderKeyRegexp)
if err != nil {
return nil, fmt.Errorf("failed to parse scope rule's header key field: %w", err)
}
}
if rule.HeaderValueRegexp != "" {
scopeRules[i].Header.Value, err = regexp.Compile(rule.HeaderValueRegexp)
if err != nil {
return nil, fmt.Errorf("failed to parse scope rule's header value field: %w", err)
}
}
if rule.BodyRegexp != "" {
scopeRules[i].Body, err = regexp.Compile(rule.BodyRegexp)
if err != nil {
return nil, fmt.Errorf("failed to parse scope rule's body field: %w", err)
}
}
2022-01-21 11:45:54 +01:00
}
return scopeRules, nil
}
func (svc *Service) SetRequestLogsFilter(ctx context.Context, req *connect.Request[SetRequestLogsFilterRequest]) (*connect.Response[SetRequestLogsFilterResponse], error) {
project, err := svc.activeProject(ctx)
if errors.Is(err, ErrNoProject) {
return nil, connect.NewError(connect.CodeFailedPrecondition, err)
}
if err != nil {
return nil, connect.NewError(connect.CodeInternal, err)
}
2022-01-21 11:45:54 +01:00
project.ReqLogFilter = req.Msg.Filter
2022-02-22 14:10:39 +01:00
err = svc.repo.UpsertProject(ctx, project)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, fmt.Errorf("proj: failed to update project: %w", err))
2022-02-22 14:10:39 +01:00
}
svc.reqLogSvc.SetRequestLogsFilter(req.Msg.Filter)
2022-02-22 14:10:39 +01:00
return &connect.Response[SetRequestLogsFilterResponse]{}, nil
2022-02-22 14:10:39 +01:00
}
func (svc *Service) SetSenderRequestFindFilter(ctx context.Context, filter *sender.RequestsFilter) error {
project, err := svc.activeProject(ctx)
2022-02-22 14:10:39 +01:00
if err != nil {
return err
}
project.SenderOnlyFindInScope = filter.OnlyInScope
project.SenderSearchExpr = filter.SearchExpr
2022-01-21 11:45:54 +01:00
err = svc.repo.UpsertProject(ctx, project)
if err != nil {
return fmt.Errorf("proj: failed to update project: %w", err)
}
svc.senderSvc.SetRequestsFilter(filter)
2022-01-21 11:45:54 +01:00
return nil
}
func (svc *Service) IsProjectActive(projectID string) bool {
return projectID == svc.activeProjectID
2022-01-21 11:45:54 +01:00
}
2022-03-23 14:31:27 +01:00
func (svc *Service) UpdateInterceptSettings(ctx context.Context, req *connect.Request[UpdateInterceptSettingsRequest]) (*connect.Response[UpdateInterceptSettingsResponse], error) {
project, err := svc.activeProject(ctx)
2022-03-23 14:31:27 +01:00
if err != nil {
return nil, err
2022-03-23 14:31:27 +01:00
}
project.InterceptRequests = req.Msg.RequestsEnabled
project.InterceptResponses = req.Msg.ResponsesEnabled
project.InterceptRequestFilterExpr = req.Msg.RequestFilterExpr
project.InterceptResponseFilterExpr = req.Msg.ResponseFilterExpr
2022-03-23 14:31:27 +01:00
err = svc.repo.UpsertProject(ctx, project)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, fmt.Errorf("proj: failed to update project: %w", err))
}
reqFilterExpr, err := filter.ParseQuery(req.Msg.RequestFilterExpr)
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, fmt.Errorf("proj: failed to parse intercept request filter: %w", err))
}
respFilterExpr, err := filter.ParseQuery(req.Msg.ResponseFilterExpr)
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, fmt.Errorf("proj: failed to parse intercept response filter: %w", err))
2022-03-23 14:31:27 +01:00
}
svc.interceptSvc.UpdateSettings(intercept.Settings{
RequestsEnabled: req.Msg.RequestsEnabled,
ResponsesEnabled: req.Msg.ResponsesEnabled,
RequestFilter: reqFilterExpr,
ResponseFilter: respFilterExpr,
})
2022-03-23 14:31:27 +01:00
return &connect.Response[UpdateInterceptSettingsResponse]{}, nil
2022-03-23 14:31:27 +01:00
}