Merge Apollo Link common + HTTP functionality into core #5412

hwillson · 2019-10-04T16:15:51Z

Background

As part of Apollo Client 3's incremental steps towards improving developer experience, portions of the Apollo Link infrastructure are being moved into core. This will help ensure developers have much of what they need to build awesome GraphQL based applications out of the box, with Apollo Client. This will also help make future Apollo Link optimizations easier, due to its closer integration with the Apollo Client core.

Implementation

This PR introduces functionality into @apollo/client that is equivalent to the following Apollo Link packages:

apollo-link
apollo-link-http
apollo-link-http-common

This means installing and referencing the previously separate apollo-link and/or apollo-link-http packages is no longer necessary. ApolloLink and HttpLink are now exported directly from @apollo/client, and HTTP links can be created automatically using the ApolloClient uri constructor option:

import { ApolloClient, useQuery } from '@apollo/client';

const client = new ApolloClient({
  uri: 'http://localhost:4000'
});

function App() {
  const { loading, data } = useQuery(SOME_QUERY, { client });
  if (loading) return <p>Loading ...</p>;
  return <p>{data.something}</p>;
}

...etc

This approach is very similar to the now deprecated Apollo Boost project, but instead of offering a limited set of capabilities from a separate project, the goal is to simplify use of the main (and only) Apollo Client project (while providing options to incrementally add in more sophisticated functionality).

Apollo Link Project

Associated PR: apollographql/apollo-link#1158

PR apollographql/apollo-link#1158 updates the Apollo Link project to remove the capabilities that will be part of the AC core, after this PR is merged in. Packages in the apollo-link repo will have a dependency on Apollo Client, to pull in the common Apollo Link functionality they need.

Documentation

Apollo Client documentation changes for this work are coming in a separate PR. We're going to merge the separate Apollo Link documentation into the Apollo Client docs, which means there will be quite a few changes.

And remove the unused isomorphic fetch dep.

Introductory import of the Apollo Link core, common and HTTP code that is going to be integrated into the Apollo Client core. This code is going to change, but this commit gets the initial code moved over, and ensures that all Link tests still pass.

Now that the HTTP link code is part of AC, we can open up the constructor to allow additional options, like Apollo Boost did. Most people will just want to use `uri`, but `credentials` and `headers` use is common enough that it probably makes sense to expose them as well. Other HTTP link options can still be accessed by instantiating an `HttpLink` and passing it in via AC's constructor `link` option. Defining a custom link overrides the `uri`, `credentials`, and `headers` options.

The Apollo Link project will be updated to re-use common and HTTP based link code from Apollo Client, so we need to make sure that code is reachable externally.

This util was adding very little additional value over just using `ApolloLink` directly.

Also removes link test utilities from the public API.

This should help make future refactoring a bit easier, and gets us away from re-exporting all link utility functions, when very few of them need to be made available outside of this project.

Smaller, more focused files should make it easier to refactor AC's link support further. Link based re-exports from Apollo Client have been adjusted at the same time, to make sure we're only exporting items that are trully needed by 3rd party links (and by the `apollo-link` repo).

I'm not sure what the historical reason was for exposing link utility functions like `concat`, `empty`, `from`, `split` and `execute` both as static functions on `ApolloLink` and as separate importable functions. Since it might be a bit jarring for people if we remove one of these options, for now lets move all `ApolloLink` functionality back into the `ApolloLink` class, and instead re-export that functionality as separate utility functions. Using the utility functions through `ApolloLink` seems to be the most popular approach, and by aligning this in the code we'll make future maintenance a bit easier.

benjamn

Looks great! I will push a couple commits with minor tweaks that I spotted while reviewing.

src/react/testing/mocks/mockSubscriptionLink.ts

package.json

benjamn · 2019-10-04T17:46:09Z

@hwillson Before we merge this, can you update CHANGELOG.md to mention this PR?

Sub-classing then re-exporting `Observable` leads to the `@types/zen-observable` types not being available, when `Observable` is exported from `@apollo/client`. This is because the `@types/zen-observable` class declaration (`declare class Observable<T>`) is replaced during TS compilation with the `class Observable extends LinkObservable` declaration, which doesn't expose any of original `Observable` methods. This means projects like Apollo Link that are using the re-exported `Observable` from `@apollo/client`, don't see any of the `Observable` methods when using Typescript. Instead of creating an `Observable` sub-class with the additional RxJS interop functionality, this commit uses TS global module augmentation to essentially add to the `@types/zen-observable` `Observable` type. It then adds the needed interop function to `Observable` directly. This allows external projects like Apollo Link to find all `@types/zen-observable` types, and keeps RxJS interop functionality in place. And just to add - method creation using `$$observable` was removed as `zen-observable` already does this: https://github.com/zenparsing/zen-observable/blob/f63849a8c60af5d514efc8e9d6138d8273c49ad6/src/Observable.js#L396

Make sure all parts of Apollo Client import `Observable` from a local module, instead of from `zen-observable` directly. This decoupling will make things easier as we investigate letting people use their own observables implementation.

hwillson added 21 commits October 4, 2019 11:35

Add fetch-mock dep for link testing

de18694

And remove the unused isomorphic fetch dep.

Initial import of Apollo Link code

3edfd4b

Introductory import of the Apollo Link core, common and HTTP code that is going to be integrated into the Apollo Client core. This code is going to change, but this commit gets the initial code moved over, and ensures that all Link tests still pass.

Replace apollo-link package references with local references

8861959

Update Rollup globals to exclude deps for link code

7f045f8

Remove deprecated makePromise

3cf1efa

Adjust dependecies and types to accommodate link code

6be12f3

Re-export link core and htttp code

c76a56c

The Apollo Link project will be updated to re-use common and HTTP based link code from Apollo Client, so we need to make sure that code is reachable externally.

Additional exports needed by Apollo Link

7aa1837

Update test snapshots after adding of uri to the AC constructor

e1fdf91

Remove unnecessary mockLink Apollo Link testing utility

b74c3d3

This util was adding very little additional value over just using `ApolloLink` directly.

Move SetContextLink utilities into the only test that uses them

c62bc1f

Move link test utilities into single test using them

be1fdae

Also removes link test utilities from the public API.

Split link utilities into separate files and limit re-exports

5fe9e7f

This should help make future refactoring a bit easier, and gets us away from re-exporting all link utility functions, when very few of them need to be made available outside of this project.

Export UriFunction type

77d1235

Increase bundlesize

705fc73

Adjust checkFetcher message to mention @apollo/client

62f9350

Expose HttpLink options to make unit testing easier

6d574df

Add a few tests for the ApolloClient uri constructor option

b87afc1

hwillson requested review from benjamn and jbaxleyiii October 4, 2019 16:16

Fix HttpLink.ts file case issue

f8b04d5

benjamn approved these changes Oct 4, 2019

View reviewed changes

src/react/testing/mocks/mockSubscriptionLink.ts Outdated Show resolved Hide resolved

package.json Show resolved Hide resolved

benjamn added 4 commits October 4, 2019 13:34

Remove unreliable toKey and getKey properties from link operations.

07463bc

Simplify parseAndCheckHttpResponse.

74dbbf7

Use constructor member declaration in HttpLink.

fc5c068

Directly export { default as Observable } from 'zen-observable'.

ff9d1fb

benjamn added this to the Release 3.0 milestone Oct 4, 2019

benjamn added 🎄 dependencies 🍳 breaking change 👩‍🏭 refactor 📦 bundle size labels Oct 4, 2019

benjamn mentioned this pull request Oct 4, 2019

Release 3.0 #5116

Merged

31 tasks

hwillson added 4 commits October 6, 2019 08:52

Hide Observable implementation details

b1cd004

Make sure all parts of Apollo Client import `Observable` from a local module, instead of from `zen-observable` directly. This decoupling will make things easier as we investigate letting people use their own observables implementation.

Changelog update

17fa3d8

Merge branch 'release-3.0' into http-link-merge

34730a7

hwillson merged commit c98a833 into release-3.0 Oct 6, 2019

hwillson deleted the http-link-merge branch October 6, 2019 13:36

hwillson mentioned this pull request Oct 18, 2019

Doc updates to accommodate the Apollo Link merge #5480

Merged

GoranZic mentioned this pull request Nov 12, 2019

Support for Apollo Client 3 apollographql/apollo-link-rest#237

Closed

github-actions bot locked as resolved and limited conversation to collaborators Feb 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge Apollo Link common + HTTP functionality into core #5412

Merge Apollo Link common + HTTP functionality into core #5412

hwillson commented Oct 4, 2019

benjamn left a comment

benjamn commented Oct 4, 2019

Merge Apollo Link common + HTTP functionality into core #5412

Merge Apollo Link common + HTTP functionality into core #5412

Conversation

hwillson commented Oct 4, 2019

Background

Implementation

Apollo Link Project

Documentation

benjamn left a comment

Choose a reason for hiding this comment

benjamn commented Oct 4, 2019