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

refactor: changed transaction handling related to Experiment package #1488

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

refactor: changed transaction handling related to Experiment package #1488

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
438d3c2
refactor: changed transaction handling related to Experiment package
kakcy Jan 28, 2025
ee61df5
refactor: changed transaction handling related to Experiment package
kakcy Jan 29, 2025
4d73a7e
fix: add GoalID check on request with NoCommand in CreateExperimentAPI
kakcy Jan 29, 2025
ce0966b
refactor: make mockgen
kakcy Jan 31, 2025
1d1071a
refactor: revert GoalIDs check on request with NoCommand
kakcy Feb 6, 2025
7f915f4
test: fix test
kakcy Feb 6, 2025
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
33 changes: 19 additions & 14 deletions pkg/experiment/api/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import (

accountclient "github.com/bucketeer-io/bucketeer/pkg/account/client"
autoopsclient "github.com/bucketeer-io/bucketeer/pkg/autoops/client"
storage "github.com/bucketeer-io/bucketeer/pkg/experiment/storage/v2"
featureclient "github.com/bucketeer-io/bucketeer/pkg/feature/client"
"github.com/bucketeer-io/bucketeer/pkg/locale"
"github.com/bucketeer-io/bucketeer/pkg/log"
Expand All @@ -50,13 +51,15 @@ func WithLogger(l *zap.Logger) Option {
}

type experimentService struct {
featureClient featureclient.Client
accountClient accountclient.Client
autoOpsClient autoopsclient.Client
mysqlClient mysql.Client
publisher publisher.Publisher
opts *options
logger *zap.Logger
featureClient featureclient.Client
accountClient accountclient.Client
autoOpsClient autoopsclient.Client
mysqlClient mysql.Client
experimentStorage storage.ExperimentStorage
goalStorage storage.GoalStorage
publisher publisher.Publisher
opts *options
logger *zap.Logger
}

func NewExperimentService(
Expand All @@ -74,13 +77,15 @@ func NewExperimentService(
opt(dopts)
}
return &experimentService{
featureClient: featureClient,
accountClient: accountClient,
autoOpsClient: autoOpsClient,
mysqlClient: mysqlClient,
publisher: publisher,
opts: dopts,
logger: dopts.logger.Named("api"),
featureClient: featureClient,
accountClient: accountClient,
autoOpsClient: autoOpsClient,
mysqlClient: mysqlClient,
experimentStorage: storage.NewExperimentStorage(mysqlClient),
goalStorage: storage.NewGoalStorage(mysqlClient),
publisher: publisher,
opts: dopts,
logger: dopts.logger.Named("api"),
}
}

Expand Down
13 changes: 11 additions & 2 deletions pkg/experiment/api/api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import (

accountclientmock "github.com/bucketeer-io/bucketeer/pkg/account/client/mock"
autoopsclientmock "github.com/bucketeer-io/bucketeer/pkg/autoops/client/mock"
storagemock "github.com/bucketeer-io/bucketeer/pkg/experiment/storage/v2/mock"
featureclientmock "github.com/bucketeer-io/bucketeer/pkg/feature/client/mock"
publishermock "github.com/bucketeer-io/bucketeer/pkg/pubsub/publisher/mock"
"github.com/bucketeer-io/bucketeer/pkg/rpc"
Expand Down Expand Up @@ -111,8 +112,16 @@ func createExperimentService(c *gomock.Controller, specifiedEnvironmentId *strin
mysqlClient := mysqlmock.NewMockClient(c)
p := publishermock.NewMockPublisher(c)
p.EXPECT().Publish(gomock.Any(), gomock.Any()).Return(nil).AnyTimes()
es := NewExperimentService(featureClientMock, accountClientMock, autoOpsClientMock, mysqlClient, p)
return es.(*experimentService)
return &experimentService{
featureClient: featureClientMock,
accountClient: accountClientMock,
autoOpsClient: autoOpsClientMock,
mysqlClient: mysqlClient,
experimentStorage: storagemock.NewMockExperimentStorage(c),
goalStorage: storagemock.NewMockGoalStorage(c),
publisher: p,
logger: zap.NewNop().Named("api"),
}
}

func createContextWithToken() context.Context {
Expand Down
81 changes: 12 additions & 69 deletions pkg/experiment/api/experiment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,7 @@ func (s *experimentService) GetExperiment(
if err := validateGetExperimentRequest(req, localizer); err != nil {
return nil, err
}
experimentStorage := v2es.NewExperimentStorage(s.mysqlClient)
experiment, err := experimentStorage.GetExperiment(ctx, req.Id, req.EnvironmentId)
experiment, err := s.experimentStorage.GetExperiment(ctx, req.Id, req.EnvironmentId)
if err != nil {
if errors.Is(err, v2es.ErrExperimentNotFound) {
dt, err := statusNotFound.WithDetails(&errdetails.LocalizedMessage{
Expand Down Expand Up @@ -168,8 +167,7 @@ func (s *experimentService) ListExperiments(
}
return nil, dt.Err()
}
experimentStorage := v2es.NewExperimentStorage(s.mysqlClient)
experiments, nextCursor, totalCount, summary, err := experimentStorage.ListExperiments(
experiments, nextCursor, totalCount, summary, err := s.experimentStorage.ListExperiments(
ctx,
whereParts,
orders,
Expand Down Expand Up @@ -332,25 +330,7 @@ func (s *experimentService) CreateExperiment(
}
return nil, dt.Err()
}
tx, err := s.mysqlClient.BeginTx(ctx)
if err != nil {
s.logger.Error(
"Failed to begin transaction",
log.FieldsFromImcomingContext(ctx).AddFields(
zap.Error(err),
)...,
)
dt, err := statusInternal.WithDetails(&errdetails.LocalizedMessage{
Locale: localizer.GetLocale(),
Message: localizer.MustLocalize(locale.InternalServerError),
})
if err != nil {
return nil, statusInternal.Err()
}
return nil, dt.Err()
}
err = s.mysqlClient.RunInTransaction(ctx, tx, func() error {
experimentStorage := v2es.NewExperimentStorage(tx)
err = s.mysqlClient.RunInTransactionV2(ctx, func(contextWithTx context.Context, _ mysql.Transaction) error {
handler, err := command.NewExperimentCommandHandler(
editor,
experiment,
Expand All @@ -363,7 +343,7 @@ func (s *experimentService) CreateExperiment(
if err := handler.Handle(ctx, req.Command); err != nil {
return err
}
return experimentStorage.CreateExperiment(ctx, experiment, req.EnvironmentId)
return s.experimentStorage.CreateExperiment(contextWithTx, experiment, req.EnvironmentId)
})
if err != nil {
if errors.Is(err, v2es.ErrExperimentAlreadyExists) {
Expand Down Expand Up @@ -477,7 +457,6 @@ func (s *experimentService) createExperimentNoCommand(
return statusGoalTypeMismatch.Err()
}
}
experimentStorage := v2es.NewExperimentStorage(s.mysqlClient)
prev := &domain.Experiment{}
if err = copier.Copy(prev, experiment); err != nil {
return err
Expand Down Expand Up @@ -513,7 +492,7 @@ func (s *experimentService) createExperimentNoCommand(
if err != nil {
return err
}
return experimentStorage.CreateExperiment(ctxWithTx, experiment, req.EnvironmentId)
return s.experimentStorage.CreateExperiment(ctxWithTx, experiment, req.EnvironmentId)
})
if err != nil {
if errors.Is(err, v2es.ErrGoalNotFound) {
Expand Down Expand Up @@ -693,27 +672,9 @@ func (s *experimentService) UpdateExperiment(
if err := validateUpdateExperimentRequest(req, localizer); err != nil {
return nil, err
}
tx, err := s.mysqlClient.BeginTx(ctx)
if err != nil {
s.logger.Error(
"Failed to begin transaction",
log.FieldsFromImcomingContext(ctx).AddFields(
zap.Error(err),
)...,
)
dt, err := statusInternal.WithDetails(&errdetails.LocalizedMessage{
Locale: localizer.GetLocale(),
Message: localizer.MustLocalize(locale.InternalServerError),
})
if err != nil {
return nil, statusInternal.Err()
}
return nil, dt.Err()
}
var experimentPb *proto.Experiment
err = s.mysqlClient.RunInTransaction(ctx, tx, func() error {
experimentStorage := v2es.NewExperimentStorage(tx)
experiment, err := experimentStorage.GetExperiment(ctx, req.Id, req.EnvironmentId)
err = s.mysqlClient.RunInTransactionV2(ctx, func(contextWithTx context.Context, _ mysql.Transaction) error {
experiment, err := s.experimentStorage.GetExperiment(contextWithTx, req.Id, req.EnvironmentId)
if err != nil {
return err
}
Expand All @@ -737,7 +698,7 @@ func (s *experimentService) UpdateExperiment(
)
return err
}
return experimentStorage.UpdateExperiment(ctx, experiment, req.EnvironmentId)
return s.experimentStorage.UpdateExperiment(contextWithTx, experiment, req.EnvironmentId)
}
if req.ChangeNameCommand != nil {
if err = handler.Handle(ctx, req.ChangeNameCommand); err != nil {
Expand All @@ -764,7 +725,7 @@ func (s *experimentService) UpdateExperiment(
}
}
experimentPb = experiment.Experiment
return experimentStorage.UpdateExperiment(ctx, experiment, req.EnvironmentId)
return s.experimentStorage.UpdateExperiment(contextWithTx, experiment, req.EnvironmentId)
})
if err != nil {
if errors.Is(err, v2es.ErrExperimentNotFound) || errors.Is(err, v2es.ErrExperimentUnexpectedAffectedRows) {
Expand Down Expand Up @@ -1209,26 +1170,8 @@ func (s *experimentService) updateExperiment(
id, environmentId string,
localizer locale.Localizer,
) error {
tx, err := s.mysqlClient.BeginTx(ctx)
if err != nil {
s.logger.Error(
"Failed to begin transaction",
log.FieldsFromImcomingContext(ctx).AddFields(
zap.Error(err),
)...,
)
dt, err := statusInternal.WithDetails(&errdetails.LocalizedMessage{
Locale: localizer.GetLocale(),
Message: localizer.MustLocalize(locale.InternalServerError),
})
if err != nil {
return statusInternal.Err()
}
return dt.Err()
}
err = s.mysqlClient.RunInTransaction(ctx, tx, func() error {
experimentStorage := v2es.NewExperimentStorage(tx)
experiment, err := experimentStorage.GetExperiment(ctx, id, environmentId)
err := s.mysqlClient.RunInTransactionV2(ctx, func(contextWithTx context.Context, _ mysql.Transaction) error {
experiment, err := s.experimentStorage.GetExperiment(contextWithTx, id, environmentId)
if err != nil {
s.logger.Error(
"Failed to get experiment",
Expand All @@ -1253,7 +1196,7 @@ func (s *experimentService) updateExperiment(
)
return err
}
return experimentStorage.UpdateExperiment(ctx, experiment, environmentId)
return s.experimentStorage.UpdateExperiment(contextWithTx, experiment, environmentId)
})
if err != nil {
if errors.Is(err, v2es.ErrExperimentNotFound) || errors.Is(err, v2es.ErrExperimentUnexpectedAffectedRows) {
Expand Down
Loading
Loading