feat(sdk)!: [NET-1464] Remove orderBy functionality from StreamrClient#searchStreams() (#3131)

**This is a breaking changes at this changes the StreamrClient API**

Note that the `id_gt` relies on the fact that `StreamPermission` ids are
prefixed with stream ids in The Graph. We'll change that in a follow-up
PR (#3132).

Author: teogeb

CHANGELOG.md

@@ -36,7 +36,8 @@ Changes before Tatum release are not documented in this file.
 #### Removed
 
 - **BREAKING CHANGE**: Remove lit protocol integration and related config options `encryption.litProtocolEnabled` and `encryption.litProtocolLogging` (https://github.com/streamr-dev/network/pull/3036)
-- **BREAKING CHANGE**: Remove `StreamrClient.generateEthereumAccount()` in favour of `EthereumKeyPairIdentity.generate()`
+- **BREAKING CHANGE**: Remove `StreamrClient#generateEthereumAccount()` in favour of `EthereumKeyPairIdentity#generate()`
+- **BREAKING CHANGE**: Remove `orderBy` parameter from `StreamrClient#searchStreams()` (https://github.com/streamr-dev/network/pull/3131)
 
 #### Fixed
 

packages/sdk/src/StreamrClient.ts

@@ -39,7 +39,7 @@ import { OperatorRegistry } from './contracts/OperatorRegistry'
 import { StorageNodeMetadata, StorageNodeRegistry } from './contracts/StorageNodeRegistry'
 import { StreamRegistry } from './contracts/StreamRegistry'
 import { StreamStorageRegistry } from './contracts/StreamStorageRegistry'
-import { SearchStreamsOrderBy, SearchStreamsPermissionFilter, toInternalSearchStreamsPermissionFilter } from './contracts/searchStreams'
+import { SearchStreamsPermissionFilter, toInternalSearchStreamsPermissionFilter } from './contracts/searchStreams'
 import { GroupKey } from './encryption/GroupKey'
 import { LocalGroupKeyStore, UpdateEncryptionKeyOptions } from './encryption/LocalGroupKeyStore'
 import { PublisherKeyExchange } from './encryption/PublisherKeyExchange'
@@ -438,21 +438,18 @@ export class StreamrClient {
      *
      * @param term - a search term that should be part of the stream id of a result
      * @param permissionFilter - permissions that should be in effect for a result
-     * @param orderBy - the default is ascending order by stream id field
      */
     searchStreams(
         term: string | undefined,
-        permissionFilter: SearchStreamsPermissionFilter | undefined,
-        orderBy: SearchStreamsOrderBy = { field: 'id', direction: 'asc' }
+        permissionFilter: SearchStreamsPermissionFilter | undefined
     ): AsyncIterable<Stream> {
         logger.debug('Search for streams', { term, permissionFilter })
         if ((term === undefined) && (permissionFilter === undefined)) {
             throw new Error('Requires a search term or a permission filter')
         }
         const streamIds = this.streamRegistry.searchStreams(
             term,
-            (permissionFilter !== undefined) ? toInternalSearchStreamsPermissionFilter(permissionFilter) : undefined,
-            orderBy
+            (permissionFilter !== undefined) ? toInternalSearchStreamsPermissionFilter(permissionFilter) : undefined
         )
         return map(streamIds, (id) => new Stream(id, this))
     }

packages/sdk/src/contracts/StreamRegistry.ts

@@ -45,7 +45,7 @@ import { Mapping, createCacheMap } from '../utils/Mapping'
 import { ChainEventPoller } from './ChainEventPoller'
 import { ContractFactory } from './ContractFactory'
 import { ObservableContract, initContractEventGateway, waitForTx } from './contract'
-import { InternalSearchStreamsPermissionFilter, SearchStreamsOrderBy, searchStreams as _searchStreams } from './searchStreams'
+import { InternalSearchStreamsPermissionFilter, searchStreams as _searchStreams } from './searchStreams'
 
 /*
  * On-chain registry of stream metadata and permissions.
@@ -297,12 +297,10 @@ export class StreamRegistry {
     async* searchStreams(
         term: string | undefined,
         permissionFilter: InternalSearchStreamsPermissionFilter | undefined,
-        orderBy: SearchStreamsOrderBy
     ): AsyncGenerator<StreamID> {
         const queryResult = _searchStreams(
             term,
             permissionFilter,
-            orderBy,
             this.theGraphClient)
         for await (const item of queryResult) {
             const id = toStreamID(item.stream.id)

packages/sdk/src/contracts/searchStreams.ts

@@ -15,11 +15,6 @@ export interface SearchStreamsPermissionFilter {
 
 export type InternalSearchStreamsPermissionFilter = ChangeFieldType<SearchStreamsPermissionFilter, 'userId', UserID>
 
-export interface SearchStreamsOrderBy {
-    field: 'id' | 'createdAt' | 'updatedAt'
-    direction: 'asc' | 'desc'
-}
-
 export type SearchStreamsResultItem = {
     id: string
     stream: StreamQueryResult
@@ -35,11 +30,10 @@ export const toInternalSearchStreamsPermissionFilter = (filter: SearchStreamsPer
 export async function* searchStreams(
     term: string | undefined,
     permissionFilter: InternalSearchStreamsPermissionFilter | undefined,
-    orderBy: SearchStreamsOrderBy,
     theGraphClient: TheGraphClient,
 ): AsyncGenerator<SearchStreamsResultItem> {
     const backendResults = theGraphClient.queryEntities<SearchStreamsResultItem>(
-        (lastId: string, pageSize: number) => buildQuery(term, permissionFilter, orderBy, lastId, pageSize)
+        (lastId: string, pageSize: number) => buildQuery(term, permissionFilter, lastId, pageSize)
     )
     /*
      * There can be orphaned permission entities if a stream is deleted (currently
@@ -85,7 +79,6 @@ export async function* searchStreams(
 const buildQuery = (
     term: string | undefined,
     permissionFilter: InternalSearchStreamsPermissionFilter | undefined,
-    orderBy: SearchStreamsOrderBy,
     lastId: string,
     pageSize: number
 ): GraphQLQuery => {
@@ -120,8 +113,7 @@ const buildQuery = (
         ) {
             streamPermissions (
                 first: ${pageSize},
-                orderBy: "stream__${orderBy.field}",
-                orderDirection: "${orderBy.direction}", 
+                orderBy: "stream__id",
                 ${TheGraphClient.createWhereClause(variables)}
             ) {
                 id

packages/sdk/src/exports.ts

@@ -23,7 +23,7 @@ export {
 export type { StreamCreationEvent } from './contracts/StreamRegistry'
 export type { StorageNodeAssignmentEvent } from './contracts/StreamStorageRegistry'
 export type { StorageNodeMetadata } from './contracts/StorageNodeRegistry'
-export type { SearchStreamsPermissionFilter, SearchStreamsOrderBy } from './contracts/searchStreams'
+export type { SearchStreamsPermissionFilter } from './contracts/searchStreams'
 export {
     type StreamrClientConfig,
     type ConnectionInfo,

packages/sdk/test/end-to-end/searchStreams.test.ts

@@ -1,5 +1,5 @@
 import { createTestPrivateKey, randomUserId } from '@streamr/test-utils'
-import { collect } from '@streamr/utils'
+import { collect, StreamID } from '@streamr/utils'
 import { Stream } from '../../src/Stream'
 import { StreamrClient } from '../../src/StreamrClient'
 import { SearchStreamsPermissionFilter } from '../../src/contracts/searchStreams'
@@ -31,11 +31,9 @@ describe('searchStreams', () => {
         return streams
     }
 
-    const searchStreamIds = async (searchTerm: string, permissionFilter?: SearchStreamsPermissionFilter) => {
+    const searchStreamIds = async (searchTerm: string, permissionFilter?: SearchStreamsPermissionFilter): Promise<StreamID[]> => {
         const streams = client.searchStreams(searchTerm, permissionFilter)
-        const ids = (await collect(streams)).map((stream) => stream.id)
-        ids.sort()
-        return ids
+        return (await collect(streams)).map((stream) => stream.id)
     }
 
     beforeAll(async () => {