chore(dp): Make relation property level instead of table level (#12518)

This allows making multiple relations to the same table. Signed-off-by: Kuba Marciniszyn <kuba@freedomfi.com>
magma · Apr 21, 2022 · 6978196 · 6978196
1 parent a0167de
commit 6978196
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 63 deletions.
diff --git a/dp/cloud/go/services/dp/storage/db/fields.go b/dp/cloud/go/services/dp/storage/db/fields.go
@@ -22,4 +22,5 @@ type Field struct {
 	HasDefault   bool
 	DefaultValue interface{}
 	Unique       bool
+	Relation     string
 }
diff --git a/dp/cloud/go/services/dp/storage/db/models.go b/dp/cloud/go/services/dp/storage/db/models.go
@@ -20,7 +20,6 @@ type Model interface {
 
 type ModelMetadata struct {
 	Table        string
-	Relations    map[string]string
 	Properties   []*Field
 	CreateObject func() Model
 }
diff --git a/dp/cloud/go/services/dp/storage/db/query_test.go b/dp/cloud/go/services/dp/storage/db/query_test.go
@@ -558,7 +558,6 @@ func (s *someModel) GetMetadata() *db.ModelMetadata {
 				SqlType: sqorc.ColumnTypeDatetime,
 			},
 		},
-		Relations: nil,
 		CreateObject: func() db.Model {
 			return &someModel{}
 		},
@@ -607,6 +606,7 @@ func (o *otherModel) GetMetadata() *db.ModelMetadata {
 				Name:     "some_id",
 				SqlType:  sqorc.ColumnTypeInt,
 				Nullable: true,
+				Relation: someTable,
 			},
 			{
 				Name:     "value",
@@ -629,7 +629,6 @@ func (o *otherModel) GetMetadata() *db.ModelMetadata {
 				Nullable: true,
 			},
 		},
-		Relations: makeRelationsMap(someTable),
 		CreateObject: func() db.Model {
 			return &otherModel{}
 		},
@@ -673,6 +672,7 @@ func (a *anotherModel) GetMetadata() *db.ModelMetadata {
 				Name:     "other_id",
 				SqlType:  sqorc.ColumnTypeInt,
 				Nullable: true,
+				Relation: otherTable,
 			},
 			{
 				Name:         "default_value",
@@ -681,7 +681,6 @@ func (a *anotherModel) GetMetadata() *db.ModelMetadata {
 				DefaultValue: defaultValue,
 			},
 		},
-		Relations: makeRelationsMap(otherTable),
 		CreateObject: func() db.Model {
 			return &anotherModel{}
 		},
@@ -742,7 +741,3 @@ func (m *modelWithUniqueFields) Fields() []db.BaseType {
 		db.IntType{X: &m.anotherUniqueFied},
 	}
 }
-
-func makeRelationsMap(table string) map[string]string {
-	return map[string]string{table: table + "_id"}
-}
diff --git a/dp/cloud/go/services/dp/storage/db/table.go b/dp/cloud/go/services/dp/storage/db/table.go
@@ -26,7 +26,6 @@ func CreateTable(tx sq.BaseRunner, builder sqorc.StatementBuilder, metadata *Mod
 		PrimaryKey("id")
 	fields := metadata.Properties
 	tableBuilder = addColumns(tableBuilder, fields)
-	tableBuilder = addRelations(tableBuilder, metadata)
 	_, err := tableBuilder.Exec()
 	return err
 }
@@ -47,17 +46,13 @@ func addColumns(builder sqorc.CreateTableBuilder, fields []*Field) sqorc.CreateT
 		if field.Unique {
 			builder = builder.Unique(field.Name)
 		}
-	}
-	return builder
-}
-
-func addRelations(builder sqorc.CreateTableBuilder, metadata *ModelMetadata) sqorc.CreateTableBuilder {
-	for table, column := range metadata.Relations {
-		builder = builder.ForeignKey(
-			table,
-			map[string]string{column: "id"},
-			sqorc.ColumnOnDeleteCascade,
-		)
+		if field.Relation != "" {
+			builder = builder.ForeignKey(
+				field.Relation,
+				map[string]string{field.Name: "id"},
+				sqorc.ColumnOnDeleteCascade,
+			)
+		}
 	}
 	return builder
 }
diff --git a/dp/cloud/go/services/dp/storage/models.go b/dp/cloud/go/services/dp/storage/models.go
@@ -58,7 +58,6 @@ func (gs *DBGrantState) GetMetadata() *db.ModelMetadata {
 				SqlType: sqorc.ColumnTypeText,
 			},
 		},
-		Relations: map[string]string{},
 		CreateObject: func() db.Model {
 			return &DBGrantState{}
 		},
@@ -112,13 +111,15 @@ func (g *DBGrant) GetMetadata() *db.ModelMetadata {
 				SqlType: sqorc.ColumnTypeInt,
 			},
 			{
-				Name:    "state_id",
-				SqlType: sqorc.ColumnTypeInt,
+				Name:     "state_id",
+				SqlType:  sqorc.ColumnTypeInt,
+				Relation: GrantStateTable,
 			},
 			{
 				Name:     "cbsd_id",
 				SqlType:  sqorc.ColumnTypeInt,
 				Nullable: true,
+				Relation: CbsdTable,
 			},
 			{
 				Name:    "grant_id",
@@ -157,10 +158,6 @@ func (g *DBGrant) GetMetadata() *db.ModelMetadata {
 				SqlType: sqorc.ColumnTypeReal,
 			},
 		},
-		Relations: map[string]string{
-			GrantStateTable: "state_id",
-			CbsdTable:       "cbsd_id",
-		},
 		CreateObject: func() db.Model {
 			return &DBGrant{}
 		},
@@ -192,7 +189,6 @@ func (cs *DBCbsdState) GetMetadata() *db.ModelMetadata {
 				SqlType: sqorc.ColumnTypeText,
 			},
 		},
-		Relations: map[string]string{},
 		CreateObject: func() db.Model {
 			return &DBCbsdState{}
 		},
@@ -262,8 +258,9 @@ func (c *DBCbsd) GetMetadata() *db.ModelMetadata {
 				SqlType: sqorc.ColumnTypeText,
 			},
 			{
-				Name:    "state_id",
-				SqlType: sqorc.ColumnTypeInt,
+				Name:     "state_id",
+				SqlType:  sqorc.ColumnTypeInt,
+				Relation: CbsdStateTable,
 			},
 			{
 				Name:     "cbsd_id",
@@ -338,9 +335,6 @@ func (c *DBCbsd) GetMetadata() *db.ModelMetadata {
 				DefaultValue: false,
 			},
 		},
-		Relations: map[string]string{
-			CbsdStateTable: "state_id",
-		},
 		CreateObject: func() db.Model {
 			return &DBCbsd{}
 		},
@@ -370,18 +364,16 @@ func (amc *DBActiveModeConfig) GetMetadata() *db.ModelMetadata {
 				SqlType: sqorc.ColumnTypeInt,
 			},
 			{
-				Name:    "cbsd_id",
-				SqlType: sqorc.ColumnTypeInt,
+				Name:     "cbsd_id",
+				SqlType:  sqorc.ColumnTypeInt,
+				Relation: CbsdTable,
 			},
 			{
-				Name:    "desired_state_id",
-				SqlType: sqorc.ColumnTypeInt,
+				Name:     "desired_state_id",
+				SqlType:  sqorc.ColumnTypeInt,
+				Relation: CbsdStateTable,
 			},
 		},
-		Relations: map[string]string{
-			CbsdTable:      "cbsd_id",
-			CbsdStateTable: "desired_state_id",
-		},
 		CreateObject: func() db.Model {
 			return &DBActiveModeConfig{}
 		},

diff --git a/dp/cloud/go/services/dp/storage/models_test.go b/dp/cloud/go/services/dp/storage/models_test.go
@@ -128,7 +128,6 @@ func TestGetMetadata(t *testing.T) {
 						SqlType: sqorc.ColumnTypeText,
 					},
 				},
-				Relations: map[string]string{},
 			},
 		},
 		{
@@ -142,13 +141,15 @@ func TestGetMetadata(t *testing.T) {
 						SqlType: sqorc.ColumnTypeInt,
 					},
 					{
-						Name:    "state_id",
-						SqlType: sqorc.ColumnTypeInt,
+						Name:     "state_id",
+						SqlType:  sqorc.ColumnTypeInt,
+						Relation: storage.GrantStateTable,
 					},
 					{
 						Name:     "cbsd_id",
 						SqlType:  sqorc.ColumnTypeInt,
 						Nullable: true,
+						Relation: storage.CbsdTable,
 					},
 					{
 						Name:    "grant_id",
@@ -187,10 +188,6 @@ func TestGetMetadata(t *testing.T) {
 						SqlType: sqorc.ColumnTypeReal,
 					},
 				},
-				Relations: map[string]string{
-					storage.CbsdTable:       "cbsd_id",
-					storage.GrantStateTable: "state_id",
-				},
 			},
 		},
 		{
@@ -208,7 +205,6 @@ func TestGetMetadata(t *testing.T) {
 						SqlType: sqorc.ColumnTypeText,
 					},
 				},
-				Relations: map[string]string{},
 			},
 		},
 		{
@@ -226,8 +222,9 @@ func TestGetMetadata(t *testing.T) {
 						SqlType: sqorc.ColumnTypeText,
 					},
 					{
-						Name:    "state_id",
-						SqlType: sqorc.ColumnTypeInt,
+						Name:     "state_id",
+						SqlType:  sqorc.ColumnTypeInt,
+						Relation: storage.CbsdStateTable,
 					},
 					{
 						Name:     "cbsd_id",
@@ -302,9 +299,6 @@ func TestGetMetadata(t *testing.T) {
 						DefaultValue: false,
 					},
 				},
-				Relations: map[string]string{
-					storage.CbsdStateTable: "state_id",
-				},
 			},
 		},
 		{
@@ -318,18 +312,16 @@ func TestGetMetadata(t *testing.T) {
 						SqlType: sqorc.ColumnTypeInt,
 					},
 					{
-						Name:    "cbsd_id",
-						SqlType: sqorc.ColumnTypeInt,
+						Name:     "cbsd_id",
+						SqlType:  sqorc.ColumnTypeInt,
+						Relation: storage.CbsdTable,
 					},
 					{
-						Name:    "desired_state_id",
-						SqlType: sqorc.ColumnTypeInt,
+						Name:     "desired_state_id",
+						SqlType:  sqorc.ColumnTypeInt,
+						Relation: storage.CbsdStateTable,
 					},
 				},
-				Relations: map[string]string{
-					storage.CbsdTable:      "cbsd_id",
-					storage.CbsdStateTable: "desired_state_id",
-				},
 			},
 		},
 	}
@@ -338,7 +330,6 @@ func TestGetMetadata(t *testing.T) {
 			actual := tc.model.GetMetadata()
 			obj := actual.CreateObject()
 
-			assert.Equal(t, tc.expected.Relations, actual.Relations)
 			assert.Equal(t, tc.expected.Properties, actual.Properties)
 			assert.Equal(t, tc.expected.Table, actual.Table)
 			assert.Equal(t, tc.model, obj)