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

Jump to bottom

feat: support non-command for web create Push API #1289

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+819 −142
Open

feat: support non-command for web create Push API #1289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f17f387
split 2 functions to apply command removal
hvn2k1 Oct 18, 2024
a62544b
Return push object and public event object instead of command
hvn2k1 Oct 20, 2024
f3de80e
feat: remove command validation
hvn2k1 Oct 21, 2024
bdaf218
fix: deprecate ErrNoCommand and implement test case for CreatePushV2
hvn2k1 Oct 21, 2024
15a8681
refactor: unexport and rename the no-command create push function
hvn2k1 Oct 21, 2024
6efb61f
refactor: rename the no-command related functions and remove service …
hvn2k1 Oct 21, 2024
68d65b1
test: implement e2e test for the no command create push
hvn2k1 Oct 23, 2024
788a022
fix: add name in create push request in e2e test
hvn2k1 Oct 23, 2024
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
2 changes: 1 addition & 1 deletion manifests/bucketeer/charts/web/values.yaml
View file
Open in desktop

Large diffs are not rendered by default.

215 changes: 208 additions & 7 deletions pkg/push/api/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"errors"
"strconv"

"github.com/jinzhu/copier"
"go.uber.org/zap"
"golang.org/x/oauth2/google"
"google.golang.org/genproto/googleapis/rpc/errdetails"
Expand All @@ -29,6 +30,7 @@ import (
"google.golang.org/grpc/status"

accountclient "github.com/bucketeer-io/bucketeer/pkg/account/client"
domainevent "github.com/bucketeer-io/bucketeer/pkg/domainevent/domain"
experimentclient "github.com/bucketeer-io/bucketeer/pkg/experiment/client"
featureclient "github.com/bucketeer-io/bucketeer/pkg/feature/client"
"github.com/bucketeer-io/bucketeer/pkg/locale"
Expand Down Expand Up @@ -108,6 +110,10 @@ func (s *PushService) CreatePush(
if err != nil {
return nil, err
}
if req.Command == nil {
return s.createPushNoCommand(ctx, req, localizer, editor)
}

if err := s.validateCreatePushRequest(req, localizer); err != nil {
return nil, err
}
Expand Down Expand Up @@ -207,7 +213,171 @@ func (s *PushService) CreatePush(
return err
}
return nil
})
if err != nil {
if err == v2ps.ErrPushAlreadyExists {
dt, err := statusAlreadyExists.WithDetails(&errdetails.LocalizedMessage{
Locale: localizer.GetLocale(),
Message: localizer.MustLocalize(locale.AlreadyExistsError),
})
if err != nil {
return nil, statusInternal.Err()
}
return nil, dt.Err()
}
s.logger.Error(
"Failed to create push",
log.FieldsFromImcomingContext(ctx).AddFields(
zap.Error(err),
zap.String("environmentNamespace", req.EnvironmentNamespace),
)...,
)
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()
}

// For security reasons we remove the service account from the API response
push.Push.FcmServiceAccount = ""

return &pushproto.CreatePushResponse{
Push: push.Push,
hvn2k1 marked this conversation as resolved.
Show resolved Hide resolved
}, nil
}

// createPushNoCommand implement logic without command
func (s *PushService) createPushNoCommand(
ctx context.Context,
req *pushproto.CreatePushRequest,
localizer locale.Localizer,
editor *eventproto.Editor,
) (*pushproto.CreatePushResponse, error) {
if err := s.validateCreatePushNoCommand(req, localizer); err != nil {
return nil, err
}
push, err := domain.NewPush(
req.Name,
string(req.FcmServiceAccount),
req.Tags,
)
if err != nil {
s.logger.Error(
"Failed to create a new push",
log.FieldsFromImcomingContext(ctx).AddFields(
zap.Error(err),
zap.String("environmentNamespace", req.EnvironmentNamespace),
zap.String("name", req.Name),
zap.Strings("tags", req.Tags),
hvn2k1 marked this conversation as resolved.
Show resolved Hide resolved
)...,
)
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()
}
pushes, err := s.listAllPushes(ctx, req.EnvironmentNamespace, localizer)
if err != nil {
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()
}
if err := s.checkFCMServiceAccount(ctx, pushes, req.FcmServiceAccount, localizer); err != nil {
return nil, err
}
err = s.containsTags(pushes, req.Tags, localizer)
if err != nil {
if status.Code(err) == codes.AlreadyExists {
dt, err := statusTagAlreadyExists.WithDetails(&errdetails.LocalizedMessage{
Locale: localizer.GetLocale(),
Message: localizer.MustLocalize(locale.AlreadyExistsError),
})
if err != nil {
return nil, statusInternal.Err()
}
return nil, dt.Err()
}
s.logger.Error(
"Failed to validate tag existence",
log.FieldsFromImcomingContext(ctx).AddFields(
zap.Error(err),
zap.String("environmentNamespace", req.EnvironmentNamespace),
zap.String("name", req.Name),
zap.Strings("tags", req.Tags),
)...,
)
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 event *eventproto.Event
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 {
pushStorage := v2ps.NewPushStorage(tx)
if err := pushStorage.CreatePush(ctx, push, req.EnvironmentNamespace); err != nil {
return err
}
prev := &domain.Push{}
if err = copier.Copy(prev, push); err != nil {
return err
}
event, err = domainevent.NewEvent(
editor,
eventproto.Event_PUSH,
push.Id,
eventproto.Event_PUSH_CREATED,
&eventproto.PushCreatedEvent{
FcmServiceAccount: push.FcmServiceAccount,
Tags: push.Tags,
Name: push.Name,
},
req.EnvironmentNamespace,
push,
prev,
)
if err != nil {
return err
}
if err = s.publisher.Publish(ctx, event); err != nil {
return err
}

return nil
})
if err != nil {
if err == v2ps.ErrPushAlreadyExists {
Expand All @@ -225,6 +395,7 @@ func (s *PushService) CreatePush(
log.FieldsFromImcomingContext(ctx).AddFields(
zap.Error(err),
zap.String("environmentNamespace", req.EnvironmentNamespace),
zap.String("name", req.Name),
)...,
)
dt, err := statusInternal.WithDetails(&errdetails.LocalizedMessage{
Expand All @@ -236,21 +407,51 @@ func (s *PushService) CreatePush(
}
return nil, dt.Err()
}
return &pushproto.CreatePushResponse{}, nil

// For security reasons we remove the service account from the API response
push.Push.FcmServiceAccount = ""

return &pushproto.CreatePushResponse{
Push: push.Push,
hvn2k1 marked this conversation as resolved.
Show resolved Hide resolved
}, nil
}

func (s *PushService) validateCreatePushRequest(req *pushproto.CreatePushRequest, localizer locale.Localizer) error {
if req.Command == nil {
dt, err := statusNoCommand.WithDetails(&errdetails.LocalizedMessage{
if string(req.Command.FcmServiceAccount) == "" {
dt, err := statusFCMServiceAccountRequired.WithDetails(&errdetails.LocalizedMessage{
Locale: localizer.GetLocale(),
Message: localizer.MustLocalizeWithTemplate(locale.RequiredFieldTemplate, "command"),
Message: localizer.MustLocalizeWithTemplate(locale.RequiredFieldTemplate, "fcm_service_account"),
})
if err != nil {
return statusInternal.Err()
}
return dt.Err()
}
if string(req.Command.FcmServiceAccount) == "" {
if len(req.Command.Tags) == 0 {
dt, err := statusTagsRequired.WithDetails(&errdetails.LocalizedMessage{
Locale: localizer.GetLocale(),
Message: localizer.MustLocalizeWithTemplate(locale.RequiredFieldTemplate, "tag"),
})
if err != nil {
return statusInternal.Err()
}
return dt.Err()
}
if req.Command.Name == "" {
dt, err := statusNameRequired.WithDetails(&errdetails.LocalizedMessage{
Locale: localizer.GetLocale(),
Message: localizer.MustLocalizeWithTemplate(locale.RequiredFieldTemplate, "name"),
})
if err != nil {
return statusInternal.Err()
}
return dt.Err()
}
return nil
}

func (s *PushService) validateCreatePushNoCommand(req *pushproto.CreatePushRequest, localizer locale.Localizer) error {
if string(req.FcmServiceAccount) == "" {
dt, err := statusFCMServiceAccountRequired.WithDetails(&errdetails.LocalizedMessage{
Locale: localizer.GetLocale(),
Message: localizer.MustLocalizeWithTemplate(locale.RequiredFieldTemplate, "fcm_service_account"),
Expand All @@ -260,7 +461,7 @@ func (s *PushService) validateCreatePushRequest(req *pushproto.CreatePushRequest
}
return dt.Err()
}
if len(req.Command.Tags) == 0 {
if len(req.Tags) == 0 {
dt, err := statusTagsRequired.WithDetails(&errdetails.LocalizedMessage{
Locale: localizer.GetLocale(),
Message: localizer.MustLocalizeWithTemplate(locale.RequiredFieldTemplate, "tag"),
Expand All @@ -270,7 +471,7 @@ func (s *PushService) validateCreatePushRequest(req *pushproto.CreatePushRequest
}
return dt.Err()
}
if req.Command.Name == "" {
if req.Name == "" {
dt, err := statusNameRequired.WithDetails(&errdetails.LocalizedMessage{
Locale: localizer.GetLocale(),
Message: localizer.MustLocalizeWithTemplate(locale.RequiredFieldTemplate, "name"),
Expand Down
Loading
Loading