[CHAT-1814] Updates to message search

[miagilepner]

CLA

• I have signed the Stream CLA (required).
• Code changes are tested

Description of the changes, What, Why and How?

Updates the channel.search() and client.search() endpoints to support pagination using a next value and sorting parameters. For example:

// get a page of sorted results
const page1 = await client.search(
{ cid: my_cid }, 
'search text', 
{ limit: 100, sort: [{ relevance: -1 }, { updated_at: 1 }, { my_custom_field: -1 }]  });

// Query the second page of results. The same sort order will be used as in your first query, so there's no need to include it
const page2 = await client.search(
{ cid: my_cid }, 
'search text', 
{ limit: 100, next: page1.next });

// Pagination backwards by using the returned `previous` value
const page1Again = await client.search(
{ cid: my_cid }, 
'search text', 
{ limit: 100, next: page2.previous });

Changelog

[github-actions]

Size Change: +803 B (0%)

Total Size: 230 kB

Filename	Size	Change
dist/browser.es.js	50.1 kB	+167 B (0%)
dist/browser.full-bundle.min.js	28.6 kB	+143 B (0%)
dist/browser.js	50.7 kB	+164 B (0%)
dist/index.es.js	50.1 kB	+167 B (0%)
dist/index.js	50.7 kB	+162 B (0%)

_{compressed-size-action}

[mahboubii]

LGTM 🌮
@nhannah could you also take a look?

[vishalnarkhede]

Suggested change

	export type SearchOptions = LimitOffsetSearchOptions | NextSearchOptions;
	export type LimitOffsetSearchOptions = {
	limit?: number;
	offset?: number;
	};
	export type NextSearchOptions = {
	limit?: number;
	next?: string;
	sort?: SearchMessageSort;
	};
	export type LimitOffsetSearchOptions = {
	limit?: number;
	offset?: number;
	};
	export type NextSearchOptions = {
	limit?: number;
	next?: string;
	sort?: SearchMessageSort;
	};
	export type SearchOptions = LimitOffsetSearchOptions | NextSearchOptions;

[vishalnarkhede]

Defining before using ... makes it a little easier to read!!

[vishalnarkhede]

Also, do we really need separate LimitOffsetSearchOptions and NextSearchOptions? Because anyways user can't switch between v1 or v2 search, right?

export type SearchOptions = {
  limit?: number;
  next?: string;
  sort?: SearchMessageSort;
};

[miagilepner]

I thought it was better to keep them separate - A user should not be allowed to use offset with next or with sort.

[vishalnarkhede]

Ah my bad. I thought sort was the only difference there :) Thanks for clarification

[nhannah]

Hey let's look at this together, if you have to hop in the TS world more I am happy to help, and we can add a test to give some piece of mind on these as well.

[nhannah]

So sort here is throwing a TS error, this is because only one of the 2 search options types has sort on it.

[nhannah]

Don't think you need to spread options here.

[nhannah]

Same as in channel but also we can probably avoid the rest spread as well, and pop everything to one line via

      sort: sort &&= normalizeQuerySort(sort_value)

[miagilepner]

I'm not quite sure what you want to do here. Which lines will be replaced with your suggestion?

[nhannah]

I put in some suggestions; looks like that old util func is messy as well so I put in a suggestion there that I think will correct it's off typing.

[nhannah]

Am I missing something here?

keyof SearchMessageSortBase<MessageType> will always be a string, so Extract<keyof SearchMessageSortBase<MessageType>, string> should be the same thing as keyof SearchMessageSortBase<MessageType>? But maybe I am not seeing something?

[miagilepner]

keyof SearchMessageSortBase<MessageType> is string | number

[nhannah]

Thanks for the changes, looks good!