Take the community feedback survey now.

dada
Jan 28, 2022
  76
(0 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

Please login to comment.
Latest blogs
A day in the life of an Optimizely OMVP - Opticon London 2025

This installment of a day in the life of an Optimizely OMVP gives an in-depth coverage of my trip down to London to attend Opticon London 2025 held...

Graham Carr | Oct 2, 2025

Optimizely Web Experimentation Using Real-Time Segments: A Step-by-Step Guide

  Introduction Personalization has become de facto standard for any digital channel to improve the user's engagement KPI’s.  Personalization uses...

Ratish | Oct 1, 2025 |

Trigger DXP Warmup Locally to Catch Bugs & Performance Issues Early

Here’s our documentation on warmup in DXP : 🔗 https://docs.developers.optimizely.com/digital-experience-platform/docs/warming-up-sites What I didn...

dada | Sep 29, 2025

Creating Opal Tools for Stott Robots Handler

This summer, the Netcel Development team and I took part in Optimizely’s Opal Hackathon. The challenge from Optimizely was to extend Opal’s abiliti...

Mark Stott | Sep 28, 2025

Integrating Commerce Search v3 (Vertex AI) with Optimizely Configured Commerce

Introduction This blog provides a technical guide for integrating Commerce Search v3, which leverages Google Cloud's Vertex AI Search, into an...

Vaibhav | Sep 27, 2025

A day in the life of an Optimizely MVP - Opti Graph Extensions add-on v1.0.0 released

I am pleased to announce that the official v1.0.0 of the Opti Graph Extensions add-on has now been released and is generally available. Refer to my...

Graham Carr | Sep 25, 2025