Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Working up towards 2.0 release #2281

Merged
merged 43 commits into from
Oct 19, 2017
Merged

Working up towards 2.0 release #2281

merged 43 commits into from
Oct 19, 2017

Conversation

jbaxleyiii
Copy link
Contributor

@jbaxleyiii jbaxleyiii commented Oct 11, 2017

This PR stands to track the 2.0 milestone and when its merged, the 2.0 will be near ready to become the official latest. Comment here if you have anything that is not working with the 2.0!

You can try it out by following the upgrade guide and installing apollo-client@next and apollo-cache-inmemory@next

Note going to merge this and tack the last few issues into smaller PR's so the docs can be part of master

@apollo-cla
Copy link

apollo-cla commented Oct 11, 2017

Warnings
⚠️

❗ Big PR

Messages
📖

Please add your name and email to the AUTHORS file (optional)

📖

If this was a change that affects the external API, please update the docs and post a link to the PR in the discussion

Generated by 🚫 dangerJS

@codecov
Copy link

codecov bot commented Oct 11, 2017

Codecov Report

Merging #2281 into master will increase coverage by 0.11%.
The diff coverage is 91.37%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2281      +/-   ##
==========================================
+ Coverage   84.58%   84.69%   +0.11%     
==========================================
  Files          36       36              
  Lines        1998     2013      +15     
  Branches      474      481       +7     
==========================================
+ Hits         1690     1705      +15     
  Misses        301      301              
  Partials        7        7
Impacted Files Coverage Δ
packages/apollo-client/src/scheduler/scheduler.ts 89.39% <ø> (ø) ⬆️
packages/apollo-cache-inmemory/src/index.ts 100% <ø> (ø) ⬆️
packages/apollo-cache-inmemory/src/types.ts 100% <ø> (ø) ⬆️
packages/apollo-cache-inmemory/src/writeToStore.ts 93.87% <ø> (ø) ⬆️
packages/apollo-utilities/src/storeUtils.ts 35.29% <ø> (ø) ⬆️
packages/apollo-client/src/data/store.ts 98.38% <ø> (+0.08%) ⬆️
packages/apollo-client-preset/src/index.ts 93.75% <0%> (ø) ⬆️
packages/apollo-client/src/util/Observable.ts 85.71% <0%> (ø) ⬆️
...ackages/apollo-cache-inmemory/src/readFromStore.ts 92.5% <100%> (+0.09%) ⬆️
...ackages/apollo-cache-inmemory/src/inMemoryCache.ts 62.83% <100%> (+1.57%) ⬆️
... and 11 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e2b4525...816a61d. Read the comment docs.

James Baxley added 2 commits October 10, 2017 22:10
 - apollo-cache-inmemory@0.2.0-beta.5
 - apollo-cache@0.2.0-beta.3
 - apollo-client-preset@0.2.0-beta.5
 - apollo-client@2.0.0-beta.5
 - apollo-utilities@0.2.0-beta.3
 - graphql-anywhere@4.0.0-beta.4
@langpavel
Copy link

langpavel commented Oct 11, 2017

Hello there.

In previous version I have a client instance on server with custom network interface like this.

The point of doing this is that isomorphic application should not waste with server resources (extra HTTP loop can be expensive) and can evaluate graphql in single server request lifecycle directly.

Can anybody give me a hint, pointing me to relevant documentation or source code where I can inspire?

Thanks!
I'm maintainer of feature-apollo branch in still popular react-starter-kit

@jbaxleyiii
Copy link
Contributor Author

@langpavel it would look something like this!

import { ApolloLink, Observable } from 'apollo-link';
import { graphql } from 'graphql';

const link = new ApolloLink(operation =>
  new Observable(observer => {
    const { query, variables, operationName } = operation;
    graphql(schema, print(query), {}, {}, variables, operationName)
      .then(result => {
        observer.next(result);
        observer.complete(result);
      })
      .catch(e => observer.error(e));
  }));

@langpavel
Copy link

langpavel commented Oct 11, 2017

@jbaxleyiii Wow It needs heavy mind shift! I know, there are some blog posts, do you remember relevant one?
I think migration guide will be needed in cases where API changed...

@langpavel
Copy link

I have another question related to abandoned redux.
In previous version I used actions to count up/down queries in fly and show state using react-redux-loading-bar.
Will be there an example how to bind queries in fly to redux, for example? :-)

@jbaxleyiii
Copy link
Contributor Author

@langpavel there is a starting point for the upgrade here and we will flesh this more out with official docs once the 2.0 is ready (should be this week / early next week).

n previous version I used actions to count up/down queries in fly and show state using react-redux-loading-bar.
Can you not just use the loading state on the query itself to do that?

James Baxley added 3 commits October 11, 2017 00:45
 - apollo-client-preset@0.2.0-beta.6
 - apollo-client@2.0.0-beta.6
James Baxley added 2 commits October 11, 2017 12:03
 - apollo-client-preset@0.2.0-rc.1
 - apollo-client@2.0.0-rc.1
@stubailo
Copy link
Contributor

Can you not just use the loading state on the query itself to do that?

I think he means for all queries.

Thankfully this can also be very easily done with Apollo Link! We'll post some code snippets here soon :]

James Baxley and others added 5 commits October 12, 2017 14:05
 - apollo-client-preset@0.2.0-rc.2
 - apollo-client@2.0.0-rc.2
It'd be helpful to UI integration libraries such as new angular-apollo, which will be released soon.
@davidblurton
Copy link

The Apollo client dev tools don't work for me with v2. We're using rc.2, although they haven't worked for any version so far. The dev tools inspector show the following error

"TypeError: Cannot read property 'query' of undefined
    at ApolloClient.window.__APOLLO_CLIENT__.makeGraphiqlQuery (<anonymous>:12:60)
    at <anonymous>:4:41
    at <anonymous>:11:7"

I opened an issue on the dev tools repo but I haven't had a response.
apollographql/apollo-client-devtools#78

We found the dev tools really useful when we were using the v1 client, so I hope this is something that will work for v2 as well.

@jbaxleyiii
Copy link
Contributor Author

@davidblurton 👋 yep that is fixed here! apollographql/apollo-client-devtools#79 We are working to get it released!

James Baxley and others added 8 commits October 13, 2017 17:04
 - apollo-cache-inmemory@0.2.0-rc.1
 - apollo-client-preset@0.2.0-rc.3
 - apollo-client@2.0.0-rc.3
style(docs): removed order

fix(docs): minor spacing tweak
* fix(client): throw errors if constructor not initialized properly

* fix(client): fix link to docs in error msg

* chore(changelog): added changes
* More edits

* Create migration.md

* Update _config.yml

Add migration guide

* Update migration.md

* Fix 'response' typo & add hyphen to refer to possible response types

* Update simple-example.md

fixed spelling

* Update simple-example.md

* Document `.graphql` file imports in Meteor

* docs(fragments): Document import syntax

Add `import` syntax mention in the `fragments` section
Link to `webpack` page where further usage / details are provided

Closes 185

* Sanitize JSON.stringify output to prevent XSS

See these docs for rationale:
http://redux.js.org/docs/recipes/ServerRendering.html#security-considerations|

* Update fragments.md

* Update subscriptions.md

Subscription client should accept a websocket address, not an http

* docs(webpack): update webpack config to Webpack 2

* Change sketch to snack

* add docs for variables argument in docs of data.refetch

* Fix a typo

* Fix typo

immeadiately => immediately

* Fix links to server side rendering recipe

These had an extra hash in front of them

* Just Angular

* Adds a minimal mention of Direct Cache Access

And links to the relevant bit in the Vanilla JS section.

* Adds a simple example

* Update index.md

* Fix SSR link

* Use fetchPolicy for legacy forceFetch

* Changed link to point at the more relevant docs

* Fleshed out the example a bit more

* documented code for subscriptions in Meteor

* Update submodule to 1.0.3

* chore(package): update dependencies

https://greenkeeper.io/

* Revert "Update all dependencies 🌴"

* Force fetch

* Fix broken SubscriptionsServer link

* fix(package): update hexo to version 3.3.5

https://greenkeeper.io/

* Add docsearch

* Add instructions for fragment matcher

* Go back to Apollo theme

* Revert "Update hexo to the latest version 🚀"

* Upgrade hexo, fix lines

* Replace `createMeteorNetworkInterface` in `meteor.md`

`createMeteorNetworkInterface` --> `createNetworkInterface` to match function name in source code

* Revert "Replace `createMeteorNetworkInterface` with `createNetworkInterface` in `meteor.md`"

* Update api-queries.md

* Update initialization.md

* Add docs for the exposure of 'dataIdFromObject' and 'dataId'

* Add docs for the exposure of 'dataIdFromObject' and 'dataId'

* Only document dataIdFromObject

* Update fetchMore docs

Check for `fetchMoreResult`, not `fetchMoreResult.data`.

* Update subscriptions.md

* Update docs about update

* Update network.md

* Fix Example

* update mutations.md formatting

Just a quick change to the "multiple mutations" code snippet, to match the formatting style of other code snippets.

* chore(package): update typedoc to version 0.7.0

https://greenkeeper.io/

* Fixed two misspellings

* chore(submodule): update to latest

* docs(subscriptions): updated subscriptions docs

* fix typo

* Clarify createApolloServer

* Fix missing word

* Update auth.md

I think it will be really helpful to mention that `withApollo` HOC is needed to access `client`.

* add missing ApolloClient import

* Fix typos

availble -> available, respositories -> repositories

* Update read-and-write.md

* minor typo

* changes per @rdickert comments on #274

* add ts typings

* Use correct property name in how-it-works.md 

The documentation states that the property is called dataIdFromObject, but the example uses dataFromObjectId instead.
When trying it out, it did work with dataIdFromObject, but not with dataFromObjectId.

* docs cleanup + additions for parsed afterware response

* Update network.md

* Make language a bit clearer

* Printer is no longer in graphql-tag

apollographql/graphql-tag#54

* GTM

* Update theme

* Add GTM

* Updated incorrect link to Mutations: Update

* Document the expected updateQuery return value

By specifying that it should have the same shape as the original query data.

* Update subscriptions.md

* subscribeToMore returns unsubscribe handler

* subscribeToMore returns unsubscribe handler

>@deep-c It's not defined because you're not actually getting an observable back. Apollo Client subscribes to it for you, so all you get back is actually the unsubscribe handle. So if you call this.subscription() it will unsubscribe. Maybe the variable name I chose in GitHunt-React isn't great 😄 . Would be better to call it unsubscribeHandle or something.

#1145 (comment)

* Fix missing variables in docs for refetchQueries

* Fix typo

* Add an example of a custom network interface

* Update network.md

* Syntax highlighting

Sorry, just realized I left off the js syntax highlighting

* - Adds intro text

* - Adds intro text

* - Adds queries
- Adds resolverCode

* - Adds queries
- Adds resolverCode

* Update partial-data.md

- Adds code example
- Fixes query
- Fixes wordings

* - Changes some wordings

* - Changes some wordings
- Adds paragraph about query batching

* - Changes wording scene to view

* - Adds link to custom resolvers

* - Changes title of the page
- Changes some wordings
- Adds link to BatchedNetworkInterface API docs

* - Applies suggested changes
- Adds destructuring for better readability

* Change the endpoint URI to the less misleading one

People don't usually use `http://localhost:3000/` as their endpoint for graphql,
I think it might be more understandable what it is if we use `http://localhost:3000/graphql` as example.

* Only send request cookie rather than full headers (See #228)

* Fix syntax error in fetchMore example

* Added batchMax to the Query batching explanation.

* tell typedoc to ignore compiler errors

* Fix broken `config.options` links for Queries and Mutations

* Fix broken generic `config.options` link

* Add documentation for the new connection directive

* Bump Node version to try to make CircleCI tests pass

* Update api-server.md

Added some corrections.

* Fix unexpected token error in example code

* Remove inaccurate part about parsed results in afterware

* Update network.md

Removing not necessary else on example code.

* Fixed link to angular page

Link pointed to /angular, which returns a 403

* Fix broken link in simple-example

* fixed typo in api-mutations.md

Changed "excepted" to "accepted".

* Update for new filter argument

* Update cache-updates.md

* Typo for Hello World link

* fix(package): update hexo to version 3.3.8

* fix(package): update hexo to version 3.3.8

* added docs for static typing (#258)

* added docs for static typing

* update from feedback

* spelling

* update class for flow since it can infer

* Improve customResolvers documentation

Add note about having to be the same data, add note about where to get `__typename`, improve overall documentation

* mention that options.context can be a function

* Minor typo fix

* Add unit of time for batchInterval in query batching description

* Remove wording about "just like above"

The previous example is actually only implementing `optimisticResponse` but then the next example implements `update` as well as `optimisticResponse`, and I found the wording to be a bit confusing around this. Do we need to implement `update` as well as `optimisticResponse` as the example shows for adding to a list? If so, the wording was incorrect. If not, then it'd be ideal to give an example where only `optimisticResponse` is required for adding to a list.

I'm currently assuming that the wording was actually slightly off, and that `update` was in fact necessary, in which case we can just remove the bit about `update` not being required.

* fix example; cursor is not available on root

* Update pagination.md

* Change "Expo Sketch" to "Expo Snack"

* Update SSR for React docs to reflect newest version of React Router

* Add relevant comment on routes file

* Add link to FuseBox plugin

* Fix createMeteorNetworkInterface in SSR section

* Fix typo in optimistic-ui.md

* Add gql to the list of imports

gql is used to create the graphql query for the Profile component so it has to be imported to work.

* fixed typo, sentence rewording in query-splitting

* update docs: PropTypes is now a separate package

* Query docs: PropTypes is now a separate package

* Updated simple-example.md

Move to the updated link on howtographql.com as learnapollo.com is deprecated. Please let me know if I need to change the label as well or if this is not relevant.

* Update SSR doc based on feedback.

* StaticRouter now wrapped in ApolloProvider, and made routes example more specific

* Update simple-example.md

Change 2nd tutorial title from "Learn Apollo" to "How to GraphQL" as the prior is deprecated.

* Fixed small typo in example

* Update index.md

Move to the updated link on howtographql.com as learnapollo.com is deprecated.

* adding a super simple client/server example

This repo is just a simple playground for GraphQL n00bs like me. It's only `client.js` and `server.js` both under 50 lines.

Having a minimalist sandbox like this helped me wrap my mind around Apollo, before I started adding all the ceremony that comes along with a UI and database.

Thanks!

* Small typo in refetchQueries example

Small typo in refetchQueries example. The variable name is incorrect in the mutation of refetchQueries example.

* Add slack button

* try edit

* Try changing versions

* Fix outdated queryDeduplication docs

* doc/link formatting

* forceFetch -> fetchPolicy

change `forceFetch: true` to `fetchPolicy: 'network-only'`

* Sync the SSR doc with the newest update added to the GitHunt app, which now uses React Router v4

* Add package lock

* Fix internal link

* move to core-docs

* adjust config and fix jsdoc

* track public

* Add docs for graphql-tag precompilation with babel (#292)

* Add rootEl const to redux.md example code (#293)

In your DOM rendering, you threw in rootEl, but rootEl was never defined. Assuming the ID is "root", I added a const that pointed to that div/element.

`const rootEl = document.querySelector("#root");`

* Update index.md (#295)

* Update auth.md (#296)

* fragment -> fragments (#297)

The component field is named `fragments`, not `fragment`.

* Add React native case (#299)

* docs(fragment matcher): added build script, revised docs for 2.0 (#302)

* Update using-with-types.md (#298)

* add note about refetch variables (#300)

add brief note to clear any variables that were set before for any query. This is helpful when you want to omit a variable from the query that was set before. e.g in case of filters you might want to clear previous filter variable but by not passing that variable will result in picking the old value.

* Docs reorg (#2339)

* start reorg

* reorg of docs for test deploy [NOT READY]

* remove built docs

* update gitignore

* Fix submodule path

* Fix submodule issues
@jbaxleyiii jbaxleyiii changed the title Official 2.0 Release Working up towards 2.0 release Oct 19, 2017
@jbaxleyiii
Copy link
Contributor Author

Deploy preview ready!

Built with commit 816a61d

https://deploy-preview-2281--apollo-client-docs.netlify.com

@jbaxleyiii jbaxleyiii merged commit 2cd695f into master Oct 19, 2017
@jbaxleyiii jbaxleyiii deleted the 2.0 branch July 3, 2019 15:16
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants