Apollo Federation MVP #851

marwan-at-work · 2019-08-30T18:07:37Z

This PR is mostly to get some eyes on the current architecture and what can be improved/re-written.

Once that looks good, I'll move on to adding unit/e2e tests

Fixes #740

coveralls · 2019-08-30T18:08:35Z

Coverage decreased (-0.7%) to 63.145% when pulling 48dc29c on marwan-at-work:federation into f869f5a on 99designs:master.

JulienBreux

Very nice work! Here a tiny review 😊
Thanks again!

codegen/directives.gotpl

api/generate.go

go.mod

plugin/federation/federation.go

vektah

Nice work, the code looks good.

I was hoping for more feedback from people who want to use this. I don't think there are any BC breaks in here though so let's get this ready to ship and iterate.

Might be nice to enumerate the current known limitations in the PR description (eg currently only supports single field simple keys)

codegen/directives.gotpl

vektah · 2019-09-16T00:16:11Z

codegen/field.go

@@ -95,6 +95,18 @@ func (b *builder) bindField(obj *Object, f *Field) error {
 		f.GoReceiverName = "ec"
 		f.GoFieldName = "introspectType"
 		return nil
+	case f.Name == "_entities":


does this generate invalid code if the plugin is missing? perhaps this should be injected by the plugin?

It would be nice to have a mechanism that can be extended with plugins.

@vektah maybe if the user has an _entities query without federation...we can possibly check cfg.Federated && f.Name == _entities ... that said, it would be great if the plugin can inject this part, but it looks like there's no way right now...can you confirm? Thanks!

Welcome back!

I wonder if we could add something to TypeMapField in config that replaces all of this logic?

type TypeMapField struct { Resolver bool `yaml:"resolver"` FieldName string `yaml:"fieldName"` // new GeneratedMethod string `yaml:"-"` }

which would be set here to reference __resolve_entities

@vektah that's an interesting idea...I'll give it a shot 👍

Actually, TypeMapField is in MutateConfig not MutateSchema where you linked above, can you expand more on how that would work? Thanks!

Lets leave it like this for now and get this on master. Might do some cleanup once it lands to make this more pluggable.

codegen/templates/templates.go

plugin/federation/federation.go

vektah · 2019-09-16T01:08:55Z

plugin/federation/federation.go

+	for _, ent := range f.Entities {
+		union.Types = append(union.Types, ent.Name)
+		s.AddPossibleType("_Entity", ent.Def)
+		// s.AddImplements(ent.Name, union) // Do we need this?


I think this is what's causing the if ent in model gen.

https://github.com/99designs/gqlgen/pull/851/files#diff-777f78d80bba845e7f5493310d21fce6R119

@vektah does that mean I won't need to check for the key directive if I add this line?

Nevermind, I uncommented the line and it added _Entity to implementors. This seems to only be used in fragment-related things?

vektah · 2019-09-16T01:19:06Z

plugin/federation/federation.go

+
+// Entity represents a federated type
+// that was declared in the GQL schema.
+type Entity struct {


I think I would prefer if this referenced the underlying types where possible, rather than copying them just out, just in case another plugin is modifying them.

We already have Def, so Name is redundant

FieldName and FieldTypeGQL come from FieldDef, so let's add that instead?

If we apply the same logic to RequireField I think it can be replaced entirely by a codegen.Field

@vektah I did it for Def and FieldDef. However, RequireField would make setEntities create a dummy codegen.Field so I can have a Name to match against in GenerateCode, then GenerateCode will have to replace its codegen.Field with the dummy one which fields a bit ugly. Would you like me to switch that up as well?

vvakame

If Apollo federation completely separate plugin from gqlgen core code, It's greatful works!
so, plugin system is still developing. this work is very good as a space explorer, I think.

Please tell me anything I can do. 😉

vvakame · 2019-10-08T08:13:37Z

codegen/field.go

@@ -95,6 +95,18 @@ func (b *builder) bindField(obj *Object, f *Field) error {
 		f.GoReceiverName = "ec"
 		f.GoFieldName = "introspectType"
 		return nil
+	case f.Name == "_entities":


It would be nice to have a mechanism that can be extended with plugins.

plugin/federation/federation.go

benjaminjkraft · 2019-10-11T00:00:29Z

I was hoping for more feedback from people who want to use this.

There are some other users over in #740, but for us (Khan Academy) I can say we're already using this and are very happy to see it merged!

cliedeman · 2019-10-14T19:14:30Z

Interested in SchemaMutator to implement a relay plugin

nurdism · 2019-10-14T20:44:42Z

couple issues I've found while messing with this

~~there should be a way to define~~

service:
  filename: "..."
  package: "..."

~~in the gqlgen.yml (there is a PR for this on your fork)~~

When generating service.go, you use _Entity interface (which goes in the generated models package), in my setup models are generated on a models package (from gqlgen.yml) , the _Entity interface should be declared in the service.go package (or use a different name). Underscore values are not exported and will cause errors when the packages differ.

~~When using custom scalars as the key in the @key directive, it should import the package and use the type when casting it~~
IE

id, ok := rep["id"].(my.pkg/custom/scalar.type)

to

import "my.pkg/custom/scalar"
...
id, ok := rep["id"].(scalar.type)

~~In my case this is causing validation errors.~~

(edit: thinking about it, would it make sense for service.go to be part of exec package? Wondering why it was decided to be a separate file, it would solve the first 3 issues I've run into)

should be a way for users to define the federation spec (for external validations or the schema files) and fill in the blanks (of it is not provided)

lastly, more of a nit pick, but the errors for failed type casting on __resolve_entities func in service.go should be more declarative (ie "Failed casting id to scalar.type", rather than it saying "opsies")

Other than that, working pretty well for me. Still doing some testing. I'll report back if I find anything else. Keep up the good work 👍

sothychan · 2019-11-07T01:40:54Z

This is great. I'm going to try using this now and will provide feedback if any.

sothychan · 2019-11-12T14:58:16Z

@marwan-at-work @vektah I have a PR that pulls in the latest gqlgen into @marwan-at-work 's federation branch and fixed the merge conflicts. Here it is: marwan-at-work#3

marwan-at-work · 2019-11-12T15:44:17Z

@sothychan that's great thank you 🙏 -- i've been incredibly busy the last couple of months (switched companies), but will get back to this ASAP.

sothychan · 2019-11-12T23:17:10Z

@marwan-at-work I'm running into a weird issue saying "_Entity not found in typemap" when I bind models. I'm going to look into why and submit a PR.

vvakame · 2019-11-19T10:03:18Z

hi, I tried to implement https://github.com/apollographql/federation-demo by gqlgen with this PR.
It's works fine! 👏

I can make public my repository but federation-demo repository's license is unclear.
I opened apollographql/federation-demo#12 . please wait.

josemarluedke · 2019-12-04T02:50:29Z

@marwan-at-work @vektah

Any new development in this area? We are starting to look for a service-oriented graphql, and the federation would be perfect for that. Any changes to get this moving?

StevenACoffman · 2019-12-05T21:42:52Z

@nurdism We implemented the filename specifier here

marwan-at-work · 2019-12-05T21:54:14Z

Now that I'm fully onboarded with my new job...I'm very happy to come back to this, I've cleared my Sunday for this PR 👍

Hopefully I can wrap it up within that day but I did notice there are some merge conflicts also when I generate tests a lot of them do fail...although federation itself works okay 😄

marwan-at-work · 2019-12-07T18:49:00Z

@vektah all of the comments are addressed except:

field.go (would love to know more about how we can fix that)
making the build/tests pass as I'm not familiar with the codebase enough to know why they're failing :)

marwan-at-work · 2019-12-08T21:30:19Z

@vektah I managed to get the builds to pass but federation tests are still super preliminary.

This leaves the field.go which I'd need some guidance as to how to inject into it from the plugin or I can a TODO comment for a follow up PR if that's something that requires more figuring out.

Thanks

jepp2078 · 2020-01-06T07:14:12Z

Quick question @marwan-at-work. Won't the name _Entity in the generated model give problems for people that use packages for their models, since _Entity isn't exported?

vektah · 2020-01-07T05:05:58Z

I've merged the gqlparser pr and tagged a new release. Lets update the this and get it 🚢'd.

This leaves the field.go which I'd need some guidance as to how to inject into it from the plugin or I can a TODO comment for a follow up PR if that's something that requires more figuring out.

Lets ship this as is and iterate on master.

marwan-at-work · 2020-01-07T05:46:49Z

@vektah sounds great, I updated the go.mod file ✌️

@jepp2078 that's a valid point, although I'm not sure in which use case you'd need to programmatically import the _Entity interface. That said, I imagine it would be possible to let the user customize those names just like any other model.

vektah · 2020-01-07T05:50:01Z

I think the mod file still needs a version bump to 1.2.1
d2a13d3#diff-37aff102a57d3d7b797f152915a6dc16L25

marwan-at-work · 2020-01-07T06:12:32Z

@vektah done

jepp2078 · 2020-01-07T06:25:46Z

@jepp2078 that's a valid point, although I'm not sure in which use case you'd need to programmatically import the _Entity interface. That said, I imagine it would be possible to let the user customize those names just like any other model.

@marwan-at-work I'm pretty sure it would break as soon as you set the package for exec and model to two different values, since generated.go and service.go needs to use _Entity.

marwan-at-work · 2020-01-07T20:37:51Z

@jepp2078 now that this is merged, it would be incredibly helpful to open an issue with reproduction steps of how it would break. I can dig into it afterwards, thanks!

gqlgen - one of the most popular graphql Go lib - just recently added support for federation. PR to the lib was merged to master Jan 7 - 99designs/gqlgen#851 The lib doesn't have documentation for the feature yet, but it's fully working, as I am already using it in one of the projects.

nitin302 · 2020-02-06T07:20:11Z

hi, I tried to implement https://github.com/apollographql/federation-demo by gqlgen with this PR.
It's works fine! 👏

I can make public my repository but federation-demo repository's license is unclear.
I opened apollographql/federation-demo#12 . please wait.

@vvakame @marwan-at-work @vektah can you point to this project where there is an working example?

vvakame · 2020-02-06T09:59:54Z

I cant make public it. I cant get response from Apollo org members yet...
We need write full-scratched example

marwan-at-work · 2020-02-06T15:25:33Z

I haven't updated this repo in a while, but I also Go'fied the federation-demo repo when I was implementing the spec in gqlgen: https://github.com/marwan-at-work/federation-demo

nitin302 · 2020-02-06T17:02:35Z

I cant make public it. I cant get response from Apollo org members yet...
We need write full-scratched example

@vvakame license is now added.

vvakame · 2020-02-07T05:48:18Z

wow, thanks!
I made public about https://github.com/vvakame/gqlgen-apollo-federation-demo

Apollo Federation MVP

JulienBreux suggested changes Sep 2, 2019

View reviewed changes

vektah reviewed Sep 16, 2019

View reviewed changes

vektah mentioned this pull request Oct 1, 2019

Schema federation #886

Closed

vvakame reviewed Oct 8, 2019

View reviewed changes

cliedeman mentioned this pull request Oct 26, 2019

(Relay) connection codegen #752

Closed

Apollo Federation MVP

368d546

marwan-at-work force-pushed the federation branch from 8fb9130 to 368d546 Compare December 7, 2019 18:46

marwan-at-work added 7 commits December 8, 2019 11:34

go generate + remove directives nil check

555a954

go generate

aae7486

fix integration

2345936

add preliminary tests

c9d6d94

add preliminary test_data

7f64842

remove debug comments

0985a78

force rebuild

db49956

vvakame requested a review from vektah December 19, 2019 05:52

vvakame approved these changes Dec 19, 2019

View reviewed changes

lwc approved these changes Dec 23, 2019

View reviewed changes

update go.mod

d2a13d3

marwan-at-work added 2 commits January 7, 2020 00:51

update gqlparse to v1.2.1

b2e8178

go 1.12 generate, 1.14 failed

48dc29c

vektah merged commit 8218c73 into 99designs:master Jan 7, 2020

VitaliiLakusta mentioned this pull request Jan 23, 2020

Add Go gqlgen lib to list of federation support apollographql/apollo-server#3706

Merged

StevenACoffman mentioned this pull request Feb 7, 2020

Support for Apollo Federation #740

Closed

cgxxv pushed a commit to cgxxv/gqlgen that referenced this pull request Mar 25, 2022

Merge pull request 99designs#851 from marwan-at-work/federation

6b8cfe8

Apollo Federation MVP

Apollo Federation MVP #851

Apollo Federation MVP #851

Conversation

marwan-at-work commented Aug 30, 2019

coveralls commented Aug 30, 2019 • edited Loading

JulienBreux left a comment

Choose a reason for hiding this comment

vektah left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vvakame left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benjaminjkraft commented Oct 11, 2019

cliedeman commented Oct 14, 2019

nurdism commented Oct 14, 2019 • edited Loading

sothychan commented Nov 7, 2019

sothychan commented Nov 12, 2019

marwan-at-work commented Nov 12, 2019

sothychan commented Nov 12, 2019 • edited Loading

vvakame commented Nov 19, 2019

josemarluedke commented Dec 4, 2019

StevenACoffman commented Dec 5, 2019 • edited Loading

marwan-at-work commented Dec 5, 2019

marwan-at-work commented Dec 7, 2019

marwan-at-work commented Dec 8, 2019

jepp2078 commented Jan 6, 2020

vektah commented Jan 7, 2020

marwan-at-work commented Jan 7, 2020

vektah commented Jan 7, 2020

marwan-at-work commented Jan 7, 2020

jepp2078 commented Jan 7, 2020 • edited Loading

marwan-at-work commented Jan 7, 2020

nitin302 commented Feb 6, 2020

vvakame commented Feb 6, 2020

marwan-at-work commented Feb 6, 2020

nitin302 commented Feb 6, 2020

vvakame commented Feb 7, 2020

coveralls commented Aug 30, 2019 •

edited

Loading

nurdism commented Oct 14, 2019 •

edited

Loading

sothychan commented Nov 12, 2019 •

edited

Loading

StevenACoffman commented Dec 5, 2019 •

edited

Loading

jepp2078 commented Jan 7, 2020 •

edited

Loading