Add db.prismaPath configuration (#8307)

Co-authored-by: Daniel Cousens <dcousens@users.noreply.github.com>
Co-authored-by: Daniel Cousens <413395+dcousens@users.noreply.github.com>

.changeset/depend-on-me.md

@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': major
+---
+
+Removes assumptions about `@prisma/client` output location, with a new `db.prismaPath` configuration option to set where to import the Prisma client from

examples/assets-local/keystone.ts

@@ -1,10 +1,14 @@
 import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 
 export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   lists,
   storage: {

examples/assets-local/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Post {

examples/assets-s3/keystone.ts

@@ -1,5 +1,6 @@
 import { config } from '@keystone-6/core';
 import dotenv from 'dotenv';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 
 dotenv.config();
@@ -15,6 +16,9 @@ export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   lists,
   storage: {

examples/assets-s3/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Post {

examples/auth/keystone.ts

@@ -1,6 +1,7 @@
 import { config } from '@keystone-6/core';
 import { statelessSessions } from '@keystone-6/core/session';
 import { createAuth } from '@keystone-6/auth';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 
 // WARNING: this example is for demonstration purposes only
@@ -59,6 +60,9 @@ export default withAuth(
     db: {
       provider: 'sqlite',
       url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+      // WARNING: this is only needed for our monorepo examples, dont do this
+      ...fixPrismaPath,
     },
     lists,
     session,

examples/auth/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model User {

examples/custom-admin-ui-logo/keystone.ts

@@ -1,10 +1,14 @@
 import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 
 export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   lists,
   ui: {},

examples/custom-admin-ui-logo/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Task {

examples/custom-admin-ui-navigation/keystone.ts

@@ -1,10 +1,14 @@
 import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 
 export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   lists,
 });

examples/custom-admin-ui-navigation/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Task {

examples/custom-admin-ui-pages/keystone.ts

@@ -1,10 +1,14 @@
 import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 
 export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   lists,
 });

examples/custom-admin-ui-pages/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Task {

examples/custom-field-view/keystone.ts

@@ -1,10 +1,14 @@
 import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 
 export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   lists,
 });

examples/custom-field-view/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Task {

examples/custom-field/keystone.ts

@@ -1,10 +1,14 @@
 import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 
 export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   lists,
 });

examples/custom-field/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Post {

examples/custom-session-validation/keystone.ts

@@ -2,6 +2,7 @@ import { KeystoneConfig, SessionStrategy } from '@keystone-6/core/types';
 import { config } from '@keystone-6/core';
 import { statelessSessions } from '@keystone-6/core/session';
 import { createAuth } from '@keystone-6/auth';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 
 // createAuth configures signin functionality based on the config below. Note this only implements
@@ -91,6 +92,9 @@ export default myAuth(
       db: {
         provider: 'sqlite',
         url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+        // WARNING: this is only needed for our monorepo examples, dont do this
+        ...fixPrismaPath,
       },
       lists,
       // We add our session configuration to the system here.

examples/custom-session-validation/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Task {

examples/default-values/keystone.ts

@@ -1,10 +1,14 @@
 import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 
 export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   lists,
 });

examples/default-values/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Task {

examples/document-field-customisation/keystone-server/keystone.ts

@@ -1,5 +1,6 @@
 import { config } from '@keystone-6/core';
 import type { KeystoneConfig } from '@keystone-6/core/types';
+import { fixPrismaPath } from '../../example-utils';
 import { seedDatabase } from './src/seed';
 import { lists } from './src/schema';
 import { Context, TypeInfo } from '.keystone/types';
@@ -12,6 +13,9 @@ const db: KeystoneConfig<TypeInfo>['db'] = {
       await seedDatabase(context);
     }
   },
+
+  // WARNING: this is only needed for our monorepo examples, dont do this
+  ...fixPrismaPath,
 };
 
 export default config({

examples/document-field-customisation/keystone-server/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model User {

examples/document-field/keystone.ts

@@ -1,10 +1,14 @@
 import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 
 export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   lists,
 });

examples/document-field/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Post {

examples/example-utils.ts

@@ -0,0 +1,10 @@
+// our monorepo examples have their @prisma/client dependencies hoisted
+//   to build them and use them without conflict, we need to ensure .prisma/client
+//   resolves to somewhere else
+//
+//   we use node_modules/.myprisma to differentiate from node_modules/.prisma, but
+//   still use node_modules/... to skip the painful experience that is jest/babel
+//   transforms
+export const fixPrismaPath = {
+  prismaPath: 'node_modules/.myprisma/client',
+};

examples/extend-express-app/keystone.ts

@@ -1,11 +1,15 @@
 import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
 import { lists } from './schema';
 import { getTasks } from './routes/tasks';
 
 export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   server: {
     /*

examples/extend-express-app/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Task {

examples/extend-express-app/seed-data.tsx

@@ -1,7 +1,7 @@
 import { getContext } from '@keystone-6/core/context';
 import { persons, tasks } from '../example-data';
 import config from './keystone';
-import * as PrismaModule from '.prisma/client';
+import * as PrismaModule from '.myprisma/client';
 
 type PersonProps = {
   name: string;

examples/extend-graphql-schema-graphql-tools/keystone.ts

@@ -1,10 +1,14 @@
 import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
 import { lists, extendGraphqlSchema } from './schema';
 
 export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   lists,
   extendGraphqlSchema,

examples/extend-graphql-schema-graphql-tools/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Post {

examples/extend-graphql-schema-graphql-ts/keystone.ts

@@ -1,10 +1,14 @@
 import { config } from '@keystone-6/core';
+import { fixPrismaPath } from '../example-utils';
 import { lists, extendGraphqlSchema } from './schema';
 
 export default config({
   db: {
     provider: 'sqlite',
     url: process.env.DATABASE_URL || 'file:./keystone-example.db',
+
+    // WARNING: this is only needed for our monorepo examples, dont do this
+    ...fixPrismaPath,
   },
   lists,
   extendGraphqlSchema,

examples/extend-graphql-schema-graphql-ts/schema.prisma

@@ -9,7 +9,7 @@ datasource sqlite {
 
 generator client {
   provider = "prisma-client-js"
-  output   = "node_modules/.prisma/client"
+  output   = "node_modules/.myprisma/client"
 }
 
 model Post {