Testing Algolia API with Playwright

[mmorris8]

In effort to improve my site's relability I've been introducing tests across the board. I'm going to start this thread to share notes.

So my first working test doing this is pretty small.

import { test, expect } from '../../../tests/fixtures.js'
import * as algoliaResponse from "./test-response.json"

test('Get Care', async({page}) => {
  await page.route(/algolia.net/, async route => {
    route.fulfill({ json: algoliaResponse })
  })

  await page.goto(testPage)

  await expect(page).toHaveScreenshot({ fullPage: true})
})

So I use visual regression testing pretty heavily. I'll likely need to mask the google maps output of this page as I can't control when they'll add new pins. The algoliaResponse json I just captured with Playwright. This page currently gets 191 hits, and I'm pruning this down to three with different attributes so that I can verify their layouts work.

Long term I'll be adjusting this to test how my system reacts to no results.

If anyone else has explored this more than the above and would like to share I'd like to take a look.

[Haroenv]

In general that is indeed a good option, alternatively you can add a custom searchClient that returns static responses for tests

[mmorris8]

That could work for unit tests, but in an integration test it constitutes a new application state. By having Playwright intercept and rewrite the data returns the normal searchClient that handles those returns gets tested.