feat: many-to-one check, constrints check
This commit is contained in:
47
relationsCheck/checkManyToOne.go
Normal file
47
relationsCheck/checkManyToOne.go
Normal file
@@ -0,0 +1,47 @@
|
||||
package relationsCheck
|
||||
|
||||
import (
|
||||
"go/types"
|
||||
"golang.org/x/tools/go/analysis"
|
||||
"gormlint/common"
|
||||
"strings"
|
||||
)
|
||||
|
||||
func checkManyToOne(pass *analysis.Pass, nestedField common.Field, model common.Model, relatedModel common.Model) bool {
|
||||
foreignKey := nestedField.Tags.GetParamOr("foreignKey", model.Name+"Id")
|
||||
references := nestedField.Tags.GetParamOr("references", "Id")
|
||||
if !relatedModel.HasField(foreignKey) {
|
||||
pass.Reportf(
|
||||
nestedField.Pos,
|
||||
"Expected foreignKey `%s` in model `%s` for 1:M relation with model `%s`",
|
||||
foreignKey,
|
||||
relatedModel.Name,
|
||||
model.Name,
|
||||
)
|
||||
return true
|
||||
}
|
||||
if !model.HasField(references) {
|
||||
pass.Reportf(
|
||||
nestedField.Pos,
|
||||
"Expected references `%s` in model `%s` for 1:M relation with model `%s`",
|
||||
references,
|
||||
model.Name,
|
||||
relatedModel.Name,
|
||||
)
|
||||
return true
|
||||
}
|
||||
foreignKeyType := types.ExprString(relatedModel.Fields[foreignKey].Type)
|
||||
referencesType := types.ExprString(model.Fields[references].Type)
|
||||
if !strings.Contains(foreignKeyType, "int") {
|
||||
// TODO: process UUID as foreign key type
|
||||
pass.Reportf(relatedModel.Fields[foreignKey].Pos, "Foreign key `%s` has invalid type", foreignKeyType)
|
||||
return true
|
||||
}
|
||||
|
||||
if !strings.Contains(referencesType, "int") {
|
||||
pass.Reportf(model.Fields[references].Pos, "References key `%s` has invalid type", referencesType)
|
||||
return true
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
29
relationsCheck/constraints.go
Normal file
29
relationsCheck/constraints.go
Normal file
@@ -0,0 +1,29 @@
|
||||
package relationsCheck
|
||||
|
||||
import (
|
||||
"golang.org/x/tools/go/analysis"
|
||||
"gormlint/common"
|
||||
"strings"
|
||||
)
|
||||
|
||||
func CheckCascadeDelete(pass *analysis.Pass, field common.Field) bool {
|
||||
if !field.Tags.HasParam("constraint") {
|
||||
pass.Reportf(field.Pos, "field %s should have a constraint", field.Name)
|
||||
return true
|
||||
}
|
||||
constraintValue := field.Tags.GetParam("constraint").Value
|
||||
pair := strings.Split(constraintValue, ":")
|
||||
trigger, value := pair[0], pair[1]
|
||||
if strings.ToLower(trigger) == "OnDelete" && strings.ToUpper(value) != "CASCADE" {
|
||||
pass.Reportf(field.Pos, "field have invalid constraint on `OnDelete trigger`")
|
||||
return true
|
||||
}
|
||||
|
||||
if field.Tags.HasParam("OnDelete") {
|
||||
if strings.ToUpper(field.Tags.GetParam("OnDelete").Value) != "CASCADE" {
|
||||
pass.Reportf(field.Pos, "field have invalid constraint on `OnDelete` trigger")
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
@@ -14,35 +14,37 @@ var RelationsAnalyzer = &analysis.Analyzer{
|
||||
Run: run,
|
||||
}
|
||||
|
||||
func CheckTypesOfM2M(pass *analysis.Pass, modelName string, relatedModelName string, relationName string, reference common.Field, backReference common.Field) {
|
||||
func CheckTypesOfM2M(pass *analysis.Pass, modelName string, relatedModelName string, relationName string, reference common.Field, backReference common.Field) bool {
|
||||
if !common.IsSlice(reference.Type) {
|
||||
pass.Reportf(reference.Pos, "M2M relation `%s` with bad type `%s` (should be a slice)", relationName, reference.Type)
|
||||
return
|
||||
return true
|
||||
}
|
||||
if !common.IsSlice(backReference.Type) {
|
||||
pass.Reportf(backReference.Pos, "M2M relation `%s` with bad type `%s` (should be a slice)", relationName, backReference.Type)
|
||||
return
|
||||
return true
|
||||
}
|
||||
|
||||
referenceBaseType := common.ResolveBaseType(reference.Type)
|
||||
if referenceBaseType == nil {
|
||||
pass.Reportf(reference.Pos, "Failed to resolve field type: `%s`", reference.Type)
|
||||
return
|
||||
return true
|
||||
}
|
||||
backReferenceBaseType := common.ResolveBaseType(backReference.Type)
|
||||
if backReferenceBaseType == nil {
|
||||
pass.Reportf(reference.Pos, "Failed to resolve type: `%s`", reference.Type)
|
||||
return
|
||||
return true
|
||||
}
|
||||
|
||||
if *backReferenceBaseType != modelName {
|
||||
pass.Reportf(backReference.Pos, "Invalid type `%s` in M2M relation (use []*%s or self-reference)", *backReferenceBaseType, modelName)
|
||||
return
|
||||
return true
|
||||
}
|
||||
|
||||
if *referenceBaseType != relatedModelName {
|
||||
pass.Reportf(reference.Pos, "Invalid type `%s` in M2M relation (use []*%s or self-reference)", *referenceBaseType, relatedModelName)
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func CheckMany2Many(pass *analysis.Pass, models map[string]common.Model) {
|
||||
@@ -55,7 +57,7 @@ func CheckMany2Many(pass *analysis.Pass, models map[string]common.Model) {
|
||||
relatedModel := common.GetModelFromType(field.Type, models)
|
||||
if relatedModel == nil {
|
||||
pass.Reportf(field.Pos, "Failed to resolve related model type")
|
||||
return
|
||||
continue
|
||||
}
|
||||
|
||||
backReference := common.FindBackReferenceInM2M(m2mRelation.Value, *relatedModel)
|
||||
@@ -66,9 +68,14 @@ func CheckMany2Many(pass *analysis.Pass, models map[string]common.Model) {
|
||||
knownModels = append(knownModels, model.Name)
|
||||
knownModels = append(knownModels, relatedModel.Name)
|
||||
}
|
||||
CheckTypesOfM2M(pass, model.Name, relatedModel.Name, m2mRelation.Value, field, *backReference)
|
||||
if CheckTypesOfM2M(pass, model.Name, relatedModel.Name, m2mRelation.Value, field, *backReference) {
|
||||
continue
|
||||
}
|
||||
// TODO: check foreign key and references
|
||||
fmt.Printf("Found M2M relation between \"%s\" and \"%s\"\n", model.Name, relatedModel.Name)
|
||||
if CheckCascadeDelete(pass, field) {
|
||||
continue
|
||||
}
|
||||
} else {
|
||||
// Check self-reference
|
||||
if model.Name == relatedModel.Name {
|
||||
@@ -77,13 +84,29 @@ func CheckMany2Many(pass *analysis.Pass, models map[string]common.Model) {
|
||||
if !relatedModel.HasPrimaryKey() {
|
||||
fmt.Printf("%#v\n", relatedModel)
|
||||
pass.Reportf(field.Pos, "Can't build M2M relation `%s`, primary key on `%s` model is absont", m2mRelation.Value, relatedModel.Name)
|
||||
continue
|
||||
}
|
||||
}
|
||||
// Here you can forbid M2M relations without back-reference
|
||||
// TODO: process m2m without backref
|
||||
if CheckCascadeDelete(pass, field) {
|
||||
continue
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// TODO: check [] and process m:1
|
||||
if common.IsSlice(field.Type) {
|
||||
relatedModel := common.GetModelFromType(field.Type, models)
|
||||
if relatedModel == nil {
|
||||
pass.Reportf(field.Pos, "Failed to resolve related model type")
|
||||
continue
|
||||
}
|
||||
if checkManyToOne(pass, field, model, *relatedModel) {
|
||||
continue
|
||||
}
|
||||
if CheckCascadeDelete(pass, field) {
|
||||
continue
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user