core: return PersistedQueryNotSupported for Apollo Persisted Queries

[glasser]

Apollo Persisted Queries is a standard for sending queries as short hashes
instead of full strings, designed to work well with GET requests. It is
implemented by servers including the Apollo Engine Proxy, and by the
apollo-link-persisted-query client.

A common configuration is to set up persisted queries on production servers but
not in development. It is still convenient to leave apollo-link-persisted-query
always on, though. While apollo-link-persisted-query can detect that servers
don't support PQs, it works better if the server actually says it doesn't
support the PQ, instead of trying to process a request without a query and
potentially printing a confusing stack trace. This commit makes apollo-server
directly return PersistedQueryNotSupported instead of allowing confusing stack
traces to occur.

[glasser]

Thanks!

In the future I prefer to merge my own PRs on repos where I have permissions, as l'esprit de l'escalier often strikes me. (I was at least intending to add a CHANGELOG note here.)

[glasser]

This has been published as apollo-server-* 1.3.6.

[billnbell]

OK When calling to get a persisted query I get an error when Graphql does not have Engine defined.

1:

http://localhost:4001/graphql?query={__typename}&extensions={%22persistedQuery%22:{%22version%22:1,%22sha256Hash%22:%22ecf4edb46db40b5132295c0291d62fb65d6759a9eedfa4d5d612dd5ec54a6b38%22}}

Then:

http://localhost:4001/graphql?extensions={%22persistedQuery%22:{%22version%22:1,%22sha256Hash%22:%22ecf4edb46db40b5132295c0291d62fb65d6759a9eedfa4d5d612dd5ec54a6b38%22}}

{
errors: [
{
message: "Cannot read property 'definitions' of undefined"
}
]
}

Stack dump is:

graphql_1 | TypeError: Cannot read property 'definitions' of undefined
graphql_1 | at Object.getOperationAST (/usr/src/app/node_modules/graphql/utilities/getOperationAST.js:17:35)
graphql_1 | at isQueryOperation (/usr/src/app/node_modules/apollo-server-core/src/runHttpQuery.ts:26:24)
graphql_1 | at /usr/src/app/node_modules/apollo-server-core/src/runHttpQuery.ts:86:16
graphql_1 | at Array.map ()
graphql_1 | at Object. (/usr/src/app/node_modules/apollo-server-core/src/runHttpQuery.ts:77:59)
graphql_1 | at step (/usr/src/app/node_modules/apollo-server-core/dist/runHttpQuery.js:42:23)
graphql_1 | at Object.next (/usr/src/app/node_modules/apollo-server-core/dist/runHttpQuery.js:23:53)
graphql_1 | at fulfilled (/usr/src/app/node_modules/apollo-server-core/dist/runHttpQuery.js:14:58)
graphql_1 | at propagateAslWrapper (/usr/src/app/node_modules/async-listener/index.js:478:23)
graphql_1 | at /usr/src/app/node_modules/async-listener/glue.js:188:31

It should probably say:

message: "Graphql Apollo Engine APQ is not enabled"

[glasser]

You are definitely running apollo-server-core@1.3.6?

[billnbell]

I am running

"apollo-engine": "^1.1.0",
"apollo-server-express": "^1.3.6",

[glasser]

But what version of apollo-server-core (according to, say, npm ls | grep apollo-server-core)?

[billnbell]

npm ls | grep apollo-server-core
│ ├─┬ apollo-server-core@1.3.6

[glasser]

That's strange — this PR really should fix that. Can you share a small reproduction git repo that shows this happening?