Improve Performance for InstantSearch.js

Preparing the connection to Algolia

When sending the first network request to a domain, a security handshake must happen, consisting of several round trips between the client and the Algolia server. If the handshake first happened when the user typed their first keystroke, the speed of that first request would be significantly slower.

You can use a preconnect link to carry out the handshake immediately after the page has loaded, before any user interaction. To do this, add a link tag with your Algolia domain in the head of your page.

1
2
3
4
<link crossorigin href="https://YOUR_APPID-dsn.algolia.net" rel="preconnect" />

<!-- for example: -->
<link crossorigin href="https://B1G2GM9NG0-dsn.algolia.net" rel="preconnect" />

Mitigate the impact of a slow network on your application

Since Algolia is a hosted search API, the search experience is affected if the network is slow. This guide shows you how to make the user’s perception of search better despite adverse network conditions.

Adding a loading indicator

Using the search box

Imagine a user using your search in a subway, by default this is the kind of experience they get:

• type some characters
• nothing happens
• still waiting, still nothing

At this point, the user is really wondering what’s happening. You can start enhancing this experience by providing a visual element to hint that something is happening: a loading indicator.

And for this, InstantSearch.js provides an option in the searchBox called showLoadingIndicator. The indicator appears in the searchBox. It’s also triggered a little after the last query has been sent to Algolia. This prevents the element to flicker. The delay can be configured using the stalledSearchDelay on the instantSearch constructor.

All examples in this guide assume you’re including InstantSearch.js in your web page via a CDN. If you’re using it with a package manager, you should adjust the way you import InstantSearch.js and its widgets. Read How to install InstantSearch.js for more information.

Here is an example:

1
2
3
4
5
6
7
8
9
10
11
12
13
const search = instantsearch({
  indexName: 'instant_search',
  stalledSearchDelay: 200, // this is the default value for the delay
  searchClient,
})

search.addWidgets([
  instantsearch.widgets.searchBox({
    container: '#searchBox',
    placeholder: 'Search for products',
    showLoadingIndicator: true, // this add the loading indicator
  }),
])

Make your own loading indicator

The mechanism of the search box loading indicator is also available to other widgets. Here, you’ll see how to make a custom widget that changes based on the loading conditions.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
const search = instantsearch({
  indexName: 'instant_search',
  searchClient,
})

// The container that we want to use has to in the page
const loadingContainer = document.querySelector('#loading')

search.addWidgets([
  {
    render({ searchMetadata = {} }) {
      const { isSearchStalled } = searchMetadata

      loadingContainer.innerHTML = isSearchStalled ? 'Loading...' : ''
    },
  },
])

This example shows how to make a custom component that writes Loading... when search stalls. If network conditions are optimal, users won’t see this message.

Debouncing

Another way of improving the perception of performance is to try to prevent lag. Although the default InstantSearch experience of generating one query per keystroke is usually desirable, this can lead to a lag in the worst network conditions because browsers can only make a limited number of parallel requests. By reducing the number of requests done, you can prevent this lag.

Debouncing is a way to limit the number of requests and avoid processing non-necessary ones by avoiding sending requests before a timeout.

There is no built-in solution to debounce in InstantSearch.js. You can implement it at the searchBox level though with the queryHook option. Here is an example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
const search = instantsearch({
  indexName: 'instant_search',
  searchClient,
})

let timerId

search.addWidgets([
  instantsearch.widgets.searchBox({
    container: document.querySelector('#searchBox'),
    placeholder: 'Search for products',
    queryHook(query, refine) {
      clearTimeout(timerId)
      timerId = setTimeout(() => refine(query), 500)
    },
  }),
])

This function uses the option queryHook. This function is called every time a keystroke has to be made. In this case, the code debounces the call to refine.

Optimize build size

InstantSearch.js supports dead code elimination via tree shaking but you need to follow a few rules to make it work correctly:

• Bundle your code using a module bundler that supports tree shaking via the sideEffects property in package.json, such as Rollup or webpack 4+.
• Make sure to pick the ES module build of InstantSearch.js by targeting the module field in package.json (resolve.mainFields option in webpack, mainFields option in @rollup/plugin-node-resolve). This is the default configuration in most popular bundlers, so you shouldn’t need to change anything unless you have a custom configuration.
• Keep Babel or other transpilers from transpiling ES6 modules to CommonJS modules. Tree shaking is much less optimal on CommonJS modules, so it’s better to let your bundler handle modules by itself.

If you’re using Babel, you can configure babel-preset-env not to process ES6 modules:

1
2
3
4
5
6
7
8
9
10
11
// babel.config.js
module.exports = {
  presets: [
    [
      'env',
      {
        modules: false,
      },
    ],
  ],
}

or if you are using the TypeScript compiler (tsc):

1
2
3
4
5
6
// tsconfig.json
{
  "compilerOptions": {
    "module": "esnext",
  }
}

• Import only what you need. For this, you can use the multiple entry points from the ES module build:

  JavaScript

  Copy

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  // instantsearch() function without reference to the widgets or connectors
  import instantsearch from 'instantsearch.js/es';
  
  // Import connectors individually
  import { connectSearchBox } from 'instantsearch.js/es/connectors';
  
  // Import widgets individually
  import { searchBox } from 'instantsearch.js/es/widgets';
  
  const search = instantsearch({ ... });
  
  search.addWidgets([searchBox({ ... })]);
  search.addWidgets([connectSearchBox(() => { ... })({ ... })])
  

Troubleshooting

To ensure tree shaking is working, you can try to import InstantSearch.js in your project without using it.

1
import 'instantsearch.js/es' // Unused import

Build your application, then look for the unused code in your final bundle (for example, “InstantSearch”). If tree shaking works, you shouldn’t find anything.

Caching

Caching by default (and how to turn it off)

By default, Algolia caches the search results of the queries, storing them locally in the cache. If the user ends up entering a search (or part of it) that has already been entered previously, the results will be retrieved from the cache, instead of requesting them from Algolia, making the application much faster. Note that the cache is an in-memory cache, which means that it only persist during the current page session. As soon as the page reloads the cache is cleared.

While it’s a very convenient feature, sometimes it’s useful to have the ability to clear the cache and make a new request to Algolia. For instance, when changes are made on some records on your index, you might want the front end of your application to be updated to reflect that change (to avoid displaying stale results retrieved from the cache).

To do so, there is a method on the instantsearch instance called refresh(). When the method is called, it clears the cache and triggers a new search.

There are two different use cases where you would want to discard the cache:

• your application data is being directly updated by your users (for example, in a dashboard). In this use case you would want to refresh the cache based on some application state such as the last modification from the user.
• your application data is being updated by another process that you don’t manage (for example a cron job that updates users inside Algolia). For this you might want to periodically refresh the cache of your application.

Refresh the cache triggered by an action from the user

If you know that the cache needs to be refreshed conditionally after a specific event, then you can trigger the refresh based on a user action (adding a new product, clicking on a button for instance).

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
const search = instantsearch({
  indexName: 'demo_ecommerce',
  searchClient,
})

search.addWidgets([
  instantsearch.widgets.searchBox({
    container: '#searchbox',
  }),
])

search.addWidgets([
  instantsearch.widgets.hits({
    container: '#hits',
  }),
])

document.querySelector('button').addEventListener('click', () => {
  search.refresh()
})

search.start()

You can also check out the live example. You can find the source code of the example on GitHub.

Refresh the cache periodically

You can also set up an interval that determines how often the cache is cleared. This method ensures that the cache is cleared on a regular basis. You should use this approach if you can’t use a user action as a specific event to trigger the clearing of the cache.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
const search = instantsearch({
  indexName: 'demo_ecommerce',
  searchClient,
})

search.addWidgets([
  instantsearch.widgets.searchBox({
    container: '#searchbox',
  }),

  instantsearch.widgets.hits({
    container: '#hits',
  }),
])

setInterval(() => {
  search.refresh()
}, 5000)

search.start()

Note that if you need to wait for an action from Algolia, you should use waitTask to avoid refreshing the cache too early. Check out the live example. You can find the source code of the example on GitHub.

Queries per second (QPS)

Search operations aren’t limited by a fixed “search quota”. That being said, they’re limited by the maximum QPS and the operations limit of your plan.

Every key press in InstantSearch using the searchBox counts as one operation. Then, depending on the widgets you add to your search interface, you may have more operations being counted on each keystroke. For example, if you have a search interface with a searchBox, a menu, and a refinementList, then every keystroke triggers one operation. But as soon as a user refines the menu or refinementList, it triggers a second operation on each keystroke.

A good rule to keep in mind is that most search interfaces using InstantSearch trigger one operation per keystroke. Then every refined widget (clicked widget) adds one more operation to the total count.

In case you have issue with the QPS you can consider implement a debounced searchBox.