Skip to content
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

Start adding tests for MSC4140 #734

Merged
merged 17 commits into from
Sep 18, 2024
Merged

Start adding tests for MSC4140 #734

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
3041a46
Start adding tests for MSC4140
AndrewFerr Sep 11, 2024
f086639
Remove redundant check for 200 from a "Must" req
AndrewFerr Sep 11, 2024
1a33f1a
Confirm that cancelled delayed state is not sent
AndrewFerr Sep 11, 2024
0e32834
Test sending uncancelled delayed state events
AndrewFerr Sep 11, 2024
63b5788
Use consts for unchanging variables
AndrewFerr Sep 11, 2024
68fe42e
Test restoring delayed events after server restart
AndrewFerr Sep 11, 2024
a197342
Test that delayed events are empty on startup
AndrewFerr Sep 13, 2024
0101b7c
Use variable for content key
AndrewFerr Sep 16, 2024
8323f51
Assert absence of unexpected content fields
AndrewFerr Sep 16, 2024
64d724c
Remove helper function for delayed message events
AndrewFerr Sep 16, 2024
129272c
Add many more test cases
AndrewFerr Sep 16, 2024
2e49021
Test delayed state event cancelled by other user
AndrewFerr Sep 17, 2024
cd42448
Skip server restart test if not Synapse
AndrewFerr Sep 17, 2024
a3ea116
Test delayed message events
AndrewFerr Sep 17, 2024
fc93193
Move txnID rerequest to subtest
AndrewFerr Sep 17, 2024
f73508f
Test that only own delayed events are returned
AndrewFerr Sep 17, 2024
5ad5d62
Add TODO for testing pagination
anoadragon453 Sep 18, 2024
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
244 changes: 243 additions & 1 deletion tests/msc4140/delayed_event_test.go
View file
Open in desktop
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,244 @@ func TestDelayedEvents(t *testing.T) {
})
})

t.Run("cannot update a delayed event without a delay ID", func(t *testing.T) {
res := user.Do(t, "POST", append(getPathForUpdateDelayedEvents(), ""))
must.MatchResponse(t, res, match.HTTPResponse{
StatusCode: 404,
})
})

t.Run("cannot update a delayed event without a request body", func(t *testing.T) {
res := user.Do(t, "POST", append(getPathForUpdateDelayedEvents(), "abc"))
must.MatchResponse(t, res, match.HTTPResponse{
StatusCode: 400,
JSON: []match.JSON{
match.JSONKeyEqual("errcode", "M_NOT_JSON"),
},
})
})

t.Run("cannot update a delayed event without an action", func(t *testing.T) {
res := user.Do(
t,
"POST",
append(getPathForUpdateDelayedEvents(), "abc"),
client.WithJSONBody(t, map[string]interface{}{}),
)
must.MatchResponse(t, res, match.HTTPResponse{
StatusCode: 400,
JSON: []match.JSON{
match.JSONKeyEqual("errcode", "M_MISSING_PARAM"),
},
})
})

t.Run("cannot update a delayed event with an invalid action", func(t *testing.T) {
res := user.Do(
t,
"POST",
append(getPathForUpdateDelayedEvents(), "abc"),
client.WithJSONBody(t, map[string]interface{}{
"action": "oops",
}),
)
must.MatchResponse(t, res, match.HTTPResponse{
StatusCode: 400,
JSON: []match.JSON{
match.JSONKeyEqual("errcode", "M_INVALID_PARAM"),
},
})
})

t.Run("parallel", func(t *testing.T) {
for _, action := range []string{"cancel", "restart", "send"} {
t.Run(fmt.Sprintf("cannot %s a delayed event without a matching delay ID", action), func(t *testing.T) {
t.Parallel()
res := user.Do(
t,
"POST",
append(getPathForUpdateDelayedEvents(), "abc"),
client.WithJSONBody(t, map[string]interface{}{
"action": action,
}),
)
must.MatchResponse(t, res, match.HTTPResponse{
StatusCode: 404,
})
})
}
})

t.Run("delayed state events can be cancelled", func(t *testing.T) {
var res *http.Response

stateKey := "to_never_send"

setterKey := "setter"
setterExpected := "none"
res = user.MustDo(
t,
"PUT",
getPathForState(roomID, eventType, stateKey),
client.WithJSONBody(t, map[string]interface{}{
setterKey: setterExpected,
}),
getDelayQueryParam("1500"),
)
delayID := client.GetJSONFieldStr(t, client.ParseJSON(t, res), "delay_id")

time.Sleep(1 * time.Second)
res = getDelayedEvents(t, user)
must.MatchResponse(t, res, match.HTTPResponse{
JSON: []match.JSON{
match.JSONKeyArrayOfSize("delayed_events", 1),
},
})
res = user.Do(t, "GET", getPathForState(roomID, eventType, stateKey))
must.MatchResponse(t, res, match.HTTPResponse{
StatusCode: 404,
})

user.MustDo(
t,
"POST",
append(getPathForUpdateDelayedEvents(), delayID),
client.WithJSONBody(t, map[string]interface{}{
"action": "cancel",
}),
)
res = getDelayedEvents(t, user)
must.MatchResponse(t, res, match.HTTPResponse{
JSON: []match.JSON{
match.JSONKeyArrayOfSize("delayed_events", 0),
},
})

time.Sleep(1 * time.Second)
res = user.Do(t, "GET", getPathForState(roomID, eventType, stateKey))
must.MatchResponse(t, res, match.HTTPResponse{
StatusCode: 404,
})
})

t.Run("delayed state events can be sent on request", func(t *testing.T) {
var res *http.Response

stateKey := "to_send_on_request"

setterKey := "setter"
setterExpected := "on_send"
res = user.MustDo(
t,
"PUT",
getPathForState(roomID, eventType, stateKey),
client.WithJSONBody(t, map[string]interface{}{
setterKey: setterExpected,
}),
getDelayQueryParam("100000"),
)
delayID := client.GetJSONFieldStr(t, client.ParseJSON(t, res), "delay_id")

time.Sleep(1 * time.Second)
res = getDelayedEvents(t, user)
must.MatchResponse(t, res, match.HTTPResponse{
JSON: []match.JSON{
match.JSONKeyArrayOfSize("delayed_events", 1),
},
})
res = user.Do(t, "GET", getPathForState(roomID, eventType, stateKey))
must.MatchResponse(t, res, match.HTTPResponse{
StatusCode: 404,
})

user.MustDo(
t,
"POST",
append(getPathForUpdateDelayedEvents(), delayID),
client.WithJSONBody(t, map[string]interface{}{
"action": "send",
}),
)
res = getDelayedEvents(t, user)
must.MatchResponse(t, res, match.HTTPResponse{
JSON: []match.JSON{
match.JSONKeyArrayOfSize("delayed_events", 0),
},
})
res = user.Do(t, "GET", getPathForState(roomID, eventType, stateKey))
must.MatchResponse(t, res, match.HTTPResponse{
JSON: []match.JSON{
match.JSONKeyEqual(setterKey, setterExpected),
},
})
})

t.Run("delayed state events can be restarted", func(t *testing.T) {
var res *http.Response

stateKey := "to_send_on_restarted_timeout"

setterKey := "setter"
setterExpected := "on_timeout"
res = user.MustDo(
t,
"PUT",
getPathForState(roomID, eventType, stateKey),
client.WithJSONBody(t, map[string]interface{}{
setterKey: setterExpected,
}),
getDelayQueryParam("1500"),
)
delayID := client.GetJSONFieldStr(t, client.ParseJSON(t, res), "delay_id")

time.Sleep(1 * time.Second)
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved
res = getDelayedEvents(t, user)
must.MatchResponse(t, res, match.HTTPResponse{
JSON: []match.JSON{
match.JSONKeyArrayOfSize("delayed_events", 1),
},
})
res = user.Do(t, "GET", getPathForState(roomID, eventType, stateKey))
must.MatchResponse(t, res, match.HTTPResponse{
StatusCode: 404,
})

user.MustDo(
t,
"POST",
append(getPathForUpdateDelayedEvents(), delayID),
client.WithJSONBody(t, map[string]interface{}{
"action": "restart",
}),
)

time.Sleep(1 * time.Second)
res = getDelayedEvents(t, user)
must.MatchResponse(t, res, match.HTTPResponse{
JSON: []match.JSON{
match.JSONKeyArrayOfSize("delayed_events", 1),
},
})
res = user.Do(t, "GET", getPathForState(roomID, eventType, stateKey))
must.MatchResponse(t, res, match.HTTPResponse{
StatusCode: 404,
})

time.Sleep(1 * time.Second)
res = getDelayedEvents(t, user)
must.MatchResponse(t, res, match.HTTPResponse{
JSON: []match.JSON{
match.JSONKeyArrayOfSize("delayed_events", 0),
},
})
res = user.MustDo(t, "GET", getPathForState(roomID, eventType, stateKey))
must.MatchResponse(t, res, match.HTTPResponse{
JSON: []match.JSON{
match.JSONKeyEqual(setterKey, setterExpected),
},
})
})

t.Run("delayed state events are cancelled by a more recent state event", func(t *testing.T) {
AndrewFerr marked this conversation as resolved.
Show resolved Hide resolved
var res *http.Response

Expand Down Expand Up @@ -186,6 +424,10 @@ func TestDelayedEvents(t *testing.T) {
})
}

func getPathForUpdateDelayedEvents() []string {
return []string{"_matrix", "client", "unstable", "org.matrix.msc4140", "delayed_events"}
}

func getPathForState(roomID string, eventType string, stateKey string) []string {
return []string{"_matrix", "client", "v3", "rooms", roomID, "state", eventType, stateKey}
}
Expand All @@ -198,5 +440,5 @@ func getDelayQueryParam(delayStr string) client.RequestOpt {

func getDelayedEvents(t *testing.T, user *client.CSAPI) *http.Response {
t.Helper()
return user.MustDo(t, "GET", []string{"_matrix", "client", "unstable", "org.matrix.msc4140", "delayed_events"})
return user.MustDo(t, "GET", getPathForUpdateDelayedEvents())
}
Loading