All files / spec/suites autocomplete.ts

98.29% Statements 289/294
76% Branches 19/25
97.11% Functions 101/104
99.14% Lines 232/234

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 4683x 3x 3x   3x 3x         3x   3x           3x     59x 59x                                             3x           3x 5x 59x               59x   125x 59x 59x   59x             5x 59x 59x 59x 59x 59x       3x             3x   3x 3x   3x   3x   6x             3x   3x   20x   15x 3x   3x 3x               3x 3x 3x 3x   3x   3x   21x   15x 3x   3x 3x               3x 3x 3x   3x 3x 3x 3x   3x 22x 4x       3x 3x 3x   3x 3x 3x 3x   3x     3x 3x 3x 3x 3x 3x 9x       3x 3x 3x   3x 3x 3x   3x 3x 3x 3x   3x     3x 3x 3x   3x 3x 3x   3x 3x 3x 3x   3x 19x     3x 3x 3x   3x 3x 3x 3x 3x 3x 3x   3x 3x     3x             3x 3x 3x   3x 3x 3x 3x 3x 3x 3x 3x   3x 3x     3x 3x 3x   3x 3x 3x 3x 3x 3x 3x   21x 3x   3x 3x 3x   3x 3x         3x 3x 3x   3x   3x 3x   3x 3x       3x 3x   3x   3x 3x   3x 3x               3x 3x   3x 3x   3x 3x 3x       3x 3x   3x 3x   3x 3x 3x               3x 3x   3x 3x   21x 21x 6x             3x 3x   3x 3x   20x 20x   3x               3x 3x   3x   3x   3x 3x   3x 3x   20x 20x 3x           3x     3x 3x   3x   3x   20x 20x 20x 20x             3x 3x   3x   3x   3x 3x   3x   3x 3x 3x 3x 3x 3x 3x 3x 3x   3x 3x           3x     3x 3x   3x   3x   21x 21x 21x 21x   21x                  
import { screen, waitFor } from "@testing-library/dom"
import userEvent from "@testing-library/user-event"
import searchResponse from "../responses/search.json"
 
import "@testing-library/jest-dom"
import {
  AutocompleteConfig,
  DefaultState,
  autocomplete,
} from "../../src/entries/base"
import { getDefaultConfig } from "../../src/config"
import type { API, SearchResult } from "@nosto/nosto-js/client"
import { mockNostojs } from "@nosto/nosto-js/testing"
 
type MockSearch = jest.Mock<ReturnType<API["search"]>>
type MockRecordSearchSubmit = jest.Mock<ReturnType<API["recordSearchSubmit"]>>
type MockRecordSearchClick = jest.Mock<ReturnType<API["recordSearchClick"]>>
 
export const handleAutocomplete = async (
  render: AutocompleteConfig<DefaultState>["render"],
  submit?: AutocompleteConfig<DefaultState>["submit"]
) => {
  autocomplete({
    fetch: {
      products: {
        fields: ["name", "url", "imageUrl", "price", "listPrice", "brand"],
        size: 5,
      },
      // @ts-expect-error missing fields
      keywords: {
        size: 5,
        fields: ["keyword", "_highlight.keyword"],
        highlight: {
          preTag: `<strong>`,
          postTag: "</strong>",
        },
      },
    },
    inputSelector: "#search",
    dropdownSelector: "#search-results",
    render,
    submit: submit ?? getDefaultConfig<DefaultState>().submit,
  })
}
 
const wait = (ms: number) => new Promise(resolve => setTimeout(resolve, ms))
 
let searchSpy: MockSearch
let recordSearchSubmitSpy: MockRecordSearchSubmit
let recordSearchClickSpy: MockRecordSearchClick
 
export function hooks(libraryScript: () => void) {
  beforeEach(() => {
    document.body.innerHTML = `
        <form id="search-form">
            <input type="text" id="search" placeholder="search" data-testid="input" />
            <button type="submit" data-testid="search-button">Search</button>
            <div id="search-results" class="ns-autocomplete" data-testid="dropdown"></div>
        </form>
    `
 
    libraryScript()
 
    searchSpy = jest.fn(async () => searchResponse as unknown as SearchResult)
    recordSearchSubmitSpy = jest.fn()
    recordSearchClickSpy = jest.fn()
 
    mockNostojs({
      search: searchSpy,
      recordSearchSubmit: recordSearchSubmitSpy,
      recordSearchClick: recordSearchClickSpy,
    })
  })
 
  afterEach(() => {
    jest.restoreAllMocks()
    const dropdown = screen.getByTestId("dropdown")
    const newElement = dropdown.cloneNode(true)
    dropdown?.parentNode?.replaceChild(newElement, dropdown)
    document.body.innerHTML = ""
  })
}
 
export function autocompleteSuite({
  render,
  libraryScript,
}: {
  render: () => AutocompleteConfig<DefaultState>["render"]
  libraryScript: () => void
}) {
  hooks(libraryScript)
 
  it("renders autocomplete", async () => {
    const user = userEvent.setup()
 
    await waitFor(() => handleAutocomplete(render()))
 
    await waitFor(
      () => {
        expect(screen.getByTestId("dropdown")).not.toBeVisible()
      },
      {
        timeout: 1000,
      }
    )
 
    await user.type(screen.getByTestId("input"), "black")
 
    await waitFor(
      () => {
        expect(screen.getByTestId("dropdown")).toBeVisible()
 
        expect(screen.getByText("Keywords")).toBeVisible()
        expect(screen.getAllByTestId("keyword")).toHaveLength(5)
 
        expect(screen.getByText("Products")).toBeVisible()
        expect(screen.getAllByTestId("product")).toHaveLength(5)
      },
      {
        timeout: 4000,
      }
    )
  })
 
  describe("history", () => {
    it("should see results after typing", async () => {
      const user = userEvent.setup()
      await waitFor(() => handleAutocomplete(render()))
 
      await user.type(screen.getByTestId("input"), "black")
 
      await waitFor(
        () => {
          expect(screen.getByTestId("dropdown")).toBeVisible()
 
          expect(screen.getByText("Keywords")).toBeVisible()
          expect(screen.getAllByTestId("keyword")).toHaveLength(5)
 
          expect(screen.getByText("Products")).toBeVisible()
          expect(screen.getAllByTestId("product")).toHaveLength(5)
        },
        {
          timeout: 4000,
        }
      )
    })
 
    it("should see history on empty input", async () => {
      const user = userEvent.setup()
      await waitFor(() => handleAutocomplete(render()))
 
      await user.clear(screen.getByTestId("input"))
      await user.type(screen.getByTestId("input"), "black")
      await user.click(screen.getByTestId("search-button"))
      await user.clear(screen.getByTestId("input"))
 
      await waitFor(() => {
        const historyElement = screen.getByText("Recently searched")
        return expect(historyElement).toBeVisible()
      })
    })
 
    it("should show history keyword", async () => {
      const user = userEvent.setup()
      await waitFor(() => handleAutocomplete(render()))
 
      await user.clear(screen.getByTestId("input"))
      await user.type(screen.getByTestId("input"), "black")
      await user.click(screen.getByTestId("search-button"))
      await user.clear(screen.getByTestId("input"))
 
      await waitFor(() => expect(screen.getByText("black")).toBeVisible())
    })
 
    it("should navigate and select history keywords with keyboard", async () => {
      const user = userEvent.setup()
      const expectedQuery = "black"
      let exactQuery = ""
      await waitFor(() =>
        handleAutocomplete(render(), query => {
          exactQuery = query
        })
      )
 
      await user.type(screen.getByTestId("input"), expectedQuery)
      await user.click(screen.getByTestId("search-button"))
      await user.clear(screen.getByTestId("input"))
 
      await user.type(screen.getByTestId("input"), "white")
      await user.click(screen.getByTestId("search-button"))
      await user.clear(screen.getByTestId("input"))
 
      await user.keyboard("{arrowdown}")
      await user.keyboard("{arrowdown}")
      await user.keyboard("{arrowup}")
      await user.keyboard("{enter}")
 
      expect(exactQuery).toBe(expectedQuery)
    })
 
    it("should show two history keywords", async () => {
      const user = userEvent.setup()
      await waitFor(() => handleAutocomplete(render()))
 
      await user.clear(screen.getByTestId("input"))
      await user.type(screen.getByTestId("input"), "red")
      await user.click(screen.getByTestId("search-button"))
 
      await user.clear(screen.getByTestId("input"))
      await user.type(screen.getByTestId("input"), "black")
      await user.click(screen.getByTestId("search-button"))
      await user.clear(screen.getByTestId("input"))
 
      await waitFor(() => expect(screen.getByText("black")).toBeVisible())
      await waitFor(() => expect(screen.getByText("red")).toBeVisible())
    })
 
    it("should clear history keyword", async () => {
      const user = userEvent.setup()
      await waitFor(() => handleAutocomplete(render()))
 
      await user.clear(screen.getByTestId("input"))
      await user.type(screen.getByTestId("input"), "red")
      await user.keyboard("{enter}")
      await user.clear(screen.getByTestId("input"))
      await user.type(screen.getByTestId("input"), "black")
      await user.keyboard("{enter}")
      await user.clear(screen.getByTestId("input"))
 
      await waitFor(async () => {
        const removeHistoryElement = screen.queryByTestId(
          "remove-history-black"
        )
        Iif (removeHistoryElement) {
          userEvent.click(removeHistoryElement)
          return waitFor(() => expect(screen.queryByText("black")).toBeNull())
        }
      })
    })
 
    it("should clear history", async () => {
      const user = userEvent.setup()
      await waitFor(() => handleAutocomplete(render()))
 
      await user.clear(screen.getByTestId("input"))
      await user.type(screen.getByTestId("input"), "red")
      await user.click(screen.getByTestId("search-button"))
      await user.clear(screen.getByTestId("input"))
      await user.type(screen.getByTestId("input"), "black")
      await user.click(screen.getByTestId("search-button"))
      await user.clear(screen.getByTestId("input"))
      await user.click(screen.getByText("Clear history"))
 
      await waitFor(() => expect(screen.queryByText("black")).toBeNull())
      await waitFor(() => expect(screen.queryByText("red")).toBeNull())
    })
 
    it("should highlight history keyword with keyboard navigation", async () => {
      const user = userEvent.setup()
      await waitFor(() => handleAutocomplete(render()))
 
      await user.clear(screen.getByTestId("input"))
      await user.type(screen.getByTestId("input"), "red")
      await user.click(screen.getByTestId("search-button"))
      await user.clear(screen.getByTestId("input"))
      await user.type(screen.getByTestId("input"), "black")
      await user.click(screen.getByTestId("search-button"))
      await user.clear(screen.getByTestId("input"))
 
      await waitFor(() => expect(screen.getByText("black")).toBeVisible())
      await waitFor(() => expect(screen.getByText("red")).toBeVisible())
 
      await user.keyboard("{arrowdown}")
      await user.keyboard("{arrowdown}")
      await user.keyboard("{arrowup}")
 
      await waitFor(() =>
        expect(screen.getByText("black")).toHaveClass("selected")
      )
    })
  })
 
  describe("analytics", () => {
    it("should record search submit", async () => {
      const user = userEvent.setup()
 
      await waitFor(() => handleAutocomplete(render()))
 
      await user.type(screen.getByTestId("input"), "black")
      await user.click(screen.getByTestId("search-button"))
 
      await waitFor(() =>
        expect(recordSearchSubmitSpy).toHaveBeenCalledWith("black")
      )
    })
 
    it("should call search with isKeyword=false", async () => {
      const user = userEvent.setup()
 
      await waitFor(() => handleAutocomplete(render()))
 
      await user.type(screen.getByTestId("input"), "black")
      await user.click(screen.getByTestId("search-button"))
 
      await waitFor(() =>
        expect(searchSpy).toHaveBeenCalledWith(expect.anything(), {
          track: "serp",
          redirect: true,
          isKeyword: false,
        })
      )
    })
 
    it("should record search submit with keyboard", async () => {
      const user = userEvent.setup()
 
      await waitFor(() => handleAutocomplete(render()))
      await user.type(screen.getByTestId("input"), "black")
 
      await waitFor(async () => {
        await user.keyboard("{enter}")
        expect(recordSearchSubmitSpy).toHaveBeenCalledWith("black")
      })
    })
 
    it("should call search with keyboard with isKeyword=false", async () => {
      const user = userEvent.setup()
 
      await waitFor(() => handleAutocomplete(render()))
      await user.type(screen.getByTestId("input"), "black")
 
      await waitFor(async () => {
        await user.keyboard("{enter}")
        expect(searchSpy).toHaveBeenCalledWith(expect.anything(), {
          track: "serp",
          redirect: true,
          isKeyword: false,
        })
      })
    })
 
    it("should record search click on keyword click", async () => {
      const user = userEvent.setup()
 
      await waitFor(() => handleAutocomplete(render()))
      await user.type(screen.getByTestId("input"), "black")
 
      await waitFor(async () => {
        await user.click(screen.getAllByTestId("keyword")?.[0])
        expect(recordSearchClickSpy).toHaveBeenCalledWith(
          "autocomplete",
          searchResponse.keywords.hits[0]
        )
      })
    })
 
    it("should call search on keyword click with isKeyword=true", async () => {
      const user = userEvent.setup()
 
      await waitFor(() => handleAutocomplete(render()))
      await user.type(screen.getByTestId("input"), "black")
 
      await waitFor(async () => {
        await user.click(screen.getAllByTestId("keyword")?.[0])
 
        expect(searchSpy).toHaveBeenCalledWith(expect.anything(), {
          track: "serp",
          redirect: false,
          isKeyword: true,
        })
      })
    })
 
    it("should record search click on product click", async () => {
      const user = userEvent.setup()
 
      const assignMock = jest.fn(() => ({}))
 
      const oldLocation = window.location
      // @ts-expect-error: mock location
      delete window.location
      window.location = { ...oldLocation, assign: assignMock }
 
      await waitFor(() => handleAutocomplete(render()))
      await user.type(screen.getByTestId("input"), "black")
 
      await waitFor(async () => {
        await user.click(screen.getAllByTestId("product")?.[0])
        expect(recordSearchClickSpy).toHaveBeenCalledWith(
          "autocomplete",
          searchResponse.products.hits[0]
        )
      })
 
      assignMock.mockClear()
    })
 
    it("should record search click on keyword submitted with keyboard", async () => {
      const user = userEvent.setup()
 
      await waitFor(() => handleAutocomplete(render()))
 
      await user.type(screen.getByTestId("input"), "black")
 
      await waitFor(async () => {
        await user.keyboard("{arrowdown}")
        await user.keyboard("{enter}")
        expect(recordSearchClickSpy).toHaveBeenCalledWith(
          "autocomplete",
          searchResponse.keywords.hits[0]
        )
      })
    })
 
    it("should record search click on product submitted with keyboard", async () => {
      const user = userEvent.setup()
 
      const assignMock = jest.fn(() => ({}))
 
      const oldLocation = window.location
      // @ts-expect-error: mock location
      delete window.location
      window.location = { ...oldLocation, assign: assignMock }
 
      await waitFor(() => handleAutocomplete(render()))
 
      await user.type(screen.getByTestId("input"), "black")
      await wait(500)
      await user.keyboard("{arrowdown}")
      await user.keyboard("{arrowdown}")
      await user.keyboard("{arrowdown}")
      await user.keyboard("{arrowdown}")
      await user.keyboard("{arrowdown}")
      await user.keyboard("{arrowdown}")
      await user.keyboard("{enter}")
 
      await waitFor(() => {
        expect(recordSearchClickSpy).toHaveBeenCalledWith(
          "autocomplete",
          searchResponse.products.hits[0]
        )
      })
 
      assignMock.mockClear()
    })
 
    it("should call search when keyword is submitted with keyboard, with isKeyword=true", async () => {
      const user = userEvent.setup()
 
      await waitFor(() => handleAutocomplete(render()))
 
      await user.type(screen.getByTestId("input"), "black")
 
      await waitFor(async () => {
        await user.keyboard("{arrowdown}")
        await user.keyboard("{arrowdown}")
        await user.keyboard("{enter}")
 
        expect(searchSpy).toHaveBeenCalledWith(expect.anything(), {
          track: "serp",
          redirect: false,
          isKeyword: true,
        })
      })
    })
  })
}