Sitecore commerce multiple AddToCart buttons

Hello Fellow Developers,

Today i will be sharing some information about sitecore commerce component called "AddToCart", One of the basic requirement of any e-commerce site is to have an AddToCart button on any component of your choice which deals with the product you are selling.

We have had similar requirement where just like ProductList or PromotedProduct component, We were supposed to create similar component called "ProductParts" component, What it supposed to do was to show the different sellable part of the product you are visiting.

So for example if you are selling a mobile so on any specific product detail page of that mobile, there should also be one component which could show different parts or accessories which user can also buy and perform AddToCart from there itself.

One thing we observed was that existing ProductList and PromotedProducts etc. none of them are having AddToCart button on them, So visitors can see those items but to add item to cart, they have to visit the main product detail page (PDP) and add the item to cart from there

Problem

We are resolving two issues here

1) Have an AddToCart button rendering or a control which can appear on any page, Existing AddToCart rendering when you drop it on the page, it reads item from the main Product item but if i have other items for which i want to AddToCart for, It is not possible, Until i go to the main PDP and add that item to cart.

2) Existing AddToCart works on Product item only, if you have a requirement where all of your data attributes of your sellable entities are residing on a variant, OOTB button will not work

So, if you have been working with sitecore commerce, You must have observed that the whole infrastructure of sitecore commerce is based on a sellable product and not it's variant, meaning if you are selling one mobile with 5 different variant, commerce's pipeline and their repository only works on the main product, so the resolving item is always a product and not any variant, so context item will always be a product.

Similarly if you observe the AddToCart button it only reads the fields from context item we are on, so for instance if you are on "Apple Iphone 5s" mobile and now if you want use AddToCart button for the ProductPart component which is "Iphone 5s cover", it is not possible with existing button because it reads data only from context item and context item is IPhone 5 and not "Iphone 5s cover"

If you see the implementation of  AddToCart.cshtml (i am putting screenshot only for the reference of the code i want to show) 

If you see above, the AddToCart button can only add products and because it passes variantId as empty, that means even if you have managed to resolve Variant as you rendering item, when you do AddToCart, It will add the main product to cart only

Also there is no way we can add existing AddToCart on our custom component "ProductPart"

Now because of this, we decide to create our own AddToCart button which will follow the same pattern and hidden fields and same mark up as main AddToCart button, but to get the data of the variant it is on (Iphone 5s Cover), We will read this item from commerce get require data and set those hidden fields on this new AddToCart button.

Solution

To get all of these working, We created our own repository, model and cshtml, cshtml was exact copy of existing AddToCart.cshtml which ships with OOTB commerce component, Following is a summary

1) We created one respository which is basically reading the data from commerce for our variants, and because "ProductPart" component is responsible to show parts of the current product, we have had one field in commerce for every product which will have parts field populated (in biztool), so our repository can read those parts, so we can show them in our custom ProductParts view

As seen in the screenshot above, ProductPart is our model for "ProductPart" component which has one property called "CartModel" which is nothing but our custom AddToCartRenderingModel (almost the copy of existing OOTB model), and we are filling that model with required properties by reading from commerce and giving it reference to "VariantId"

2) We create our custom AddToCart.cshtml, and our custom AddToCartRenderingModel.cs so that from our repository we could easily fill this model and we can populate all those properties which existing AddToCartRenderingModel.cs is not filling for example VariantId and simply in "ProductPart.cshtml" we can render the AddToCart button by rendering our custom AddToCart.cshtml partial view like following

 End result

So after reading all parts of the product in product repository and filling AddToCartRenderingModel for all of those parts in the repository, end result looks like following, where all the parts for current product can be seen with AddToCart button in it

 

Let me know if this helps, There are so many customization you can do with Sitecore commerce, as they say "Requirement is mother of all inventions", Happy customizing Sitecore commerce !!!

Sitecore azure hosted apps suddenly started giving 502 Bad Gateway error

 Hello People,

Today, i will be writing about the issue we had on one of our Sitecore app which was hosted on azure, Everything was working fine until fine morning, Our CD site started giving "502 Bad Gateway" error page.

With my surprise, i hit the refresh button 4-5 times to double check if its really down or what? but yes it was down and had no clue, we did not have any deployments, we did not deploy anything, and why it just stopped working?

Problem

CD Sites started giving 502 bad gateway out of the blue and suddenly

Troubleshooting & Solution

To resolve this issue, we did everything possible, but very first thing i did was to blame azure infrastructure or the plan under which the app was running, Because we did not deploy anything, no new code binaries, so why it stopped, so i got on a call with our DevOps team and started discussing the possibilities from infrastructure point of view, and we did following steps together until the issue got resolved

1) We started digging into the logs, and there were random exceptions present and i had no idea why these exceptions are coming and from where, Also i was not concerned with those exceptions because here the APP was not responding at all, so i never thought that due to these exception app is down, and It can never be

2) I compared this azure app log with other environment which was also on azure (production environment), and i did not find those exceptions, which was little surprising for me, We had couple exceptions like below, For which i had no clue

 

3) We started looking into that specific CD app's azure options to "Diagnose & Solve problem" option and in that "Availability & Performance"

We found out the almost all the request to the app was failing and platform availability was 100% but app's availability was down to 0-5%, almost all the requests to the app were turning into 502 bad gateway, Technically app was totally down and was not able to serve anything.

 

Now we got the idea that, There is something wrong with behind the scene and not the azure infra structure issue

3) To know more about the nature of the exceptions and dependencies and call telemetry, I got into "Application Insights" of the associated app, which showed us that there are repetitive exceptions, and which also made us feel that, Traffic is definitely coming onto app but because of these exceptions, Something is going wrong and app is making the gateway as "Bad gateway"

4) Next we look into the configuration of the app gateway, where it was configured that if the app is not able to come online in specific time, then azure will treat it as a bad gateway, Due to these exceptions, It could be possible that app is making some calls and those are not responding in time and hence gateway is timing out.

It looked logical to us, Below was we observed in "Application Insight"

There was a big count of similar dependencies exception, We did correct those configuration to get rid of those exceptions, we were fine and exception count was reduced but still app did not came up and it was still giving the same "502 Bad Gateway"

5) We observed that the APP was in S1 plan of azure, we decided to scale up the app to S3 plan, to get some more memory and see if that works, and with our surprise the app was working, "Bad Gateway" was gone but still the app performance was very poor, So we concluded that, there is something wrong with the memory, because the moment we increased the memory, app worked

Now it was time to find out what is going wrong with the memory, and we also had seen Memory related exception in our previous azure app diagnosis.

5) We decided to create the memory dump and see in the time of crash what might have gone wrong to find out more info, also we raise a ticket with MSFT and Sitecore too so we get more insights 

The memory dump revealed some important information 

Memory Dump Analysis

With our luck, Sitecore also pointed out in the same direction of memory and following were the observations

In memory dump, Garbage Collector was running. 2 long running threads about ContentSearch indexing was waiting for GC to complete. 

There were about 2.7 GB of memory allocated for System.String. These strings were being used by Event Queue.
Additionally, one of our item where we are storing big XML string was having a huge 6MB string in a field. This was then multiplied by EventQueue, jobs etc and had easily taken 700+ MB of memory.

So next thing was to see the eventqueue, and we had around about 300K entries and it was confirmed that, this could be the issue of why app was working fine before and why it stopped suddenly, eventqueue must have grown significantly by that time

So we cleared the eventqueue table from core, master, web DB

There were couple of other Findings too, Which are following

Our your CD had "sitecore_web_index" using "onPublishEndAsyncSingleInstance" strategy.
this is the default configuration. However in a scaled environment, we should only let 1 instance, e.g. CM perform this indexing strategy.
 

An improvement was made since Sitecore 9.2 with the addition of a new Indexing sub-role. This allows user to combine them with the desired ContentManagement role.

Regardless of how many CM/CD you have, only 1 CM is supposed to perform indexing operations, other instance should have this strategy set to "manual".

 So we changed our CD configs to have following configurations

<strategy ref="contentSearch/indexConfigurations/indexUpdateStrategies/manual" />

Now, After doing these changes, we restarted our CD instances and hit the site and voila, Instead of seeing "Bad gateway", we were seeing our site and all gateway turned "Healthy" from "Faulty"

Solution

Because eventqueue entries were large and it was getting multiplied with those huge sitecore items, and due to that memory was getting fuller and site was taking time to come up and it was greater than defined gateway time out period and hence it was giving "Bad Gateway" error

1) Delete eventqueue table entries, and configure Sitecore to clean up eventqueue so that in future also it can only have limited number of records, Sitecore recommends 1000 records for eventqueue for recommended performance

2) Always have CM role to perform indexing operations on CDs, so change all CDs indexing strategy to manual and keep only CM to perform indexing operations.

After this change we also scale down the app back to S1 and still everything is working fine now, Hope this helps someone facing the same issue

Package installation is taking huge time even if few items

Hello Folks,

Last week we have had couple of deployments on different environments, and we have similar standard environments like Dev, Stage, Production and so on

Our DEV environment is something all of our developer uses and we have set up automated deployments on azure apps via octopus deployment and DEV environment generally has lot of deployments happening as and when developers finish their work

Stage and Production are something i have a control over, so i make sure that i do all branching and merging and deployment plans for it and do the deployments (of course we do it as a team :) ), and i never faced this issue in those environments.

Now from last week i was just observing that our developers are triggering the deployment and the DEV deployment was taking longtime, Our last deployment took around 6+ hours which is completely insane, So i start digging to see why it is happening and i also observed that gradually as the weeks passed, the deployment was taking longer time, so initially it was taking 3+ hours, later on 5+ hours, So i decided to dig and see what could be the issue 

Problem

Octopus deployment for sitecore items was taking huge time to finish the deployment around 5+ hours

Troubleshooting Steps

As our deployment was happening from octopus and octopus deployment was configured to do around 25+ steps, so one by one it executes different deployment steps and i was more interested in which step is actually talking long time? and very quickly i figured out that it is the Sitecore package installation which was consuming almost all the time

Now the next step was to find why it is taking so long, So i compared this same steps with other environment for which deployments were happening smoother and for the same package it was taking few mins to complete, now this was eyebrow raising.

So, It was time to observe the logs to find out what is going wrong because now it was evident that nothing is wrong from octopus side, but something is fishy on Sitecore package installation process

One thing was observed in the log that, after every item it tried to install it was showing below log 

and it was filled with these logs but they were warnings but that definitely pointed me to some extra search if there was something wrong with the index strategy, so went on to google to find something about it and i found few really helpful articles which were pointing into this direction 

https://sitecore.stackexchange.com/questions/478/sitecore-index-update-jobs-getting-stuck

https://community.sitecore.net/developers/f/8/t/7764#pi214filter=all&pi214scroll=false

1) These links have different scenarios but issue was same, so i went ahead and changed the strategy for my master index, to following (change from syncMaster to intervalAsyncMaster)

<strategies hint="list:AddStrategy">
              <strategy ref="contentSearch/indexConfigurations/indexUpdateStrategies/intervalAsyncMaster" />
</strategies>

2) Also changed CheckForThreshold in Sitecore.ContentSearch.DefaultConfiguration.config to false from true

3) This is where it hit me that, this CheckForThreshold flag is used for EventQueue and one of the thread was also talking about EventQueue size limit, and Sitecore recommends not to have more than 1000 items in that table for optimized performance, Also i have observed in my deployments that it gradually started taking time so in my back of the mind EventQueue was already started shaping that because of the table is growing, The deployments might be taking longer time depending on entries it had

 So i went in and hit the query to see the size of EventQueue table in core, master and web sql tables

and with my surprise it was huge and was having couple of thousands of records, i kept data only of last week and deleted all the records from it, and now there were only around 300+ records 

Now it was time to hit the deployment again, so i restarted my azure web apps after these changes, stopped on going deployment and once CM was up, i started the deployment again and i was waiting for that step to come where it installs the packages 

This time it was giving me same WARN logs but it took only and 1.5 hour to finish the whole process which was taking humongous 5+ hours  

Solution

It was definitely that event queue which was causing this package installations to go on and on and on, it is always best practice to configure Sitecore to have only EventQueue to certain days if really needed, so Sitecore can be configured to clean the queue automatically after few days

I hope this will also help someone who is running into the same issue.

Sitecore commerce AddToCart component quantity issue in catalog-productquantity.js

Hello Friends,

There is an OOTB component AddToCart for commerce which comes with input box to enter quantity and Add To Cart button

It also has + and - button so you can manually increase and decrease quantity and the textbox will show quantity as per that

Problem

While working on the component i found out that when we enter the quantity manually into the box and if i try to increase and decrease its value using + and -, it was malfunctioning and not updating the quantity which was strange as without touching the textbox, it was working just fine

Solution

Well, Because of some of the code in javascript it was not working and, following is the old code which caused the issue and will also paste the new code which was changed and after that it started working

We will need to edit catalog-productquantity.js full path of this item is /sitecore/media library/Base Themes/Commerce Components Theme/Scripts/Catalog/catalog-productquantity item

, So go to this item in Sitecore, download it and make below change

Old Code

$(quantityInput).attr('value', currentValue);

Above is the code which was causing the issue so you just need to find this line in JS and replce it with following

New Code

$(quantityInput).val(currentValue);

After making this change upload this file back to the Sitecore path shown above and publish.

The issue should have been resolved for you now.

NOTE: Sitecore was also able to reproduced this behavior on their end and above is the solution for it.

Sitecore Commerce ProductList getting variant prices for a product

Hello Sitecore Lovers !!!!

Today i will talk little about sitecore commerce OOTB component "Product List", if you have used existing storefront site and observe the list, it looks something like below

So far so good, now i will talk about the actual issue we run into

Problem
Most of the storefront OOTB component works on a product level, but in our case we needed prices from a variant and not from a product, Sitecore commerce has a pricing manager but it was always returning NULL for variant prices and was only returning prices for a product and not variant underneath it.

Details
Now because we knew that this component is using ProductListRepository.cs and if we override it, we could see what pricing logic is written and we can tweak it to get the variant price, but before that we wanted to find why it is not considering variants and only considering a product, Logically it should also fetch its variant prices too

So i started digging by looking into ProductListRepository.cs and found below code which actually is responsible to get prices on a product and a variant level.

if you observe below code in ProductListRepository.cs

 

There is one thing to note here
When ProductEntity is initialized using mode.Initialize method, VariantEntity list is passed null, now because it is passed as null, Variant list will always be empty from the model initialize method, see below

Setting up VariantEntityList is important because other wise no OOTB methods will fill out variant prices.

Now it was time to modify, ProductListRepository to have VariantList to fill and use existing pricing manager to fill variant prices like following

  protected override ICollection<ProductEntity> AdjustProductPriceAndStockStatus(
      IVisitorContext visitorContext,
      SearchResults searchResult,
      Item currentCategory,
      StringPropertyCollection propertyBag = null)
        {
            CommerceStorefront currentStorefront = this.StorefrontContext.CurrentStorefront;
            List<ProductEntity> productEntityList = new List<ProductEntity>();
            string str = "Category/" + currentCategory.Name;
            if (this.SiteContext.Items[(object)str] != null)
                return (List<ProductEntity>)this.SiteContext.Items[(object)str];
            if (searchResult.SearchResultItems != null && searchResult.SearchResultItems.Count > 0)
            {
                foreach (Item searchResultItem in searchResult.SearchResultItems)
                {
                    List<VariantEntity> variantEntityList = new List<VariantEntity>();
                    if (searchResultItem != null && searchResultItem.HasChildren)
                    {

                        foreach (Item child in searchResultItem.Children)
                        {
                            VariantEntity variantModel = this.ModelProvider.GetModel<VariantEntity>();
                            variantModel.Initialize(child);
                            variantEntityList.Add(variantModel);
                        }
                    }
                    ProductEntity model = this.ModelProvider.GetModel<ProductEntity>();
                    model.Initialize(currentStorefront, searchResultItem, variantEntityList);
                    productEntityList.Add(model);
                }
                this.CatalogManager.GetProductBulkPrices(currentStorefront, visitorContext, productEntityList);
                this.InventoryManager.GetProductsStockStatus(currentStorefront, productEntityList, currentStorefront.UseIndexFileForProductStatusInLists);
                using (List<ProductEntity>.Enumerator enumerator = productEntityList.GetEnumerator())
                {
                    while (enumerator.MoveNext())
                    {
                        ProductEntity productEntity = enumerator.Current;
                        Item obj = searchResult.SearchResultItems.FirstOrDefault<Item>((Func<Item, bool>)(item =>
                        {
                            if (item.Name == productEntity.ProductId)
                                return item.Language == Sitecore.Context.Language;
                            return false;
                        }));
                        //if (obj != null)
                        // productEntity.set_CustomerAverageRating(this.CatalogManager.GetProductRating(obj));
                    }
                }
                this.BulkManager.GetProductPricesAndStockInformation(currentStorefront, (IEnumerable<ProductEntity>)productEntityList, false, propertyBag, (string[])null);
            }
            this.SiteContext.Items[(object)str] = (object)productEntityList;
            return (ICollection<ProductEntity>)productEntityList;
        }

 
As you see now, We have initialized VariantEntityList and also we are now calling OOTB method to fill variant prices which is

 this.CatalogManager.GetProductBulkPrices(currentStorefront, visitorContext, productEntityList);

 
We used this method initially and found out that, until this productEntityList does not have the variant list initialized, it will not will not fill any prices for variant and hence VariantEntityList code is introduced  

It took some time to figure out this but DotPeek is your best friend while working with sitecore commerce, Specially when you want to do customization   

Happy troubleshootings !!!