apollographql / apollographql/apollo-client

Research and compare new rover persisted query manifest generator with npm package

Open
#13,331 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
19.8k
Forks
2.9k
Avg merge
10h 17m
Merged PRs (30d)
19

Description

Rover has a new pq manifest generate command. We need to test it to see if it covers what we expect from the Apollo Client side so that we can deprecate the existing [`@apollo/generate-persisted-query-manifest`](https://www.npmjs.com/package/@apollo/generate-persisted-query-manifest) npm package.

Some things we will need to check:
- Apollo Client v3 compatibility (`addTypename` controls whether `__typename` is added)
- Apollo Client v4 compatibility (`__typename` is always added)
- [Custom document transforms](https://www.apollographql.com/docs/react/data/document-transforms)
- What docs replacements we would need

My biggest concern is custom document transforms capability. I know of at least one business entity that relies heavily on them.

Contributor guide

Open the contributing guide

Research direction

Start by running Rover's `pq manifest generate` against Apollo Client v3 and v4 cases, checking `addTypename` and custom document transforms against the existing `@apollo/generate-persisted-query-manifest` behavior. Review the current package documentation and record required replacements; done means compatibility results and a decision on whether deprecation is safe.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, typescript
Domain
documentation, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.