sliding-sync/state/migrations/20230802121023_device_data_jsonb_test.go

package migrations

import (
	"context"
	"encoding/json"
	"testing"

	"github.com/jmoiron/sqlx"
	_ "github.com/lib/pq"
	"github.com/matrix-org/sliding-sync/testutils"
)

var postgresConnectionString = "user=xxxxx dbname=syncv3_test sslmode=disable"

func connectToDB(t *testing.T) (*sqlx.DB, func()) {
	postgresConnectionString = testutils.PrepareDBConnectionString()
	db, err := sqlx.Open("postgres", postgresConnectionString)
	if err != nil {
		t.Fatalf("failed to open SQL db: %s", err)
	}
	return db, func() {
		db.Close()
	}
}

func TestJSONBMigration(t *testing.T) {
	ctx := context.Background()
	db, close := connectToDB(t)
	defer close()

	// Create the table in the old format (data = BYTEA instead of JSONB)
	_, err := db.Exec(`CREATE TABLE syncv3_device_data (
		user_id TEXT NOT NULL,
		device_id TEXT NOT NULL,
		data BYTEA NOT NULL,
		UNIQUE(user_id, device_id)
	);`)

	if err != nil {
		t.Fatal(err)
	}

	tx, err := db.Begin()
	if err != nil {
		t.Fatal(err)
	}
	defer tx.Commit()

	// insert some "invalid" data
	dd := OldDeviceData{
		DeviceLists: OldDeviceLists{
			New:  map[string]int{"@💣:localhost": 1},
			Sent: map[string]int{},
		},
		OTKCounts:        map[string]int{},
		FallbackKeyTypes: []string{},
	}
	data, err := json.Marshal(dd)
	if err != nil {
		t.Fatal(err)
	}

	_, err = tx.ExecContext(ctx, `INSERT INTO syncv3_device_data (user_id, device_id, data) VALUES ($1, $2, $3)`, "bob", "bobDev", data)
	if err != nil {
		t.Fatal(err)
	}

	// validate that invalid data can be migrated upwards
	err = upJSONB(ctx, tx)
	if err != nil {
		t.Fatal(err)
	}

	// and downgrade again
	err = downJSONB(ctx, tx)
	if err != nil {
		t.Fatal(err)
	}
}