Add start_stream to /messages (#1648)

This commit is contained in:
Kegsay 2020-12-16 18:10:39 +00:00 committed by GitHub
parent 42e9cbf342
commit 76becac003
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -50,9 +50,10 @@ type messagesReq struct {
} }
type messagesResp struct { type messagesResp struct {
Start string `json:"start"` Start string `json:"start"`
End string `json:"end"` StartStream string `json:"start_stream,omitempty"` // NOTSPEC: so clients can hit /messages then immediately /sync with a latest sync token
Chunk []gomatrixserverlib.ClientEvent `json:"chunk"` End string `json:"end"`
Chunk []gomatrixserverlib.ClientEvent `json:"chunk"`
} }
const defaultMessagesLimit = 10 const defaultMessagesLimit = 10
@ -87,7 +88,8 @@ func OnIncomingMessagesRequest(
// Pagination tokens. // Pagination tokens.
var fromStream *types.StreamingToken var fromStream *types.StreamingToken
fromQuery := req.URL.Query().Get("from") fromQuery := req.URL.Query().Get("from")
if fromQuery == "" { emptyFromSupplied := fromQuery == ""
if emptyFromSupplied {
// NOTSPEC: We will pretend they used the latest sync token if no ?from= was provided. // NOTSPEC: We will pretend they used the latest sync token if no ?from= was provided.
// We do this to allow clients to get messages without having to call `/sync` e.g Cerulean // We do this to allow clients to get messages without having to call `/sync` e.g Cerulean
currPos := srp.Notifier.CurrentPosition() currPos := srp.Notifier.CurrentPosition()
@ -195,14 +197,19 @@ func OnIncomingMessagesRequest(
"return_end": end.String(), "return_end": end.String(),
}).Info("Responding") }).Info("Responding")
res := messagesResp{
Chunk: clientEvents,
Start: start.String(),
End: end.String(),
}
if emptyFromSupplied {
res.StartStream = fromStream.String()
}
// Respond with the events. // Respond with the events.
return util.JSONResponse{ return util.JSONResponse{
Code: http.StatusOK, Code: http.StatusOK,
JSON: messagesResp{ JSON: res,
Chunk: clientEvents,
Start: start.String(),
End: end.String(),
},
} }
} }