useSuspenseQuery data possibly undefined

[mvdstam]

Which packages are impacted by your issue?

@graphql-codegen/typescript-react-apollo

Describe the bug

Hi,

Since https://github.com/dotansimha/graphql-code-generator-community/pull/835 and after updating @graphql-codegen/typescript-react-apollo to 4.3.2, all of our suspense hooks now return data that are possibly 'undefined', breaking compilation:

Before:

const { data } = useGetCountriesSuspenseQuery()

// data has type GetCountriesQuery and can be accessed without issues

Now:

const { data } = useGetCountriesSuspenseQuery()

// data has type GetCountriesQuery | undefined, and needs optional chaining

I'm not sure whether or not this is a bug, or that there is an additional step necessary on my end to make typescript understand that in the above examples, we're not skipping the query using a skipToken. Only when passing the skipToken in the hook should the return type be possibly undefined.

Perhaps @jefrydco can shed some light on this? Is there any more configuration necessary to support the skipToken variable in generated suspense hooks?

Cheers!

Your Example Website or App

N/A

Steps to Reproduce the Bug or Issue

Upgrade to @graphql-codegen/typescript-react-apollo v4.3.2 when using generated useSuspenseQuery hooks

Expected behavior

I expected the return type of data for a useGetMyDataSuspenseQuery be either GetMyData or GetMyData | undefined, depending on whether or not a skipToken is present. Existing code not containing a skipToken in the hook should have the same return types as before upgrading to @graphql-codegen/typescript-react-apollo v4.3.2.

Screenshots or Videos

No response

Platform

• OS: Linux
• NodeJS: 18.16.0
• graphql version: 16.8.1
• @graphql-codegen/* version(s):

"@graphql-codegen/add": "^3.2.1",
"@graphql-codegen/cli": "^5.0.2",
"@graphql-codegen/introspection": "^4.0.3",
"@graphql-codegen/typescript": "^4.0.6",
"@graphql-codegen/typescript-operations": "^4.2.0",
"@graphql-codegen/typescript-react-apollo": "^4.3.2",

Codegen Config File

overwrite: true
schema: ${VITE_API_URL}/graphql
documents: "src/**/*.graphql"
generates:
  src/graphql/graphql.tsx:
    plugins:
      - add:
          content: 'const defaultOptions = { onError: () => {} }'
      - "typescript"
      - "typescript-operations"
      - "typescript-react-apollo"
    config:
      scalars:
        DateTimeTz: 'Date'
        JSON: '{ [key: string]: any }'
        Percentage: 'number'
        Upload: 'File'
  ./graphql.schema.json:
    plugins:
      - "introspection"

Additional context

No response

[Moeface]

I suspect that PR that introduced SkipToken support is going to need to be reverted. It suffers from the problem outlined in the original issue.

No shade to the developer that implemented it, as they were trying to be useful, but the implementation is perhaps a bit too naive.

This perhaps shows that the tests may not be covering what needs to be tested in regards to suspense hook functionality, as this is a breaking change that essentially undoes the entire point of using suspense hooks.

[mvdstam]

@saihaj

Can you please take a look at this, since https://github.com/dotansimha/graphql-code-generator-community/pull/835 most definitely introduced a breaking change? :+1:

[Moeface]

@saihaj can we please get some eyes on this PR please? 🙏

It's broken suspense hook generation functionality for close to 5 months now and is preventing us from upgrading this package.

[jrnxf]

@Moeface a little goofy, but in the meantime you can do this

  const { data } = useXyzSuspenseQuery(
    shouldSkip
      ? { skip: true }
      : {
          variables: {
            foo: "bar",
          },
        },
  );

[copleykj]

This has been an issue for over a year now.

[eddeee888]

Thanks all, this is fixed in: https://github.com/dotansimha/graphql-code-generator-community/releases/tag/release-1765608699717

For more context, we'll deprecate this package soon, since it doesn't work well with Apollo Client v4: https://github.com/dotansimha/graphql-code-generator-community/issues/1216