astFromValue - JavaScript BigInt support by ardatan · Pull Request #4088 · graphql/graphql-js

ardatan · 2024-05-08T15:30:38Z

This PR adds support for BigInt values to astFromValue.
It coerces whenever possible instead of failing.
This will also allow custom scalars like https://the-guild.dev/graphql/scalars/docs/scalars/big-int to get a BigInt as a default value. Similar to #4085

netlify · 2024-05-08T15:30:55Z

✅ Deploy Preview for compassionate-pike-271cb3 ready!

Name	Link
🔨 Latest commit	`62f92fe`
🔍 Latest deploy log	https://app.netlify.com/sites/compassionate-pike-271cb3/deploys/670bb7bed4d9de000852eb12
😎 Deploy Preview	https://deploy-preview-4088--compassionate-pike-271cb3.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2024-05-08T15:31:07Z

Hi @ardatan, I'm @github-actions bot happy to help you with this PR 👋

Supported commands

Please post this commands in separate comments and only one per comment:

@github-actions run-benchmark - Run benchmark comparing base and merge commits for this PR
@github-actions publish-pr-on-npm - Build package from this PR and publish it on NPM

saihaj

not sure if we want to merge this 🤔

Numeric integer values larger than 32-bit should either use String or a custom-defined Scalar type, as not all platforms and transports support encoding integer numbers larger than 32-bit.

ardatan · 2024-05-09T17:14:22Z

@saihaj Isn't it for Int scalar type? However, this PR doesn't change that behavior. Int still doesn't support larger integers. This PR just allows to use bigint type of JavaScript just like number and string. So it is not the size of the number but the type of it.
If Int supports 32-bit numeric values in string format, it should allow the same values in bigint format as well right?
Same for ID and `Float but without 32-bit limit.

saihaj · 2024-05-09T18:32:08Z

@saihaj Isn't it for Int scalar type? However, this PR doesn't change that behavior. Int still doesn't support larger integers. This PR just allows to use bigint type of JavaScript just like number and string. So it is not the size of the number but the type of it. If Int supports 32-bit numeric values in string format, it should allow the same values in bigint format as well right? Same for ID and `Float but without 32-bit limit.

Oh I see what you mean, its like we are coercing 2147483646n as 2147483646 since it is a valid GraphQL Int after all

src/utilities/__tests__/astFromValue-test.ts

yaacovCR · 2024-10-01T10:22:53Z

In terms of default values, that use case should probably be re-examined after #3814 lands, which should hopefully be soon! We are halfway-through the stack.

I suppose we will need to support conversion from BigInt to Int/Float when possible if the received JSON is parsed with a BigInt supporting parser. I think it probably would require some discussion at the WG in terms of whether to include it, but I would be in favor.

yaacovCR · 2024-10-01T11:05:52Z

In terms of output, I am of two minds in terms of whether we should be supporting conversion from bigint to int, because that means that a custom scalar probably should have been used, in case the value was greater than the int threshold. Maybe it's better to fail overall?

For conversion to string or id, I imagine we would want to support it, I can't see why not?

See #3973 and #3109.

yaacovCR · 2024-10-13T12:05:19Z

src/utilities/__tests__/astFromValue-test.ts

      value: '123',
    });

+    expect(astFromValue(9007199254740993n, GraphQLFloat)).to.deep.equal({


The change in type of this test is because astFromValue is not safe, set to be replaced by valueToLiteral() for all remaining uses in #3814

But a bigint of sufficient size, -- as far as I know -- cannot be converted to a JS float.

We also in this PR do not properly handle GraphQLFloat scalar parsing and serialization of small BigInts, I will push a failing test to demonstrate what I mean.

We also probably should update the logic within the new valueToLiteral() utility. It's possible that overall we can just delay landing this PR until after #3814

building on prior work: - #3109 - #3973 - #4088 - #4223 - #4276 This PR adds bigint support to: - GraphQLInt, including input/output coercion, throwing if out of bounds, and new default value programmatic default value to literal - GraphQLFloat, including input/output coercion, throwing if cannot be represented, including with any loss of precision. - GraphQLString, output coercion only, like number - GraphQLBoolean, output coercion only, like number - GraphQLID, output and input coercion, in parallel to number, and new default value programmatic default value to literal Also, for custom scalars: - updates the `defaultScalarValueToLiteral` to convert a `bigint` to an Int literal - updates for deprecated `astFromValue` for passthrough custom scalars, i.e. scalars that return `bigint` from coerceOutputValue/serialize, to convert `bigint` to an Int literal. cf. also #3913 Co-authored-by: Arda TANRIKULU <ardatanrikulu@gmail.com> Co-authored-by: jdecroock <decroockjovi@gmail.com> Co-authored-by: Hkmu <3169251+hkmu@users.noreply.github.com> Co-authored-by: xonx <119700621+xonx4l@users.noreply.github.com>

yaacovCR · 2026-03-05T23:15:17Z

Thank you @ardatan so much for your work on this! bigint support belatedly made it into v17 as reworked in #4550

ardatan · 2026-03-06T12:31:05Z

Thanks @yaacovCR ! But like we discussed here earlier -> #4085
v17 seems far from being released any time soon. So I think a patch-fix in v16 would be better to have.

vercel · 2026-03-06T12:42:43Z

@yaacovCR is attempting to deploy a commit to the The GraphQL Foundation Team on Vercel.

A member of the Team first needs to authorize it.

yaacovCR · 2026-03-06T12:54:35Z

Thanks @yaacovCR ! But like we discussed here earlier -> #4085 v17 seems far from being released any time soon. So I think a patch-fix in v16 would be better to have.

I'm hopeful to (finally!) move v17 to beta over the weekend.

Reopening to help track, however, as I think now that we have this merged into v17 and we know directionally where the code is headed with the new valueToLiteral() functionality, etc, perhaps we can backport more of the new changes to v16.

Ideally this would be a non-change for anyone not using the new functionality.

ardatan mentioned this pull request May 8, 2024

astFromValue fails with a custom scalar serializing to an object value #4085

Open

saihaj reviewed May 9, 2024

View reviewed changes

ardatan requested a review from saihaj May 9, 2024 17:16

saihaj reviewed May 9, 2024

View reviewed changes

src/utilities/__tests__/astFromValue-test.ts Show resolved Hide resolved

saihaj approved these changes May 9, 2024

View reviewed changes

saihaj requested review from a team and removed request for a team June 26, 2024 17:11

yaacovCR mentioned this pull request Sep 27, 2024

v17 Roadmap #4205

Open

17 tasks

This was referenced Oct 1, 2024

FIX:Support for bigint in ID. #3973

Closed

scalars: ID and String support for serializing BigInt #3109

Closed

yaacovCR mentioned this pull request Oct 11, 2024

Allow for serializing int as BigInt #4223

Closed

JoviDeCroock approved these changes Oct 11, 2024

View reviewed changes

ardatan and others added 4 commits October 13, 2024 14:53

JavaScript BigInt support

9284dab

Add more tests

1781164

reduce diff, don't modify existing tests

47f71f8

add a few tests for scalars

e78d663

yaacovCR force-pushed the bigint-support branch from 2268937 to e78d663 Compare October 13, 2024 11:54

yaacovCR reviewed Oct 13, 2024

View reviewed changes

add failing test

62f92fe

JoviDeCroock mentioned this pull request Nov 1, 2024

BigInt support in scalars #4276

Closed

yaacovCR mentioned this pull request Feb 4, 2026

add bigint support #4550

Merged

yaacovCR closed this Mar 5, 2026

yaacovCR reopened this Mar 6, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

astFromValue - JavaScript BigInt support#4088

astFromValue - JavaScript BigInt support#4088
ardatan wants to merge 5 commits intographql:nextfrom
ardatan:bigint-support

ardatan commented May 8, 2024 •

edited

Loading

Uh oh!

netlify bot commented May 8, 2024 •

edited

Loading

Uh oh!

github-actions bot commented May 8, 2024

Uh oh!

saihaj left a comment

Uh oh!

ardatan commented May 9, 2024 •

edited

Loading

Uh oh!

saihaj commented May 9, 2024

Uh oh!

Uh oh!

yaacovCR commented Oct 1, 2024 •

edited

Loading

Uh oh!

yaacovCR commented Oct 1, 2024

Uh oh!

yaacovCR Oct 13, 2024

Uh oh!

yaacovCR commented Mar 5, 2026

Uh oh!

ardatan commented Mar 6, 2026

Uh oh!

vercel bot commented Mar 6, 2026

Uh oh!

yaacovCR commented Mar 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

ardatan commented May 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented May 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for compassionate-pike-271cb3 ready!

Uh oh!

github-actions bot commented May 8, 2024

Uh oh!

saihaj left a comment

Choose a reason for hiding this comment

Uh oh!

ardatan commented May 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

saihaj commented May 9, 2024

Uh oh!

Uh oh!

yaacovCR commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yaacovCR commented Oct 1, 2024

Uh oh!

yaacovCR Oct 13, 2024

Choose a reason for hiding this comment

Uh oh!

yaacovCR commented Mar 5, 2026

Uh oh!

ardatan commented Mar 6, 2026

Uh oh!

vercel bot commented Mar 6, 2026

Uh oh!

yaacovCR commented Mar 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ardatan commented May 8, 2024 •

edited

Loading

netlify bot commented May 8, 2024 •

edited

Loading

ardatan commented May 9, 2024 •

edited

Loading

yaacovCR commented Oct 1, 2024 •

edited

Loading