Implementation of Apollo Server 2 for Google Cloud Functions #1446

reaktivo · 2018-07-28T11:47:40Z

This PR adds support for Google Cloud Functions (based on the Lambda one), you can check out a minimal but working example at: https://europe-west1-test-project-bdb0d.cloudfunctions.net/test-apollo-server-cloud-function

This issue fixes #1402

TODO:

Update CHANGELOG.md with your change (include reference to issue & this PR)
Make sure all of the significant new logic is covered by tests
Rebase your changes on master so that they can be merged easily
Make sure all tests and linter rules pass

apollo-cla · 2018-07-28T11:47:41Z

@reaktivo: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Meteor Contributor Agreement here: https://contribute.meteor.com/

hwillson

This is awesome @reaktivo - everything here looks great! The only small suggestion I have is to maybe rename the gqlApollo.ts and gqlApollo.test.ts files to be more inline with the naming used by the other integrations. The Lambda integration uses lambdaApollo.ts for example, CloudFlare uses cloudflareApollo.ts, etc. Maybe something like gcfApollo.ts or googleCloudApollo.ts? Honestly, this is a super minor thing, and I don't really consider it essential to getting this approved. Thanks vey much for working on this!

reaktivo · 2018-07-31T14:19:05Z

Hah! That was a funny slip up, I meant them to be gcfApollo.ts but I think having them as googleCloudApollo.ts makes them way more explicit any way, I'll update

evans

@reaktivo Thank you so much for the PR! Super excited about GCF support.

I left a couple of comments on the documentation that would help people start using the package. Can't wait to get this out the door 🎉

evans · 2018-07-31T18:39:05Z

packages/apollo-server-cloud-function/README.md

+
+## Getting request info
+
+To read information about the current request from the API Gateway event (HTTP headers, HTTP method, body, path, ...) or the current Google Cloud Function (Function Name, Function Version, awsRequestId, time remaining, ...) use the options function. This way they can be passed to your schema resolvers using the context option.


awsRequestId seems out of place. I'm not super familiar with GCF, so it totally could be a thing!

I've removed mentions to aws and simplified this section

evans · 2018-07-31T18:39:56Z

packages/apollo-server-cloud-function/README.md

+#### 2. Configure your Cloud function and deploy
+
+Set the _Function to execute_ option to _handler_
+and deploy


A quick section here on how to deploy the GCF would be incredible! Hopefully it includes a link to some of GCF's documentation as well

In the lambda world, we have to do some special things to ensure that all requests are piped to the handler, so that the OPTIONS request to cors is properly routed. My naive assumption is that GCF has similar configuration requirements

I've added a bit more details. But in general GCF doesn't requiring much additional configuration

evans · 2018-07-31T18:40:59Z

packages/apollo-server-cloud-function/README.md

+
+#### 1. Write the API handlers
+
+In a file named `graphql.js`, place the following code:


In a lambda environment, the specific file was necessary, since the configuration referenced graphql.handler. Does GCF have the same sort of dependency?

I noticed it's actually necessary for the js file to be named index.js since the configuration only allows setting the directory of the function and not the file itself.

reaktivo · 2018-08-02T13:03:06Z

The changes are on their way, thanks for the feedback!

reaktivo · 2018-08-02T14:09:48Z

@evans @hwillson Updated!

hwillson · 2018-08-20T10:34:40Z

Thanks for these changes @reaktivo. We should be all set here, so LGTM!

@thetre97

The `apollo-server-cloud-functions` has been been mis-referenced (or referenced inconsistently) since its original inception in #1446 when its package directory was `apollo-server-cloud-function` (singular!) and the `package.json` referenced the plural form (`apollo-server-cloud-functions`): 724d9ff0#diff-e1d725fd66f7e9ef5251abf0437a09ca These references have been mostly fixed in the READMEs and supporting documentation, but the underlying monorepo directory structure has still not been fixed, which I'm sure contributed to this module being overlooked and unreferenced in the move to TypeScript project references in #1772. Additionally, the lack of referencing in the monorepo's TS config has resulted in it being broken in the most recent 2.2.0 release, as reported by @pyros2097 and @thetre97 in: #1896 (comment) This should fix that by properly adding the TypeScript project references.

@thetre97

…1948) * Add correct project references for `apollo-server-cloud-functions`. The `apollo-server-cloud-functions` has been been mis-referenced (or referenced inconsistently) since its original inception in #1446 when its package directory was `apollo-server-cloud-function` (singular!) and the `package.json` referenced the plural form (`apollo-server-cloud-functions`): 724d9ff0#diff-e1d725fd66f7e9ef5251abf0437a09ca These references have been mostly fixed in the READMEs and supporting documentation, but the underlying monorepo directory structure has still not been fixed, which I'm sure contributed to this module being overlooked and unreferenced in the move to TypeScript project references in #1772. Additionally, the lack of referencing in the monorepo's TS config has resulted in it being broken in the most recent 2.2.0 release, as reported by @pyros2097 and @thetre97 in: #1896 (comment) This should fix that by properly adding the TypeScript project references. * Sorting.

ghost added ⛲️ feature New addition or enhancement to existing solutions labels Jul 28, 2018

reaktivo force-pushed the google-cloud-function-support branch from dff1d09 to 4861872 Compare July 28, 2018 16:17

ghost added the ⛲️ feature New addition or enhancement to existing solutions label Jul 28, 2018

reaktivo force-pushed the google-cloud-function-support branch from fcd29db to 30174e2 Compare July 30, 2018 11:35

reaktivo changed the title ~~WIP: Initial implementation of Apollo Server 2 for gcf~~ Implementation of Apollo Server 2 for Google Cloud Functions Jul 30, 2018

ghost added the ⛲️ feature New addition or enhancement to existing solutions label Jul 30, 2018

reaktivo force-pushed the google-cloud-function-support branch from 30174e2 to 2424dfa Compare July 31, 2018 11:25

hwillson requested review from evans and hwillson July 31, 2018 12:59

hwillson approved these changes Jul 31, 2018

View reviewed changes

ghost added the ⛲️ feature New addition or enhancement to existing solutions label Jul 31, 2018

evans reviewed Jul 31, 2018

View reviewed changes

reaktivo force-pushed the google-cloud-function-support branch from bd9b26b to 22d186c Compare August 2, 2018 14:07

reaktivo force-pushed the google-cloud-function-support branch 2 times, most recently from 4cf1fd5 to 784cd5f Compare August 6, 2018 13:22

reaktivo added 10 commits August 20, 2018 09:42

Initial implementation of Apollo Server 2 for gcf

9216e4c

First try at running with tests

28c4eb3

Updated naming

4903516

Removed lambda mentions

96c7f49

Simply use referer

7845ec1

Updated README

9bdd522

Updated Changelog

14c5556

Renamed gqlApollo to googleCloudApollo

e77bc58

Added more details

40fe3b7

Removed extra check

25fa7bd

reaktivo force-pushed the google-cloud-function-support branch from 784cd5f to 25fa7bd Compare August 20, 2018 07:44

hwillson merged commit 724d9ff into apollographql:master Aug 20, 2018

tgriesser mentioned this pull request Aug 20, 2018

Fix implicit any types in apollo-server-cloud-function #1554

Merged

martijnwalraven mentioned this pull request Sep 1, 2018

Google Cloud Functions tests #1601

Closed

dependencies bot mentioned this pull request Sep 3, 2018

Update apollo-server-express in / from 1.2.0 to 2.0.5 LibreTubeApp/LibreTube#172

Open

dependencies bot mentioned this pull request Oct 1, 2018

Update apollo-server-express in /modules/api from 1.3.4 to 2.1.0 project-accelerate/accelerate#241

Open

abernix mentioned this pull request Nov 12, 2018

Updated Cloud Functions README to reflect package name #1896

Closed

4 tasks

abernix mentioned this pull request Nov 12, 2018

Add correct project references for apollo-server-cloud-functions. #1948

Merged

github-actions bot locked as resolved and limited conversation to collaborators Apr 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implementation of Apollo Server 2 for Google Cloud Functions #1446

Implementation of Apollo Server 2 for Google Cloud Functions #1446

reaktivo commented Jul 28, 2018 •

edited by evans

apollo-cla commented Jul 28, 2018

hwillson left a comment

reaktivo commented Jul 31, 2018

evans left a comment

evans Jul 31, 2018

reaktivo Aug 2, 2018

evans Jul 31, 2018

reaktivo Aug 2, 2018

evans Jul 31, 2018

reaktivo Aug 2, 2018

reaktivo commented Aug 2, 2018

reaktivo commented Aug 2, 2018

hwillson commented Aug 20, 2018


		## Getting request info

		To read information about the current request from the API Gateway event (HTTP headers, HTTP method, body, path, ...) or the current Google Cloud Function (Function Name, Function Version, awsRequestId, time remaining, ...) use the options function. This way they can be passed to your schema resolvers using the context option.


		#### 1. Write the API handlers

		In a file named `graphql.js`, place the following code:

Implementation of Apollo Server 2 for Google Cloud Functions #1446

Implementation of Apollo Server 2 for Google Cloud Functions #1446

Conversation

reaktivo commented Jul 28, 2018 • edited by evans

apollo-cla commented Jul 28, 2018

hwillson left a comment

Choose a reason for hiding this comment

reaktivo commented Jul 31, 2018

evans left a comment

Choose a reason for hiding this comment

evans Jul 31, 2018

Choose a reason for hiding this comment

reaktivo Aug 2, 2018

Choose a reason for hiding this comment

evans Jul 31, 2018

Choose a reason for hiding this comment

reaktivo Aug 2, 2018

Choose a reason for hiding this comment

evans Jul 31, 2018

Choose a reason for hiding this comment

reaktivo Aug 2, 2018

Choose a reason for hiding this comment

reaktivo commented Aug 2, 2018

reaktivo commented Aug 2, 2018

hwillson commented Aug 20, 2018

reaktivo commented Jul 28, 2018 •

edited by evans