Skip to content

Commit 84c9364

Browse files
committed
Mark doc areas that should be fixed for AS3 with "FIXME AS3"
1 parent 80f8275 commit 84c9364

12 files changed

+28
-1
lines changed

docs/source/api/apollo-server.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,7 @@ An object containing configuration options for connecting Apollo Server to [Apol
279279
An array of [plugins](../integrations/plugins) to install in your server instance. Each array element can be either a valid plugin object or a zero-argument function that _returns_ a valid plugin object.
280280

281281
In certain cases, Apollo Server installs some of its built-in plugins automatically (for example, when you provide an Apollo Studio API key with the `APOLLO_KEY` environment variable). For details, see the API references for these plugins: [usage reporting](./plugin/usage-reporting/), [schema reporting](./plugin/schema-reporting/), and [inline trace](./plugin/inline-trace/).
282+
FIXME AS3: More things are installable plugins now (cache control, landing pages) which should be documented on their own pages and mentioned here.
282283

283284
</td>
284285
</tr>

docs/source/data/file-uploads.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: Enabling file uploads in Apollo Server
55

66
> Note: As of Apollo Server 3.0, in order to allow the `graphql-upload` package to evolve and live on its own, uploads are no longer enabled by default and are not an integrated part of Apollo Server.
77
8+
FIXME AS3: Need to verify that the code below still works. Should note that federation does not support uploads.
9+
810
File uploads can be enabled by using the third-party [`graphql-upload`](https://npm.im/graphql-upload) package. Using this package will introduce support for the `multipart/form-data` content-type.
911

1012
The instructions below demonstrate how to do this on Express. Those wishing to implement similar functionality on other Node.js HTTP frameworks (e.g., Koa) should see the [`graphql-upload` repository's documentation](https://github.com/jaydenseric/graphql-upload) for more information. Some integrations may need to use `graphql-upload`'s `processRequest` directly.
@@ -69,6 +71,8 @@ const server = new ApolloServer({
6971
typeDefs,
7072
resolvers,
7173
});
74+
// FIXME AS3: Missing `await server.start()` though that implies we should refactor
75+
// into a larger async function.
7276

7377
const app = express();
7478

docs/source/data/subscriptions.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: Persistent GraphQL read operations
55

66
import {ExpansionPanel} from 'gatsby-theme-apollo-docs';
77

8+
FIXME AS3: Whole file needs to be rewritten, as we don't have built in subscription support any more, and probably shouldn't recommend using `subscriptions-transport-ws` at this time.
9+
810
> **Subscriptions are not currently supported in [Apollo Federation](https://www.apollographql.com/docs/federation/).**
911
1012
**Subscriptions** are long-lasting GraphQL read operations that can update their result whenever a particular server-side event occurs. Most commonly, updated results are _pushed_ from the server to subscribing clients. For example, a chat application's server might use a subscription to push newly received messages to all clients in a particular chat room.

docs/source/deployment/azure-functions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: Deploying your GraphQL server to Azure Functions
55
---
66
This is the Azure Functions integration for the Apollo community GraphQL Server. [Read Docs](https://www.npmjs.com/package/apollo-server-azure-functions)
77

8+
FIXME AS3: Walk through and test this whole file. Ensure README.md reflects changes here (or remove the duplication).
9+
810
All examples below was created using Linux environments, if you are working with Windows-based platforms some commands couldn’t work fine.
911

1012
## Prerequisites

docs/source/deployment/gcp-functions.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Deploying with Google Cloud Functions
33
sidebar_title: Google Cloud Functions
44
---
55

6+
FIXME AS3: Walk through and test this whole file. Ensure README.md reflects changes here (or remove the duplication).
7+
68
import {
79
ExpansionPanel,
810
} from 'gatsby-theme-apollo-docs/src/components/expansion-panel';
@@ -64,6 +66,8 @@ Paste the example code at the top of this page into the contents of `index.js` i
6466

6567
Edit `package.json` so that it lists `apollo-server-cloud-functions` and `graphql` in its dependencies:
6668

69+
FIXME AS3: can we make this just be an `npm install` somehow? Otherwise we have to keep the version up to date here. At the very least we have to get this to 3.0.0.
70+
6771
```json:title=package.json
6872
"dependencies": {
6973
"apollo-server-cloud-functions": "^2.24.0",
@@ -180,6 +184,8 @@ exports.handler = server.createHandler();
180184

181185
## Modifying the GCF Response (CORS)
182186

187+
FIXME AS3: I think CORS is now enabled by default so at least part of this can be removed.
188+
183189
To enable CORS, you need to modify your HTTP response headers. To do so, use the `cors` option:
184190

185191
```javascript{23-26}

docs/source/deployment/heroku.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ sidebar_title: Heroku
44
description: Deploying your GraphQL server to Heroku
55
---
66

7+
FIXME AS3: Walk through and test this whole file.
8+
79
Heroku is a common Platform as a Service solution that allows users to deploy and have a functioning GraphQL endpoint running in a matter of minutes.
810

911
## Prerequisites

docs/source/deployment/lambda.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ sidebar_title: Lambda
44
description: How to deploy Apollo Server with AWS Lambda
55
---
66

7+
FIXME AS3: Walk through and test this whole file. Ensure README.md reflects changes here (or remove the duplication).
8+
79
AWS Lambda is a service that allows users to run code without provisioning or managing servers. Cost is based on the compute time that is consumed, and there is no charge when code is not running.
810

911
This guide explains how to setup Apollo Server 2 to run on AWS Lambda using Serverless Framework. To use CDK and SST instead, [follow this tutorial](https://serverless-stack.com/examples/how-to-create-an-apollo-graphql-api-with-serverless.html).
@@ -191,6 +193,8 @@ exports.graphqlHandler = server.createHandler();
191193

192194
## Modifying the Lambda response (Enable CORS)
193195

196+
FIXME AS3: I think CORS is now enabled by default so at least part of this can be removed.
197+
194198
To enable CORS, the response HTTP headers need to be modified. To accomplish this, use the `cors` options.
195199

196200
```js

docs/source/deployment/netlify.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ sidebar_title: Netlify
44
description: How to run your API using Netlify Functions on AWS Lambda
55
---
66

7+
FIXME AS3: Walk through and test this whole file.
8+
79
[Netlify Functions](https://www.netlify.com/docs/functions/) allow deploying server-side code, directly from GitHub, to AWS Lambda. This guide demonstrates how to use Netlify Functions to deploy a GraphQL server and reference the server in Apollo Client. Some benefits of Netlify Functions include:
810

911
1. Use the same platform to deploy your frontend and API code.

docs/source/getting-started.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ We're up and running!
185185
We can now execute GraphQL queries on our server. To execute our first query,
186186
we can use **Apollo Sandbox**.
187187

188+
FIXME AS3: Should we instead tell folks to go to the printed localhost URL and click through the landing page to Sandbox?
188189
With your server still running, visit [studio.apollographql.com/sandbox](https://studio.apollographql.com/sandbox) to open Sandbox:
189190

190191
<img class="screenshot" src="./images/sandbox.jpg" alt="Apollo Sandbox"/>

docs/source/migration-engine-plugins.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: Migrating from the "engine" option
33
---
44

5+
FIXME AS3: We can probably remove this but also have the first step in the migration guide say "if you're using `engine:`, then before migrating to 2.0, stop setting `engine` based on this page in the v2 migration guide"
6+
57
Apollo Server v2.18 deprecates the `engine` option to the `ApolloServer` constructor and provides a new way of configuring its communication with Apollo Studio. The `engine` option continues to work for existing functionality, but you will eventually want to update to the new API. If you don't explicitly pass `engine` to the `ApolloServer` constructor, you don't have to do anything.
68

79
Apollo Server ships with several plugins that help it integrate with Apollo Studio: the [usage reporting plugin](./api/plugin/usage-reporting/) plugin, the [schema reporting plugin](./api/plugin/schema-reporting/), and the [inline trace plugin](./api/plugin/inline-trace/). Apollo Server has some heuristics to install these plugins by default in certain circumstances (documented in the individual plugin reference pages), but otherwise they are standard [Apollo Server plugins](./integrations/plugins/). They are configured by passing arguments to the constructor functions. Some overall graph configuration (such as your graph API key and graph variant name) is set via the `apollo` option to the `ApolloServer` constructor (or via environment variables).

0 commit comments

Comments
 (0)