Add config.graphql.path option

keystonejs · Sep 3, 2021 · ce9c2fc · ce9c2fc
1 parent f231178
commit ce9c2fc
Show file tree

Hide file tree

Showing 48 changed files with 73 additions and 25 deletions.
diff --git a/.changeset/sour-onions-serve.md b/.changeset/sour-onions-serve.md
@@ -0,0 +1,5 @@
+---
+'@keystone-next/keystone': minor
+---
+
+Added the config option `config.graphql.path` to configure the endpoint of the GraphQL API (default `'/api/graphql'`).
diff --git a/docs/pages/docs/apis/config.mdx b/docs/pages/docs/apis/config.mdx
@@ -287,6 +287,7 @@ Options:
   These can be filtered out with `apolloConfig.formatError` if you need to process them, but do not want them returned over the GraphQL API.
 - `queryLimits` (default: `undefined`): Allows you to limit the total number of results returned from a query to your GraphQL API.
   See also the per-list `graphql.queryLimits` option in the [Schema API](./schema).
+- `path` (default: `'/api/graphql'`): The path of the GraphQL API endpoint.
 - `apolloConfig` (default: `undefined`): Allows you to pass extra options into the `ApolloServer` constructor.
   - `playground` (default: `process.env.NODE_ENV !== 'production'`): If truthy, will enable the GraphQL Playground for testing queries and mutations in the browser.
     To configure behaviour, pass an object of [GraphQL Playground settings](https://github.com/graphql/graphql-playground#settings). See the [Apollo docs](https://www.apollographql.com/docs/apollo-server/api/apollo-server/#constructor) for more supported options.
@@ -297,6 +298,7 @@ export default config({
   graphql: {
     debug: process.env.NODE_ENV !== 'production',
     queryLimits: { maxTotalResults: 100 },
+    path: '/api/graphql',
     apolloConfig: {
       playground: process.env.NODE_ENV !== 'production',
       introspection: process.env.NODE_ENV !== 'production',

diff --git a/docs/pages/docs/walkthroughs/embedded-mode-with-sqlite-nextjs.mdx b/docs/pages/docs/walkthroughs/embedded-mode-with-sqlite-nextjs.mdx
@@ -132,7 +132,7 @@ Edit the `next.config.js` file in your project root with the following:
 - module.exports = {
 -   reactStrictMode: true,
 - }
- 
+
 + const { withKeystone } = require("@keystone-next/keystone/next");
 
 + module.exports = withKeystone({

diff --git a/examples-staging/assets-cloud/schema.graphql b/examples-staging/assets-cloud/schema.graphql
@@ -245,6 +245,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples-staging/assets-local/schema.graphql b/examples-staging/assets-local/schema.graphql
@@ -223,6 +223,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples-staging/auth/schema.graphql b/examples-staging/auth/schema.graphql
@@ -166,6 +166,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples-staging/basic/keystone.ts b/examples-staging/basic/keystone.ts
@@ -29,10 +29,6 @@ export default auth.withAuth(
       provider: 'sqlite',
       url: process.env.DATABASE_URL || 'file:./keystone-example.db',
     },
-    // NOTE -- this is not implemented, keystone currently always provides a graphql api at /api/graphql
-    // graphql: {
-    //   path: '/api/graphql',
-    // },
     ui: {
       // NOTE -- this is not implemented, keystone currently always provides an admin ui at /
       // path: '/admin',

diff --git a/examples-staging/basic/schema.graphql b/examples-staging/basic/schema.graphql
@@ -412,6 +412,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples-staging/ecommerce/schema.graphql b/examples-staging/ecommerce/schema.graphql
@@ -795,6 +795,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples-staging/embedded-nextjs/schema.graphql b/examples-staging/embedded-nextjs/schema.graphql
@@ -90,6 +90,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples-staging/graphql-api-endpoint/schema.graphql b/examples-staging/graphql-api-endpoint/schema.graphql
@@ -341,6 +341,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples-staging/playground/schema.graphql b/examples-staging/playground/schema.graphql
@@ -84,6 +84,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples-staging/roles/schema.graphql b/examples-staging/roles/schema.graphql
@@ -351,6 +351,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples-staging/sandbox/schema.graphql b/examples-staging/sandbox/schema.graphql
@@ -194,6 +194,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/blog/schema.graphql b/examples/blog/schema.graphql
@@ -212,6 +212,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/custom-admin-ui-logo/schema.graphql b/examples/custom-admin-ui-logo/schema.graphql
@@ -250,6 +250,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/custom-admin-ui-navigation/schema.graphql b/examples/custom-admin-ui-navigation/schema.graphql
@@ -250,6 +250,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/custom-admin-ui-pages/schema.graphql b/examples/custom-admin-ui-pages/schema.graphql
@@ -250,6 +250,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/custom-field-view/schema.graphql b/examples/custom-field-view/schema.graphql
@@ -253,6 +253,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/custom-field/schema.graphql b/examples/custom-field/schema.graphql
@@ -186,6 +186,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/default-values/schema.graphql b/examples/default-values/schema.graphql
@@ -250,6 +250,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/document-field/schema.graphql b/examples/document-field/schema.graphql
@@ -197,6 +197,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/extend-graphql-schema/schema.graphql b/examples/extend-graphql-schema/schema.graphql
@@ -205,6 +205,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/json/schema.graphql b/examples/json/schema.graphql
@@ -175,6 +175,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/task-manager/schema.graphql b/examples/task-manager/schema.graphql
@@ -250,6 +250,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/testing/schema.graphql b/examples/testing/schema.graphql
@@ -307,6 +307,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/virtual-field/schema.graphql b/examples/virtual-field/schema.graphql
@@ -194,6 +194,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/examples/with-auth/schema.graphql b/examples/with-auth/schema.graphql
@@ -307,6 +307,7 @@ type KeystoneMeta {
 }
 
 type KeystoneAdminMeta {
+  apiPath: String!
   enableSignout: Boolean!
   enableSessionItem: Boolean!
   lists: [KeystoneAdminUIListMeta!]!

diff --git a/...ages/keystone/src/___internal-do-not-use-will-break-in-patch/admin-ui/pages/App/index.tsx b/...ages/keystone/src/___internal-do-not-use-will-break-in-patch/admin-ui/pages/App/index.tsx
@@ -11,6 +11,7 @@ type AppConfig = {
   adminMetaHash: string;
   fieldViews: FieldViews;
   lazyMetadataQuery: DocumentNode;
+  apiPath: string;
 };
 
 export const getApp =

diff --git a/packages/keystone/src/___internal-do-not-use-will-break-in-patch/next-graphql.ts b/packages/keystone/src/___internal-do-not-use-will-break-in-patch/next-graphql.ts
@@ -19,5 +19,5 @@ export function nextGraphQLAPIRoute(keystoneConfig: KeystoneConfig, prismaClient
     connectionPromise: keystone.connect(),
   });
 
-  return apolloServer.createHandler({ path: '/api/graphql' });
+  return apolloServer.createHandler({ path: keystoneConfig.graphql?.path || '/api/graphql' });
 }
diff --git a/packages/keystone/src/admin-ui/admin-meta-graphql.ts b/packages/keystone/src/admin-ui/admin-meta-graphql.ts
@@ -7,6 +7,7 @@ export const staticAdminMetaQuery = gql`
       __typename
       adminMeta {
         __typename
+        apiPath
         enableSignout
         enableSessionItem
         lists {
@@ -65,7 +66,7 @@ export type StaticAdminMetaQuery = { __typename?: 'Query' } & {
   keystone: { __typename: 'KeystoneMeta' } & {
     adminMeta: { __typename: 'KeystoneAdminMeta' } & Pick<
       KeystoneAdminMeta,
-      'enableSignout' | 'enableSessionItem'
+      'apiPath' | 'enableSignout' | 'enableSessionItem'
     > & {
         lists: Array<
           { __typename: 'KeystoneAdminUIListMeta' } & Pick<
@@ -124,6 +125,7 @@ type KeystoneMeta = {
 
 type KeystoneAdminMeta = {
   __typename: 'KeystoneAdminMeta';
+  apiPath: Scalars['String'];
   enableSignout: Scalars['Boolean'];
   enableSessionItem: Scalars['Boolean'];
   lists: Array<KeystoneAdminUIListMeta>;

diff --git a/packages/keystone/src/admin-ui/components/Navigation.tsx b/packages/keystone/src/admin-ui/components/Navigation.tsx
@@ -61,6 +61,8 @@ export const NavItem = ({ href, children, isSelected: _isSelected }: NavItemProp
 };
 
 const AuthenticatedItemDialog = ({ item }: { item: AuthenticatedItem | undefined }) => {
+  const { adminMeta } = useKeystone();
+  const { apiPath } = adminMeta;
   const { spacing, typography } = useTheme();
   return (
     <div
@@ -96,7 +98,7 @@ const AuthenticatedItemDialog = ({ item }: { item: AuthenticatedItem | undefined
       >
         <Stack gap="medium" padding="large" dividers="between">
           {/* FIXME: Use config.graphql.path */}
-          <PopoverLink target="_blank" href="/api/graphql">
+          <PopoverLink target="_blank" href={apiPath}>
             API Explorer
           </PopoverLink>
           <PopoverLink target="_blank" href="https://github.com/keystonejs/keystone">

diff --git a/packages/keystone/src/admin-ui/context.tsx b/packages/keystone/src/admin-ui/context.tsx
@@ -24,6 +24,7 @@ type KeystoneContextType = {
   visibleLists: VisibleLists;
   createViewFieldModes: CreateViewFieldModes;
   reinitContext: () => void;
+  apiPath: String;
 };
 
 const KeystoneContext = createContext<KeystoneContextType | undefined>(undefined);
@@ -34,6 +35,7 @@ type KeystoneProviderProps = {
   adminMetaHash: string;
   fieldViews: FieldViews;
   lazyMetadataQuery: DocumentNode;
+  apiPath: string;
 };
 
 function InternalKeystoneProvider({
@@ -42,6 +44,7 @@ function InternalKeystoneProvider({
   adminMetaHash,
   children,
   lazyMetadataQuery,
+  apiPath,
 }: KeystoneProviderProps) {
   const adminMeta = useAdminMeta(adminMetaHash, fieldViews);
   const { authenticatedItem, visibleLists, createViewFieldModes, refetch } =
@@ -70,6 +73,7 @@ function InternalKeystoneProvider({
             reinitContext,
             visibleLists,
             createViewFieldModes,
+            apiPath,
           }}
         >
           {children}
@@ -84,10 +88,9 @@ export const KeystoneProvider = (props: KeystoneProviderProps) => {
     () =>
       new ApolloClient({
         cache: new InMemoryCache(),
-        // FIXME: Use config.graphql.path
-        link: createUploadLink({ uri: '/api/graphql' }),
+        link: createUploadLink({ uri: props.apiPath }),
       }),
-    []
+    [props.apiPath]
   );
 
   return (

diff --git a/packages/keystone/src/admin-ui/system/createAdminMeta.ts b/packages/keystone/src/admin-ui/system/createAdminMeta.ts
@@ -9,6 +9,7 @@ export function createAdminMeta(
 ) {
   const { ui, lists, session } = config;
   const adminMetaRoot: AdminMetaRootVal = {
+    apiPath: config.graphql?.path || '/api/graphql',
     enableSessionItem: ui?.enableSessionItem || false,
     enableSignout: session !== undefined,
     listsByKey: {},

diff --git a/packages/keystone/src/admin-ui/system/createAdminUIServer.ts b/packages/keystone/src/admin-ui/system/createAdminUIServer.ts
@@ -4,13 +4,14 @@ import type { KeystoneConfig, SessionStrategy, CreateContext } from '../../types
 import { createSessionContext } from '../../session';
 
 export const createAdminUIServer = async (
-  ui: KeystoneConfig['ui'],
+  config: KeystoneConfig,
   createContext: CreateContext,
   dev: boolean,
   projectAdminPath: string,
   sessionStrategy?: SessionStrategy<any>
 ) => {
   /** We do this to stop webpack from bundling next inside of next */
+  const { ui, graphql } = config;
   const thing = 'next';
   const next = require(thing);
   const app = next({ dev, dir: projectAdminPath });
@@ -20,7 +21,7 @@ export const createAdminUIServer = async (
   const publicPages = ui?.publicPages ?? [];
   return async (req: express.Request, res: express.Response) => {
     const { pathname } = url.parse(req.url);
-    if (pathname?.startsWith('/_next') || pathname === '/api/graphql') {
+    if (pathname?.startsWith('/_next') || pathname === (graphql?.path || '/api/graphql')) {
       handle(req, res);
       return;
     }

diff --git a/packages/keystone/src/admin-ui/system/getAdminMetaSchema.ts b/packages/keystone/src/admin-ui/system/getAdminMetaSchema.ts
@@ -257,6 +257,9 @@ export function getAdminMetaSchema({
   const adminMeta = graphql.object<AdminMetaRootVal>()({
     name: 'KeystoneAdminMeta',
     fields: {
+      apiPath: graphql.field({
+        type: graphql.nonNull(graphql.String),
+      }),
       enableSignout: graphql.field({
         type: graphql.nonNull(graphql.Boolean),
       }),

diff --git a/packages/keystone/src/admin-ui/templates/api.ts b/packages/keystone/src/admin-ui/templates/api.ts
@@ -18,5 +18,5 @@ export const config = {
     bodyParser: false,
   },
 };
-export default apolloServer.createHandler({ path: '/api/graphql' });
+export default apolloServer.createHandler({ path: initializedKeystoneConfig.graphql?.path || '/api/graphql' });
 `;
diff --git a/packages/keystone/src/admin-ui/templates/app.ts b/packages/keystone/src/admin-ui/templates/app.ts
@@ -53,7 +53,8 @@ export default getApp({
   lazyMetadataQuery: ${JSON.stringify(getLazyMetadataQuery(graphQLSchema, adminMeta))},
   fieldViews: [${allViews.map((_, i) => `view${i}`)}],
   adminMetaHash: "${adminMetaQueryResultHash}",
-  adminConfig: adminConfig
+  adminConfig: adminConfig,
+  apiPath: "${adminMetaRootVal.apiPath}",
 });
 `;
   // -- TEMPLATE END