Merge pull request #18 from dipdup-io/GO-80-refine-MakeComments-with-struct-composition

Author: vvuwei

database/comment.go

@@ -3,6 +3,7 @@ package database
 import (
 	"context"
 	"github.com/dipdup-net/go-lib/hasura"
+	"github.com/pkg/errors"
 	"reflect"
 	"strings"
 )
@@ -47,26 +48,65 @@ func MakeComments(ctx context.Context, sc SchemeCommenter, models ...interface{}
 				continue
 			}
 
-			comment, ok := getComment(fieldType)
-			if !ok || comment == "" {
+			if fieldType.Anonymous {
+				if err := makeEmbeddedComments(ctx, sc, tableName, fieldType.Type); err != nil {
+					return err
+				}
 				continue
 			}
 
-			columnName, ok := getPgName(fieldType)
-
-			if columnName == "-" {
-				continue
+			if err := makeFieldComment(ctx, sc, tableName, fieldType); err != nil {
+				return err
 			}
+		}
+	}
+	return nil
+}
 
-			if !ok {
-				columnName = hasura.ToSnakeCase(fieldType.Name)
-			}
+func makeEmbeddedComments(ctx context.Context, sc SchemeCommenter, tableName string, t reflect.Type) error {
+	for i := 0; i < t.NumField(); i++ {
+		fieldType := t.Field(i)
 
-			if err := sc.MakeColumnComment(ctx, tableName, columnName, comment); err != nil {
+		if fieldType.Anonymous {
+			if err := makeEmbeddedComments(ctx, sc, tableName, fieldType.Type); err != nil {
 				return err
 			}
+
+			continue
+		}
+
+		if fieldType.Name == "tableName" {
+			return errors.New("Embedded type must not have tableName field.")
+		}
+
+		if err := makeFieldComment(ctx, sc, tableName, fieldType); err != nil {
+			return err
 		}
 	}
+
+	return nil
+}
+
+func makeFieldComment(ctx context.Context, sc SchemeCommenter, tableName string, fieldType reflect.StructField) error {
+	comment, ok := getComment(fieldType)
+	if !ok || comment == "" {
+		return nil
+	}
+
+	columnName, ok := getPgName(fieldType)
+
+	if columnName == "-" {
+		return nil
+	}
+
+	if !ok {
+		columnName = hasura.ToSnakeCase(fieldType.Name)
+	}
+
+	if err := sc.MakeColumnComment(ctx, tableName, columnName, comment); err != nil {
+		return err
+	}
+
 	return nil
 }
 

database/comment_test.go

@@ -296,3 +296,168 @@ func TestMakeCommentsIgnoreNoModels(t *testing.T) {
 	// Assert
 	assert.Empty(t, err)
 }
+
+func TestMakeCommentsWithStructCompositionAndCorrectOrder(t *testing.T) {
+	type Operation struct {
+		CreatedAt int64  `json:"-" comment:"Date of creation in seconds since UNIX epoch."`
+		UpdatedAt int64  `json:"-" comment:"Date of last update in seconds since UNIX epoch."`
+		Network   string `json:"network" pg:",pk" comment:"Identifies belonging network."`
+	}
+
+	type Ballot struct {
+		//nolint
+		tableName struct{} `pg:"ballots" comment:"This table name comment"`
+		Operation
+		Ballot string `json:"ballot" comment:"This is field comment"`
+	}
+
+	mockCtrl, mockSC, ctx := initMocks(t)
+	defer mockCtrl.Finish()
+
+	model := Ballot{}
+
+	// Assert prepare
+	tableNameCall := mockSC.
+		EXPECT().
+		MakeTableComment(ctx, "ballots", "This table name comment").
+		Times(1).
+		Return(nil)
+
+	createdAtCall := mockSC.
+		EXPECT().
+		MakeColumnComment(ctx, "ballots", "created_at", "Date of creation in seconds since UNIX epoch.").
+		After(tableNameCall).
+		Times(1).
+		Return(nil)
+
+	updatedAtCall := mockSC.
+		EXPECT().
+		MakeColumnComment(ctx, "ballots", "updated_at", "Date of last update in seconds since UNIX epoch.").
+		After(createdAtCall).
+		Times(1).
+		Return(nil)
+
+	networkCall := mockSC.
+		EXPECT().
+		MakeColumnComment(ctx, "ballots", "network", "Identifies belonging network.").
+		After(updatedAtCall).
+		Times(1).
+		Return(nil)
+
+	mockSC.
+		EXPECT().
+		MakeColumnComment(ctx, "ballots", "ballot", "This is field comment").
+		After(networkCall).
+		Times(1).
+		Return(nil)
+
+	// Act
+	err := MakeComments(ctx, mockSC, model)
+
+	// Assert
+	assert.Empty(t, err)
+}
+
+func TestMakeCommentsWithDeepStructComposition(t *testing.T) {
+	type CreatedMetadata struct {
+		CreatedAt int64 `json:"-" comment:"Date of creation in seconds since UNIX epoch."`
+	}
+
+	type UpdatedMetadata struct {
+		CreatedMetadata
+		UpdatedAt int64 `json:"-" comment:"Date of last update in seconds since UNIX epoch."`
+	}
+
+	type Operation struct {
+		UpdatedMetadata
+		Network string `json:"network" pg:",pk" comment:"Identifies belonging network."`
+	}
+
+	type Ballot struct {
+		//nolint
+		tableName struct{} `pg:"ballots" comment:"This table name comment"`
+		Operation
+		Ballot string `json:"ballot" comment:"This is field comment"`
+	}
+
+	mockCtrl, mockSC, ctx := initMocks(t)
+	defer mockCtrl.Finish()
+
+	model := Ballot{}
+
+	// Assert prepare
+	tableNameCall := mockSC.
+		EXPECT().
+		MakeTableComment(ctx, "ballots", "This table name comment").
+		Times(1).
+		Return(nil)
+
+	createdAtCall := mockSC.
+		EXPECT().
+		MakeColumnComment(ctx, "ballots", "created_at", "Date of creation in seconds since UNIX epoch.").
+		After(tableNameCall).
+		Times(1).
+		Return(nil)
+
+	updatedAtCall := mockSC.
+		EXPECT().
+		MakeColumnComment(ctx, "ballots", "updated_at", "Date of last update in seconds since UNIX epoch.").
+		After(createdAtCall).
+		Times(1).
+		Return(nil)
+
+	networkCall := mockSC.
+		EXPECT().
+		MakeColumnComment(ctx, "ballots", "network", "Identifies belonging network.").
+		After(updatedAtCall).
+		Times(1).
+		Return(nil)
+
+	mockSC.
+		EXPECT().
+		MakeColumnComment(ctx, "ballots", "ballot", "This is field comment").
+		After(networkCall).
+		Times(1).
+		Return(nil)
+
+	// Act
+	err := MakeComments(ctx, mockSC, model)
+
+	// Assert
+	assert.Empty(t, err)
+}
+
+func TestMakeCommentsWithStructCompositionErrorOnEmbeddedTableName(t *testing.T) {
+	type Operation struct {
+		//nolint
+		tableName struct{} `pg:"operation" comment:"This embedded type tableName comment."`
+		CreatedAt int64    `json:"-" comment:"Date of creation in seconds since UNIX epoch."`
+		UpdatedAt int64    `json:"-" comment:"Date of last update in seconds since UNIX epoch."`
+		Network   string   `json:"network" pg:",pk" comment:"Identifies belonging network."`
+	}
+
+	type Ballot struct {
+		//nolint
+		tableName struct{} `pg:"ballots" comment:"This table name comment"`
+		Operation
+		Ballot string `json:"ballot" comment:"This is field comment"`
+	}
+
+	mockCtrl, mockSC, ctx := initMocks(t)
+	defer mockCtrl.Finish()
+
+	model := Ballot{}
+
+	// Assert prepare
+	mockSC.
+		EXPECT().
+		MakeTableComment(ctx, "ballots", "This table name comment").
+		Times(1).
+		Return(nil)
+
+	// Act
+	err := MakeComments(ctx, mockSC, model)
+
+	// Assert
+	assert.Error(t, err, "Embedded type must not have tableName field.")
+}