Merge pull request #3 from ConsultingMD/gr-gqlentity-servicename

[CARESERV-928] Renaming Entity in gqlgen to avoid type name conflict

README.md

@@ -1,3 +1,27 @@
+# Grand Rounds Fork of gqlgen
+
+This fork was created by:
+
+1. Forking the repository
+1. Resetting master of the fork to the tagged commit of the last stable release
+   of gqlgen. At the time of writing this, it's tag v0.13.0 and commit 07c1f93.
+1. Pushing -f to reset master of this fork the above commit.
+1. Creating a branch in this repo and applying the desired patch.
+1. Runing `go generate ./...` in the root of this repository.
+1. Opening a pull request of the patch we've applied, to this fork
+1. Testing the forked code in the downstream repo (bobs) using `replace` in
+   `go.mod`.
+1. Merging the patch into the master branch of this fork.
+1. Updating downstream consumers to use the master branch of this fork using
+   `replace` in `go.mod`
+
+Note that means the master branch of this fork diverges from the official
+repository. To update this fork to the latest version of gqlgen:
+
+1. Merge the latest version tagged commit of upstream into master of this fork.
+   **Don't** merge in the master branch of the main repository, just the commit
+   of the next tagged version.
+
 # gqlgen [![Continuous Integration](https://github.com/99designs/gqlgen/workflows/Continuous%20Integration/badge.svg)](https://github.com/99designs/gqlgen/actions) [![Read the Docs](https://badgen.net/badge/docs/available/green)](http://gqlgen.com/) [![GoDoc](https://godoc.org/github.com/99designs/gqlgen?status.svg)](https://godoc.org/github.com/99designs/gqlgen)
 
 ![gqlgen](https://user-images.githubusercontent.com/46195831/89802919-0bb8ef00-db2a-11ea-8ba4-88e7a58b2fd2.png)
@@ -85,6 +109,25 @@ func (r *userResolver) Friends(ctx context.Context, obj *User) ([]*User, error)
 }
 ```
 
+You can also use inline config with directives to achieve the same result
+
+```graphql
+directive @goModel(model: String, models: [String!]) on OBJECT
+    | INPUT_OBJECT
+    | SCALAR
+    | ENUM
+    | INTERFACE
+    | UNION
+
+directive @goField(forceResolver: Boolean, name: String) on INPUT_FIELD_DEFINITION
+    | FIELD_DEFINITION
+
+type User @goModel(model: "github.com/you/pkg/model.User") {
+    id: ID!         @goField(name: "todoId")
+    friends: [User!]!   @goField(forceResolver: true)
+}
+```
+
 ### Can I change the type of the ID from type String to Type Int?
 
 Yes! You can by remapping it in config as seen below:

codegen/templates/templates.go

@@ -282,10 +282,25 @@ func Call(p *types.Func) string {
 	return pkg + p.Name()
 }
 
+// Federated graphs have the types _Entity and _Service. With default Go struct
+// name generation, those become `Service`, which can conflict with users
+// of this library who have their own `type Service`. Special case handle the
+// federated entity names
+var internalNames = map[string]string{
+	"_Entity":  "GqlgenEntity",
+	"_Service": "GqlgenService",
+}
+
 func ToGo(name string) string {
 	if name == "_" {
 		return "_"
 	}
+
+	internalName, hasInternalName := internalNames[name]
+	if hasInternalName {
+		return internalName
+	}
+
 	runes := make([]rune, 0, len(name))
 
 	wordWalker(name, func(info *wordInfo) {

codegen/templates/templates_test.go

@@ -38,6 +38,11 @@ func TestToGo(t *testing.T) {
 	require.Equal(t, "RelatedUrls", ToGo("RelatedUrls"))
 	require.Equal(t, "ITicket", ToGo("ITicket"))
 	require.Equal(t, "FooTicket", ToGo("fooTicket"))
+
+	require.Equal(t, "GqlgenEntity", ToGo("_Entity"))
+	require.Equal(t, "GqlgenService", ToGo("_Service"))
+	require.Equal(t, "Entity", ToGo("Entity"))
+	require.Equal(t, "Service", ToGo("Service"))
 }
 
 func TestToGoPrivate(t *testing.T) {