From 3fc49bd4ea405cfe49628d67a6afeae227efaa13 Mon Sep 17 00:00:00 2001
From: Kegan Dougal <7190048+kegsay@users.noreply.github.com>
Date: Mon, 20 May 2024 08:37:09 +0100
Subject: [PATCH] Migration review comments

---
 .../20240517104423_device_list_table.go       |  6 +-
 .../20240517104423_device_list_table_test.go  | 85 +++++++++++++++++++
 2 files changed, 89 insertions(+), 2 deletions(-)

diff --git a/state/migrations/20240517104423_device_list_table.go b/state/migrations/20240517104423_device_list_table.go
index 5e6d771..315b79c 100644
--- a/state/migrations/20240517104423_device_list_table.go
+++ b/state/migrations/20240517104423_device_list_table.go
@@ -168,8 +168,10 @@ func upDeviceListTable(ctx context.Context, tx *sql.Tx) error {
 }
 
 func downDeviceListTable(ctx context.Context, tx *sql.Tx) error {
-	// no-op: we'll drop the device list updates but still work correctly as new/sent are still in the cbor but are empty
-	return nil
+	// no-op: we'll drop the device list updates but still work correctly as new/sent are still in the cbor but are empty.
+	// This will lose some device list updates.
+	_, err := tx.Exec(`DROP TABLE IF EXISTS syncv3_device_list_updates`)
+	return err
 }
 
 func deserialiseCBOR(data []byte) (*OldDeviceData, error) {
diff --git a/state/migrations/20240517104423_device_list_table_test.go b/state/migrations/20240517104423_device_list_table_test.go
index a9d53dd..88571cf 100644
--- a/state/migrations/20240517104423_device_list_table_test.go
+++ b/state/migrations/20240517104423_device_list_table_test.go
@@ -2,9 +2,12 @@ package migrations
 
 import (
 	"context"
+	"reflect"
 	"testing"
 
 	"github.com/fxamacker/cbor/v2"
+	"github.com/matrix-org/sliding-sync/internal"
+	"github.com/matrix-org/sliding-sync/state"
 )
 
 func TestDeviceListTableMigration(t *testing.T) {
@@ -71,4 +74,86 @@ func TestDeviceListTableMigration(t *testing.T) {
 	}
 	tx.Commit()
 
+	wantSents := []internal.DeviceData{
+		{
+			UserID:   "@alice:localhost",
+			DeviceID: "ALICE",
+			DeviceKeyData: internal.DeviceKeyData{
+				OTKCounts: internal.MapStringInt{
+					"bar": 42,
+				},
+				FallbackKeyTypes: []string{"narp"},
+				ChangedBits:      2,
+			},
+		},
+		{
+			UserID:   "@bob:localhost",
+			DeviceID: "BOB",
+			DeviceListChanges: internal.DeviceListChanges{
+				DeviceListChanged: []string{"@sent:localhost"},
+			},
+			DeviceKeyData: internal.DeviceKeyData{
+				OTKCounts: internal.MapStringInt{
+					"foo": 100,
+				},
+				FallbackKeyTypes: []string{"yep"},
+			},
+		},
+	}
+
+	table := state.NewDeviceDataTable(db)
+	for _, wantSent := range wantSents {
+		gotSent, err := table.Select(wantSent.UserID, wantSent.DeviceID, false)
+		if err != nil {
+			t.Fatal(err)
+		}
+		assertVal(t, "'sent' data was corrupted during the migration", *gotSent, wantSent)
+	}
+
+	wantNews := []internal.DeviceData{
+		{
+			UserID:   "@alice:localhost",
+			DeviceID: "ALICE",
+			DeviceListChanges: internal.DeviceListChanges{
+				DeviceListLeft: []string{"@bob:localhost"},
+			},
+			DeviceKeyData: internal.DeviceKeyData{
+				OTKCounts: internal.MapStringInt{
+					"bar": 42,
+				},
+				FallbackKeyTypes: []string{"narp"},
+				ChangedBits:      2,
+			},
+		},
+		{
+			UserID:   "@bob:localhost",
+			DeviceID: "BOB",
+			DeviceListChanges: internal.DeviceListChanges{
+				DeviceListChanged: []string{"@💣:localhost"},
+				DeviceListLeft:    []string{"@bomb:localhost"},
+			},
+			DeviceKeyData: internal.DeviceKeyData{
+				OTKCounts: internal.MapStringInt{
+					"foo": 100,
+				},
+				FallbackKeyTypes: []string{"yep"},
+			},
+		},
+	}
+
+	for _, wantNew := range wantNews {
+		gotNew, err := table.Select(wantNew.UserID, wantNew.DeviceID, true)
+		if err != nil {
+			t.Fatal(err)
+		}
+		assertVal(t, "'new' data was corrupted during the migration", *gotNew, wantNew)
+	}
+
+}
+
+func assertVal(t *testing.T, msg string, got, want interface{}) {
+	t.Helper()
+	if !reflect.DeepEqual(got, want) {
+		t.Errorf("%s: got\n%#v\nwant\n%#v", msg, got, want)
+	}
 }