Docs: Mocking Page edits #6026

rkoron007 · 2022-01-25T17:40:10Z

Took a pass at editing the Mocking article. Didn't change any of the code, just tweaked and elaborated on the text.

docs/source/testing/mocking.md

glasser

Looking good overall. I tried to look for semantic issues (Stephen's suggestions are of course great).

docs/source/testing/mocking.md

StephenBarlow · 2022-01-27T19:32:34Z

docs/source/testing/mocking.md


-By default, the functions in `mocks` will overwrite any currently defined resolvers. In the below example, both `hello` and `resolved` will return `Hello`.
+By default, the functions in `mocks` will take precedence over any currently defined resolvers. In the below example, both `hello` and `resolved` return `Hello`.


For an abundance of clarity, I might say "both Query.hello and Query.resolved"

StephenBarlow · 2022-01-27T19:40:03Z

docs/source/testing/mocking.md


-In the below example, take note that our `mocks`' `Person` object will invoke a function returning an object with fields pointing at more functions:
+In the below example, note that our mocked `Person` object calls a function returning an object with fields pointing at _other_ functions:


On second pass I guess we don't typically use "pointing at", and I might recommend something like:

"with fields that contain other functions"

StephenBarlow · 2022-01-27T19:40:23Z

docs/source/testing/mocking.md

@@ -93,11 +171,11 @@ const mocks = {
 };
 ```

-The previous example uses [casual](https://github.com/boo1ean/casual), a fake data generator for JavaScript, which returns a different result every time the function is called. In other scenarios, such as testing, a collection of fake objects or a generator that always uses a consistent seed are often necessary to provide consistent data.
+The previous example uses [casual](https://github.com/boo1ean/casual), a fake data generator for JavaScript which returns a different result every time the function is called. In other scenarios, such as testing, a collection of fake objects or a generator that always uses a consistent seed are often necessary to provide consistent data.


"which" -> "that"

StephenBarlow · 2022-01-27T19:41:14Z

docs/source/testing/mocking.md

@@ -152,13 +230,13 @@ server.listen().then(({ url }) => {
 });
 ```

-Running the above example, with the `mockEntireSchema` option set to false, `resolved` will now return the string `Resolved`.
+Running the above example with the `mockEntireSchema` option set to false, the `resolved` field now returns the string `Resolved`.


codefont false here as well

StephenBarlow · 2022-01-27T19:42:10Z

docs/source/testing/mocking.md

@@ -183,7 +261,7 @@ server.listen().then(({ url }) => {

 Under the hood, Apollo Server's mocking functionality is provided by the function [`addMocksToSchema`](https://www.graphql-tools.com/docs/mocking/) from the `@graphql-tools/mock` package. The `mocks` object is passed directly to the `addMocksToSchema` function, and `preserveResolvers` is the inverse of `mockEntireSchema`.

-Apollo Server does not support all of the arguments to `addMocksToSchema`, such as `resolvers`. If you'd like to use the features of `@graphql-tools/mock` that aren't supported by Apollo Server, you can use `@graphql-tools/mock` directly:
+Apollo Server does not support all of the arguments to `addMocksToSchema`, such as `resolvers`. If you'd like to use the features of `@graphql-tools/mock` that aren't supported by Apollo Server, you can install and use `@graphql-tools/mock` directly:


"If you'd like to use the features" -> "To use features"

StephenBarlow

Text approved with a last few tiny edits, whenever @glasser thinks it's ✅ !

glasser · 2022-01-27T20:43:53Z

docs/source/testing/mocking.md

+</tbody>
+</table>
+
+By default when using mocks, your existing resolvers are **ignored** in favor of `mocks`. To configure this behavior, see [Using existing resolvers with mocks](#using-existing-resolvers-with-mocks).


maybe be even more explicit, more like:

When using mocks, you don't have to specify `resolvers` at all. In fact, by default any `resolvers` you specify will be **ignored** when you enable `mocks`. To configure...

glasser

Other than that (and Stephen's notes), looks good.

Note that we are considering removing these options from ApolloServer in AS4, though we probably would still document how to use @graphql-tools/mock directly. #6063

rkoron007 added 3 commits January 25, 2022 07:40

First pass at editing

7318f33

Final pass and added result of mockEntireSchema

db3dc93

Fix link and small tweaks

1ba37e7

rkoron007 requested a review from StephenBarlow January 25, 2022 17:40

rkoron007 added the 📝 documentation Focuses on changes to the documentation (docs) label Jan 25, 2022

rkoron007 added 2 commits January 25, 2022 09:52

Adding commas back in

04a500b

Revert default mocks heading name

fe059c7

rkoron007 added the size/small Estimated to take LESS THAN A DAY label Jan 25, 2022

StephenBarlow reviewed Jan 25, 2022

View reviewed changes