Friday, November 8, 2019

Sitecore 9 GEO IP Service Fails When xConnect is Down

Just wanted to share small but valuable point I learned recently.

We faced a same issue on two of my client's site implementations where their home pages takes 10-15 seconds load. But the other pages inside the site loads without any delays.

We were in contact with Sitecore for this issue and then we got an answer from Sitecore consultancy team.

The issue was related to GEO IP lookup service & xConnect.

On both the solutions I worked, there is a GEO IP lookup call happening on the home page to redirect visitors to their relevant regions.

But due to different reasons (rebooting the xConnect server for maintenance, etc), both of those sites xConnect site was down.

So, when the xConnect is down, GEO IP lookup requests fails to work as required and tries several times to fetch the correct information for the IP. After several attempts it gets failed.
Due to this delay of trying to fetch the IP several times due to failures, home page gets delay to load.

I don't know exact reason why GEO IP lookup needs xConnect site running, but will update here if I find it in future.

Thank you for Sitecore for helping us to find this issue.

Happy Sitecore!!

Thursday, November 7, 2019

Path Analyzer Map Errors Populating Sitecore Logs After Sitecore 9.1 Upgrade

Recently we upgraded a Sitecore 8.1 solution to Sitecore 9.1 Update-1

After the upgrade we rebuild the reporting database. After the reporting database rebuild we started to notice that our Sitecore logs (setup to log level "ERROR") is getting populated with lot of Path Analyzer errors.

7404 18:45:08 ERROR [Path Analyzer] Cannot apply rule on the interaction.
Exception: Sitecore.XConnect.Segmentation.ExpressionBuilder.PredicateDescriptorException
Message: No known predicate type could be determined from ' Sitecore.Analytics.Rules.Conditions.ContactVisitIndexCondition,Sitecore.Analytics' specified in the definition item (Id = '61370693-189d-44a0-abc5-2592dbd579ed', db = 'master') : Could not load type 'Sitecore.Analytics.Rules.Conditions.ContactVisitIndexCondition' from assembly 'Sitecore.Analytics'.
Source: Sitecore.Marketing.Segmentation.xMgmt
   at Sitecore.Marketing.Segmentation.ExpressionBuilder.ContentTreePredicateDescriptorLocator.GetDescriptor(Guid id)
   at Sitecore.Marketing.Segmentation.RuleXmlConverter.ConditionXmlNodeConverter.LookupType(Guid descriptorId)
   at Sitecore.Marketing.Segmentation.RuleXmlConverter.ConditionXmlNodeConverter.ConvertNodeInternal(INodeConversionContext`2 context, XElement element)
   at Sitecore.Marketing.Segmentation.RuleXmlConverter.BaseXmlRuleNodeConverter`1.Convert(INodeConversionContext`2 context, XElement node)
   at Sitecore.Marketing.Segmentation.RuleXmlConverter.AndXmlNodeConverter.ConvertNodeInternal(INodeConversionContext`2 context, XElement element)
   at Sitecore.Marketing.Segmentation.RuleXmlConverter.BaseXmlRuleNodeConverter`1.Convert(INodeConversionContext`2 context, XElement node)
   at Sitecore.XConnect.Segmentation.ExpressionBuilder.TreeConverter.TreeConverter`2.Convert(TFromNode treeRoot)
   at Sitecore.Marketing.Segmentation.RuleXmlConverter.RuleXmlConverter.CreateRule(XElement ruleElement)
   at System.Linq.Enumerable.WhereSelectEnumerableIterator`2.MoveNext()
   at System.Linq.Buffer`1..ctor(IEnumerable`1 source)
   at System.Linq.Enumerable.ToArray[TSource](IEnumerable`1 source)
   at Sitecore.PathAnalyzer.Rules.RulesBuilder.BuildXmlRules(String rulesXml)
   at Sitecore.PathAnalyzer.Rules.RulesBuilder.BuildRules(String rulesXml)
   at Sitecore.PathAnalyzer.Rules.RulesValidator.ValidateRule(Interaction interaction, String rulesXml, ConditionParameters parameters)
   at Sitecore.PathAnalyzer.Construction.TreeBuilder.IsApplicable(Interaction interaction, String rulesXml, ConditionParameters conditionParameters)
Nested Exception
Exception: System.TypeLoadException
Message: Could not load type 'Sitecore.Analytics.Rules.Conditions.ContactVisitIndexCondition' from assembly 'Sitecore.Analytics'.
Source: mscorlib
   at System.RuntimeTypeHandle.GetTypeByName(String name, Boolean throwOnError, Boolean ignoreCase, Boolean reflectionOnly, StackCrawlMarkHandle stackMark, IntPtr pPrivHostBinder, Boolean loadTypeFromPartialName, ObjectHandleOnStack type)
   at System.RuntimeTypeHandle.GetTypeByName(String name, Boolean throwOnError, Boolean ignoreCase, Boolean reflectionOnly, StackCrawlMark& stackMark, IntPtr pPrivHostBinder, Boolean loadTypeFromPartialName)
   at System.Type.GetType(String typeName, Boolean throwOnError)
   at Sitecore.Marketing.Segmentation.ExpressionBuilder.ContentTreePredicateDescriptorLocator.GetDescriptor(Guid id)

Unsure if following steps did help, but anyways mentioning them also :

  • Since the item ID mentioned in the error was "/sitecore/system/Settings/Rules/Definitions/Elements/Visitor/Global Visit No", I did try to remove/clean all the items that used this rule 
  • Deleted all the custom Maps from Sitecore 8.1
  • Cleared all the table in the RefData database and Deploy all the Marketing Definitions again
  • Removing EMPTY Site definition entry in "SiteNames" table in Reporting database entry that I removed was SiteNameId was set to 0 & SiteName was empty


But all the above steps did not stopped the error population on the logs.


Then I did the following steps and after the last step the error went away.

Step 1: Delete all the Map definitions from "TreeDefinitions" table in Reporting database

Step 2: Redeploy all Path Analyzer Map definitions by visiting following tool and clicking "Deploy all maps that are not deployed" button
http:/<sitecore_hostname>/Sitecore/admin/pathanalyzer.aspx

Step 3: In the same tool above, click "Rebuild" button on "Historic Map Rebuild" section

NOTE: These were mainly taking from https://sitecore.stackexchange.com/questions/17162/sitecore-9-processing-server-exception-when-executing-agent-pathanalyzer-mapre post on Sitecore StackExchange


Some useful links related to Sitecore Path Analyzer Errors on Log files :

https://sitecore.namics.com/2019/08/14/sitecore-pathanalyzer-undeploy-maps/
https://sitecore.stackexchange.com/questions/11253/no-known-predicate-type-could-be-determined-from-sitecore-analytics-omnichannel
https://blog.wesleylomax.co.uk/posts/2019-08-08-sitecore-9-1-processing-server-an-error-occured-evaluating-the-primary-condition-of-the-rule/



Sunday, October 13, 2019

Sitecore 9 Initial Page Load Deadlock Senario

Recently we have upgraded a solution to Sitecore 9.1.1 and started facing an strange issue.

When we set the Sitecore instance to "ContentDelivery" role from web.config app settings property, front-end site's initial page load request takes ages to respond. After the initial respond site starts to work property.

I tried to look into the issue few days and still couldn't find a reason for the issue. Since this worked when sitecore role is set to "ContentManagement" role, debug or finding actual reason made much harder.

Finally we contacted Sitecore Support and they were able to find the reason for this.

According to Sitecore Support, there is a code deadlock scenario when EXM & FXM used together in Sitecore 9 versions.

Issue :
When the Sitecore role set to "ContentDelivery" in app settings, initial page request for the front-end site takes 15-30 minutes time to load.
Some have experience this same scenario on ContentManagement role as well as running on "Standalone" role.

Fix :

Sitecore.Support.329897.config
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
  <sitecore>
    <hooks>
<hook type="Sitecore.Owin.Authentication.Pipelines.CookieAuthentication.ValidateIdentity.CheckIdentityProvider, Sitecore.Owin.Authentication" resolve="true" patch:before = "*[1]" />
</hooks>
  </sitecore>
</configuration>


NOTE: This fix is a temporarily fix where it tries to find the erroneous request earlier in the request pipeline and will throw an error onto the logs once that captured.

Example Error on logs after this patch:

ERROR Hook object does not implement IHook. Config node: <hook type="Sitecore.Owin.Authentication.Pipelines.CookieAuthentication.ValidateIdentity.CheckIdentityProvider, Sitecore.Owin.Authentication" resolve="true" patch:source="Sitecore.Support.329897.config" xmlns:patch="http://www.sitecore.net/xmlconfig/" /> (method: Sitecore.Events.Hooks.HookManager.LoadAll()).
11020 11:52:51 ERROR Error loading hook: <hook type="Sitecore.Owin.Authentication.Pipelines.CookieAuthentication.ValidateIdentity.CheckIdentityProvider, Sitecore.Owin.Authentication" resolve="true" patch:source="Sitecore.Support.329897.config" xmlns:patch="http://www.sitecore.net/xmlconfig/" />
Exception: System.Exception
Message: Hook object does not implement IHook. Config node: <hook type="Sitecore.Owin.Authentication.Pipelines.CookieAuthentication.ValidateIdentity.CheckIdentityProvider, Sitecore.Owin.Authentication" resolve="true" patch:source="Sitecore.Support.329897.config" xmlns:patch="http://www.sitecore.net/xmlconfig/" /> (method: Sitecore.Events.Hooks.HookManager.LoadAll()).
Source: Sitecore.Events.Hooks.HookManager.LoadAll()

According to Sitecore Support, this issue should be patched/fixed with upcoming Sitecore 9.3 release

Thursday, September 5, 2019

Sitecore 9 Identity Server Error With CA SSL Certificates

One of the implementations I did recently is a Sitecore 9.1 installation/upgrade.

Initially we had the Sitecore Identity server IIS site running using a Self-Signed certificate and I adjusted it to be using CA signed SSL certificate.

That was done by importing that certs .pfx file into Trusted Root Certificate section of the Local Computer cert store, using MMC.
Then adjusted the Sitecore Identity server settings and Sitecore instance setting to match that certificate location & its certificate key. Also adjusted IIS site instance to use this newly imported certificate.

Once the above is done, we started to face issues with Sitecore logins. We were not able to get the Sitecore login working with Identity Server instance returning 500 error message.

[FTL] (Sitecore STS/auenws-sccm-w01) Unhandled exception: "Keyset does not exist"
Internal.Cryptography.CryptoThrowHelper+WindowsCryptographicException: Keyset does not exist
   at Internal.NativeCrypto.CapiHelper.CreateProvHandle(CspParameters parameters, Boolean randomKeyContainer)
   at System.Security.Cryptography.RSACryptoServiceProvider.get_SafeProvHandle()
   at System.Security.Cryptography.RSACryptoServiceProvider.get_SafeKeyHandle()
   at System.Security.Cryptography.RSACryptoServiceProvider..ctor(Int32 keySize, CspParameters parameters, Boolean useDefaultKeySize)
   at System.Security.Cryptography.RSACryptoServiceProvider..ctor(CspParameters parameters)
   at Internal.Cryptography.Pal.CertificatePal.<>c.<GetRSAPrivateKey>b__61_0(CspParameters csp)
   at Internal.Cryptography.Pal.CertificatePal.GetPrivateKey[T](Func`2 createCsp, Func`2 createCng)
   at Internal.Cryptography.Pal.CertificatePal.GetRSAPrivateKey()
   at Internal.Cryptography.Pal.CertificateExtensionsCommon.GetPrivateKey[T](X509Certificate2 certificate, Predicate`1 matchesConstraints)
   at Microsoft.IdentityModel.Tokens.X509SecurityKey.get_PrivateKey()
   at Microsoft.IdentityModel.Tokens.X509SecurityKey.get_PrivateKeyStatus()
   at Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider..ctor(SecurityKey key, String algorithm, Boolean willCreateSignatures)
   at Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateSignatureProvider(SecurityKey key, String algorithm, Boolean willCreateSignatures)
   at System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.CreateEncodedSignature(String input, SigningCredentials signingCredentials)
   at System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler.WriteToken(SecurityToken token)
   at IdentityServer4.Services.DefaultTokenCreationService.CreateJwtAsync(JwtSecurityToken jwt)
   at IdentityServer4.Services.DefaultTokenCreationService.CreateTokenAsync(Token token)
   at IdentityServer4.Services.DefaultTokenService.CreateSecurityTokenAsync(Token token)
   at IdentityServer4.ResponseHandling.AuthorizeResponseGenerator.CreateImplicitFlowResponseAsync(ValidatedAuthorizeRequest request, String authorizationCode)
   at ......

Then what I did was searching the internet for the above error message.

The solution that was provided by the to people was to set the permission on the imported certificate for the IIS app user account.

To achieve that, we need to be able to access the "All Tasks -> Manage Private Keys..." option for that certificate.




But that option was not available when the certificate is on the "Trusted Root Certification Authorities" OR "Intermediate Certification Authorities". But that option is only available for certificates on "Personal" certificate store.

So what I did was,
1) I moved our imported certificate from "Trusted Root Certification Authories" store to "Personal" store.
2) Then set the permission for "IIS_IUSRS" user for that certificate using "Manage Private Keys..." option.
3) Then moved back the certificate again to "Trusted Root Certification Authorities" store.

(info on https://stackoverflow.com/questions/12106011/system-security-cryptography-cryptographicexception-keyset-does-not-exist)

This solved the issues with the Sitecore login.

Happy Sitecore!!

Monday, July 29, 2019

Glass Mapper StackOverflow Memory exception with InferType property set to Disable Lazy Loading

Recently we upgraded one of our solutions to Sitecore 9.1 and Glass Mapper 5.

After the upgrade, with some custom code also added, we started to get an issue with the Glass Mapper implemented solution, where the front-end website just throw an error and just dies. We were able to login to Backend Sitecore without any issues.

Following popup message is the only thing we get and site just throw this error continuously until we do an IIS reset.

Front-End Website Error Popup



There were nothing in the Sitecore Logs too related to this error.

But we could see following error on Windows event logs, which does not provide any useful information.

Faulting application name: w3wp.exe, version: 10.0.17134.1, time stamp: 0xed729d4eFaulting module name: clr.dll, version: 4.7.3416.0, time stamp: 0x5cabfc63Exception code: 0xc00000fdFault offset: 0x00000000000f503fFaulting process ID: 0x35b4Faulting application start time: 0x01d53db16c6f9a75Faulting application path: c:\windows\system32\inetsrv\w3wp.exeFaulting module path: C:\Windows\Microsoft.NET\Framework64\v4.0.30319\clr.dllReport ID: a175fc77-b1fd-4370-bee8-f2dd927f34daFaulting package full name:


So, we go a memory dump and was able to see following error was thrown with StackOverflow exception. This below error was throwing over and over again.
.........Glass.Mapper.Sc.SitecoreService.RunCreateType(Sitecore.Data.Items.Item, Glass.Mapper.GetOptions, System.Collections.Generic.Dictionary`2<System.String, System.Object>)Glass.Mapper.Sc.LazyItemEnumerable`1[[System.__Canon, mscorlib]].ProcessItems()mscorlib_ni!System.Lazy`1[System.__Canon].CreateValue()$##6000F19+ecmscorlib_ni!System.Lazy`1[System.__Canon].LazyInitValue()$##6000F18+b8Glass.Mapper.Sc.LazyItemEnumerable`1[[System.__Canon, mscorlib]]..ctor(Glass.Mapper.Sc.GetItemsOptions, Glass.Mapper.Sc.ISitecoreService, Glass.Mapper.LazyLoadingHelper)DynamicClass.lambda_method(System.Runtime.CompilerServices.Closure, System.Object[])Glass.Mapper.Utilities.CreateGenericType(System.Type, System.Type[], System.Object[])Glass.Mapper.Sc.SitecoreService.GetItems(Glass.Mapper.Sc.GetItemsOptions)Glass.Mapper.AbstractDataMapper.MapCmsToProperty(Glass.Mapper.AbstractDataMappingContext)Glass.Mapper.Configuration.AbstractTypeConfiguration.MapPropertiesToObject(System.Object, Glass.Mapper.IAbstractService, Glass.Mapper.AbstractTypeCreationContext)Glass.Mapper.Pipelines.ObjectConstruction.Tasks.CreateConcrete.CreateConcreteTask.CreateObjectAndMapProperties(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs)Glass.Mapper.Pipelines.ObjectConstruction.Tasks.CreateConcrete.CreateConcreteTask.Execute(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs)Glass.Mapper.Pipelines.AbstractPipelineTask`1[[System.__Canon, mscorlib]].Next(System.__Canon)Glass.Mapper.Sc.Pipelines.ObjectConstruction.EnforcedTemplateCheck.PerformTemplateCheck(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs, Sitecore.Data.ID, Glass.Mapper.Sc.Configuration.SitecoreEnforceTemplate)Glass.Mapper.Pipelines.AbstractPipelineTask`1[[System.__Canon, mscorlib]].Next(System.__Canon)Glass.Mapper.Pipelines.ObjectConstruction.Tasks.CacheCheck.CacheCheckTask.Execute(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs)Glass.Mapper.Pipelines.AbstractPipelineTask`1[[System.__Canon, mscorlib]].Next(System.__Canon)Glass.Mapper.Sc.Pipelines.ObjectConstruction.SitecoreItemTask.Execute(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs)Glass.Mapper.Pipelines.AbstractPipelineTask`1[[System.__Canon, mscorlib]].Next(System.__Canon)Glass.Mapper.Pipelines.AbstractPipelineTask`1[[System.__Canon, mscorlib]].Next(System.__Canon)Glass.Mapper.Sc.Pipelines.ObjectConstruction.NullItemTask.Execute(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs)Glass.Mapper.Pipelines.AbstractPipelineRunner`2[[System.__Canon, mscorlib], [System.__Canon, mscorlib]].Run(System.__Canon)Glass.Mapper.AbstractService.InstantiateObject(Glass.Mapper.AbstractTypeCreationContext)Glass.Mapper.Sc.SitecoreService.RunCreateType(Sitecore.Data.Items.Item, Glass.Mapper.GetOptions, System.Collections.Generic.Dictionary`2<System.String, System.Object>)Glass.Mapper.AbstractDataMapper.MapCmsToProperty(Glass.Mapper.AbstractDataMappingContext)Glass.Mapper.Configuration.AbstractTypeConfiguration.MapPropertiesToObject(System.Object, Glass.Mapper.IAbstractService, Glass.Mapper.AbstractTypeCreationContext)Glass.Mapper.Pipelines.ObjectConstruction.Tasks.CreateConcrete.CreateConcreteTask.CreateObjectAndMapProperties(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs)Glass.Mapper.Pipelines.ObjectConstruction.Tasks.CreateConcrete.CreateConcreteTask.Execute(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs)Glass.Mapper.Pipelines.AbstractPipelineTask`1[[System.__Canon, mscorlib]].Next(System.__Canon)Glass.Mapper.Sc.Pipelines.ObjectConstruction.EnforcedTemplateCheck.PerformTemplateCheck(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs, Sitecore.Data.ID, Glass.Mapper.Sc.Configuration.SitecoreEnforceTemplate)Glass.Mapper.Pipelines.AbstractPipelineTask`1[[System.__Canon, mscorlib]].Next(System.__Canon)Glass.Mapper.Pipelines.ObjectConstruction.Tasks.CacheCheck.CacheCheckTask.Execute(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs)Glass.Mapper.Pipelines.AbstractPipelineTask`1[[System.__Canon, mscorlib]].Next(System.__Canon)Glass.Mapper.Sc.Pipelines.ObjectConstruction.SitecoreItemTask.Execute(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs)Glass.Mapper.Pipelines.AbstractPipelineTask`1[[System.__Canon, mscorlib]].Next(System.__Canon)Glass.Mapper.Pipelines.AbstractPipelineTask`1[[System.__Canon, mscorlib]].Next(System.__Canon)Glass.Mapper.Sc.Pipelines.ObjectConstruction.NullItemTask.Execute(Glass.Mapper.Pipelines.ObjectConstruction.ObjectConstructionArgs)Glass.Mapper.Pipelines.AbstractPipelineRunner`2[[System.__Canon, mscorlib], [System.__Canon, mscorlib]].Run(System.__Canon)Glass.Mapper.AbstractService.InstantiateObject(Glass.Mapper.AbstractTypeCreationContext)Glass.Mapper.Sc.SitecoreService.RunCreateType(Sitecore.Data.Items.Item, Glass.Mapper.GetOptions, System.Collections.Generic.Dictionary`2<System.String, System.Object>)Glass.Mapper.Sc.SitecoreService.GetItem[[System.__Canon, mscorlib]](Glass.Mapper.Sc.GetItemOptions) ................

After few days of investigation, we were lucky enough to see some code part in our solution that might caused this. It was actually a LazyLoad setting setup for InferType properties in the base Glass model. From our code, we have disabled LazyLoading for InterType which caused the Glass Mapper to load all the parent/children items for Parents/Children InferType property defined in the Glass Base mode.

public GetItemByIdOptions CreateGetItemByIdOptions(Guid id) => new GetItemByIdOptions(id) { InferType = true, Lazy = Glass.Mapper.LazyLoading.Disabled };

Once we adjusted that "Lazy" setting to "Enabled" (see below), site starts to load without any issue again.


public GetItemByIdOptions CreateGetItemByIdOptions(Guid id) => new GetItemByIdOptions(id) { InferType = true, Lazy = Glass.Mapper.LazyLoading.Enabled };

Special thanks for Kamruz Jaman & Mike Renolds in Sitecore community to helping out with this issue with suggestions and time.


Hope this will help someone.. :-)


References :
This should be another reason for your Sitecore 9 site not loading - https://medium.com/@markgibbons25/sitecore-crashing-on-startup-with-internal-error-in-the-net-runtime-be5831e94b6e


Happy Sitecore!!!














Saturday, July 6, 2019

Sitecore User Group Conference - India - 2019

SUGCON India was held for the second consecutive year in this year (2019) at Bengaluru, India. This years event was held at ITC Gardenia hotel, Bengaluru and was a success with more than 200 participated.




I had the opportunity to conduct the Sitecore JSS workshop at the Sitecore User Group Conference India 2019. 30 people participated for this JSS workshop organized by Sitecore as pre-event classroom training. Special thanks to Pieter Brinkman & Rob Earlam from Sitecore for giving me the opportunity to conduct this JSS workshop on behalf of Sitecore. I hope participants walk away with good understanding of Sitecore JSS.




Also I had the opportunity of presenting my findings & experience on Sitecore SXA. Topic of the talk was "Accelerate your Sitecore website delivery with Sitecore SXA" and hope participants got motivation after seeing the website time-to-deliver got reduced dramatically using Sitecore SXA.


Presentation Slides : https://www.slideshare.net/chaturangaranatunga/accelerate-your-sitecore-website-delivery-with-sitecore-sxa-sugcon-india-2019
Presentation Recording : https://www.youtube.com/watch?v=D9oGYdANBN4&list=PLFwvXROgXsHMcp3KWefRIQSQMdTn0YIe0&index=27&t=0s


During the award ceremony held at the conclusion of the event, I receive my Sitecore Technology MVP 2019 award from Pieter Brinkman (Senior Director - Sitecore Technical Marketing). I thank Sitecore & Sitecore Technocal Marketing Team for the continuous help/encouragement provided for the community.

This is my 4th consecutive Sitecore Technology MVP award starting from year 2016.

Photo Credit : SUGCON India 2019 Website


I was interviewed by Sitecore for a Media bites session and following is its recording.



Overall it was a great event with meeting lots of community friends and lots and lots of knowledge sharing.

Hoping to see you all in next year's SUGCON India.



References:

SUGCON India Website : https://www.sugcon.in/
My Media bites interview : https://www.youtube.com/watch?v=lJFujE3J-RA&list=PLFwvXROgXsHM7Kh_64DSS_CXHOEka_Pb1&index=10
All the presentations slides : https://www.sugcon.in/2019-home/session-slides/
All the presentations recordings : https://www.youtube.com/playlist?list=PLFwvXROgXsHMcp3KWefRIQSQMdTn0YIe0
All the media from the event : https://www.sugcon.in/2019-home/media/




Wednesday, May 22, 2019

Make Sitecore SXA Sitemap Generation Respect SiteLanguages Setting

Recently we faced an issue where Sitecore SXA Sitemap is not respecting the Languages selected from the "Site Languages" field in site settings item.


For example, say you have a SXA site with "en-GB" selected as the Site Language in the settings. (see image below).



But  if an item have "en" language item also, generated sitemap will contain "hreflang" entries for both "en-GB" and "en" languages. (see image below)



So I decoded the Sitecore.XA.Feature.SiteMetadata.dll and in the "BuildMultilanguageSitemap" method, it's taking all the languages of the item and adding "hreflang" for each of those languages.
As you can see in the below image, it doesn't consider "Site Languages" setting set in the "Settings" item.




public class SitemapGenerator : Sitecore.XA.Feature.SiteMetadata.Sitemap.SitemapGenerator
{
    {
        private _MultiLanguageSettings _multiLanguageSettings;

        public SitemapGenerator() : base()
        {
            _multiLanguageSettings = ServiceLocator.ServiceProvider.GetService<IMultiLanguageRepository>().GetMultiLanguageSettings(Sitecore.Context.Site);
        }

        protected override StringBuilder BuildMultilanguageSitemap(IEnumerable<Item> childrenTree, SitemapLinkOptions options)
        {
            UrlOptions urlOptions = this.GetUrlOptions();
            SitemapLinkOptions options1 = new SitemapLinkOptions(options.Scheme, urlOptions, options.TargetHostname);
            List<XElement> xelementList1 = new List<XElement>();
            StringBuilder stringBuilder = new StringBuilder();

            if (_multiLanguageSettings == null || _multiLanguageSettings.SiteLanguages == null || !_multiLanguageSettings.SiteLanguages.Any())
            {
                return stringBuilder;
            }

            foreach (Item item in childrenTree)
            {
                SitemapChangeFrequency sitemapChangeFrequency = item.Fields[Sitecore.XA.Feature.SiteMetadata.Templates.Sitemap._Sitemap.Fields.ChangeFrequency].ToEnum<SitemapChangeFrequency>();

                if (sitemapChangeFrequency != SitemapChangeFrequency.DoNotInclude)
                {
                    List<XElement> xelementList2 = new List<XElement>();

                    foreach (Language language in item.Languages)
                    {
                        if (!_multiLanguageSettings.SiteLanguages.Any(l => l.Name.Equals(language.Name, StringComparison.InvariantCultureIgnoreCase)))
                        {
                            continue;
                        }

                        Item langItem = item.Database.GetItem(item.ID, language);
                        if (langItem.Versions.Count > 0)
                        {
                            options1.UrlOptions.Language = language;
                            XElement xelement = this.BuildAlternateLinkElement(this.GetFullLink(langItem, options1), language.CultureInfo.Name, "alternate");
                            xelementList2.Add(xelement);
                        }
                    }

                    options1.UrlOptions.Language = item.Language;
                    XElement xelement1 = this.BuildPageElement(this.GetFullLink(item, options1), this.GetUpdatedDate(item), sitemapChangeFrequency.ToString().ToLower(), this.GetPriority(item), (IEnumerable<XElement>)xelementList2);
                    xelementList1.Add(xelement1);
                }
            }

            XDocument xdocument = this.BuildXmlDocument((IEnumerable<XElement>)xelementList1);

            using (TextWriter textWriter = (TextWriter)new StringWriter(stringBuilder))
            {
                xdocument.Save(textWriter);
            }

            this.FixDeclaration(stringBuilder);
            return stringBuilder;
        }
}


Hope this helps !!!