From 369d44064f54aaad87a23f39566ab37cdbca2033 Mon Sep 17 00:00:00 2001
From: Neil Alexander <neilalexander@users.noreply.github.com>
Date: Wed, 27 May 2020 16:13:09 +0100
Subject: [PATCH] Pass full device into CompleteSync

---
 syncapi/storage/interface.go         |  2 +-
 syncapi/storage/shared/syncserver.go |  4 ++--
 syncapi/storage/storage_test.go      |  4 ++--
 syncapi/sync/requestpool.go          | 12 ++++++------
 4 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/syncapi/storage/interface.go b/syncapi/storage/interface.go
index 3e9ff0533..7e1a40fd6 100644
--- a/syncapi/storage/interface.go
+++ b/syncapi/storage/interface.go
@@ -58,7 +58,7 @@ type Database interface {
 	// ID.
 	IncrementalSync(ctx context.Context, device authtypes.Device, fromPos, toPos types.StreamingToken, numRecentEventsPerRoom int, wantFullState bool) (*types.Response, error)
 	// CompleteSync returns a complete /sync API response for the given user.
-	CompleteSync(ctx context.Context, userID string, numRecentEventsPerRoom int) (*types.Response, error)
+	CompleteSync(ctx context.Context, device authtypes.Device, numRecentEventsPerRoom int) (*types.Response, error)
 	// GetAccountDataInRange returns all account data for a given user inserted or
 	// updated between two given positions
 	// Returns a map following the format data[roomID] = []dataTypes
diff --git a/syncapi/storage/shared/syncserver.go b/syncapi/storage/shared/syncserver.go
index 145a3dbf3..888f85e0b 100644
--- a/syncapi/storage/shared/syncserver.go
+++ b/syncapi/storage/shared/syncserver.go
@@ -666,10 +666,10 @@ func (d *Database) getResponseWithPDUsForCompleteSync(
 }
 
 func (d *Database) CompleteSync(
-	ctx context.Context, userID string, numRecentEventsPerRoom int,
+	ctx context.Context, device authtypes.Device, numRecentEventsPerRoom int,
 ) (*types.Response, error) {
 	res, toPos, joinedRoomIDs, err := d.getResponseWithPDUsForCompleteSync(
-		ctx, userID, numRecentEventsPerRoom,
+		ctx, device.UserID, numRecentEventsPerRoom,
 	)
 	if err != nil {
 		return nil, err
diff --git a/syncapi/storage/storage_test.go b/syncapi/storage/storage_test.go
index 6b0458527..bb8554f43 100644
--- a/syncapi/storage/storage_test.go
+++ b/syncapi/storage/storage_test.go
@@ -181,7 +181,7 @@ func TestSyncResponse(t *testing.T) {
 			Name: "CompleteSync limited",
 			DoSync: func() (*types.Response, error) {
 				// limit set to 5
-				return db.CompleteSync(ctx, testUserIDA, 5)
+				return db.CompleteSync(ctx, testUserDeviceA, 5)
 			},
 			// want the last 5 events
 			WantTimeline: events[len(events)-5:],
@@ -193,7 +193,7 @@ func TestSyncResponse(t *testing.T) {
 		{
 			Name: "CompleteSync",
 			DoSync: func() (*types.Response, error) {
-				return db.CompleteSync(ctx, testUserIDA, len(events)+1)
+				return db.CompleteSync(ctx, testUserDeviceA, len(events)+1)
 			},
 			WantTimeline: events,
 			// We want no state at all as that field in /sync is the delta between the token (beginning of time)
diff --git a/syncapi/sync/requestpool.go b/syncapi/sync/requestpool.go
index 82ce283b6..bd29b3338 100644
--- a/syncapi/sync/requestpool.go
+++ b/syncapi/sync/requestpool.go
@@ -47,7 +47,6 @@ func (rp *RequestPool) OnIncomingSyncRequest(req *http.Request, device *authtype
 	var syncData *types.Response
 
 	// Extract values from request
-	userID := device.UserID
 	syncReq, err := newSyncRequest(req, *device)
 	if err != nil {
 		return util.JSONResponse{
@@ -56,10 +55,11 @@ func (rp *RequestPool) OnIncomingSyncRequest(req *http.Request, device *authtype
 		}
 	}
 	logger := util.GetLogger(req.Context()).WithFields(log.Fields{
-		"userID":  userID,
-		"since":   syncReq.since,
-		"timeout": syncReq.timeout,
-		"limit":   syncReq.limit,
+		"userID":   device.UserID,
+		"deviceID": device.ID,
+		"since":    syncReq.since,
+		"timeout":  syncReq.timeout,
+		"limit":    syncReq.limit,
 	})
 
 	currPos := rp.notifier.CurrentPosition()
@@ -136,7 +136,7 @@ func (rp *RequestPool) OnIncomingSyncRequest(req *http.Request, device *authtype
 func (rp *RequestPool) currentSyncForUser(req syncRequest, latestPos types.StreamingToken) (res *types.Response, err error) {
 	// TODO: handle ignored users
 	if req.since == nil {
-		res, err = rp.db.CompleteSync(req.ctx, req.device.UserID, req.limit)
+		res, err = rp.db.CompleteSync(req.ctx, req.device, req.limit)
 	} else {
 		res, err = rp.db.IncrementalSync(req.ctx, req.device, *req.since, latestPos, req.limit, req.wantFullState)
 	}