dada
Jan 28, 2022
  4317
(3 votes)

Configure your own Search & Navigation timeouts

Changing the timeout for Search & Navigation requests is something that has been requested over and over in forums and support cases for quite some time.
The default request timeout is set to 100 seconds (HttpWebRequest.Timeout default) which could be problematic when requests takes longer than expected.

You might know that you can set the request timeout in configuration

This will be used for all types of Find requests and could pose a problem if you want to lower it to 10 secs but at the same time not affect requests that should be allowed to run longer e.g bulk requests.

Timeout is set in milliseconds.

CMS 11 and lower

<appSettings><add key="episerver:FindDefaultRequestTimeout" value="30000" />

CMS 12

   "AppSettings": {
        "episerver:FindDefaultRequestTimeout": 30000
    }

More on configuration here https://world.optimizely.com/documentation/developer-guides/CMS/configuration/

But it's also possible with some code to set the timeout for a specific request

Add the following extension methods

public static ITypeSearch<TResult> SetTimeout<TResult>(this ITypeSearch<TResult> search, int timeout)
{
    return new Search<TResult, IQuery>(search, context =>
    {
        var existingAction = context.CommandAction;
        context.CommandAction = command =>
        {
            if (existingAction.IsNotNull())
            {
                existingAction(command);
            }
            command.ExplicitRequestTimeout = timeout;
        };

    });
}

public static ISearch<TResult> SetTimeout<TResult>(this ISearch<TResult> search, int timeout)
{
    return new Search<TResult, IQuery>(search, context =>
    {
        var existingAction = context.CommandAction;
        context.CommandAction = command =>
        {
            if (existingAction.IsNotNull())
            {
                existingAction(command);
            }
            command.ExplicitRequestTimeout = timeout;
        };

    });
}

public static IMultiSearch<TResult> SetTimeout<TResult>(this IMultiSearch<TResult> multiSearch, int timeout)
{
    var searches = new List<ISearch<TResult>>(multiSearch.Searches);
    multiSearch.Searches.Clear();
    foreach (var search in searches)
    {
        multiSearch.Searches.Add(SetTimeout(search, timeout));
    }
    return multiSearch;
}

And use it like this

var results = SearchClient.Instance
  .UnifiedSearch
  .For("random fruit")
  .SetTimeout(10000)
  .GetResult();

var results = searchClient.Search<Fruits>
  .For("banana")
  .SetTimeout(1000)
  .GetResult();

var results = searchClient.MultiSearch<Fruits>()
  .Search<Exotic>(x => x.For("Kiwi").InField(y => y.SearchTitle()))
  .Search<Ordinary>(x => x.For("Apple").InField(y => y.SearchTitle()))
  .SetTimeout(1000)
  .GetResult();


Make sure you catch your timeouts. They will throw a ServiceException.
More on Find exceptions you should consider catching is available in Jonas Bergqvist's blog post Exceptions in find 

Jan 28, 2022

Comments

Matthew Boniface
Matthew Boniface Oct 6, 2023 05:35 AM

Thanks for this post, really need this on most projects. However, I found two things didn't work for me:

1) CMS 12 DefaultRequestTimeout I found needed to be configured as:

{
  "EPiServer": {
    "Find": {
      //developer index
      "ServiceUrl": "https://demo02.find.episerver.net/xxxAAAyyyZZZ/",
      "DefaultIndex": "me_xx202310",
      "DefaultRequestTimeout": 10000,
      "ReindexMySitesOnly": true
    },

2) The IMultiSearch extension methods seemed to have no effect - no matter what I tried I found that it just used the DefaultRequestTimeout.

Please login to comment.
Latest blogs
Creating an Optimizely Addon - Packaging for NuGet

In   Part One   and   Part Two   of this series; I covered topics from having a great idea, solution structure, extending the menus and adding...

Mark Stott | Sep 16, 2024

Optimizely CMS and weekly updates

Learn how reporting bugs in Optimizely CMS not only helps improve the platform but also benefits you and the entire user community.

Tomas Hensrud Gulla | Sep 12, 2024 | Syndicated blog

Introduce the ablility to select then delete items manually on FIND UI

In FIND 16.3.0 we introduce an ability to select items and delete them manually, it will helps you to delete unexpected items from the UI without a...

Manh Nguyen | Sep 12, 2024

The composable consulting model our industry needs

The architecture of a modern consulting business is ‘composable’. Certainly, we think of ourselves a composable consulting business and have done...

Mark Everard | Sep 12, 2024 | Syndicated blog

Keynote Summary from Opticon 2024, Stockholm

At Opticon in Stockholm, marking the 30th anniversary of Optimizely, the company celebrated significant achievements. These included surpassing $40...

Luc Gosso (MVP) | Sep 11, 2024 | Syndicated blog

#Onederful!

Opticon Stockholm has finished and my journey back to Yorkshire from #Onederland (via Oslo) has given me space to reflect. Here are the Top (or...

Mark Everard | Sep 11, 2024 | Syndicated blog