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

Fix for broken healthcheck in apollo-server-lambda #4892

Merged
merged 3 commits into from Mar 5, 2021

Conversation

iannickb
Copy link
Contributor

@iannickb iannickb commented Feb 3, 2021

Use endsWith except of === to check if the healthcheck endpoint is called. This should fix #4891.

@apollo-cla
Copy link

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

@glasser
Copy link
Member

glasser commented Feb 3, 2021

Is this something that used to work and has changed in Lambda? Or is it an issue specific to custom domains and that's why it wasn't caught before? Are there docs you can point me at that make it clear what the expected value of event.path is? What does the value look like in your custom domain use case? Do we have to apply a similar change to the other use of event.path in the file (which brings in graphql-playground)?

@iannickb
Copy link
Contributor Author

iannickb commented Feb 8, 2021

Thank you for the quick response @glasser !

Is this something that used to work and has changed in Lambda?

My guess is that it never worked. It was introduced when onHealthCheck was added 84e1aa5#diff-859ee6c9b8a50783a3f6358ec930fd105d32832ffd678c836f58e02ee3ed60d9

Or is it an issue specific to custom domains and that's why it wasn't caught before?

It is specific to Custom Domains and how the event.path is populated when behind a Cloudfront distribution

Are there docs you can point me at that make it clear what the expected value of event.path is?

For some reason, I could not find any documentation related to that on the aWS website. I did find a good explanation on the serverless-express repo from someone who encountered the same thing.
CodeGenieApp/serverless-express#216

What does the value look like in your custom domain use case?

Everything works fine if I am calling the APIG generated endpoint. The value is different when running behind a custom domain and a non-default base path mapping.

Do we have to apply a similar change to the other use of event.path in the file (which brings in graphql-playground)?

It would be better to be consistent and change it across the board.

@iannickb iannickb closed this Feb 8, 2021
@iannickb iannickb deleted the patch-1 branch February 8, 2021 13:25
@iannickb iannickb restored the patch-1 branch February 8, 2021 13:30
@iannickb iannickb reopened this Feb 8, 2021
@iannickb
Copy link
Contributor Author

iannickb commented Feb 8, 2021

I reviewed the code for playground and I am wondering why there is a check for event.path. That value should always be there for apollo-server-lambda.
https://github.com/iannickb/apollo-server/blob/f1a8d518339e98d429d414288b3c2e3eed15b488/packages/apollo-server-lambda/src/ApolloServer.ts#L208-L211

Also, since the condition is on method and the playground setting, maybe we could leave as is?

@kamaz
Copy link
Contributor

kamaz commented Feb 27, 2021

@iannickb I believe that is a real problem and doesn't apply only on api gateway. I use it with ALB where Apollo Server is bound by custom context. In my scenario, I get /bff/.well-known/apollo/server-health.

@glasser
Copy link
Member

glasser commented Mar 2, 2021

Just want to note that I am still tracking this for the next day of "merge a bunch of PRs that cover parts of the codebase where I need to do some research before I can evaluate them"; this hasn't happened yet largely due to some vacation.

@glasser
Copy link
Member

glasser commented Mar 5, 2021

OK. I find this whole thing to be pretty confusing. Sounds like the way event.path works in Lambda is very inconsistent depending on which particular service your Lambda lives behind. I'm also rather confused that #4687 is asking for the opposite resolution (they're saying event.path is shorter than it should be rather than longer).

That said, this particular change does seem unlikely to break anything: nobody should be depending on any URL ending with /.well-known/apollo/server-health doing anything other than triggering a health check. So I'll merge it, though I'm still pretty confused about #4687.

@glasser glasser merged commit df23e06 into apollographql:main Mar 5, 2021
glasser added a commit that referenced this pull request Mar 5, 2021
@glasser
Copy link
Member

glasser commented Mar 6, 2021

I've published a release with this to version 2.21.1-alpha.0. My plan is to release 2.21.1 on Monday. If you want to test that this fix works before then, try running the prerelease yourself, and provide feedback on #4990

This was referenced Mar 15, 2021
kodiakhq bot added a commit to ProjectXero/dbds that referenced this pull request Mar 17, 2021
Bumps apollo-datasource from 0.7.2 to 0.7.3.

Changelog
Sourced from apollo-datasource's changelog.

CHANGELOG
The version headers in this history reflect the versions of Apollo Server itself.  Versions of other packages (e.g., those which are not actual HTTP integrations; packages not prefixed with "apollo-server", or just supporting packages) may use different versions.
🆕 Please Note!: 🆕 The @apollo/federation and @apollo/gateway packages now live in the apollographql/federation repository.

@apollo/gateway
@apollo/federation

vNEXT

The changes noted within this vNEXT section have not been released yet.  New PRs and commits which introduce changes should include an entry in this vNEXT section as part of their development.  With few exceptions, the format of the entry should follow convention (i.e., prefix with package name, use markdown backtick formatting for package names and code, suffix with a link to the change-set à la [PR #YYY](https://link/pull/YYY), etc.).  When a release is being prepared, a new header will be (manually) created below and the appropriate changes within that release will be moved into the new section.


apollo-server-core: The SIGINT and SIGTERM signal handlers installed by default (when not disabled by stopOnTerminationSignals: false) now stay active (preventing process termination) while the server shuts down, instead of letting a second signal terminate the process. The handlers still re-signal the process after this.stop() concludes. Also, if this.stop() throws, the signal handlers will now log and exit 1 instead of throwing an uncaught exception. [Issue #4931](apollographql/apollo-server#4931)
apollo-server-lambda: (UPDATE THIS MESSAGE BEFORE RELEASE; we are not sure if this actually helps nodejs14 compatibility or if it's just a nice refactor.) Support the nodejs14 runtime by changing the handler to be an async handler. (For backwards compatibility, if the handler receives a callback, it still acts like a non-async handler.) [Issue #1989](apollographql/apollo-server#1989) [PR #5004](apollographql/apollo-server#5004)

v2.21.1

apollo-server-lambda: The onHealthCheck option did not previously work. Additionally, health checks (with onHealthCheck or without) didn't work in all Lambda contexts, such as behind Custom Domains; the path check is now more flexible. [Issue #3999](apollographql/apollo-server#3999) [PR #4969](apollographql/apollo-server#4969) [Issue #4891](apollographql/apollo-server#4891) [PR #4892](apollographql/apollo-server#4892)
The debug option to new ApolloServer (which adds stack traces to errors) now affects errors that come from requests executed with server.executeOperation (and its wrapper apollo-server-testing), instead of just errors that come from requests executed over HTTP. [Issue #4107](apollographql/apollo-server#4107) [PR #4948](apollographql/apollo-server#4948)
Bump version of @apollographql/graphql-playground-html to v1.6.27 and @apollographql/graphql-playground-react to v1.7.39 to resolve incorrectly rendered CDN URL when Playground version was false-y.  [PR #4932](apollographql/apollo-server#4932) [PR #4955](apollographql/apollo-server#4955) [Issue #4937](apollographql/apollo-server#4937)

v2.21.0

Apollo Server can now be installed with graphql@15 without causing peer dependency errors or warnings. (Apollo Server has a file upload feature which was implemented as a wrapper around the graphql-upload package. We have been unable to upgrade our dependency on that package due to backwards-incompatible changes in later versions, and the version we were stuck on did not allow graphql@15 as a peer dependency. We have now switched to a fork of that old version called @apollographql/graphql-upload-8-fork that allows graphql@15.) Also bump the graphql-tools dependency from 4.0.0 to 4.0.8 for graphql@15 support. [Issue #4865](apollographql/apollo-server#4865)

v2.20.0

apollo-server: Previously, ApolloServer.stop() functioned like net.Server.close() in that it did not close idle connections or close active connections after a grace period. This meant that trying to await ApolloServer.stop() could hang indefinitely if there are open connections. Now, this method closes idle connections, and closes active connections after 10 seconds. The grace period can be adjusted by passing the new stopGracePeriodMillis option to new ApolloServer, or disabled by passing Infinity (though it will still close idle connections). Note that this only applies to the "batteries-included" ApolloServer in the apollo-server package with its own built-in Express and HTTP servers. [PR #4908](apollographql/apollo-server#4908) [Issue #4097](apollographql/apollo-server#4097)
apollo-server-core: When used with ApolloGateway, ApolloServer.stop now invokes ApolloGateway.stop. (This makes sense because ApolloServer already invokes ApolloGateway.load which is what starts the behavior stopped by ApolloGateway.stop.) Note that @apollo/gateway 0.23 will expect to be stopped in order for natural program shutdown to occur. [PR #4907](apollographql/apollo-server#4907) [Issue #4428](apollographql/apollo-server#4428)
apollo-server-core: Avoid instrumenting schemas for the old graphql-extensions library unless extensions are provided. [PR #4893](apollographql/apollo-server#4893) [Issue #4889](apollographql/apollo-server#4889)
apollo-server-plugin-response-cache@0.6.0: The shouldReadFromCache and shouldWriteToCache hooks were always documented as returning ValueOrPromise<boolean> (ie, that they could be either sync or async), but they actually only worked if they returned a bool. Now they can be either sync or async as intended. [PR #4890](apollographql/apollo-server#4890) [Issue #4886](apollographql/apollo-server#4886)
apollo-datasource-rest@0.10.0: The RESTDataSource.trace method is now protected instead of private to allow more control over logging and metrics. [PR #3940](apollographql/apollo-server#3940)

v2.19.2

apollo-server-express: types: Export ExpressContext from main module. [PR #4821](apollographql/apollo-server#4821) [Issue #3699](apollographql/apollo-server#3699)
apollo-server-env: types: The first parameter to fetch is now marked as required, as intended and in accordance with the Fetch API specification. [PR #4822](apollographql/apollo-server#4822) [Issue #4741](apollographql/apollo-server#4741)
apollo-server-core: Update graphql-tag package to latest, now with its graphql-js peerDependencies expanded to include ^15.0.0 [PR #4833](apollographql/apollo-server#4833)

v2.19.1

apollo-server-core: The debugPrintReports option to ApolloServerPluginUsageReporting now prints traces as well. [PR #4805](apollographql/apollo-server#4805)

v2.19.0

apollo-server-testing: types: Allow generic variables usage of query and mutate functions. [PR #4383](apollograpqh/apollo-server#4383)
apollo-server-express: Export the GetMiddlewareOptions type. [PR #4599](apollograpqh/apollo-server#4599)
apollo-server-lambda: Fix file uploads - ignore base64 decoding for multipart queries. [PR #4506](apollographql/apollo-server#4506)
apollo-server-core: Do not send  operation documents that cannot be executed to Apollo Studio. Instead, information about these operations will be combined into one "operation" for parse failures, one for validation failures, and one for unknown operation names.



... (truncated)


Commits

c212627 Release
See full diff in compare view




Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 21, 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.

Healthcheck does not work for apollo-server-lambda when using an API gateway custom domain
5 participants