fix: prevent using invalid field name for type/packet/message (ignite#842)

Co-authored-by: İlker G. Öztürk <ilkergoktugozturk@gmail.com>

Author: lumtis

starport/services/scaffolder/message.go

@@ -52,11 +52,11 @@ func (s *Scaffolder) AddMessage(moduleName string, msgName string, msgDesc strin
 	}
 
 	// Parse provided fields
-	parsedMsgFields, err := parseFields(fields)
+	parsedMsgFields, err := parseFields(fields, isForbiddenMessageField)
 	if err != nil {
 		return err
 	}
-	parsedResFields, err := parseFields(resField)
+	parsedResFields, err := parseFields(resField, isGoReservedWord)
 	if err != nil {
 		return err
 	}
@@ -109,6 +109,7 @@ func (s *Scaffolder) AddMessage(moduleName string, msgName string, msgDesc strin
 	return fmtProject(pwd)
 }
 
+// isMsgCreated checks if the message is already scaffolded
 func isMsgCreated(appPath, moduleName, msgName string) (isCreated bool, err error) {
 	absPath, err := filepath.Abs(filepath.Join(
 		appPath,
@@ -129,3 +130,12 @@ func isMsgCreated(appPath, moduleName, msgName string) (isCreated bool, err erro
 
 	return true, err
 }
+
+// isForbiddenTypeField returns true if the name is forbidden as a message name
+func isForbiddenMessageField(name string) bool {
+	if name == "creator" {
+		return true
+	}
+
+	return isGoReservedWord(name)
+}

starport/services/scaffolder/packet.go

@@ -64,13 +64,13 @@ func (s *Scaffolder) AddPacket(moduleName string, packetName string, packetField
 	}
 
 	// Parse packet fields
-	parsedPacketFields, err := parseFields(packetFields)
+	parsedPacketFields, err := parseFields(packetFields, isForbiddenPacketField)
 	if err != nil {
 		return err
 	}
 
 	// Parse acknowledgment fields
-	parsedAcksFields, err := parseFields(ackFields)
+	parsedAcksFields, err := parseFields(ackFields, isGoReservedWord)
 	if err != nil {
 		return err
 	}
@@ -140,3 +140,16 @@ func isPacketCreated(appPath, moduleName, packetName string) (isCreated bool, er
 
 	return true, err
 }
+
+// isForbiddenPacketField returns true if the name is forbidden as a packet name
+func isForbiddenPacketField(name string) bool {
+	switch name {
+	case
+		"sender",
+		"port",
+		"channelID":
+		return true
+	}
+
+	return isGoReservedWord(name)
+}

starport/services/scaffolder/type.go

@@ -69,7 +69,7 @@ func (s *Scaffolder) AddType(addTypeOptions AddTypeOption, moduleName string, st
 	}
 
 	// Parse provided field
-	tFields, err := parseFields(fields)
+	tFields, err := parseFields(fields, isForbiddenTypeField)
 	if err != nil {
 		return err
 	}
@@ -131,7 +131,7 @@ func (s *Scaffolder) AddType(addTypeOptions AddTypeOption, moduleName string, st
 }
 
 // parseFields parses the provided fields, analyses the types and checks there is no duplicated field
-func parseFields(fields []string) ([]typed.Field, error) {
+func parseFields(fields []string, isForbiddenField func(string) bool) ([]typed.Field, error) {
 	// Used to check duplicated field
 	existingFields := make(map[string]bool)
 
@@ -141,7 +141,7 @@ func parseFields(fields []string) ([]typed.Field, error) {
 		name := fs[0]
 
 		// Ensure the field name is not a Go reserved name, it would generate an incorrect code
-		if isGoReservedWord(name) {
+		if isForbiddenField(name) {
 			return tFields, fmt.Errorf("%s can't be used as a field name", name)
 		}
 
@@ -222,6 +222,19 @@ func isMsgServerDefined(appPath, moduleName string) (bool, error) {
 	return true, err
 }
 
+// isForbiddenTypeField returns true if the name is forbidden as a field name
+func isForbiddenTypeField(name string) bool {
+	switch name {
+	case
+		"id",
+		"index",
+		"creator":
+		return true
+	}
+
+	return isGoReservedWord(name)
+}
+
 func isGoReservedWord(name string) bool {
 	// Check keyword or literal
 	if token.Lookup(name).IsKeyword() {