MSC3030 Jump to date API endpoint

internal/client/client.go

@@ -212,6 +212,27 @@ func (c *CSAPI) RegisterUser(t *testing.T, localpart, password string) (userID,
 	return userID, accessToken
 }
 
+// GetEvent fetches the given event from the specified room and returns a typed Event
+func (c *CSAPI) GetEvent(t *testing.T, roomID, eventId string) b.Event {
+	t.Helper()
+	res := c.MustDoFunc(t, "GET", []string{"_matrix", "client", "r0", "rooms", roomID, "event", eventId})
+	body := ParseJSON(t, res)
+
+	statKeyRes := gjson.GetBytes(body, "state_key")
+	var stateKey *string = nil
+	if statKeyRes.Exists() {
+		stateKey = b.Ptr(statKeyRes.Str)
+	}
+
+	return b.Event{
+		Type:     GetJSONFieldStr(t, body, "type"),
+		Sender:   GetJSONFieldStr(t, body, "sender"),
+		StateKey: stateKey,
+		Content:  GetJSONFieldStringMap(t, body, "content"),
+		Unsigned: GetJSONFieldStringMap(t, body, "unsigned"),
+	}
+}
+
 // MustDo will do the HTTP request and fail the test if the response is not 2xx
 func (c *CSAPI) MustDo(t *testing.T, method string, paths []string, jsonBody interface{}) *http.Response {
 	t.Helper()
@@ -406,6 +427,26 @@ func GetJSONFieldStringArray(t *testing.T, body []byte, wantKey string) []string
 	return arr
 }
 
+func GetJSONFieldStringMap(t *testing.T, body []byte, wantKey string) map[string]interface{} {
+	t.Helper()
+
+	res := gjson.GetBytes(body, wantKey)
+
+	if !res.Exists() {
+		t.Fatalf("GetJSONFieldStringMap: key '%s' missing from %s", wantKey, string(body))
+	}
+
+	jsonMap := map[string]interface{}{}
+	res.ForEach(func(key, value gjson.Result) bool {
+		jsonMap[key.Str] = value.Str
+
+		// Keep iterating
+		return true
+	})
+
+	return jsonMap
+}
+
 // ParseJSON parses a JSON-encoded HTTP Response body into a byte slice
 func ParseJSON(t *testing.T, res *http.Response) []byte {
 	t.Helper()

tests/msc3030_test.go

@@ -0,0 +1,147 @@
+// +build msc3030
+
+// This file contains tests for a jump to date API endpoint,
+// currently experimental feature defined by MSC3030, which you can read here:
+// https://github.com/matrix-org/matrix-doc/pull/3030
+
+package tests
+
+import (
+	"fmt"
+	"net/url"
+	"strconv"
+	"testing"
+	"time"
+
+	"github.com/matrix-org/complement/internal/b"
+	"github.com/matrix-org/complement/internal/client"
+	"github.com/tidwall/gjson"
+)
+
+func TestJumpToDateEndpoint(t *testing.T) {
+	deployment := Deploy(t, b.BlueprintFederationTwoLocalOneRemote)
+	defer deployment.Destroy(t)
+
+	// Create the normal user which will send messages in the room
+	userID := "@alice:hs1"
+	alice := deployment.Client(t, "hs1", userID)
+
+	roomID := alice.CreateRoom(t, map[string]interface{}{})
+	alice.JoinRoom(t, roomID, nil)
+
+	timeBeforeEventA := time.Now()
+	eventAID := alice.SendEventSynced(t, roomID, b.Event{
+		Type: "m.room.message",
+		Content: map[string]interface{}{
+			"msgtype": "m.text",
+			"body":    "Message A",
+		},
+	})
+	eventBID := alice.SendEventSynced(t, roomID, b.Event{
+		Type: "m.room.message",
+		Content: map[string]interface{}{
+			"msgtype": "m.text",
+			"body":    "Message A",
+		},
+	})
+	timeAfterEventB := time.Now()
+
+	t.Run("parallel", func(t *testing.T) {
+		t.Run("should find event after given timestmap", func(t *testing.T) {
+			checkEventisReturnedForTime(t, alice, roomID, timeBeforeEventA, eventAID)
+		})
+
+		t.Run("should find event before given timestmap", func(t *testing.T) {
+			checkEventisReturnedForTime(t, alice, roomID, timeAfterEventB, eventBID)
+		})
+	})
+}
+
+func checkEventisReturnedForTime(t *testing.T, c *client.CSAPI, roomID string, givenTime time.Time, expectedEventId string) {
+	t.Helper()
+
+	givenTimestamp := makeTimestampFromTime(givenTime)
+	timestampString := strconv.FormatInt(givenTimestamp, 10)
+	timestampToEventRes := c.MustDoFunc(t, "GET", []string{"_matrix", "client", "r0", "rooms", roomID, "timestamp_to_event"}, client.WithContentType("application/json"), client.WithQueries(url.Values{
+		"ts": []string{timestampString},
+	}))
+	timestampToEventResBody := client.ParseJSON(t, timestampToEventRes)
+
+	actualEventIdRes := gjson.GetBytes(timestampToEventResBody, "event_id")
+	actualEventId := actualEventIdRes.String()
+
+	if actualEventId != expectedEventId {
+		debugMessageList := getDebugMessageListFromMessagesResponse(t, c, roomID, expectedEventId, actualEventId, givenTimestamp)
+		t.Fatalf(
+			"Expected to see %s given %s but received %s\n%s",
+			decorateStringWithAnsiColor(expectedEventId, AnsiColorGreen),
+			decorateStringWithAnsiColor(timestampString, AnsiColorYellow),
+			decorateStringWithAnsiColor(actualEventId, AnsiColorRed),
+			debugMessageList,
+		)
+	}
+}
+
+func getDebugMessageListFromMessagesResponse(t *testing.T, c *client.CSAPI, roomID string, expectedEventId string, actualEventId string, givenTimestamp int64) string {
+	t.Helper()
+
+	messagesRes := c.MustDoFunc(t, "GET", []string{"_matrix", "client", "r0", "rooms", roomID, "messages"}, client.WithContentType("application/json"), client.WithQueries(url.Values{
+		"dir":   []string{"b"},
+		"limit": []string{"100"},
+	}))
+	messsageResBody := client.ParseJSON(t, messagesRes)
+
+	wantKey := "chunk"
+	res := gjson.GetBytes(messsageResBody, wantKey)
+	if !res.Exists() {
+		t.Fatalf("missing key '%s'", wantKey)
+	}
+	if !res.IsArray() {
+		t.Fatalf("key '%s' is not an array (was %s)", wantKey, res.Type)
+	}
+
+	givenTimestampMarker := decorateStringWithAnsiColor(fmt.Sprintf("-- givenTimestamp=%s --\n", strconv.FormatInt(givenTimestamp, 10)), AnsiColorYellow)
+
+	resultantString := ""
+	givenTimestampAlreadyInserted := false
+	res.ForEach(func(key, r gjson.Result) bool {
+		// The timestmap could be after-in-time of any of the events
+		if r.Get("origin_server_ts").Int() < givenTimestamp && !givenTimestampAlreadyInserted {
+			resultantString += givenTimestampMarker
+			givenTimestampAlreadyInserted = true
+		}
+
+		event_id := r.Get("event_id").String()
+		event_id_string := event_id
+		if event_id == expectedEventId {
+			event_id_string = decorateStringWithAnsiColor(event_id, AnsiColorGreen)
+		} else if event_id == actualEventId {
+			event_id_string = decorateStringWithAnsiColor(event_id, AnsiColorRed)
+		}
+
+		resultantString += fmt.Sprintf("%s (%s) - %s\n", event_id_string, strconv.FormatInt(r.Get("origin_server_ts").Int(), 10), r.Get("type").String())
+
+		// The timestmap could be before-in-time of any of the events
+		if r.Get("origin_server_ts").Int() > givenTimestamp && !givenTimestampAlreadyInserted {
+			resultantString += givenTimestampMarker
+			givenTimestampAlreadyInserted = true
+		}
+
+		// keep iterating
+		return true
+	})
+
+	return resultantString
+}
+
+func makeTimestampFromTime(t time.Time) int64 {
+	return t.UnixNano() / int64(time.Millisecond)
+}
+
+const AnsiColorRed string = "31"
+const AnsiColorGreen string = "32"
+const AnsiColorYellow string = "33"
+
+func decorateStringWithAnsiColor(inputString, decorationColor string) string {
+	return fmt.Sprintf("\033[%sm%s\033[0m", decorationColor, inputString)
+}