apidoc_room_receipts_test.go

package csapi_tests

import (
	"testing"

	"github.com/matrix-org/complement"
	"github.com/matrix-org/complement/b"
	"github.com/matrix-org/complement/client"
	"github.com/matrix-org/complement/helpers"
	"github.com/tidwall/gjson"
)

// tests/10apidoc/37room-receipts.pl

func createRoomForReadReceipts(t *testing.T, c *client.CSAPI) (string, string) {
	roomID := c.MustCreateRoom(t, map[string]interface{}{"preset": "public_chat"})

	c.MustSyncUntil(t, client.SyncReq{}, client.SyncJoinedTo(c.UserID, roomID))

	eventID := sendMessageIntoRoom(t, c, roomID)

	return roomID, eventID
}

func sendMessageIntoRoom(t *testing.T, c *client.CSAPI, roomID string) string {
	return c.SendEventSynced(t, roomID, b.Event{
		Type: "m.room.message",
		Content: map[string]interface{}{
			"msgtype": "m.text",
			"body":    "Hello world!",
		},
	})
}

func syncHasReadReceipt(roomID, userID, eventID string) client.SyncCheckOpt {
	return client.SyncEphemeralHas(roomID, func(result gjson.Result) bool {
		return result.Get("type").Str == "m.receipt" &&
			result.Get("content").Get(eventID).Get(`m\.read`).Get(userID).Exists()
	})
}

// sytest: POST /rooms/:room_id/receipt can create receipts
func TestRoomReceipts(t *testing.T) {
	deployment := complement.Deploy(t, 1)
	defer deployment.Destroy(t)
	alice := deployment.Register(t, "hs1", helpers.RegistrationOpts{})
	roomID, eventID := createRoomForReadReceipts(t, alice)

	alice.MustDo(t, "POST", []string{"_matrix", "client", "v3", "rooms", roomID, "receipt", "m.read", eventID}, client.WithJSONBody(t, struct{}{}))

	// Make sure the read receipt shows up in sync.
	sinceToken := alice.MustSyncUntil(t, client.SyncReq{}, syncHasReadReceipt(roomID, alice.UserID, eventID))

	// Receipt events include a `room_id` field over federation, but they should
	// not do so down `/sync` to clients. Ensure homeservers strip that field out.
	t.Run("Receipts DO NOT include a `room_id` field", func(t *testing.T) {
		// Send another event to read.
		eventID2 := sendMessageIntoRoom(t, alice, roomID)

		// Send a read receipt for the event.
		alice.MustDo(t, "POST", []string{"_matrix", "client", "v3", "rooms", roomID, "receipt", "m.read", eventID2}, client.WithJSONBody(t, struct{}{}))

		alice.MustSyncUntil(
			t,
			client.SyncReq{Since: sinceToken},
			client.SyncEphemeralHas(roomID, func(r gjson.Result) bool {
				if r.Get("type").Str != "m.read" {
					return false
				}

				// Ensure that the `room_id` field does NOT exist.
				if r.Get("room_id").Exists() {
					t.Fatalf("Read receipt included `room_id` field down sync: %s", r.Raw)
				}

				// Exit the /sync loop.
				return true;
			}),
		)
	})
}

// sytest: POST /rooms/:room_id/read_markers can create read marker
func TestRoomReadMarkers(t *testing.T) {
	deployment := complement.Deploy(t, 1)
	defer deployment.Destroy(t)
	alice := deployment.Register(t, "hs1", helpers.RegistrationOpts{})
	roomID, eventID := createRoomForReadReceipts(t, alice)

	reqBody := client.WithJSONBody(t, map[string]interface{}{
		"m.fully_read": eventID,
		"m.read":       eventID,
	})
	alice.MustDo(t, "POST", []string{"_matrix", "client", "v3", "rooms", roomID, "read_markers"}, reqBody)

	// Make sure the read receipt shows up in sync.
	alice.MustSyncUntil(t, client.SyncReq{}, syncHasReadReceipt(roomID, alice.UserID, eventID))

	// Make sure that the fully_read receipt shows up in account data via sync.
	// Use the same token as above to replay the syncs.
	alice.MustSyncUntil(t, client.SyncReq{}, client.SyncRoomAccountDataHas(roomID, func(result gjson.Result) bool {
		return result.Get("type").Str == "m.fully_read" &&
			result.Get("content.event_id").Str == eventID
	}))
}