more actionable federation errors for nil key field queries #3437
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Steve Coffman <steve@khanacademy.org>
Signed-off-by: Steve Coffman <steve@khanacademy.org>
StevenACoffman
commented
Dec 14, 2024
plugin/federation/federation.gotpl
Outdated
| } | ||
| {{- if (ne $i $keyField.Field.LastIndex ) }} | ||
| if m, ok = val.(map[string]interface{}); !ok { | ||
| break | ||
| // nested field value is not a map[string]interface | ||
| return "", fmt.Errorf("%w for {{$entity.Name}} due to nested Keyfield not being map value", ErrTypeNotFound) |
There was a problem hiding this comment.
@clayne11 This is the one I am least confident if it is a good error message
StevenACoffman
changed the title
StevenACoffman
force-pushed
the
federation_errors
branch
3 times, most recently
from
b0fbf6d to
bfaf7fc
Compare
Signed-off-by: Steve Coffman <steve@khanacademy.org>
StevenACoffman
force-pushed
the
federation_errors
branch
from
bfaf7fc to
d6b38cf
Compare
StevenACoffman
commented
Dec 15, 2024
| @@ -310,10 +313,15 @@ func (ec *executionContext) resolveManyEntities( | |||
| {{- range $i, $field := .Field }} | |||
| val, ok = m["{{.}}"] | |||
| if !ok { | |||
| entityResolverErrs = append(entityResolverErrs, | |||
| fmt.Errorf("%w due to missing Key Field \"{{.}}\" for {{$entity.Name}}", ErrTypeNotFound)) | |||
| break | |||
| } | |||
| {{- if (ne $i $keyField.Field.LastIndex ) }} | |||
There was a problem hiding this comment.
I am not very sure I understand what this code is doing here.
We only want to possibly skip suggesting this resolver if the current field index does not match the last index of the key field?
StevenACoffman
added
help wanted
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #3029 @clayne11 altered the federation behavior, so that null values for key Fields would now also skip using the resolver (since it would never work). This was both a security and performance enhancement, as expensive safelisted queries with nil KeyField values could have been sent for no reason.
However, the error messages for this change were not very specific and as a result, were not very clearly actionable.
I think I correctly understand the cases and have added more specific error messages, but I would definitely appreciate confirmation from @clayne11 or @kanodia-parag or anyone else that I'm not subtly misleading people.
I am collecting entity resolution errors as it is valid for entities with multiple key fields to fail with some resolvers and then succeed with a different resolver.