Skip to main content

Sitecore CLI error - The request queue limit of the session is exceeded

Welcome to another short story about debugging an issue we faced recently during our production release. We use Azure DevOps build/release pipelines to release our code to higher environments.

The Problem

We have an Install Sitecore Items task in release pipeline to install Sitecore items on higher environments. We started facing an issue where the task failed with below errors -

2023-12-20T21:17:46.2357659Z Root config: C:\azagent\A3\_work\_tasks\InlinePowershell_31f040e5-e040-4336-878a-59a493355534\1.1.7\sitecore.json
2023-12-20T21:17:46.2383724Z [GraphQLHttpException] Unexpected HttpResponseMessage with code: InternalServerError
2023-12-20T21:17:46.2499102Z at GraphQL.Client.Http.Internal.GraphQLHttpHandler.ReadHttpResponseMessageAsync(HttpResponseMessage httpResponseMessage)
2023-12-20T21:17:46.2500367Z at GraphQL.Client.Http.Internal.GraphQLHttpHandler.PostAsync(GraphQLRequest request, CancellationToken cancellationToken)
2023-12-20T21:17:46.2501478Z at Sitecore.DevEx.Core.Client.GraphQl.SitecoreApiClient.<>c__DisplayClass11_0.<<RunQuery>b__0>d.MoveNext()
2023-12-20T21:17:46.2502543Z --- End of stack trace from previous location ---
2023-12-20T21:17:46.2504096Z at Sitecore.DevEx.Configuration.Authentication.OidcAuthenticationProvider.MakeAuthenticatedRequestInternal(HttpClient client, Func`2 requestAction) in C:\BA\ca7111d945a16af4\src\Sitecore.DevEx.Configuration\Authentication\OidcAuthenticationProvider.cs:line 87
2023-12-20T21:17:46.2505209Z at Sitecore.DevEx.Configuration.Authentication.OidcAuthenticationProvider.MakeAuthenticatedRequest(HttpClient client, Func`2 requestAction) in C:\BA\ca7111d945a16af4\src\Sitecore.DevEx.Configuration\Authentication\OidcAuthenticationProvider.cs:line 76
2023-12-20T21:17:46.2506308Z at Sitecore.DevEx.Configuration.Authentication.ClientCredentialsAuthenticationProvider.MakeAuthenticatedRequest(HttpClient client, Func`2 requestAction) in C:\BA\ca7111d945a16af4\src\Sitecore.DevEx.Configuration\Authentication\ClientCredentialsAuthenticationProvider.cs:line 106
2023-12-20T21:17:46.2507416Z at Sitecore.DevEx.Configuration.Models.EnvironmentConfiguration.MakeAuthenticatedRequest(HttpClient client, Func`2 requestAction) in C:\BA\ca7111d945a16af4\src\Sitecore.DevEx.Configuration\Models\EnvironmentConfiguration.cs:line 275
2023-12-20T21:17:46.2508581Z at Sitecore.DevEx.Core.Client.GraphQl.SitecoreApiClient.RunQuery(String servicePath, GraphQLRequest request, Boolean assertNoErrors, CancellationToken cancellationToken)
2023-12-20T21:17:46.2509746Z at Sitecore.DevEx.Serialization.Client.Datasources.Sc.Query.SitecoreTreeDataStore.ExecuteSingleBatchQuery[T](String batchQueryFragment, TreeScope scope, ItemSpec[] specs, CancellationToken cancellationToken)
2023-12-20T21:17:46.2510916Z at Sitecore.DevEx.Serialization.Client.Datasources.Sc.Query.SitecoreTreeDataStore.CreateParallelBatchQuery[T](String batchQueryFragment, TreeScope scope, ItemSpec[] specs, CancellationToken cancellationToken)
2023-12-20T21:17:46.2512035Z at Sitecore.DevEx.Serialization.Client.Datasources.Sc.Query.SitecoreTreeDataStore.GetTreeNodesInternal(IEnumerable`1 itemSpecs, TreeScope scope, CancellationToken cancellationToken)
2023-12-20T21:17:46.2513104Z at Sitecore.DevEx.Serialization.Client.Datasources.Sc.Query.SitecoreTreeDataStore.GetTreeNodes(IEnumerable`1 itemSpecs, CancellationToken cancellationToken)
2023-12-20T21:17:46.2514024Z at Sitecore.DevEx.Serialization.Client.TreeCongruencyCommandBuilder.<>c__DisplayClass11_0.<<CreateProcessDataflow>b__0>d.MoveNext()
2023-12-20T21:17:46.3912755Z ##[error]Sitecore CLI is failed


When we looked at our CM logs, we found below errors which we never saw in logs before -

11808 21:17:36 INFO HttpModule is being initialized
11808 21:17:36 ERROR Application error.
Exception: System.Web.HttpException
Message: The request queue limit of the session is exceeded.
Source: System.Web
at System.Web.SessionState.SessionStateModule.QueueRef()
at System.Web.SessionState.SessionStateModule.PollLockedSession()
at System.Web.SessionState.SessionStateModule.GetSessionStateItem()
at System.Web.SessionState.SessionStateModule.BeginAcquireState(Object source, EventArgs e, AsyncCallback cb, Object extraData)
at System.Web.HttpApplication.AsyncEventExecutionStep.System.Web.HttpApplication.IExecutionStep.Execute()
at System.Web.HttpApplication.ExecuteStepImpl(IExecutionStep step)
at System.Web.HttpApplication.ExecuteStep(IExecutionStep step, Boolean& completedSynchronously)


We tried increasing the polling intervals to 60 based on recommendations we could find on internet but it did not help. This issue did not occur in any of the lower environments which used the same release pipelines and deployed same Sitecore Item package.

 The Research

The error we encountered was related to the exceptions noted on the CM side. Typically, the message "The request queue limit of the session is exceeded." arises when the server receives an excessive number of requests and can't process them all at once. This is due to the ASP .NET Session State Module's exclusive locking of each request from the same session, resulting in one-at-a-time request execution.

As far as we saw the provided logs, some of the requests take quite a noticeable amount of time to execute, for example: 
2023-12-20T21:17:45.2197466Z [master] [GraphQL> Get metadata (master; 3 specs, SingleItem)] Request 422 returned in 8720ms
...
2023-12-20T21:17:45.7170789Z [master] [GraphQL> Get metadata (master; 2 specs, SingleItem)] Request 420 returned in 9217ms
...
2023-12-20T21:17:46.2331741Z [master] [GraphQL> Get metadata (master; 10 specs, SingleItem)] Request 417 returned in 9738ms 

Thus, the issue could have been potentially caused by the slowness on the CM instance. 

At the same time, it looked like the "aspnet:RequestQueueLimitPerSession" setting is set to 25 in your Web.config file. We realized since we didn't experience any noticeable performance issues in our  CM instance apart from the failing CLI command, we tried increasing the value of the setting to see if it has any effect. This increased the max allowed  request request queue and, thus, decrease the chance of  this error arriving. And it worked!!

To confirm our theory, we also connected with the Sitecore Support team and they confirmed the fix we implemented is the expected solution in such scenarios.

Thanks for reading, hope it helps you!!

Labels:

Popular posts from this blog

Sitecore PowerShell Script to create all language versions for an item from en version

  We have lots of media items and our business wants to copy the data from en version of media item to all other language versions defined in System/Languages. This ensures that media is available in all the languages. So, we created the below powershell script to achieve the same -  #Get all language versions defined in System/Languages $languages = Get-ChildItem /sitecore/System/Languages -recurse | Select $_.name | Where-Object {$_.name -ne "en"} | Select Name #Ensuring correct items are updated by comparing the template ID  $items = Get-ChildItem -Path "/sitecore/media library/MyProjects" -Recurse | Where-Object {'<media item template id>' -contains $_.TemplateID} #Bulk update context to improve performance New-UsingBlock (New-Object Sitecore.Data.BulkUpdateContext) { foreach($item in $items){    foreach($language in $languages){ $languageVersion = Get-Item -Path $item.Paths.Path -Language $language.Name #Check if language versi
Read more

Export Sitecore media library files to zip using SPE

If you ever require to export Sitecore media files to zip (may be to optimize them), SPE (Sitecore Powershell Extension) has probably the easiest way to do this for you. It's as easy as the below 3 steps -  1. Right click on your folder (icons folder in snap)>Click on Scripts> Click on Download 2. SPE will start zipping all the media files placed within this folder. 3. Once zipping is done, you will see the Download option in the next screen. Click Download Zip containing the media files within is available on your local machine. You can play around with the images now. Hope this helps!! Like and Share ;)
Read more

Make Sitecore instance faster using Roslyn Compiler

When we install the Sitecore instance on local, the first load is slow. After each code deploy also, it takes a while for the Sitecore instance to load and experience editor to come up. For us, the load time for Sitecore instance on local machines was around 4 minutes. We started looking for ways to minimize it and found that if we update our Web.config to use Roslyn compiler and include the relevant Nugets into the project, our load times will improve. We followed the simple steps - Go to the Project you wish to add the NuGet package and right click the project and click 'Manage NuGet Packages'. Make sure your 'Package Source' is set to nuget.org and go to the 'Browse' Tab and search Microsoft.CodeDom.Providers.DotNetCompilerPlatform. Install whichever version you desire, make sure you note which version you installed. You can learn more about it  here . After installation, deploy your project, make sure the Microsoft.CodeDom.Providers.DotNetCompilerPlatform.d
Read more

Experience of a first time Sitecore MVP

The Journey I have been working in Sitecore for almost 10 years now. When I was a beginner in Sitecore, I was highly impressed by the incredible community support. In fact, my initial Sitecore learning path was entirely based on community written blogs on Sitecore. During a discussion with my then technology lead Neeraj Gulia , he proposed the idea that I should start giving back to developer community whenever I get chance. Just like I have been helped by many developers via online blogs, stackoverflow etc., I should also try to help others. Fast forward a few years and I met  Nehemiah Jeyakumar  (now an MVP). He had a big archive of his technical notes in the form Sitecore blogs. I realized my first blog dont have to be perfect and it can be as simple as notes to a specific problem for reference in future. That's when I probably created my first blog post on Sitecore. At that time, I didn't knew about the Sitecore MVP program. Over the years, I gained more confidence to write
Read more

Clean Coding Principles in CSharp

A code shall be easy to read and understand. In this post, I am outlining basic principles  about clean coding after researching through expert recommended books, trainings and based on my experience. A common example to start with is a variable declaration like - int i  The above statement did not clarify the purpose of variable i. However,  the same variable can be declared as -  int pageNumber The moment we declared the variable as int pageNumber, our brain realized that the variable is going to store the value for number of pages. We have set the context in our brain now and it is ready to understand what the code is going to do next with these page numbers. This is one of the basic advantages of clean coding. Reasons for clean coding -  • Reading clean code is easier - Every code is revisited after certain amount of time either by the same or different developer who created it. In both the cases, if the code is unclean, its difficult to understand and update it. • To avoid s
Read more