Don't bundle Apollo Client if the user specify their own client

[Tobbe]

Redwood bundles Apollo GraphQL, but offers the ability to specify your own GraphQL client. Unfortunately even when you use your own GraphQL client you'll still get Apollo bundled. This PR attempts to place Apollo's client outside of main, so if you do not use it it will not be bundled.

[github-actions]

📦 PR Packages

Click to Show Package Download Links

https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/create-redwood-app-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-api-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-api-server-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-auth-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-cli-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-core-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-dev-server-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-eslint-config-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-eslint-plugin-redwood-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-forms-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-internal-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-router-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-structure-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-testing-0.23.0-c0f6164.tgz
https://rw-pr-redwoodjs-com.s3.amazonaws.com/1639/redwoodjs-web-0.23.0-c0f6164.tgz

Install this PR by running yarn rw upgrade --pr 1639:0.23.0-c0f6164

[thedavidprice]

@Tobbe could you please add some description/background to the original message in this PR? The goal is to make it possible for others in the community to follow along as well as provide context when drafting Release Notes.

Thanks in advance!

[peterp]

@thedavidprice Totally my fault, I offered to create an issue and I didn't do it in time. I'll update the description @Tobbe

[peterp]

@Tobbe What was blocking this PR again?

[Tobbe]

@Tobbe What was blocking this PR again?

Need to update the template in crwa. Looks like that's moving into this repo now, so I'll wait until that's settled, and then include that change in this PR as well

[thedavidprice]

@peterp @Tobbe along with this PR being merged, do you think it will be good timing to create a Doc about being able to swap/remove GraphQL Client?

[Tobbe]

@thedavidprice Funny that you should ask. I just got started on a draft for a blog post (on my blog) on how to do it. Obviously going to post on the forums too

[thedavidprice]

Seems like a Doc would be super helpful too redwoodjs.com/docs/graphql-client And/or maybe this is a cookbook? I guess it depends on whether it's a "just get to the how-to details" or more of a walk through.

Either would be 🚀

[Tobbe]

Sneak peek

[Tobbe]

Seems like a Doc would be super helpful too redwoodjs.com/docs/graphql-client

Docs definitely sound like a good idea 👍

[peterp]

@Tobbe That PR has merged!

[Tobbe]

With @apollo/client

With graphql-hooks and graphql-hooks-memcache

Previously the bundle size got bigger when you used your own graphql client, because both the one you use, and apollo client were included. Now, as you can see, the bundle size goes down, and @apollo/client is no longer included when you decide to use another client instead.

[mojombo]

Nice!

[peterp]

Nice thanks @Tobbe!

I would love to figure out a pattern that allows "exports" to work without having to hack around TS and webpack, since we're going to start seeing this more and more.

I'll create some issues for this.

[peterp]

P.S. I wonder why "graphql" is packaged. It was my understanding that we transpile the gql syntax at build-time, but maybe the babel-plugin isn't working properly... Or my understanding is misguided.

[Tobbe]

P.S. I wonder why "graphql" is packaged

I included it to use its print function, which takes a gql ast and transforms it to a string. I replaced it by this function in my index.js file

const gqlToString = (gqlAst) => {
  return gqlAst.loc?.source.body
}

And now it looks like this

It was my understanding that we transpile the gql syntax at build-time, but maybe the babel-plugin isn't working properly... Or my understanding is misguided.

It's not transpiled. If it was my gqlToString function above wouldn't work (and wouldn't be needed)

[thedavidprice]

Nice! Moving forward, does this require:

• any doc updates (I don't believe so)
• any CRWA template or Tutorial updates (again, assuming not)
• any upgrade instructions because of breaking change?

[Tobbe]

Nice! Moving forward, does this require:

• any doc updates (I don't believe so)
• any CRWA template or Tutorial updates (again, assuming not)
• any upgrade instructions because of breaking change?

CRWA template update is part of this PR

This is also a breaking change. Whenever someone upgrades to the next release (0.24.0?) they'd have to do the update above manually.

The docs do mention <RedwoodProvider> in a few places. Those need to be updated to <RedwoodApolloProvider>. The tutorial is fine.

As for the breaking change, is it enough to just mention it in upgrade instructions? Or should I create a <RedwoodProvider> component that throws a helpful error message when/if someone tries to use it?

[thedavidprice]

Docs See https://github.com/redwoodjs/redwoodjs.com/issues/528

Breaking I've labeled this and added to my release To Dos. Seems simple enough to explain. We should definitely focus on deprecation warnings and more graceful changes after v1.

Sound like a plan?