Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix error response on large numbers in query transformations #3820

Merged
merged 3 commits into from
Sep 14, 2023

Conversation

goto-bus-stop
Copy link
Member

@goto-bus-stop goto-bus-stop commented Sep 13, 2023

In GraphQL source text, you can write an integer outside the int32 range if a float is expected. apollo-rs parses these numbers as f64 inside hir::Value::Int because at that time, the expected type of the value is not known, especially because it's possible to parse queries without knowledge of the schema.

In the defer label transformation, any apollo-rs hir::Value::Int was treated as an i32. This would cause an error if it's one such large integer. The fully proper way to convert hir::Value to another type (ie. encoder or serde_json, as is done elsewhere) would be to match on the actual GraphQL type declared by the schema. But the simpler thing to do is to just use a Float if the value is too big for an Int. This will round-trip correctly.

See test for an example that used to fail:

compiler.add_type_system("type Query { field(id: Float): String! }", "schema.graphql");
let file_id = compiler.add_executable(r#"{ field(id: 1234567890123) }"#, "query.graphql");


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

In GraphQL source text, you can write an integer outside the int32 range
if a float is expected. apollo-rs parses these numbers as
`hir::Value::Int` because at that time, the expected type of the value is
not known, especially because it's possible to parse queries without
knowledge of the schema.

In the defer label transformation, any apollo-rs `hir::Value::Int` was
treated as an i32. This would cause an error if it's one such large integer.
The fully proper way to convert `hir::Value` to another type (ie. encoder or
serde_json, as is done elsewhere) would be to match on the actual
GraphQL type expected by the schema. But the simpler thing to do is to
just use a Float if the value is too big for an Int. This will
round-trip correctly.
@goto-bus-stop goto-bus-stop self-assigned this Sep 13, 2023
@github-actions

This comment has been minimized.

@router-perf
Copy link

router-perf bot commented Sep 13, 2023

CI performance tests

  • events_big_cap_high_rate - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity
  • events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • large-request - Stress test with a 1 MB request payload
  • step - Basic stress test that steps up the number of users over time
  • xlarge-request - Stress test with 10 MB request payload
  • reload - Reload test over a long period of time at a constant rate of users
  • no-graphos - Basic stress test, no GraphOS.
  • xxlarge-request - Stress test with 100 MB request payload
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • const - Basic stress test that runs with a constant number of users

@goto-bus-stop goto-bus-stop requested review from a team, garypen, Geal and o0Ignition0o September 13, 2023 15:03
@goto-bus-stop goto-bus-stop removed the bug label Sep 13, 2023
@goto-bus-stop goto-bus-stop merged commit cfc5e88 into dev Sep 14, 2023
2 checks passed
@goto-bus-stop goto-bus-stop deleted the renee/preserve-large-ints branch September 14, 2023 08:29
@lrlna lrlna mentioned this pull request Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants