the-guild-org / the-guild-org/apollo-angular

Compatibility with "classic" and "modern" signatures

Open
#2,429 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.5k
Forks
309
Avg merge
1h 45m
Merged PRs (30d)
3

Description

@jerelmiller (cc @phryneas), I would like to make apollo-angular compatible with the latest changes of @apollo/client 4.2 that introduced "classic" and "modern" signatures. However, I am not quite sure how to proceed, and since you contributed very heavily to the new-ish typing structure of apollo-angular during the migration to Apollo v4, I hoped you might have a few advice on the matter ?

More specifically, I don't think we can use the types you introduced such as Apollo.QueryResult (vs ApolloClient.QueryResult) as-is anymore. And instead we should somewhat rely on the the ApolloClient.query.Signature, but I am not sure what would the best way to do that.

I am willing to break everything and make a major release if needed. I am even considering dropping most features, so that apollo-angular becomes an extremely thin wrapper that monkey-patch @apollo/client, in order to rely 100% on @apollo/client types instead of introducing an "extra layer" of types... but hopefully you have better comprehension of @apollo/client and you can guide me toward a saner solution 😅

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no repository files or tests. Start by reading the Apollo Client 4.2 classic and modern signature changes and the Apollo v4 migration in PR 2355, then trace the Apollo.QueryResult and ApolloClient.QueryResult types mentioned here. Done means apollo-angular is compatible with those signatures without the current typing mismatch.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, graphql, typescript
Domain
api, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.