genqlient/generate/names_test.go

package generate

import (
	"testing"

	"github.com/vektah/gqlparser/v2/ast"
)

func fakeField(containingTypeName, fieldName string) *ast.Field {
	// (just the fields we need, probably not usable outside this file)
	return &ast.Field{
		Alias:            fieldName,
		ObjectDefinition: &ast.Definition{Name: containingTypeName},
	}
}

func TestTypeNames(t *testing.T) {
	tests := []struct {
		expectedTypeName string
		fields           []*ast.Field
		leafTypeName     string
	}{{
		"OperationFieldType",
		[]*ast.Field{fakeField("Query", "field")},
		"Type",
	}, {
		"OperationUser",
		[]*ast.Field{fakeField("Query", "user")},
		"User",
	}, {
		// We don't shorten field-names.
		"OperationOperationUser",
		[]*ast.Field{fakeField("Query", "operationUser")},
		"User",
	}, {
		// We do shorten across multiple prefixes.
		"OperationUser",
		[]*ast.Field{fakeField("Query", "user")},
		"OperationUser",
	}, {
		"OperationFavoriteUser",
		[]*ast.Field{fakeField("Query", "favoriteUser")},
		"User",
	}, {
		"OperationField1Type1Field2Type2",
		[]*ast.Field{fakeField("Query", "field1"), fakeField("Type1", "field2")},
		"Type2",
	}, {
		"OperationUpperFieldLowerType",
		// This is legal GraphQL!
		[]*ast.Field{fakeField("Query", "UpperField")},
		"lowerType",
	}, {
		"OperationUpperLowerUpperLower",
		[]*ast.Field{fakeField("Query", "Upper"), fakeField("lower", "Upper")},
		"lower",
	}}
	for _, test := range tests {
		test := test
		t.Run(test.expectedTypeName, func(t *testing.T) {
			prefix := newPrefixList("Operation")
			for _, field := range test.fields {
				prefix = nextPrefix(prefix, field)
			}
			actualTypeName := makeTypeName(prefix, test.leafTypeName)
			if actualTypeName != test.expectedTypeName {
				t.Errorf("name mismatch:\ngot:  %s\nwant: %s",
					actualTypeName, test.expectedTypeName)
			}
		})
	}
}

func TestTypeNameCollisions(t *testing.T) {
	tests := []struct {
		fields       []*ast.Field
		leafTypeName string
	}{
		{[]*ast.Field{fakeField("Query", "user")}, "UserInterface"},
		{[]*ast.Field{fakeField("Query", "user")}, "User"},
		{[]*ast.Field{fakeField("Query", "user")}, "QueryUser"},
		{[]*ast.Field{fakeField("Query", "queryUser")}, "User"},
		// Known issues, described in names.go file-documentation:
		// Interface/implementation collision:
		// 	{[]*ast.Field{fakeField("Query", "queryUser")}, "QueryUser"},
		// Case collision:
		// 	{[]*ast.Field{fakeField("Query", "QueryUser")}, "User"},
		// Overlapping-parts collision:
		//	{[]*ast.Field{fakeField("Query", "userQuery")}, "User"},
	}
	seen := map[string]int{} // name -> index of test that had it
	for i, test := range tests {
		prefix := newPrefixList("Operation")
		for _, field := range test.fields {
			prefix = nextPrefix(prefix, field)
		}
		actualTypeName := makeTypeName(prefix, test.leafTypeName)

		otherIndex, ok := seen[actualTypeName]
		if ok {
			t.Errorf("name collision:\ncase %2d: %#v\ncase %2d: %#v",
				i, test, otherIndex, tests[otherIndex])
		}
		seen[actualTypeName] = i
	}
}