Post search route

[bidoubiwa]

This PR creates an additional parameter method on the search route. This lets the user decide if he wants to use the POST method (faster) or the GET method.

The tests in the CI will fail until MeiliSearch v0.13.0 is out.

Currently, tested with the v0.13.0rc0, tests are failing because of:

• the error message changed (Change tests error messages #531 )
• Settings tests fixed in Settings changes #530 -> merged
• 404 on get system info tests: fixed in Remove sys-info and sys-info pretty #528 -> merged

Typescript issues

1 Itterating through an object with Typescrypt

The typings in the following code sample seems to be more complicated than it should be

function removeUndefinedFromObject(object: Record<string, any>): object {
  return Object.keys(object).reduce((acc: Record<string, any>, key: string) => {
    if (object[key] !== undefined) {
      acc[key] = object[key]
    }
    return acc
  }, {})
}

2 Using fixed values as types in jest describe

Here is the type of my function

  search: <P extends SearchParams<T>>(
    query: string,
    options?: P,
    method?: 'POST' | 'GET' // method can only be `POST` or `GET`
  ) => Promise<SearchResponse<T, P>>

Here is how I do multiple tests on different methods:

describe.each([
  { client: masterClient, permission: 'Master' },
  { client: privateClient, permission: 'Private' },
  { client: publicClient, permission: 'Public' },
])('Test on search', ({ client, permission }) => {
  describe.each([
    { method: 'POST', permission, client },
    { method: 'GET', permission, client },
  ])('Test on search', ({ client, permission, method }) => {
    beforeAll(async () => {
      ...
    })
    test(`${permission} key: Basic ${method} search`, async () => {
      if (method === 'POST' || method == 'GET') {
        await client
          .getIndex(index.uid)
          .search('prince', {}, method)
          .then((response) => {
            expect(response).toHaveProperty('hits', expect.any(Array))
            ...
          })
      }
    })
})

As you can see I need to add the if condition because otherwise I recieve this error:

Argument of type 'string' is not assignable to parameter of type '"POST" | "GET"'.

I tried a lot of ways to add the types in the describe function but I couln't find how.
@emyann maybe you have an idea ?

[curquiza]

@bidoubiwa could you rebase your branch please? 🙂

[curquiza]

Just a suggestion, not sure about that: could we have the same tests running for the POST and then with the GET? The goal is to avoid tests duplication.

[emyann]

@bidoubiwa This is a Type widening behaviour in Typescript. One thing you could try is to use a const type assertion:

describe.each([
  { method: 'POST' as const,  },
  { method: 'GET' as const,  },
])('Test on search', ({  method }) => {...})

Then the method property instead of being a widened string, will be of type POST | GET

Does it answer your question ? :)

[bidoubiwa]

@emyann Yes ! This worked great :) Thanks a lot for answering

[curquiza]

Question:

• What is the difference between tests/search_tests.ts and tests/typed_search_tests.ts?

Plus, could you update the search method prototype in the README? 🙂

[curquiza]

Cannot Typscript handle this part? 🙂

[bidoubiwa]

Well, yes, but not if the user is not using typescript but javascript. In which case I prefer the error to be really obvious.

[curquiza]

What the purpose of ESNext? 🙂

[bidoubiwa]

This are the rules to transpile typescript to javascript. By saying ESNext I inform the transpiler that I will be writing with the last features of javascript. This will make it possible for me to write for example optionnal chaining. These features are not released in an official Ecmascript version but are bound to be in the next one.

if (response.data?.hits?.something)

[curquiza]

Thanks for the explanations! 😁

[bidoubiwa]

What is the difference between tests/search_tests.ts and tests/typed_search_tests.ts?

In type_search_search every time I use an index I give the type of the document that will be inside that index:

 await client
        .getIndex<Movie>(index.uid)

Which means that the compiler should raise an error if I try to access a field that does not exist in movie.

interface Movie {
  id: number
  title: string
  comment?: string
  genre?: string
}

response.hits[0].director // ERROR because director is not defined in Movie interface

In search_tests I have not added <Movie>. When not adding it, typescript infer that the document could have anything inside it. Thus is way less strict on what I do.

response.hits[0].director // No errors but undefined