datamodeldiagram.go

package datamodeldiagram

import (
	"fmt"

	"github.com/anz-bank/sysl/pkg/mermaid"
	"github.com/anz-bank/sysl/pkg/sysl"
	"github.com/anz-bank/sysl/pkg/syslwrapper"
)

// Remove goconst linter warnings
const (
	ref      = "ref"
	enum     = "enum"
	mapS     = "map"
	tuple    = "tuple"
	relation = "relation"
)

// externalLink keeps track of the dependencies between two types
type externalLink struct {
	firstType, secondType string
}

// GenerateFullDataDiagram accepts a sysl module and returns a string (and an error if any)
// The resulting string is the mermaid code for the data model for that module
func GenerateFullDataDiagram(m *sysl.Module) (string, error) {
	mapper := syslwrapper.MakeAppMapper(m)
	mapper.IndexTypes()
	mapper.ConvertTypes()
	return generateFullDataDiagramHelper(mapper.SimpleTypes, &[]externalLink{})
}

// GenerateDataDiagramWithMapper generates the data model diagram for a specific type with a provided mapper
// The mapper should first be initialised using
// mapper := syslwrapper.MakeAppMapper(module)
// mapper.IndexTypes()
// mapper.ConvertTypes()
func GenerateDataDiagramWithMapper(mapper *syslwrapper.AppMapper, appName string, typeName string,
) (string, error) {
	return generateDataDiagramWithAppAndTypeHelper(mapper.SimpleTypes, appName, typeName,
		&[]externalLink{}, &[]string{}, &[]externalLink{})
}

// GenerateDataDiagramWithAppAndType generates the data model for a specific type
func GenerateDataDiagramWithAppAndType(m *sysl.Module, appName string, typeName string) (string, error) {
	mapper := syslwrapper.MakeAppMapper(m)
	mapper.IndexTypes()
	mapper.ConvertTypes()
	return generateDataDiagramWithAppAndTypeHelper(mapper.SimpleTypes, appName, typeName,
		&[]externalLink{}, &[]string{}, &[]externalLink{})
}

func GeneratePrimitive(typeName string) string {
	appName := "primitive"
	mermaidString := "%% AUTOGENERATED CODE -- DO NOT EDIT!\n\n"
	mermaidString += fmt.Sprintf("classDiagram\n class %s{\n  var %s\n }", appName, typeName)
	return mermaidString
}

// generateDataDiagramWithAppAndTypeHelper is a helper which has additional arguments
func generateDataDiagramWithAppAndTypeHelper(simpleTypes map[string]*syslwrapper.Type, appName string,
	typeName string, externalLinks *[]externalLink, appTypes *[]string, eLinks *[]externalLink) (string, error) {
	var result string
	appType1 := fmt.Sprintf("%s:%s", appName, typeName)
	result = mermaid.GeneratedHeader + "classDiagram\n"
	for appType, value := range simpleTypes {
		switch value.Type {
		case relation, tuple:
			printProperties(value.Properties, appType, externalLinks)
		case enum:
			printEnum(value.Enum)
		case mapS:
			printMap(value.Properties, appType, value.PrimaryKey, externalLinks)
		default:
			result += ""
		}
	}
	getRelatedTypes(appType1, *externalLinks, appTypes, eLinks)
	for _, appType := range *appTypes {
		if typeValue := simpleTypes[appType]; typeValue != nil {
			result += fmt.Sprintf(" class %s {\n", mermaid.CleanString(appType))
			switch typeValue.Type {
			case relation, tuple:
				result += printProperties(typeValue.Properties, appType, externalLinks)
			case enum:
				result += printEnum(typeValue.Enum)
			case mapS:
				result += printMap(typeValue.Properties, appType, typeValue.PrimaryKey, externalLinks)
			default:
				result += ""
			}
			result += " }\n"
		}
	}
	for _, eLink := range *eLinks {
		result += fmt.Sprintf(" %s <-- %s\n", mermaid.CleanString(eLink.firstType),
			mermaid.CleanString(eLink.secondType))
	}
	return result, nil
}

// generateFullDataDiagramHelper is a helper which has additional arguments
func generateFullDataDiagramHelper(simpleTypes map[string]*syslwrapper.Type,
	externalLinks *[]externalLink) (string, error) {
	var result string
	result = mermaid.GeneratedHeader + "classDiagram\n"
	for appType, value := range simpleTypes {
		result += fmt.Sprintf(" class %s {\n", mermaid.CleanString(appType))
		switch value.Type {
		case relation, tuple:
			result += printProperties(value.Properties, appType, externalLinks)
		case enum:
			result += printEnum(value.Enum)
		case mapS:
			result += printMap(value.Properties, appType, value.PrimaryKey, externalLinks)
		default:
			result += ""
		}
		result += " }\n"
	}
	for _, eLink := range *externalLinks {
		result += fmt.Sprintf(" %s <-- %s\n", mermaid.CleanString(eLink.firstType),
			mermaid.CleanString(eLink.secondType))
	}
	return result, nil
}

// printProperties prints appropriate mermaid code for values inside a property
func printProperties(properties map[string]*syslwrapper.Type, appType string, externalLinks *[]externalLink) string {
	var result string
	// TODO: sort elements in map for uniformity
	for typeName, value := range properties {
		switch value.Type {
		case "int", "bool", "float", "decimal", "string", "string_8", "bytes", "date", "datetime", "xml", "uuid":
			result += fmt.Sprintf("  %s %s\n", value.Type, mermaid.CleanString(typeName))
		case ref:
			pair := externalLink{appType, value.Reference}
			if !externalLinksContain(*externalLinks, pair) {
				*externalLinks = append(*externalLinks, pair)
			}
			result += fmt.Sprintf("  %s %s\n", mermaid.CleanString(value.Reference),
				mermaid.CleanString(typeName))
		case "list", "set":
			// TODO: check if list of lists is possible
			if value.Items[0].Type == ref {
				pair := externalLink{appType,
					value.Items[0].Reference}
				if !externalLinksContain(*externalLinks, pair) {
					*externalLinks = append(*externalLinks, pair)
				}
				result += fmt.Sprintf("  List<%s> %s\n", mermaid.CleanString(value.Items[0].Reference),
					mermaid.CleanString(typeName))
			} else {
				result += fmt.Sprintf("  List<%s> %s\n", mermaid.CleanString(value.Items[0].Type),
					mermaid.CleanString(typeName))
			}
		default:
			result += ""
		}
	}
	return result
}

// printMap prints appropriate mermaid code for values inside a map
func printMap(properties map[string]*syslwrapper.Type,
	appType string, primaryKey string, externalLinks *[]externalLink) string {
	var result string
	var type1, type2, name, name1, name2 string
	name = appType
	name1 = primaryKey
	// TODO: sort elements in map for uniformity
	for typeName, value := range properties {
		if typeName == primaryKey {
			type1 = value.Type
		} else {
			name2 = typeName
			type2 = value.Type
		}
		switch value.Type {
		case "int", "bool", "float", "decimal", "string", "string_8", "bytes", "date", "datetime", "xml", "uuid":
			break
		case ref:
			pair := externalLink{mermaid.CleanString(appType), mermaid.CleanString(value.Reference)}
			if !externalLinksContain(*externalLinks, pair) {
				*externalLinks = append(*externalLinks, pair)
			}
		case "list", "set":
			// TODO: check if list of lists is possible
			if value.Items[0].Type == ref {
				pair := externalLink{mermaid.CleanString(appType),
					mermaid.CleanString(value.Items[0].Reference)}
				if !externalLinksContain(*externalLinks, pair) {
					*externalLinks = append(*externalLinks, pair)
				}
			}
		default:
			result += ""
		}
	}
	result += fmt.Sprintf("  Map<%s, %s> %s<%s, %s>\n", type1, type2, name, name1, name2)
	return result
}

// printEnum prints appropriate mermaid code for values inside an enum
func printEnum(enum map[int64]string) string {
	var result string
	// TODO: sort keys in map for uniformity
	for key, value := range enum {
		result += fmt.Sprintf("  %s %d\n", value, key)
	}
	return result
}

// getRelatedTypes finds all the types that are referred in a type
func getRelatedTypes(appType string, externalLinks []externalLink, appTypes *[]string, elinks *[]externalLink) {
	if !appTypesContain(*appTypes, appType) {
		*appTypes = append(*appTypes, appType)
	} else {
		return
	}
	for _, value := range externalLinks {
		if appType == value.secondType {
			pair := externalLink{value.firstType, value.secondType}
			if !externalLinksContain(*elinks, pair) {
				*elinks = append(*elinks, pair)
			}
			getRelatedTypes(value.firstType, externalLinks, appTypes, elinks)
		}
	}
}

// externalLinksContain checks if a connection between two data types exists or not
func externalLinksContain(f []externalLink, s externalLink) bool {
	for _, a := range f {
		if a == s {
			return true
		}
	}
	return false
}

// appTypesContain checks if an app is already present in the visited apps
func appTypesContain(f []string, s string) bool {
	for _, a := range f {
		if a == s {
			return true
		}
	}
	return false
}