redisearch.search returns different shapes when result count is above/below limit parameter

[RShohoney]

When performing searches against redisearch, I'm seeing an inconsistency with the shapes of the return. In the case of no results, the response is just a number === 0, which I actually think should be [0] so as to follow the shape for when there are responses.

The bigger problem is as follows:

• in the case of a search where the number of returned results is greater than the limit.num parameter of the request, the return array appears as such: [numResults, { key: id }, { key: [path, document] }, { key: score, [path]: document }, ...] where { key: id }, { key: [path, document] }, { key: score, [path]: document } is the ...
• When the number of results is fewer than the limit.num parameter, the return array appears as such: [numResults, id, score, [path, document], ...] where id, score, [path,document] is the ...

The corresponding request shape is this:

redisearch.search(
  indexName, 
  query,
  {
    scorer: 'BM25',
    withScores: true,
    limit: {
      first: 0,
      num: 50,
    }
  }
});

I tried messing with the parseSearchQueries option, and it seems to be somewhat related. It would change which responses would break with my handling, vs not.

It also seems possible that WITHSCORES is causing issues. It appears that this line makes assumptions about the length of each collection of strings in the response array being length 2, rather than accounting for additional parameters being present due to additional options being passed: https://github.com/danitseitlin/redis-modules-sdk-ts/blob/081eebcddbdc7550920603d6827b512011a201f4/modules/module.base.ts#L126

Let me know if you need more information, I'll provide all that I can.

[danitseitlin]

Can you add reproduction steps please? I need more than the search query, I also need the index created so I can reproduce

[RShohoney]

These tests on my fork should help show the issues I'm observing. https://github.com/RShohoney/redis-modules-sdk-ts/blob/rshohoney--unhandled-extra-return-properties/tests/redisearch.ts#L466

[danitseitlin]

Hi, I'm unavailable this week, will take a look in the next week.

[RShohoney]

As an aside, I think it might be a good idea to allow users to opt out of request parsing, and instead get back the raw response from RediSearch. What do you think?

[danitseitlin]

@RShohoney I agree, please open a separate issue for that request, I will get to it once once off vacation