client.search should take parameters as object, but send as string

[Haroenv]

Description

Steps to reproduce

1. Use method searchClient.search
2. With parameters { requests: [{ indexName: "abc", params: { query: 'something', hitsPerPage: 2 }}]}
3. See error in browser (400 bad request)

Expected behavior

it should have turned the params into params: "query=something&hitsPerPage=2"

I think some search parameters are more than one level, but then don't get transformed further, just encoded and escaped

Environment

• OS: [e.g. Windows / Linux / macOS / iOS / Android] /
• Environment: [e.g. Browser / Node] /
• Client: [e.g. All / Recommend / Search / Insights] Search
• Language: [e.g. JavaScript / PHP / Java] JavaScript
• Client version: [e.g. 5.0.0] 577293e

[shortcuts]

Thanks!

Do you know if it's also the case with other clients?

[shortcuts]

Also, it seems to only be for this endpoint, right? The searchSingleIndex method allows sending objects?

[Haroenv]

see an example encoded string from v4: https://codesandbox.io/s/y05j5kyolj?file=/src/decode.js

in v4 it's done using serializeQueryParameters:

https://github.com/algolia/algoliasearch-client-javascript/blob/7f201f3769071f516d585ba293524739390b3c65/packages/client-search/src/methods/client/multipleQueries.ts#L19

https://github.com/algolia/algoliasearch-client-javascript/blob/7f201f3769071f516d585ba293524739390b3c65/packages/transporter/src/serializer.ts

[shortcuts]

Yep we do have that logic in place too but not at this level for this method

[Haroenv]

yes, singleIndexSearch doesn't have params, the options are json top-level (verified in https://codesandbox.io/s/gallant-hofstadter-v4ps0v?file=/src/app.js)

[Haroenv]

Actually that made me think, and the engine already accepts this (no scoping of params):

  const { results } = await client.search({
    requests: [
      {
        type: 'default',
        indexName: 'instant_search',
        query: 'hi',
        hitsPerPage: 1,
        analyticsTags: ['search!!'],
      },
      {
        type: 'facet',
        indexName: 'instant_search',
        facet: 'brand',
        facetQuery: 'app',
        hitsPerPage: 1,
        analyticsTags: ['facet'],
      },
    ],
  });

[Haroenv]

I don't know how to express that in specs, but the correct type is:

import type { SearchParamsObject } from './searchParamsObject';

export type SearchQueries = SearchParamsObject &
  (
    | {
        type: 'facet';
        indexName: string;
        facet: string;
        facetQuery?: string;
      }
    | {
        type?: 'default';
        indexName: string;
      }
  );

PS. this type should be called SearchQuery, not SearchQueries, as it's a single object

[shortcuts]

Can you open a second issue for #528 (comment) 😇 ? So we can tackle both and make tickets :D

[Haroenv]

I think the original issue doesn't need to be solved if #528 (comment) or #529 approach is chosen. That way the parameters are

search({
  requests: [{
    indexName,
    query,
    hitsPerPage,
    params, // as string, if you really still want it
  }]
})