Review changes

Author: anoadragon453

tests/csapi/sync_test.go

@@ -277,29 +277,29 @@ func TestSync(t *testing.T) {
 
 			t.Parallel()
 
-			// alice creates two rooms, which charlie (on our test server) joins
+			// alice creates two rooms, which hs2ObserverUser (on our test server) joins
 			srv := federation.NewServer(t, deployment,
 				federation.HandleKeyRequests(),
 				federation.HandleTransactionRequests(nil, nil),
 			)
 			cancel := srv.Listen()
 			defer cancel()
 
-			charlie := srv.UserID("charlie")
+			hs2ObserverUser := srv.UserID("hs2ObserverUser")
 
 			redactionRoomID := alice.MustCreateRoom(t, map[string]interface{}{"preset": "public_chat"})
-			redactionRoom := srv.MustJoinRoom(t, deployment, deployment.GetFullyQualifiedHomeserverName(t, "hs1"), redactionRoomID, charlie)
+			redactionRoom := srv.MustJoinRoom(t, deployment, deployment.GetFullyQualifiedHomeserverName(t, "hs1"), redactionRoomID, hs2ObserverUser)
 
 			sentinelRoomID := alice.MustCreateRoom(t, map[string]interface{}{"preset": "public_chat"})
-			sentinelRoom := srv.MustJoinRoom(t, deployment, deployment.GetFullyQualifiedHomeserverName(t, "hs1"), sentinelRoomID, charlie)
+			sentinelRoom := srv.MustJoinRoom(t, deployment, deployment.GetFullyQualifiedHomeserverName(t, "hs1"), sentinelRoomID, hs2ObserverUser)
 
-			// charlie creates a bogus redaction, which he sends out, followed by
+			// hs2ObserverUser creates a bogus redaction, which he sends out, followed by
 			// a good event - in another room - to act as a sentinel. It's not
 			// guaranteed, but hopefully if the sentinel is received, so was the
 			// redaction.
 			redactionEvent := srv.MustCreateEvent(t, redactionRoom, federation.Event{
 				Type:    "m.room.redaction",
-				Sender:  charlie,
+				Sender:  hs2ObserverUser,
 				Content: map[string]interface{}{},
 				Redacts: "$12345"})
 			redactionRoom.AddEvent(redactionEvent)
@@ -308,7 +308,7 @@ func TestSync(t *testing.T) {
 
 			sentinelEvent := srv.MustCreateEvent(t, sentinelRoom, federation.Event{
 				Type:    "m.room.test",
-				Sender:  charlie,
+				Sender:  hs2ObserverUser,
 				Content: map[string]interface{}{"body": "1234"},
 			})
 			sentinelRoom.AddEvent(sentinelEvent)
@@ -318,14 +318,14 @@ func TestSync(t *testing.T) {
 			// wait for the sentinel to arrive
 			nextBatch := alice.MustSyncUntil(t, client.SyncReq{}, client.SyncTimelineHasEventID(sentinelRoomID, sentinelEvent.EventID()))
 
-			// charlie sends another batch of events to force a gappy sync.
+			// hs2ObserverUser sends another batch of events to force a gappy sync.
 			// We have to send 11 events to force a gap, since we use a filter with a timeline limit of 10 events.
 			pdus := make([]json.RawMessage, 11)
 			var lastSentEventId string
 			for i := range pdus {
 				ev := srv.MustCreateEvent(t, redactionRoom, federation.Event{
 					Type:    "m.room.message",
-					Sender:  charlie,
+					Sender:  hs2ObserverUser,
 					Content: map[string]interface{}{},
 				})
 				redactionRoom.AddEvent(ev)
@@ -403,7 +403,7 @@ func TestSync(t *testing.T) {
 				//
 				// Regression test for https://github.com/element-hq/synapse/issues/16948
 
-				charlie := deployment.Register(t, "hs1", helpers.RegistrationOpts{LocalpartSuffix: "charlie"})
+				hs2ObserverUser := deployment.Register(t, "hs1", helpers.RegistrationOpts{LocalpartSuffix: "hs2ObserverUser"})
 				roomID := alice.MustCreateRoom(t, map[string]interface{}{"preset": "public_chat"})
 
 				aliceSyncFilter := `{
@@ -414,23 +414,23 @@ func TestSync(t *testing.T) {
 				}`
 				_, initialSyncToken := alice.MustSync(t, client.SyncReq{Filter: aliceSyncFilter})
 
-				charlie.MustJoinRoom(t, roomID, nil)
+				hs2ObserverUser.MustJoinRoom(t, roomID, nil)
 				syncToken := alice.MustSyncUntil(t, client.SyncReq{Filter: aliceSyncFilter, Since: initialSyncToken},
-					syncDeviceListsHas("changed", charlie.UserID),
+					syncDeviceListsHas("changed", hs2ObserverUser.UserID),
 				)
 
 				// Charlie sends a message, and leaves
-				sendMessages(t, charlie, roomID, "test", 1)
-				charlie.MustLeaveRoom(t, roomID)
+				sendMessages(t, hs2ObserverUser, roomID, "test", 1)
+				hs2ObserverUser.MustLeaveRoom(t, roomID)
 
-				// Alice sees charlie in the "left" section
+				// Alice sees hs2ObserverUser in the "left" section
 				alice.MustSyncUntil(t, client.SyncReq{Filter: aliceSyncFilter, Since: syncToken},
-					syncDeviceListsHas("left", charlie.UserID),
+					syncDeviceListsHas("left", hs2ObserverUser.UserID),
 				)
 
 				// ... even if she makes the request twice
 				resp, _ := alice.MustSync(t, client.SyncReq{Filter: aliceSyncFilter, Since: syncToken})
-				if err := syncDeviceListsHas("left", charlie.UserID)(alice.UserID, resp); err != nil {
+				if err := syncDeviceListsHas("left", hs2ObserverUser.UserID)(alice.UserID, resp); err != nil {
 					t.Error(err)
 				}
 			})
@@ -441,11 +441,11 @@ func TestSync(t *testing.T) {
 // This is a regression test for
 // https://github.com/matrix-org/synapse/issues/16463
 //
-// We test this by having a local user (alice) and remote user (charlie) in a
+// We test this by having a local user (alice) and remote user (hs2ObserverUser) in a
 // room. Charlie sends 50+ messages into the room without sending to Alice's
 // server. Charlie then sends one more which get sent to Alice.
 //
-// Alice should observe that she receives some (though not all) of charlie's
+// Alice should observe that she receives some (though not all) of hs2ObserverUser's
 // events, with the `limited` flag set.
 func TestSyncTimelineGap(t *testing.T) {
 	runtime.SkipIf(t, runtime.Dendrite)
@@ -460,10 +460,10 @@ func TestSyncTimelineGap(t *testing.T) {
 	cancel := srv.Listen()
 	defer cancel()
 
-	charlie := srv.UserID("charlie")
+	hs2ObserverUser := srv.UserID("hs2ObserverUser")
 
 	roomID := alice.MustCreateRoom(t, map[string]interface{}{"preset": "public_chat"})
-	room := srv.MustJoinRoom(t, deployment, deployment.GetFullyQualifiedHomeserverName(t, "hs1"), roomID, charlie)
+	room := srv.MustJoinRoom(t, deployment, deployment.GetFullyQualifiedHomeserverName(t, "hs1"), roomID, hs2ObserverUser)
 
 	filterID := createFilter(t, alice, map[string]interface{}{
 		"room": map[string]interface{}{
@@ -489,7 +489,7 @@ func TestSyncTimelineGap(t *testing.T) {
 	for i := 0; i < 50; i++ {
 		event := srv.MustCreateEvent(t, room, federation.Event{
 			Type:   "m.room.message",
-			Sender: charlie,
+			Sender: hs2ObserverUser,
 			Content: map[string]interface{}{
 				"body":    "Remote message",
 				"msgtype": "m.text",
@@ -503,7 +503,7 @@ func TestSyncTimelineGap(t *testing.T) {
 	// previous 50.
 	lastEvent := srv.MustCreateEvent(t, room, federation.Event{
 		Type:   "m.room.message",
-		Sender: charlie,
+		Sender: hs2ObserverUser,
 		Content: map[string]interface{}{
 			"body":    "End",
 			"msgtype": "m.text",
@@ -520,11 +520,11 @@ func TestSyncTimelineGap(t *testing.T) {
 	// We now test two different modes of /sync work. The first is when we are
 	// syncing when the server receives the `lastEvent` (and so, at least
 	// Synapse, will start sending down some events immediately). In this mode
-	// we may see alice's message, but charlie's messages should set the limited
+	// we may see alice's message, but hs2ObserverUser's messages should set the limited
 	// flag.
 	//
 	// The second mode is when we incremental sync *after* all the events have
-	// finished being persisted, and so we get only charlie's messages.
+	// finished being persisted, and so we get only hs2ObserverUser's messages.
 	t.Run("incremental", func(t *testing.T) {
 		timelineSequence := make([]gjson.Result, 0)
 
@@ -574,7 +574,7 @@ func TestSyncTimelineGap(t *testing.T) {
 						t.Fatalf("Got message from alice after limited flag")
 					}
 				} else {
-					if ev.Get("sender").Str == charlie {
+					if ev.Get("sender").Str == hs2ObserverUser {
 						t.Fatalf("Got message from remote without limited flag being set")
 					}
 				}
@@ -631,32 +631,32 @@ func TestPresenceSyncDifferentRooms(t *testing.T) {
 	alice := deployment.Register(t, "hs1", helpers.RegistrationOpts{})
 	bob := deployment.Register(t, "hs1", helpers.RegistrationOpts{})
 
-	charlie := deployment.Register(t, "hs1", helpers.RegistrationOpts{
-		LocalpartSuffix: "charlie",
+	hs2ObserverUser := deployment.Register(t, "hs1", helpers.RegistrationOpts{
+		LocalpartSuffix: "hs2ObserverUser",
 	})
 
 	// Alice creates two rooms: one with her and Bob, and a second with her and Charlie.
 	bobRoomID := alice.MustCreateRoom(t, map[string]interface{}{})
-	charlieRoomID := alice.MustCreateRoom(t, map[string]interface{}{})
-	nextBatch := alice.MustSyncUntil(t, client.SyncReq{}, client.SyncJoinedTo(alice.UserID, bobRoomID), client.SyncJoinedTo(alice.UserID, charlieRoomID))
+	hs2ObserverUserRoomID := alice.MustCreateRoom(t, map[string]interface{}{})
+	nextBatch := alice.MustSyncUntil(t, client.SyncReq{}, client.SyncJoinedTo(alice.UserID, bobRoomID), client.SyncJoinedTo(alice.UserID, hs2ObserverUserRoomID))
 
 	alice.MustInviteRoom(t, bobRoomID, bob.UserID)
-	alice.MustInviteRoom(t, charlieRoomID, charlie.UserID)
+	alice.MustInviteRoom(t, hs2ObserverUserRoomID, hs2ObserverUser.UserID)
 	bob.MustJoinRoom(t, bobRoomID, nil)
-	charlie.MustJoinRoom(t, charlieRoomID, nil)
+	hs2ObserverUser.MustJoinRoom(t, hs2ObserverUserRoomID, nil)
 
 	nextBatch = alice.MustSyncUntil(t,
 		client.SyncReq{Since: nextBatch},
 		client.SyncJoinedTo(bob.UserID, bobRoomID),
-		client.SyncJoinedTo(charlie.UserID, charlieRoomID),
+		client.SyncJoinedTo(hs2ObserverUser.UserID, hs2ObserverUserRoomID),
 	)
 
 	// Bob and Charlie mark themselves as online.
 	reqBody := client.WithJSONBody(t, map[string]interface{}{
 		"presence": "online",
 	})
 	bob.Do(t, "PUT", []string{"_matrix", "client", "v3", "presence", bob.UserID, "status"}, reqBody)
-	charlie.Do(t, "PUT", []string{"_matrix", "client", "v3", "presence", charlie.UserID, "status"}, reqBody)
+	hs2ObserverUser.Do(t, "PUT", []string{"_matrix", "client", "v3", "presence", hs2ObserverUser.UserID, "status"}, reqBody)
 
 	// Alice should see that Bob and Charlie are online. She may see this happen
 	// simultaneously in one /sync response, or separately in two /sync
@@ -675,14 +675,14 @@ func TestPresenceSyncDifferentRooms(t *testing.T) {
 			if x.Get("sender").Str == bob.UserID {
 				seenBobOnline = true
 			}
-			if x.Get("sender").Str == charlie.UserID {
+			if x.Get("sender").Str == hs2ObserverUser.UserID {
 				seenCharlieOnline = true
 			}
 			if seenBobOnline && seenCharlieOnline {
 				return nil
 			}
 		}
-		return fmt.Errorf("all users not present yet, bob %t charlie %t", seenBobOnline, seenCharlieOnline)
+		return fmt.Errorf("all users not present yet, bob %t hs2ObserverUser %t", seenBobOnline, seenCharlieOnline)
 	})
 }
 
@@ -827,8 +827,8 @@ func TestLeaveReinviteSyncFederated(t *testing.T) {
 	alice := deployment.Register(t, "hs1", helpers.RegistrationOpts{})
 	bob := deployment.Register(t, "hs2", helpers.RegistrationOpts{})
 
-	// Charlie is simply here to flag when events arrive over federation to hs2.
-	charlie := deployment.Register(t, "hs2", helpers.RegistrationOpts{})
+	// This user is here to flag when events arrive over federation to hs2.
+	hs2ObserverUser := deployment.Register(t, "hs2", helpers.RegistrationOpts{})
 
 	// 1. Alice creates a room and both Bob and Charlie join
 	roomID := alice.MustCreateRoom(t, map[string]any{
@@ -837,20 +837,20 @@ func TestLeaveReinviteSyncFederated(t *testing.T) {
 
 	// Users on hs2 need to join via federation, so we need to specify the server name
 	alice.MustInviteRoom(t, roomID, bob.UserID)
-	alice.MustInviteRoom(t, roomID, charlie.UserID)
+	alice.MustInviteRoom(t, roomID, hs2ObserverUser.UserID)
 	bob.MustSyncUntil(t, client.SyncReq{}, client.SyncInvitedTo(bob.UserID, roomID))
-	charlie.MustSyncUntil(t, client.SyncReq{}, client.SyncInvitedTo(charlie.UserID, roomID))
+	hs2ObserverUser.MustSyncUntil(t, client.SyncReq{}, client.SyncInvitedTo(hs2ObserverUser.UserID, roomID))
 
 	bob.MustJoinRoom(t, roomID, []spec.ServerName{
 		deployment.GetFullyQualifiedHomeserverName(t, "hs1"),
 	})
-	charlie.MustJoinRoom(t, roomID, []spec.ServerName{
+	hs2ObserverUser.MustJoinRoom(t, roomID, []spec.ServerName{
 		deployment.GetFullyQualifiedHomeserverName(t, "hs1"),
 	})
 
 	// 2. Both Bob and Charlie do a sync and verify that they see the join
 	bobSince := bob.MustSyncUntil(t, client.SyncReq{}, client.SyncJoinedTo(bob.UserID, roomID))
-	charlieSince := charlie.MustSyncUntil(t, client.SyncReq{}, client.SyncJoinedTo(charlie.UserID, roomID))
+	hs2ObserverUser.MustSyncUntil(t, client.SyncReq{}, client.SyncJoinedTo(hs2ObserverUser.UserID, roomID))
 
 	// 3. Alice kicks Bob from the room and then re-invites them.
 	// For kicking, we need to use the POST /rooms/{roomId}/kick endpoint
@@ -862,17 +862,19 @@ func TestLeaveReinviteSyncFederated(t *testing.T) {
 
 	// Wait until Bob is kicked.
 	aliceSince := alice.MustSyncUntil(t, client.SyncReq{}, client.SyncLeftFrom(bob.UserID, roomID))
-	charlieSince = charlie.MustSyncUntil(t, client.SyncReq{Since: charlieSince}, client.SyncLeftFrom(bob.UserID, roomID))
+	
+	// Wait until hs2 sees that Bob has been kicked. If we don't wait, then we
+	// have no idea whether `hs2` received the kick event.
+	hs2ObserverUser.MustSyncUntil(t, client.SyncReq{}, client.SyncLeftFrom(bob.UserID, roomID))
 
 	// Alice re-invites Bob
 	alice.MustInviteRoom(t, roomID, bob.UserID)
 	alice.MustSyncUntil(t, client.SyncReq{Since: aliceSince}, client.SyncInvitedTo(bob.UserID, roomID))
 
-	// Wait until hs2 sees that Bob has been kicked and re-invited (this is all
-	// Charlie is needed for). If we don't wait, then Bob might sync too early
-	// (slow federation) and catch the kick in one sync iteration, and the
-	// invite in another, invalidating the test conditions.
-	charlieSince = charlie.MustSyncUntil(t, client.SyncReq{Since: charlieSince}, client.SyncInvitedTo(bob.UserID, roomID))
+	// Wait until hs2 sees that Bob has been re-invited. If we don't wait, then
+	// Bob might sync too early (slow federation) and catch the kick in one sync
+	// iteration, and the invite in another, invalidating the test conditions.
+	hs2ObserverUser.MustSyncUntil(t, client.SyncReq{}, client.SyncInvitedTo(bob.UserID, roomID))
 
 	// 4. Bob does an incremental sync. Bob's last sync was after they joined the room.
 	jsonRes, _ := bob.MustSync(t, client.SyncReq{Since: bobSince})