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

chore: add tracing to cart and checkout #514

Merged
merged 4 commits into from
Feb 2, 2024
Merged

chore: add tracing to cart and checkout #514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c86d4bb
chore(cart): add tracing
IvanMaidurov Feb 1, 2024
15c4fb4
chore(checkout): add tracing
IvanMaidurov Feb 1, 2024
e90995a
chore: fix tests
IvanMaidurov Feb 2, 2024
f633808
chore: fix imports
IvanMaidurov Feb 2, 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
20 changes: 20 additions & 0 deletions cart/application/cartCache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import (
"strings"
"time"

"go.opencensus.io/trace"

"flamingo.me/flamingo-commerce/v3/cart/domain/cart"
"flamingo.me/flamingo/v3/core/auth"
"flamingo.me/flamingo/v3/framework/flamingo"
Expand Down Expand Up @@ -114,6 +116,9 @@ func (cs *CartSessionCache) Inject(

// BuildIdentifier creates a CartCacheIdentifier based on the login state
func (cs *CartSessionCache) BuildIdentifier(ctx context.Context, session *web.Session) (CartCacheIdentifier, error) {
ctx, span := trace.StartSpan(ctx, "cart/CartSessionCache/BuildIdentifier")
defer span.End()

identity := cs.webIdentityService.Identify(ctx, web.RequestFromContext(ctx))
if identity != nil {
return CartCacheIdentifier{
Expand All @@ -139,6 +144,9 @@ func (cs *CartSessionCache) BuildIdentifier(ctx context.Context, session *web.Se

// GetCart fetches a Cart from the Cache
func (cs *CartSessionCache) GetCart(ctx context.Context, session *web.Session, id CartCacheIdentifier) (*cart.Cart, error) {
ctx, span := trace.StartSpan(ctx, "cart/CartSessionCache/GetCart")
defer span.End()

if cache, ok := session.Load(CartSessionCacheCacheKeyPrefix + id.CacheKey()); ok {
if cachedCartsEntry, ok := cache.(CachedCartEntry); ok {
cs.logger.WithContext(ctx).Debugf("Found cached cart: %v InValid: %v", id.CacheKey(), cachedCartsEntry.IsInvalid)
Expand Down Expand Up @@ -168,6 +176,9 @@ func (cs *CartSessionCache) GetCart(ctx context.Context, session *web.Session, i

// CacheCart adds a Cart to the Cache
func (cs *CartSessionCache) CacheCart(ctx context.Context, session *web.Session, id CartCacheIdentifier, cartForCache *cart.Cart) error {
ctx, span := trace.StartSpan(ctx, "cart/CartSessionCache/CacheCart")
defer span.End()

if cartForCache == nil {
return errors.New("no cart given to cache")
}
Expand All @@ -183,6 +194,9 @@ func (cs *CartSessionCache) CacheCart(ctx context.Context, session *web.Session,

// Invalidate a Cache Entry
func (cs *CartSessionCache) Invalidate(ctx context.Context, session *web.Session, id CartCacheIdentifier) error {
ctx, span := trace.StartSpan(ctx, "cart/CartSessionCache/Invalidate")
defer span.End()

if cache, ok := session.Load(CartSessionCacheCacheKeyPrefix + id.CacheKey()); ok {
if cachedCartsEntry, ok := cache.(CachedCartEntry); ok {
cachedCartsEntry.IsInvalid = true
Expand All @@ -197,6 +211,9 @@ func (cs *CartSessionCache) Invalidate(ctx context.Context, session *web.Session

// Delete a Cache entry
func (cs *CartSessionCache) Delete(ctx context.Context, session *web.Session, id CartCacheIdentifier) error {
ctx, span := trace.StartSpan(ctx, "cart/CartSessionCache/Delete")
defer span.End()

if _, ok := session.Load(CartSessionCacheCacheKeyPrefix + id.CacheKey()); ok {
session.Delete(CartSessionCacheCacheKeyPrefix + id.CacheKey())

Expand All @@ -209,6 +226,9 @@ func (cs *CartSessionCache) Delete(ctx context.Context, session *web.Session, id

// DeleteAll empties the Cache
func (cs *CartSessionCache) DeleteAll(ctx context.Context, session *web.Session) error {
ctx, span := trace.StartSpan(ctx, "cart/CartSessionCache/DeleteAll")
defer span.End()

deleted := false
for _, k := range session.Keys() {
if stringKey, ok := k.(string); ok {
Expand Down
53 changes: 53 additions & 0 deletions cart/application/cartReceiver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import (
"errors"
"fmt"

"go.opencensus.io/trace"

"flamingo.me/flamingo/v3/core/auth"
"flamingo.me/flamingo/v3/framework/web"

Expand Down Expand Up @@ -92,6 +94,9 @@ func (cs *BaseCartReceiver) Inject(
// RestoreCart restores a previously used guest / customer cart
// deprecated: use CartService.RestoreCart(), ensure that your cart implements the CompleteBehaviour
func (cs *BaseCartReceiver) RestoreCart(ctx context.Context, session *web.Session, cartToRestore cartDomain.Cart) (*cartDomain.Cart, error) {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/RestoreCart")
defer span.End()

identity := cs.webIdentityService.Identify(ctx, web.RequestFromContext(ctx))
if identity != nil {
restoredCart, err := cs.customerCartService.RestoreCart(ctx, identity, cartToRestore)
Expand All @@ -115,6 +120,9 @@ func (cs *BaseCartReceiver) RestoreCart(ctx context.Context, session *web.Sessio

// ShouldHaveCart - checks if there should be a cart. Indicated if a call to GetCart should return a real cart
func (cs *BaseCartReceiver) ShouldHaveCart(ctx context.Context, session *web.Session) bool {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/ShouldHaveCart")
defer span.End()

if cs.webIdentityService.Identify(ctx, web.RequestFromContext(ctx)) != nil {
return true
}
Expand All @@ -130,6 +138,9 @@ func (cs *BaseCartReceiver) ShouldHaveGuestCart(session *web.Session) bool {

// ViewDecoratedCart return a Cart for view
func (cs *CartReceiverService) ViewDecoratedCart(ctx context.Context, session *web.Session) (*decorator.DecoratedCart, error) {
ctx, span := trace.StartSpan(ctx, "cart/CartReceiverService/ViewDecoratedCart")
defer span.End()

cart, err := cs.ViewCart(ctx, session)
if err != nil {
return nil, err
Expand All @@ -140,6 +151,9 @@ func (cs *CartReceiverService) ViewDecoratedCart(ctx context.Context, session *w

// ViewDecoratedCartWithoutCache return a Cart for view
func (cs *CartReceiverService) ViewDecoratedCartWithoutCache(ctx context.Context, session *web.Session) (*decorator.DecoratedCart, error) {
ctx, span := trace.StartSpan(ctx, "cart/CartReceiverService/ViewDecoratedCartWithoutCache")
defer span.End()

cart, err := cs.GetCartWithoutCache(ctx, session)
if err != nil {
return nil, err
Expand All @@ -150,6 +164,9 @@ func (cs *CartReceiverService) ViewDecoratedCartWithoutCache(ctx context.Context

// ViewCart return a Cart for view
func (cs *BaseCartReceiver) ViewCart(ctx context.Context, session *web.Session) (*cartDomain.Cart, error) {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/ViewCart")
defer span.End()

if cs.ShouldHaveCart(ctx, session) {
cart, _, err := cs.GetCart(ctx, session)
if err != nil {
Expand All @@ -163,6 +180,9 @@ func (cs *BaseCartReceiver) ViewCart(ctx context.Context, session *web.Session)
}

func (cs *BaseCartReceiver) storeCartInCacheIfCacheIsEnabled(ctx context.Context, session *web.Session, cart *cartDomain.Cart) error {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/storeCartInCacheIfCacheIsEnabled")
defer span.End()

if cs.cartCache == nil {
return errors.New("no cache")
}
Expand All @@ -177,6 +197,9 @@ func (cs *BaseCartReceiver) storeCartInCacheIfCacheIsEnabled(ctx context.Context

// GetCart Get the correct Cart (either Guest or User)
func (cs *BaseCartReceiver) GetCart(ctx context.Context, session *web.Session) (*cartDomain.Cart, cartDomain.ModifyBehaviour, error) {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/GetCart")
defer span.End()

if cs.webIdentityService.Identify(ctx, web.RequestFromContext(ctx)) != nil {
return cs.getCustomerCart(ctx, session)
}
Expand All @@ -188,6 +211,9 @@ func (cs *BaseCartReceiver) GetCart(ctx context.Context, session *web.Session) (

// ModifyBehaviour returns the correct behaviour to modify the cart for the current user (guest/customer)
func (cs *BaseCartReceiver) ModifyBehaviour(ctx context.Context) (cartDomain.ModifyBehaviour, error) {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/ModifyBehaviour")
defer span.End()

identity := cs.webIdentityService.Identify(ctx, web.RequestFromContext(ctx))
if identity != nil {
return cs.customerCartService.GetModifyBehaviour(ctx, identity)
Expand All @@ -197,6 +223,9 @@ func (cs *BaseCartReceiver) ModifyBehaviour(ctx context.Context) (cartDomain.Mod

// getCustomerCart
func (cs *BaseCartReceiver) getCustomerCart(ctx context.Context, session *web.Session) (*cartDomain.Cart, cartDomain.ModifyBehaviour, error) {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/getCustomerCart")
defer span.End()

cart, found, err := cs.getCartFromCacheIfCacheIsEnabled(ctx, session)

switch err {
Expand Down Expand Up @@ -229,6 +258,9 @@ func (cs *BaseCartReceiver) getCustomerCart(ctx context.Context, session *web.Se
}

func (cs *BaseCartReceiver) getCartFromCacheIfCacheIsEnabled(ctx context.Context, session *web.Session) (*cartDomain.Cart, bool, error) {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/getCartFromCacheIfCacheIsEnabled")
defer span.End()

if cs.cartCache == nil {
return nil, false, nil
}
Expand All @@ -253,6 +285,9 @@ func (cs *BaseCartReceiver) getCartFromCacheIfCacheIsEnabled(ctx context.Context

// getExistingGuestCart
func (cs *BaseCartReceiver) getExistingGuestCart(ctx context.Context, session *web.Session) (*cartDomain.Cart, cartDomain.ModifyBehaviour, error) {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/getExistingGuestCart")
defer span.End()

cart, found, err := cs.getCartFromCacheIfCacheIsEnabled(ctx, session)

if err != nil {
Expand Down Expand Up @@ -296,6 +331,9 @@ func (cs *BaseCartReceiver) getExistingGuestCart(ctx context.Context, session *w

// getNewGuestCart
func (cs *BaseCartReceiver) getNewGuestCart(ctx context.Context, session *web.Session) (*cartDomain.Cart, cartDomain.ModifyBehaviour, error) {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/getNewGuestCart")
defer span.End()

guestCart, err := cs.guestCartService.GetNewCart(ctx)
if err != nil {
if !errors.Is(err, context.Canceled) {
Expand Down Expand Up @@ -325,6 +363,9 @@ func (cs *BaseCartReceiver) getNewGuestCart(ctx context.Context, session *web.Se

// GetCartWithoutCache - forces to get the cart without cache
func (cs *BaseCartReceiver) GetCartWithoutCache(ctx context.Context, session *web.Session) (*cartDomain.Cart, error) {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/GetCartWithoutCache")
defer span.End()

// Invalidate cart cache
if cs.eventRouter != nil {
cs.eventRouter.Dispatch(ctx, &cartDomain.InvalidateCartEvent{Session: session})
Expand All @@ -345,6 +386,9 @@ func (cs *BaseCartReceiver) GetCartWithoutCache(ctx context.Context, session *we

// ViewGuestCart try to get the guest Cart - even if the user is logged in
func (cs *BaseCartReceiver) ViewGuestCart(ctx context.Context, session *web.Session) (*cartDomain.Cart, error) {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/ViewGuestCart")
defer span.End()

if cs.ShouldHaveGuestCart(session) {
guestCart, err := cs.getSessionGuestCart(ctx, session)
if err != nil {
Expand All @@ -370,6 +414,9 @@ func (cs *CartService) DeleteSavedSessionGuestCartID(session *web.Session) error

// getSessionGuestCart
func (cs *BaseCartReceiver) getSessionGuestCart(ctx context.Context, session *web.Session) (*cartDomain.Cart, error) {
ctx, span := trace.StartSpan(ctx, "cart/BaseCartReceiver/getSessionGuestCart")
defer span.End()

if guestcartid, ok := session.Load(GuestCartSessionKey); ok {
existingCart, err := cs.guestCartService.GetCart(ctx, guestcartid.(string))
if err != nil {
Expand All @@ -388,6 +435,9 @@ func (cs *BaseCartReceiver) getSessionGuestCart(ctx context.Context, session *we

// DecorateCart Get the correct Cart
func (cs *CartReceiverService) DecorateCart(ctx context.Context, cart *cartDomain.Cart) (*decorator.DecoratedCart, error) {
ctx, span := trace.StartSpan(ctx, "cart/CartReceiverService/DecorateCart")
defer span.End()

if cart == nil {
return nil, errors.New("no cart given")
}
Expand All @@ -397,6 +447,9 @@ func (cs *CartReceiverService) DecorateCart(ctx context.Context, cart *cartDomai

// GetDecoratedCart Get the correct Cart
func (cs *CartReceiverService) GetDecoratedCart(ctx context.Context, session *web.Session) (*decorator.DecoratedCart, cartDomain.ModifyBehaviour, error) {
ctx, span := trace.StartSpan(ctx, "cart/CartReceiverService/GetDecoratedCart")
defer span.End()

cart, behaviour, err := cs.GetCart(ctx, session)
if err != nil {
return nil, nil, err
Expand Down
Loading
Loading