Skip to content

Commit

Permalink
Add tests for MSC2716 being backwards compatible with existing room v…
Browse files Browse the repository at this point in the history 
…ersions (#192)

Synapse changes added in matrix-org/synapse#10566
  • Loading branch information
@MadLittleMods
MadLittleMods authored Sep 8, 2021
1 parent 735548e commit f58adb0
Showing 1 changed file with 124 additions and 4 deletions.
128 changes: 124 additions & 4 deletions tests/msc2716_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -501,7 +501,8 @@ func TestBackfillingHistory(t *testing.T) {
},
}
// We can't use as.SendEventSynced(...) because application services can't use the /sync API
insertionSendRes := as.MustDoFunc(t, "PUT", []string{"_matrix", "client", "r0", "rooms", roomID, "send", insertionEvent.Type, "txn-i123"}, client.WithJSONBody(t, insertionEvent.Content))
txnId := getTxnID("sendInsertionAndEnsureBackfilled-txn")
insertionSendRes := as.MustDoFunc(t, "PUT", []string{"_matrix", "client", "r0", "rooms", roomID, "send", insertionEvent.Type, txnId}, client.WithJSONBody(t, insertionEvent.Content))
insertionSendBody := client.ParseJSON(t, insertionSendRes)
insertionEventID := client.GetJSONFieldStr(t, insertionSendBody, "event_id")
// Make sure the insertion event has reached the homeserver
Expand Down Expand Up @@ -726,9 +727,105 @@ func TestBackfillingHistory(t *testing.T) {
},
})
})

t.Run("Existing room versions", func(t *testing.T) {
createUnsupportedMSC2716RoomOpts := map[string]interface{}{
"preset": "public_chat",
"name": "the hangout spot",
// v6 is an existing room version that does not support MSC2716
"room_version": "6",
}

t.Run("Room creator can send MSC2716 events", func(t *testing.T) {
t.Parallel()

roomID := as.CreateRoom(t, createUnsupportedMSC2716RoomOpts)
alice.JoinRoom(t, roomID, nil)

// Create the "live" event we are going to insert our backfilled events next to
eventIDsBefore := createMessagesInRoom(t, alice, roomID, 1)
eventIdBefore := eventIDsBefore[0]
timeAfterEventBefore := time.Now()

// Insert a backfilled event
batchSendRes := batchSendHistoricalMessages(
t,
as,
roomID,
eventIdBefore,
"",
createJoinStateEventsForBackfillRequest([]string{virtualUserID}, timeAfterEventBefore),
createMessageEventsForBackfillRequest([]string{virtualUserID}, timeAfterEventBefore, 1),
// Status
200,
)
batchSendResBody := client.ParseJSON(t, batchSendRes)
historicalEventIDs := getEventsFromBatchSendResponseBody(t, batchSendResBody)

messagesRes := alice.MustDoFunc(t, "GET", []string{"_matrix", "client", "r0", "rooms", roomID, "messages"}, client.WithContentType("application/json"), client.WithQueries(url.Values{
"dir": []string{"b"},
"limit": []string{"100"},
}))

must.MatchResponse(t, messagesRes, match.HTTPResponse{
JSON: []match.JSON{
match.JSONCheckOffAllowUnwanted("chunk", makeInterfaceSlice(historicalEventIDs), func(r gjson.Result) interface{} {
return r.Get("event_id").Str
}, nil),
},
})
})

t.Run("Not allowed to redact MSC2716 insertion, chunk, marker events", func(t *testing.T) {
t.Parallel()

roomID := as.CreateRoom(t, createUnsupportedMSC2716RoomOpts)
alice.JoinRoom(t, roomID, nil)

// Create the "live" event we are going to insert our backfilled events next to
eventIDsBefore := createMessagesInRoom(t, alice, roomID, 1)
eventIdBefore := eventIDsBefore[0]
timeAfterEventBefore := time.Now()

// Insert a backfilled event
batchSendRes := batchSendHistoricalMessages(
t,
as,
roomID,
eventIdBefore,
"",
createJoinStateEventsForBackfillRequest([]string{virtualUserID}, timeAfterEventBefore),
createMessageEventsForBackfillRequest([]string{virtualUserID}, timeAfterEventBefore, 1),
// Status
200,
)
batchSendResBody := client.ParseJSON(t, batchSendRes)
historicalEventIDs := getEventsFromBatchSendResponseBody(t, batchSendResBody)
insertionEventID := historicalEventIDs[0]
chunkEventID := historicalEventIDs[2]
baseInsertionEventID := historicalEventIDs[3]

// Send the marker event
markerEventID := sendMarkerAndEnsureBackfilled(t, as, alice, roomID, baseInsertionEventID)

redactEventID(t, alice, roomID, insertionEventID, 403)
redactEventID(t, alice, roomID, chunkEventID, 403)
redactEventID(t, alice, roomID, markerEventID, 403)
})
})
})
}

var txnCounter int = 0

func getTxnID(prefix string) (txnID string) {
txnId := fmt.Sprintf("%s-%d", prefix, txnCounter)

txnCounter++

return txnId
}

func makeInterfaceSlice(slice []string) []interface{} {
interfaceSlice := make([]interface{}, len(slice))
for i := range slice {
Expand Down Expand Up @@ -837,7 +934,7 @@ func ensureVirtualUserRegistered(t *testing.T, c *client.CSAPI, virtualUserLocal
}
}

func sendMarkerAndEnsureBackfilled(t *testing.T, as *client.CSAPI, c *client.CSAPI, roomID, insertionEventID string) {
func sendMarkerAndEnsureBackfilled(t *testing.T, as *client.CSAPI, c *client.CSAPI, roomID, insertionEventID string) (markerEventID string) {
t.Helper()

// Send a marker event to let all of the homeservers know about the
Expand All @@ -849,9 +946,10 @@ func sendMarkerAndEnsureBackfilled(t *testing.T, as *client.CSAPI, c *client.CSA
},
}
// We can't use as.SendEventSynced(...) because application services can't use the /sync API
markerSendRes := as.MustDoFunc(t, "PUT", []string{"_matrix", "client", "r0", "rooms", roomID, "send", markerEvent.Type, "txn-m123"}, client.WithJSONBody(t, markerEvent.Content))
txnId := getTxnID("sendMarkerAndEnsureBackfilled-txn")
markerSendRes := as.MustDoFunc(t, "PUT", []string{"_matrix", "client", "r0", "rooms", roomID, "send", markerEvent.Type, txnId}, client.WithJSONBody(t, markerEvent.Content))
markerSendBody := client.ParseJSON(t, markerSendRes)
markerEventID := client.GetJSONFieldStr(t, markerSendBody, "event_id")
markerEventID = client.GetJSONFieldStr(t, markerSendBody, "event_id")

// Make sure the marker event has reached the remote homeserver
c.SyncUntilTimelineHas(t, roomID, func(ev gjson.Result) bool {
Expand All @@ -867,6 +965,8 @@ func sendMarkerAndEnsureBackfilled(t *testing.T, as *client.CSAPI, c *client.CSA

return false
})

return markerEventID
}

func createMessagesInRoom(t *testing.T, c *client.CSAPI, roomID string, count int) (eventIDs []string) {
Expand Down Expand Up @@ -967,6 +1067,26 @@ func createMessageEventsForBackfillRequest(
return evs
}

func redactEventID(t *testing.T, c *client.CSAPI, roomID, eventID string, expectedStatus int) {
t.Helper()

txnID := getTxnID("redactEventID-txn")
redactionRes := c.DoFunc(
t,
"PUT",
[]string{"_matrix", "client", "r0", "rooms", roomID, "redact", eventID, txnID},
client.WithJSONBody(t, map[string]interface{}{"reason": "chaos"}),
client.WithContentType("application/json"),
)
redactionResBody := client.ParseJSON(t, redactionRes)
redactionResErrcode := client.GetJSONFieldStr(t, redactionResBody, "error")
redactionResError := client.GetJSONFieldStr(t, redactionResBody, "errcode")

if redactionRes.StatusCode != expectedStatus {
t.Fatalf("msc2716.redactEventID: Expected redaction response to be %d but received %d -> %s: %s", expectedStatus, redactionRes.StatusCode, redactionResErrcode, redactionResError)
}
}

var chunkCount int64 = 0

func batchSendHistoricalMessages(
Expand Down

0 comments on commit f58adb0

Please sign in to comment.