Move /event to the SyncAPI
This allows us to apply history visibility without having to recalculate
it in the roomserver.
Unblocks fix missing
part of
DELETE
clientapi/routing/getevent.go
-// Copyright 2019 Alex Chen
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package routing
-
-import (
- "net/http"
-
- "github.com/matrix-org/dendrite/clientapi/jsonerror"
- "github.com/matrix-org/dendrite/roomserver/api"
- "github.com/matrix-org/dendrite/setup/config"
- userapi "github.com/matrix-org/dendrite/userapi/api"
- "github.com/matrix-org/gomatrixserverlib"
- "github.com/matrix-org/util"
-)
-
-type getEventRequest struct {
- req *http.Request
- device *userapi.Device
- roomID string
- eventID string
- cfg *config.ClientAPI
- requestedEvent *gomatrixserverlib.Event
-}
-
-// GetEvent implements GET /_matrix/client/r0/rooms/{roomId}/event/{eventId}
-// https://matrix.org/docs/spec/client_server/r0.4.0.html#get-matrix-client-r0-rooms-roomid-event-eventid
-func GetEvent(
- req *http.Request,
- device *userapi.Device,
- roomID string,
- eventID string,
- cfg *config.ClientAPI,
- rsAPI api.ClientRoomserverAPI,
-) util.JSONResponse {
- eventsReq := api.QueryEventsByIDRequest{
- EventIDs: []string{eventID},
- }
- var eventsResp api.QueryEventsByIDResponse
- err := rsAPI.QueryEventsByID(req.Context(), &eventsReq, &eventsResp)
- if err != nil {
- util.GetLogger(req.Context()).WithError(err).Error("queryAPI.QueryEventsByID failed")
- return jsonerror.InternalServerError()
- }
-
- if len(eventsResp.Events) == 0 {
- // Event not found locally
- return util.JSONResponse{
- Code: http.StatusNotFound,
- JSON: jsonerror.NotFound("The event was not found or you do not have permission to read this event"),
- }
- }
-
- requestedEvent := eventsResp.Events[0].Event
-
- r := getEventRequest{
- req: req,
- device: device,
- roomID: roomID,
- eventID: eventID,
- cfg: cfg,
- requestedEvent: requestedEvent,
- }
-
- stateReq := api.QueryStateAfterEventsRequest{
- RoomID: r.requestedEvent.RoomID(),
- PrevEventIDs: r.requestedEvent.PrevEventIDs(),
- StateToFetch: []gomatrixserverlib.StateKeyTuple{{
- EventType: gomatrixserverlib.MRoomMember,
- StateKey: device.UserID,
- }},
- }
- var stateResp api.QueryStateAfterEventsResponse
- if err := rsAPI.QueryStateAfterEvents(req.Context(), &stateReq, &stateResp); err != nil {
- util.GetLogger(req.Context()).WithError(err).Error("queryAPI.QueryStateAfterEvents failed")
- return jsonerror.InternalServerError()
- }
-
- if !stateResp.RoomExists {
- util.GetLogger(req.Context()).Errorf("Expected to find room for event %s but failed", r.requestedEvent.EventID())
- return jsonerror.InternalServerError()
- }
-
- if !stateResp.PrevEventsExist {
- // Missing some events locally; stateResp.StateEvents unavailable.
- return util.JSONResponse{
- Code: http.StatusNotFound,
- JSON: jsonerror.NotFound("The event was not found or you do not have permission to read this event"),
- }
- }
-
- var appService *config.ApplicationService
- if device.AppserviceID != "" {
- for _, as := range cfg.Derived.ApplicationServices {
- if as.ID == device.AppserviceID {
- appService = &as
- break
- }
- }
- }
-
- for _, stateEvent := range stateResp.StateEvents {
- if appService != nil {
- if !appService.IsInterestedInUserID(*stateEvent.StateKey()) {
- continue
- }
- } else if !stateEvent.StateKeyEquals(device.UserID) {
- continue
- }
- membership, err := stateEvent.Membership()
- if err != nil {
- util.GetLogger(req.Context()).WithError(err).Error("stateEvent.Membership failed")
- return jsonerror.InternalServerError()
- }
- if membership == gomatrixserverlib.Join {
- return util.JSONResponse{
- Code: http.StatusOK,
- JSON: gomatrixserverlib.ToClientEvent(r.requestedEvent, gomatrixserverlib.FormatAll),
- }
- }
- }
-
- return util.JSONResponse{
- Code: http.StatusNotFound,
- JSON: jsonerror.NotFound("The event was not found or you do not have permission to read this event"),
- }
-}

MODIFY
clientapi/routing/routing.go
clientapi/routing/routing.go
@@ -367,15 +367,6 @@ func Setup(
nil, cfg, rsAPI, transactionsCache)
}),
).Methods(http.MethodPut, http.MethodOptions)
- v3mux.Handle("/rooms/{roomID}/event/{eventID}",
- httputil.MakeAuthAPI("rooms_get_event", userAPI, func(req *http.Request, device *userapi.Device) util.JSONResponse {
- vars, err := httputil.URLDecodeMapValues(mux.Vars(req))
- if err != nil {
- return util.ErrorResponse(err)
- }
- return GetEvent(req, device, vars["roomID"], vars["eventID"], cfg, rsAPI)
- }),
- ).Methods(http.MethodGet, http.MethodOptions)
v3mux.Handle("/rooms/{roomID}/state", httputil.MakeAuthAPI("room_state", userAPI, func(req *http.Request, device *userapi.Device) util.JSONResponse {
vars, err := httputil.URLDecodeMapValues(mux.Vars(req))

MODIFY
docs/caddy/polylith/Caddyfile
docs/caddy/polylith/Caddyfile
@@ -55,7 +55,7 @@ matrix.example.com {
# Change the end of each reverse_proxy line to the correct
# address for your various services.
@sync_api {
- path_regexp /_matrix/client/.*?/(sync|user/.*?/filter/?.*|keys/changes|rooms/.*?/messages)$
+ path_regexp /_matrix/client/.*?/(sync|user/.*?/filter/?.*|keys/changes|rooms/.*?/(messages|context/.*?|event/.*?))$
}
reverse_proxy @sync_api sync_api:8073

MODIFY
docs/hiawatha/polylith-sample.conf
docs/hiawatha/polylith-sample.conf
@@ -18,8 +18,10 @@ VirtualHost {
# /_matrix/client/.*/user/{userId}/filter/{filterID}
# /_matrix/client/.*/keys/changes
# /_matrix/client/.*/rooms/{roomId}/messages
+ # /_matrix/client/.*/rooms/{roomId}/context/{eventID}
+ # /_matrix/client/.*/rooms/{roomId}/event/{eventID}
# to sync_api
- ReverseProxy = /_matrix/client/.*?/(sync|user/.*?/filter/?.*|keys/changes|rooms/.*?/messages) http://localhost:8073 600
+ ReverseProxy = /_matrix/client/.*?/(sync|user/.*?/filter/?.*|keys/changes|rooms/.*?/(messages|context/.*?|event/.*?))$ http://localhost:8073 600
ReverseProxy = /_matrix/client http://localhost:8071 600
ReverseProxy = /_matrix/federation http://localhost:8072 600
ReverseProxy = /_matrix/key http://localhost:8072 600

MODIFY
docs/nginx/polylith-sample.conf
docs/nginx/polylith-sample.conf
@@ -28,8 +28,10 @@ server {
# /_matrix/client/.*/user/{userId}/filter/{filterID}
# /_matrix/client/.*/keys/changes
# /_matrix/client/.*/rooms/{roomId}/messages
+ # /_matrix/client/.*/rooms/{roomId}/context/{eventID}
+ # /_matrix/client/.*/rooms/{roomId}/event/{eventID}
# to sync_api
- location ~ /_matrix/client/.*?/(sync|user/.*?/filter/?.*|keys/changes|rooms/.*?/messages)$ {
+ location ~ /_matrix/client/.*?/(sync|user/.*?/filter/?.*|keys/changes|rooms/.*?/(messages|context/.*?|event/.*?))$ {
proxy_pass http://sync_api:8073;
}

MODIFY
syncapi/internal/history_visibility.go
syncapi/internal/history_visibility.go
@@ -19,11 +19,13 @@ import (
"math"
"time"
- "github.com/matrix-org/dendrite/roomserver/api"
- "github.com/matrix-org/dendrite/syncapi/storage"
"github.com/matrix-org/gomatrixserverlib"
"github.com/prometheus/client_golang/prometheus"
+ "github.com/sirupsen/logrus"
"github.com/tidwall/gjson"
+
+ "github.com/matrix-org/dendrite/roomserver/api"
+ "github.com/matrix-org/dendrite/syncapi/storage"
)
func init() {
@@ -189,7 +191,7 @@ func visibilityForEvents(
UserID: userID,
}, membershipResp)
if err != nil {
- return result, err
+ logrus.WithError(err).Error("visibilityForEvents: failed to fetch membership at event, defaulting to 'leave'")
}
// Create a map from eventID -> eventVisibility

ADD
syncapi/routing/getevent.go
+// Copyright 2022 The Matrix.org Foundation C.I.C.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package routing
+
+import (
+ "net/http"
+
+ "github.com/matrix-org/gomatrixserverlib"
+ "github.com/matrix-org/util"
+ "github.com/sirupsen/logrus"
+
+ "github.com/matrix-org/dendrite/clientapi/jsonerror"
+ "github.com/matrix-org/dendrite/roomserver/api"
+ "github.com/matrix-org/dendrite/setup/config"
+ "github.com/matrix-org/dendrite/syncapi/internal"
+ "github.com/matrix-org/dendrite/syncapi/storage"
+ userapi "github.com/matrix-org/dendrite/userapi/api"
+)
+
+// GetEvent implements
+//
+// GET /_matrix/client/r0/rooms/{roomId}/event/{eventId}
+//
+// https://spec.matrix.org/v1.4/client-server-api/#get_matrixclientv3roomsroomideventeventid
+func GetEvent(
+ req *http.Request,
+ device *userapi.Device,
+ roomID string,
+ eventID string,
+ cfg *config.SyncAPI,
+ syncDB storage.Database,
+ rsAPI api.SyncRoomserverAPI,
+) util.JSONResponse {
+ ctx := req.Context()
+ db, err := syncDB.NewDatabaseTransaction(ctx)
+ logger := util.GetLogger(ctx).WithFields(logrus.Fields{
+ "event_id": eventID,
+ "room_id": roomID,
+ })
+ if err != nil {
+ logger.WithError(err).Error("GetEvent: syncDB.NewDatabaseTransaction failed")
+ return jsonerror.InternalServerError()
+ }
+
+ events, err := db.Events(ctx, []string{eventID})
+ if err != nil {
+ logger.WithError(err).Error("GetEvent: syncDB.Events failed")
+ return jsonerror.InternalServerError()
+ }
+
+ // The requested event does not exist in our database
+ if len(events) == 0 {
+ logger.Debugf("GetEvent: requested event doesn't exist locally")
+ return util.JSONResponse{
+ Code: http.StatusNotFound,
+ JSON: jsonerror.NotFound("The event was not found or you do not have permission to read this event"),
+ }
+ }
+
+ // If the request is coming from an appservice, get the user from the request
+ userID := device.UserID
+ if asUserID := req.FormValue("user_id"); device.AppserviceID != "" && asUserID != "" {
+ userID = asUserID
+ }
+
+ // Apply history visibility to determine if the user is allowed to view the event
+ events, err = internal.ApplyHistoryVisibilityFilter(ctx, db, rsAPI, events, nil, userID, "event")
+ if err != nil {
+ logger.WithError(err).Error("GetEvent: internal.ApplyHistoryVisibilityFilter failed")
+ return util.JSONResponse{
+ Code: http.StatusInternalServerError,
+ JSON: jsonerror.InternalServerError(),
+ }
+ }
+
+ // We only ever expect there to be one event
+ if len(events) != 1 {
+ // 0 events -> not allowed to view event; > 1 events -> something that shouldn't happen
+ logger.WithField("event_count", len(events)).Debug("GetEvent: can't return the requested event")
+ return util.JSONResponse{
+ Code: http.StatusNotFound,
+ JSON: jsonerror.NotFound("The event was not found or you do not have permission to read this event"),
+ }
+ }
+
+ return util.JSONResponse{
+ Code: http.StatusOK,
+ JSON: gomatrixserverlib.HeaderedToClientEvent(events[0], gomatrixserverlib.FormatAll),
+ }
+}

MODIFY
syncapi/routing/routing.go
syncapi/routing/routing.go
@@ -60,6 +60,16 @@ func Setup(
return OnIncomingMessagesRequest(req, syncDB, vars["roomID"], device, rsAPI, cfg, srp, lazyLoadCache)
})).Methods(http.MethodGet, http.MethodOptions)
+ v3mux.Handle("/rooms/{roomID}/event/{eventID}",
+ httputil.MakeAuthAPI("rooms_get_event", userAPI, func(req *http.Request, device *userapi.Device) util.JSONResponse {
+ vars, err := httputil.URLDecodeMapValues(mux.Vars(req))
+ if err != nil {
+ return util.ErrorResponse(err)
+ }
+ return GetEvent(req, device, vars["roomID"], vars["eventID"], cfg, syncDB, rsAPI)
+ }),
+ ).Methods(http.MethodGet, http.MethodOptions)
+
v3mux.Handle("/user/{userId}/filter",
httputil.MakeAuthAPI("put_filter", userAPI, func(req *http.Request, device *userapi.Device) util.JSONResponse {
vars, err := httputil.URLDecodeMapValues(mux.Vars(req))

Move /event to the SyncAPI (#2782)

This allows us to apply history visibility without having to recalculate
it in the roomserver.
Unblocks https://github.com/matrix-org/complement/pull/495, fix missing
part of https://github.com/matrix-org/dendrite/issues/617