Tighter integration with persisted queries and GraphQL Codegen #414

jerelmiller · 2024-02-22T03:57:28Z

GraphQL Codegen provides a persisted documents feature that outputs a manifest file with queries detected by the package. Unfortunately the output format and generated queries aren't fully compatible with @apollo/generate-persisted-query-manifest.

This PR aims to add tighter integration with the persisted documents feature to allow us to parse and use the documents in that manifest as the source of truth. Doing so will skip file system traversal and instead rely on the documents written to that manifest.

NOTE: It's important that we send these documents through this utility to allow Apollo Client to run any additional transforms built into the library to run on the output. Without doing so, there is a risk of query mismatch between what is written to the persisted documents manifest and what Apollo Client sends to the server. This also ensures the pq manifest file is written in the proper format.

// persisted-query-manifest.config.ts
import { fromGraphQLCodegenPersistedDocuments } from '@apollo/generate-persisted-query-manifest';

const config = {
  documents: fromGraphQLCodegenPersistedDocuments('./path/to/persisted-documents.json')
}

changeset-bot · 2024-02-22T03:57:31Z

🦋 Changeset detected

Latest commit: 3ef87a5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@apollo/generate-persisted-query-manifest	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

codesandbox-ci · 2024-02-22T04:32:22Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

jerelmiller · 2024-02-22T06:28:38Z

packages/generate-persisted-query-manifest/src/index.ts

+ *
+ * @since 1.2.0
+ */
+export function fromGraphQLCodegenPersistedDocuments(


Should this functionality also be available on the CLI as an option, or should we generally rely more on the config for this kind of change?

Hmm, this seems fine I think.

…tions

glasser · 2024-02-22T07:08:48Z

packages/generate-persisted-query-manifest/src/index.ts

+ },
+ });
+ }
+
 maybeReportErrorsAndExit(uniq(sources.map((source) => source.file)));

 // Using createFragmentRegistry means our minimum AC version is 3.7. We can


I would prefer that we leave out the fragment registry if we've parsed our documents from a format that's supposed to have already done the fragment stuff.

Done! 8243f09

glasser · 2024-02-22T07:09:17Z

packages/generate-persisted-query-manifest/src/index.ts

+ *
+ * @since 1.2.0
+ */
+export function fromGraphQLCodegenPersistedDocuments(


Hmm, this seems fine I think.

glasser · 2024-02-22T07:20:53Z

packages/generate-persisted-query-manifest/README.md

@@ -96,6 +96,27 @@ Default:
 ]
 ```

+#### Usage with GraphQL Codegen persisted documents


Hmm. I feel like the docs could somehow be a bit clearer that there are two distinct advantages to taking this approach:

The sorta obvious reason: if you've already carefully configured graphql-codegen to know exactly which files contain GraphQL documents and you trust it to have done so accurately, you might as well just piggy-back on its work rather than having to configure our tool identically.

The less obvious reason: if you're using certain graphql-codegen features (like the client-preset) then the actual documented being passed to Apollo Client is not the value you wrote in your source code, but the outcome of some light transforms applied by graphql-codegen. While those transforms are intended to be similar to the ones that AC does, they aren't quite the same, so to analyze things accurately we should be running our tool against the output of that process.

I'm not really sure how to reword that in a clearer and more succinct manner but it doesn't seem like the README right now tries to express this? Though maybe it's subtle enough to be futile.

Ya thats a good point. I'll take a stab at conveying both and see how it feels.

Took a stab at both with b16fcf2. Let me know what you think!

glasser · 2024-02-22T07:23:14Z

packages/generate-persisted-query-manifest/README.md

+export default config;
+```
+
+> NOTE: Running these documents through this package is necessary to ensure all document transforms built into Apollo Client are also run on these documents. This ensures forward compatibility with any future changes introduced by Apollo Client that may alter the GraphQL document output.


This sort of explains the opposite issue to the one I'm concerned about above (that one could imagine just taking the codegen JSON and generating our manifest from it directly rather than using ApolloClient like this tool does), whereas my thought above is about "can't you just use the normal version of this tool directly on your app source".

Funny I think this shows the 2 different ways you and I think about this 🤣. Some of this comes form insider knowledge on whats coming with Apollo Client, but you have a solid point here. I think it might be worth expressing both.

Took a stab at this with b16fcf2. Let me know what you think!

packages/generate-persisted-query-manifest/README.md

Co-authored-by: David Glasser <[email protected]>

jerelmiller added 6 commits February 21, 2024 20:56

Create helper to install dependencies for a test

68b76b6

Add graphql-codegen client preset as dev dependency

04e5067

Add failing test for integration with graphql codegen

0556d36

Ensure function can be resolved in test

71477af

Minor formatting update

3e69d0a

Stub out check for custom documents source

484bfb2

jerelmiller mentioned this pull request Feb 22, 2024

Version Packages #413

Merged

jerelmiller added 4 commits February 21, 2024 21:00

Add missing __typename in assertion

9459d55

Add implementation for parsing gql codegen manifest

73dc7f3

Pull sources from gql codegen or filepath list

b8b1182

Fix output assertion and enable all tests

a38e8a6

jerelmiller added 17 commits February 21, 2024 21:36

Add changeset

bb50f9e

Increase timeout on test that installs deps

23c2988

Install @graphql-codegen/cli as dev dep

0aa5eeb

Use programatic API for GraphQL codegen

8f18b13

Simplify installDependencies helper

42d9bd4

Remove custom timeout on test

ff5f256

Rename symbol for clarity

091b3a0

Add test to ensure persisted documents file exists

3b03164

Read from filepath directly before parsing

bd1fb16

Check for array in parseable config

1c7be06

Move error messages to ERROR_MESSAGES. Update erro for malformed json

5d1adc7

Add test to check malformed manifest

ece65b4

Handle when manifest is not json serialized

8e95e77

Add docblock for fromGraphQLCodegenPersistedDocuments

20a4e9f

Update README with new capability

d772230

Update type of documents to allow for custom document source config

c795f3e

Add comment about not running validation

cc8e607

jerelmiller added 3 commits February 21, 2024 23:08

Move validation of entries to document sourcer

de894dc

Fix test assertion on JSON parse failure

ce8dad5

Fix formatting in README

f400546

jerelmiller changed the title ~~[WIP] Tighter integration with persisted queries and GraphQL Codegen~~ Tighter integration with persisted queries and GraphQL Codegen Feb 22, 2024

jerelmiller requested a review from glasser February 22, 2024 06:25

jerelmiller marked this pull request as ready for review February 22, 2024 06:25

jerelmiller requested a review from a team as a code owner February 22, 2024 06:25

jerelmiller commented Feb 22, 2024

View reviewed changes

jerelmiller added 2 commits February 21, 2024 23:31

Mark getFilepaths and generatePersistedQueryManifest as internal func…

756dda7

…tions

Ensure --list-files works with persisted documents

effeb5a

glasser reviewed Feb 22, 2024

View reviewed changes

jerelmiller added 2 commits February 22, 2024 08:51

Update changes to explain benefits a bit more clearly

b16fcf2

Only use the fragment registry if the document source should use it

8243f09

glasser approved these changes Feb 23, 2024

View reviewed changes

packages/generate-persisted-query-manifest/README.md Outdated Show resolved Hide resolved

Fix typo in README

3ef87a5

Co-authored-by: David Glasser <[email protected]>

jerelmiller enabled auto-merge (squash) February 23, 2024 23:52

jerelmiller merged commit b8b7d12 into main Feb 23, 2024
11 checks passed

jerelmiller deleted the jerel/codegen-manifest branch February 23, 2024 23:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tighter integration with persisted queries and GraphQL Codegen #414

Tighter integration with persisted queries and GraphQL Codegen #414

jerelmiller commented Feb 22, 2024 •

edited

Loading

changeset-bot bot commented Feb 22, 2024 •

edited

Loading

codesandbox-ci bot commented Feb 22, 2024 •

edited

Loading

jerelmiller Feb 22, 2024

glasser Feb 22, 2024

glasser Feb 22, 2024

jerelmiller Feb 22, 2024

glasser Feb 22, 2024

glasser Feb 22, 2024

jerelmiller Feb 22, 2024

jerelmiller Feb 22, 2024

glasser Feb 22, 2024

jerelmiller Feb 22, 2024

jerelmiller Feb 22, 2024

Tighter integration with persisted queries and GraphQL Codegen #414

Tighter integration with persisted queries and GraphQL Codegen #414

Conversation

jerelmiller commented Feb 22, 2024 • edited Loading

changeset-bot bot commented Feb 22, 2024 • edited Loading

🦋 Changeset detected

codesandbox-ci bot commented Feb 22, 2024 • edited Loading

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

jerelmiller commented Feb 22, 2024 •

edited

Loading

changeset-bot bot commented Feb 22, 2024 •

edited

Loading

codesandbox-ci bot commented Feb 22, 2024 •

edited

Loading