Allow search results to appear in multiple orders

[richvdh]

Fixes #478, I hope, though there may be other tests with the same problem.

[squahtx]

lgtm

[S7evinK]

@richvdh RE your comment

The problem here is that the complement test is assuming that the search results will be returned in a particular order, which I don't think is correct (and certainly the sytest that it was ported from did not make that assumption).

Looking at the deleted Sytest code, it definitely did that assumption.

[S7evinK]

Aha.. Looking closer.. It might be related to the different message body? message 1 vs message before upgrade?

[richvdh]

Looking at the deleted Sytest code, it definitely did that assumption

I don't think so. Look at https://github.com/matrix-org/sytest/blob/bebf431edf7311d5147139f44dab97131a784d29/tests/43search.pl#L287: it sets $result to the first "result" whose event_id matches $event_id_one, and then proceeds to do checks on $result. That means it will pass even if "message 1" appears second in the result list. It then goes on to do something similar for "message 2".

[S7evinK]

Oh, true, didn't read that right.

[kegsay]

Though CI seems to be failing:

TestSearch/parallel/Search_works_across_an_upgraded_room_and_its_predecessor (1.09s)
      apidoc_search_test.go:208: SendEventSynced waiting for event ID $5_V3NGmyDWKZwYZLCdmopuvHpzes6ao4ILTml5aQAGo
      apidoc_search_test.go:223: SendEventSynced waiting for event ID $1xoBlX0wz7xtwUeiit0K72msQ0cC8wOIvsFe17e_Xck
      apidoc_search_test.go:250: MatchResponse JSONCheckOff: unexpected item  - http://localhost:49342/_matrix/client/v3/search => {"search_categories":{"room_events":{"results":[{"rank":0.5,"result":{"type":"m.room.message","room_id":"!zgnaljHeflTPgVGwXI:hs1","sender":"@alice:hs1","content":{"body":"Message before upgrade","msgtype":"m.text"},"origin_server_ts":1664277514508,"unsigned":{"age":733},"event_id":"$5_V3NGmyDWKZwYZLCdmopuvHpzes6ao4ILTml5aQAGo","user_id":"@alice:hs1","age":733},"context":{}},{"rank":0.5,"result":{"type":"m.room.message","room_id":"!ZrmSMkfiHQuBjbdUuD:hs1","sender":"@alice:hs1","content":{"body":"Message after upgrade","msgtype":"m.text"},"origin_server_ts":1664277515138,"unsigned":{"age":103},"event_id":"$1xoBlX0wz7xtwUeiit0K72msQ0cC8wOIvsFe17e_Xck","user_id":"@alice:hs1","age":103},"context":{}}],"count":2,"highlights":[]}}}