Merge previous breaking changes (#8776)

Co-authored-by: Daniel Cousens <[email protected]>
Co-authored-by: Josh Calder <[email protected]>

Author: dcousens

.changeset/fix-frozen-prisma.md

@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': major
+---
+
+Fix `keystone prisma` behaviour to respect `--frozen`, dont generate types or Prisma client when using `--frozen`

.changeset/more-errors-please.md

@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': minor
+---
+
+`KS_PRISMA_ERRORS` are now logged with `console.error` on the server

packages/core/src/lib/createSystem.ts

@@ -156,6 +156,8 @@ function injectNewDefaults (prismaClient: unknown, lists: Record<string, Initial
         try {
           return await query(args)
         } catch (e: any) {
+          console.error(e)
+
           if ((e as any).code === undefined) {
             return new GraphQLError(`Prisma error`, {
               extensions: {

packages/core/src/scripts/prisma.ts

@@ -5,8 +5,10 @@ import {
   getBuiltKeystoneConfiguration
 } from '../lib/createSystem'
 import {
+  generateArtifacts,
+  generatePrismaClient,
+  generateTypes,
   validateArtifacts,
-  generatePrismaClient
 } from '../artifacts'
 import { getEsbuildConfig } from '../lib/esbuild'
 import { ExitError } from './utils'
@@ -21,8 +23,17 @@ export async function prisma (cwd: string, args: string[], frozen: boolean) {
   // TODO: this cannot be changed for now, circular dependency with getSystemPaths, getEsbuildConfig
   const config = getBuiltKeystoneConfiguration(cwd)
   const system = createSystem(config)
-  await validateArtifacts(cwd, system)
-  await generatePrismaClient(cwd, system)
+
+  if (frozen) {
+    await validateArtifacts(cwd,  system)
+    console.log('✨ GraphQL and Prisma schemas are up to date')
+  } else {
+    await generateArtifacts(cwd, system)
+    console.log('✨ Generated GraphQL and Prisma schemas')
+
+    await generatePrismaClient(cwd, system)
+    await generateTypes(cwd, system)
+  }
 
   return new Promise<void>((resolve, reject) => {
     const p = spawn('node', [require.resolve('prisma'), ...args], {

tests/cli-tests/__snapshots__/prisma.test.ts.snap

@@ -0,0 +1,61 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`keystone prisma exits with the same code as the prisma child process exits with 1`] = `
+"? Generated GraphQL and Prisma schemas
+
+! Unknown command "bad-thing"
+
+?  Prisma is a modern DB toolkit to query, migrate and model your database (https://prisma.io)
+
+Usage
+
+  $ prisma [command]
+
+Commands
+
+            init   Set up Prisma for your app
+        generate   Generate artifacts (e.g. Prisma Client)
+              db   Manage your database schema and lifecycle
+         migrate   Migrate your database
+          studio   Browse your data with Prisma Studio
+        validate   Validate your Prisma schema
+          format   Format your Prisma schema
+
+Flags
+
+     --preview-feature   Run Preview Prisma commands
+
+Examples
+
+  Set up a new Prisma project
+  $ prisma init
+
+  Generate artifacts (e.g. Prisma Client)
+  $ prisma generate
+
+  Browse your data
+  $ prisma studio
+
+  Create migrations from your Prisma schema, apply them to the database, generate artifacts (e.g. Prisma Client)
+  $ prisma migrate dev
+
+  Pull the schema from an existing database, updating the Prisma schema
+  $ prisma db pull
+
+  Push the Prisma schema state to the database
+  $ prisma db push
+
+  Validate your Prisma schema
+  $ prisma validate
+
+  Format your Prisma schema
+  $ prisma format
+"
+`;
+
+exports[`keystone prisma uses the db url in the keystone config 1`] = `
+"? Generated GraphQL and Prisma schemas
+Prisma schema loaded from schema.prisma
+Datasource "sqlite": SQLite database "app.db" at "file:./app.db"
+Error: P1003: Database app.db does not exist at ./app.db"
+`;

tests/cli-tests/artifacts.test.ts

@@ -9,22 +9,34 @@ import {
   testdir,
 } from './utils'
 
-describe.each(['postinstall', ['build', '--frozen'], ['prisma', 'migrate', 'status']])(
-  '%s',
-  command => {
-    test('logs an error and exits with 1 when the schemas do not exist', async () => {
-      const tmp = await testdir({
-        ...symlinkKeystoneDeps,
-        'keystone.js': basicKeystoneConfig,
-      })
-      const recording = recordConsole()
-      await expect(runCommand(tmp, command)).rejects.toEqual(new ExitError(1))
-      expect(recording()).toMatchInlineSnapshot(
-        `"Your Prisma and GraphQL schemas are not up to date"`
-      )
+describe.each(['postinstall', ['build', '--frozen']])('%s', command => {
+  test('logs an error and exits with 1 when the schemas do not exist', async () => {
+    const tmp = await testdir({
+      ...symlinkKeystoneDeps,
+      'keystone.js': basicKeystoneConfig,
+    })
+
+    const recording = recordConsole()
+    await expect(runCommand(tmp, command)).rejects.toEqual(new ExitError(1))
+
+    expect(recording()).toMatchInlineSnapshot(`"Your Prisma and GraphQL schemas are not up to date"`)
+  })
+})
+
+describe('prisma migrate status', () => {
+  test('logs an error and exits with 1 when the schemas do not exist', async () => {
+    const tmp = await testdir({
+      ...symlinkKeystoneDeps,
+      'keystone.js': basicKeystoneConfig,
     })
-  }
-)
+    await expect(runCommand(tmp, ['build', '--no-ui', '--frozen'])).rejects.toEqual(new ExitError(1))
+
+    const recording = recordConsole()
+    await expect(runCommand(tmp, ['prisma', '--frozen', 'migrate', 'status'])).rejects.toEqual(new ExitError(1))
+
+    expect(recording()).toMatchInlineSnapshot(`"Your Prisma and GraphQL schemas are not up to date"`)
+  })
+})
 
 const schemasMatch = ['schema.prisma', 'schema.graphql']
 
@@ -37,9 +49,11 @@ describe('postinstall', () => {
       ...symlinkKeystoneDeps,
       'keystone.js': basicKeystoneConfig,
     })
+
     const recording = recordConsole()
     await runCommand(tmp, ['postinstall', '--fix'])
     const files = await getFiles(tmp, schemasMatch)
+
     expect(files).toEqual(await getFiles(`${__dirname}/fixtures/basic-project`, schemasMatch))
     expect(recording()).toMatchInlineSnapshot(`"? Generated GraphQL and Prisma schemas"`)
   })
@@ -50,9 +64,11 @@ describe('postinstall', () => {
       ...schemas,
       'keystone.js': basicKeystoneConfig,
     })
+
     const recording = recordConsole()
     await runCommand(tmp, 'postinstall')
     const files = await getFiles(tmp, schemasMatch)
+
     expect(files).toEqual(await getFiles(`${__dirname}/fixtures/basic-project`, schemasMatch))
     expect(recording()).toMatchInlineSnapshot(`"? GraphQL and Prisma schemas are up to date"`)
   })
@@ -63,8 +79,10 @@ describe('postinstall', () => {
       ...schemas,
       'keystone.js': basicKeystoneConfig,
     })
+
     const recording = recordConsole()
     await runCommand(tmp, 'postinstall')
+
     expect(await getFiles(tmp, ['node_modules/.keystone/**/*'])).toMatchSnapshot()
     expect(recording()).toMatchInlineSnapshot(`"? GraphQL and Prisma schemas are up to date"`)
   })

tests/cli-tests/migrations.test.ts

@@ -250,7 +250,8 @@ describe('useMigrations: false', () => {
     }
 
     expect(recording()).toMatchInlineSnapshot(`
-      "? Starting Keystone
+      "? Generated GraphQL and Prisma schemas
+      ? Starting Keystone
       ? Server listening on :3000 (http://localhost:3000/)
       ? GraphQL API available at /api/graphql
       ? Generating GraphQL and Prisma schemas

tests/cli-tests/prisma.test.ts

@@ -14,57 +14,7 @@ test('keystone prisma exits with the same code as the prisma child process exits
     all: true,
     cwd: tmp,
   })
-  expect(result.all!.replace(/[^ -~\n]/g, '?')).toMatchInlineSnapshot(`
-    "
-    ! Unknown command "bad-thing"
-
-    ?  Prisma is a modern DB toolkit to query, migrate and model your database (https://prisma.io)
-
-    Usage
-
-      $ prisma [command]
-
-    Commands
-
-                init   Set up Prisma for your app
-            generate   Generate artifacts (e.g. Prisma Client)
-                  db   Manage your database schema and lifecycle
-             migrate   Migrate your database
-              studio   Browse your data with Prisma Studio
-            validate   Validate your Prisma schema
-              format   Format your Prisma schema
-    
-    Flags
-
-         --preview-feature   Run Preview Prisma commands
-
-    Examples
-
-      Set up a new Prisma project
-      $ prisma init
-
-      Generate artifacts (e.g. Prisma Client)
-      $ prisma generate
-
-      Browse your data
-      $ prisma studio
-
-      Create migrations from your Prisma schema, apply them to the database, generate artifacts (e.g. Prisma Client)
-      $ prisma migrate dev
-      
-      Pull the schema from an existing database, updating the Prisma schema
-      $ prisma db pull
-
-      Push the Prisma schema state to the database
-      $ prisma db push
-
-      Validate your Prisma schema
-      $ prisma validate
-
-      Format your Prisma schema
-      $ prisma format
-    "
-  `)
+  expect(result.all!.replace(/[^ -~\n]/g, '?').replace(/  \n/g, '\n')).toMatchSnapshot()
   expect(result.exitCode).toBe(1)
 })
 
@@ -79,10 +29,6 @@ test('keystone prisma uses the db url in the keystone config', async () => {
     all: true,
     cwd: tmp,
   })
-  expect(result.all).toMatchInlineSnapshot(`
-    "Prisma schema loaded from schema.prisma
-    Datasource "sqlite": SQLite database "app.db" at "file:./app.db"
-    Error: P1003: Database app.db does not exist at ./app.db"
-  `)
+  expect(result.all!.replace(/[^ -~\n]/g, '?').replace(/  \n/g, '\n')).toMatchSnapshot()
   expect(result.exitCode).toBe(1)
 })