Skip to content

TestJumpToDateEndpoint: Clarify why we use /context end for paginating backwards despite the spec saying "A token that can be used to paginate forwards with." #852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MadLittleMods merged 5 commits into from
Apr 10, 2026
Merged

TestJumpToDateEndpoint: Clarify why we use /context end for paginating backwards despite the spec saying "A token that can be used to paginate forwards with." #852

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a03b187
Clarify why we use `end` despite the spec saying "A token that can be…
MadLittleMods Mar 26, 2026
91c73f9
Clarify desire
MadLittleMods Mar 26, 2026
9c6c144
Fix 'to' missing typo
MadLittleMods Apr 10, 2026
8abd31a
Be more specific
MadLittleMods Apr 10, 2026
4513157
Merge branch 'main' into madlittlemods/clarify-why-end-timestamp-to-e…
MadLittleMods Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions tests/room_timestamp_to_event_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,10 +213,20 @@ func TestJumpToDateEndpoint(t *testing.T) {
mustCheckEventisReturnedForTime(t, remoteCharlie, roomID, eventB.AfterTimestamp, "b", eventB.EventID)

// Get a pagination token from eventB
contextRes := remoteCharlie.MustDo(t, "GET", []string{"_matrix", "client", "r0", "rooms", roomID, "context", eventB.EventID}, client.WithContentType("application/json"), client.WithQueries(url.Values{
"limit": []string{"0"},
}))
contextRes := remoteCharlie.MustDo(t, "GET", []string{"_matrix", "client", "r0", "rooms", roomID, "context", eventB.EventID},
client.WithContentType("application/json"), client.WithQueries(url.Values{
"limit": []string{"0"},
}),
)
Copy link
Copy Markdown
Collaborator Author

@MadLittleMods MadLittleMods Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just line wrapping this better. There is no functional change in this PR.

contextResResBody := client.ParseJSON(t, contextRes)
// Remember: Tokens are positions between events. Normally, you would use the
// `start` token to paginate backwards with but for the sake of the test we want
// to paginate `/messages` and want see both A and B in the response; so we use
// the `end` token. The `end` token comes after B.
//
// start end
// | |
// [A] <-- ▼ [B] ▼ <--- [remoteCharlie join]
Comment on lines +222 to +229
Copy link
Copy Markdown
Collaborator Author

@MadLittleMods MadLittleMods Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inspired by these comments in Synapse

paginationToken := client.GetJSONFieldStr(t, contextResResBody, "end")

// Hit `/messages` until `eventA` has been backfilled and replicated across
Expand All @@ -226,12 +236,15 @@ func TestJumpToDateEndpoint(t *testing.T) {
return ev.Get("event_id").Str == eventA.EventID
})

// Paginate backwards from eventB
messagesRes := remoteCharlie.MustDo(t, "GET", []string{"_matrix", "client", "r0", "rooms", roomID, "messages"}, client.WithContentType("application/json"), client.WithQueries(url.Values{
"dir": []string{"b"},
"limit": []string{"100"},
"from": []string{paginationToken},
}))
// Paginate backwards from the point after eventB
messagesRes := remoteCharlie.MustDo(t, "GET", []string{"_matrix", "client", "r0", "rooms", roomID, "messages"},
client.WithContentType("application/json"),
client.WithQueries(url.Values{
"dir": []string{"b"},
"limit": []string{"100"},
"from": []string{paginationToken},
}),
)

// Make sure both messages are visible
must.MatchResponse(t, messagesRes, match.HTTPResponse{
Expand Down
Loading