test(client): add relationMode datasource property tests for all databases

docker/docker-compose.yml

@@ -30,6 +30,57 @@ services:
     ports:
       - '26257:26257'
 
+  # Planetscale
+  # From https://github.com/prisma/prisma-engines/blob/976a00ae3c30ab9507fa742986c9c6f5327ba10f/docker-compose.yml
+
+  #  vitess-test-5_7:
+  #     image: vitess/vttestserver:mysql57@sha256:2b132a22d08b3b227d9391f8f58ed7ab5c081ca07bf0f87a0c166729124d360a
+  #     restart: always
+  #     ports:
+  #       - 33577:33577
+  #     environment:
+  #       PORT: 33574
+  #       KEYSPACES: "test"
+  #       NUM_SHARDS: "1"
+  #       MYSQL_BIND_HOST: "0.0.0.0"
+  #       FOREIGN_KEY_MODE: "disallow"
+
+  vitess-test-8_0:
+    image: vitess/vttestserver:mysql80@sha256:9412e3d51bde38e09c3039090b5c68808e299579f12c79178a4ec316f7831889
+    restart: always
+    ports:
+      - 33807:33807
+    environment:
+      PORT: 33804
+      KEYSPACES: 'test'
+      NUM_SHARDS: '1'
+      MYSQL_BIND_HOST: '0.0.0.0'
+      FOREIGN_KEY_MODE: 'disallow'
+
+  # vitess-shadow-5_7:
+  #   image: vitess/vttestserver:mysql57@sha256:2b132a22d08b3b227d9391f8f58ed7ab5c081ca07bf0f87a0c166729124d360a
+  #   restart: always
+  #   ports:
+  #     - 33578:33577
+  #   environment:
+  #     PORT: 33574
+  #     KEYSPACES: "shadow"
+  #     NUM_SHARDS: "1"
+  #     MYSQL_BIND_HOST: "0.0.0.0"
+  #     FOREIGN_KEY_MODE: "disallow"
+  #
+  # vitess-shadow-8_0:
+  #   image: vitess/vttestserver:mysql80@sha256:9412e3d51bde38e09c3039090b5c68808e299579f12c79178a4ec316f7831889
+  #   restart: always
+  #   ports:
+  #     - 33808:33807
+  #   environment:
+  #     PORT: 33804
+  #     KEYSPACES: 'shadow'
+  #     NUM_SHARDS: '1'
+  #     MYSQL_BIND_HOST: '0.0.0.0'
+  #     FOREIGN_KEY_MODE: 'disallow'
+
   mysql:
     image: mysql:8.0
     command: --default-authentication-plugin=mysql_native_password --lower_case_table_names=1

packages/client/tests/functional/_utils/getTestSuiteInfo.ts

@@ -6,7 +6,7 @@ import { merge } from '../../../../../helpers/blaze/merge'
 import { MatrixTestHelper } from './defineMatrix'
 import type { TestSuiteMeta } from './setupTestSuiteMatrix'
 
-export type TestSuiteMatrix = { [K in string]: string }[][]
+export type TestSuiteMatrix = { [K in string]: string | Record<string, string> }[][]
 export type TestSuiteConfig = ReturnType<typeof getTestSuiteConfigs>[number]
 
 type MatrixModule = (() => TestSuiteMatrix) | MatrixTestHelper<TestSuiteMatrix>

packages/client/tests/functional/jest.config.js

@@ -21,7 +21,7 @@ module.exports = () => {
     globalSetup: './_utils/globalSetup.js',
     snapshotSerializers: ['@prisma/internals/src/utils/jestSnapshotSerializer'],
     setupFilesAfterEnv: ['./_utils/setupFilesAfterEnv.ts'],
-    testTimeout: 40000,
+    testTimeout: 10_000,
     collectCoverage: process.env.CI ? true : false,
   }
 

packages/client/tests/functional/referential-integrity/_matrix.ts

@@ -0,0 +1,121 @@
+import { defineMatrix } from '../_utils/defineMatrix'
+import { Providers } from '../_utils/providers'
+
+const RI = process.env.RI
+if (RI && RI !== 'prisma' && RI !== 'foreignKeys') {
+  throw new Error(`RI must be either "prisma" or "foreignKeys" but was "${RI}"`)
+}
+
+type RIType = 'prisma' | 'foreignKeys' | ''
+const referentialIntegrity: RIType = (RI as RIType) || ''
+
+// Note: testing 'SetDefault' requires a relation with a scalar field having the "@default" attribute.
+// If no defaults are provided for any of the scalar fields, a runtime error will be thrown.
+//
+// Note: 'Restrict' is not available when using 'sqlserver' as a provider, and it triggers a schema parsing error arising from DMMF.
+//
+// Note: 'SetNull' is only available on optional relations.
+//
+// Note: 'SetDefault' is making SQL Server crash badly
+//  const referentialActionsChoices = ['', 'Cascade', 'NoAction']
+
+// TODO: generate the referentialActions combinations matrix outside, and merge it to the defined matrix below
+type ReferentialActions = 'DEFAULT' | 'Cascade' | 'Restrict' | 'NoAction' | 'SetNull' | 'SetDefault'
+
+/**
+ * [foreignKeys] Tests with referential actions that are passing on Postgres, CockroachDB, MySQL, and SQL Server:
+ * - [x] DEFAULT
+ * - [x] Cascade
+ * - [x] NoAction
+ *
+ * SetNull causes Rust panics on MySQL, and SQL Server.
+ * On CockroachDB, it causes jest to to timeout.
+ * On Postgres, it runs fine.
+ *
+ * SetDefault causes Rust panics on SQL Server.
+ * On CockroachDB, it causes jest to to timeout.
+ * On Postgres and MySQL, it runs fine.
+ */
+
+const onUpdate: ReferentialActions | string = 'DEFAULT'
+const onDelete: ReferentialActions | string = 'DEFAULT'
+// const onUpdate: ReferentialActions | string = 'Cascade'
+// const onDelete: ReferentialActions | string = 'Cascade'
+// const onUpdate: ReferentialActions | string = 'Restrict'
+// const onDelete: ReferentialActions | string = 'Restrict'
+// const onUpdate: ReferentialActions | string = 'NoAction'
+// const onDelete: ReferentialActions | string = 'NoAction'
+// const onUpdate: ReferentialActions | string = 'SetNull'
+// const onDelete: ReferentialActions | string = 'SetNull'
+// const onUpdate: ReferentialActions | string = 'SetDefault'
+// const onDelete: ReferentialActions | string = 'SetDefault'
+
+// figure out how to separate the test
+
+// TODO: fix mysql issues with Restrict
+export default defineMatrix(() => [
+  [
+    {
+      provider: Providers.POSTGRESQL,
+      id: 'String @id',
+      referentialIntegrity,
+      referentialActions: {
+        onUpdate,
+        onDelete,
+      },
+    },
+    {
+      provider: Providers.COCKROACHDB,
+      id: 'String @id',
+      referentialIntegrity,
+      referentialActions: {
+        onUpdate,
+        onDelete,
+      },
+    },
+    {
+      provider: Providers.MYSQL,
+      id: 'String @id',
+      referentialIntegrity,
+      referentialActions: {
+        onUpdate,
+        onDelete,
+      },
+    },
+    {
+      provider: Providers.SQLSERVER,
+      id: 'String @id',
+      referentialIntegrity,
+      referentialActions: {
+        // Restrict is not supported by SQL Server
+        // TODO we should not run the test intead of switching to default
+        onUpdate: onUpdate === 'Restrict' ? '' : onUpdate,
+        onDelete: onDelete === 'Restrict' ? '' : onDelete,
+      },
+    },
+    {
+      provider: Providers.SQLITE,
+      id: 'String @id',
+      referentialIntegrity,
+      referentialActions: {
+        onUpdate,
+        onDelete,
+      },
+    },
+    {
+      provider: Providers.MONGODB,
+      id: 'String @id @map("_id")',
+      referentialIntegrity,
+      referentialActions: {
+        // Note: on MongoDB SetDefault is not supported
+        onUpdate: onUpdate === 'SetDefault' ? '' : onUpdate,
+        onDelete: onDelete === 'SetDefault' ? '' : onDelete,
+      },
+    },
+  ],
+  [
+    {
+      previewFeatures: '"referentialIntegrity"',
+    },
+  ],
+])

packages/client/tests/functional/referential-integrity/_utils.ts

@@ -0,0 +1,9 @@
+// @ts-ignore this is just for type checks
+declare let prisma: import('@prisma/client').PrismaClient
+
+export async function checkIfEmpty(...models: unknown[]) {
+  const checkEmptyArr = await prisma.$transaction(models.map((model) => prisma[model].findMany()))
+  checkEmptyArr.forEach((checkEmpty) => {
+    expect(checkEmpty).toHaveLength(0)
+  })
+}

packages/client/tests/functional/referential-integrity/prisma/_schema.ts

@@ -0,0 +1,129 @@
+import { Providers } from '../../_utils/providers'
+import testMatrix from '../_matrix'
+
+const PLANETSCALE = false
+// const PLANETSCALE = true
+
+export default testMatrix.setupSchema(({ provider, previewFeatures, referentialIntegrity, referentialActions, id }) => {
+  // if referentialIntegrity is not defined, we do not add the line
+  // if referentialIntegrity is defined
+  // we add the line only if the provider is not MongoDB, since MongoDB doesn't need the setting, it's on by default
+  const referentialIntegrityLine =
+    provider === Providers.MONGODB || !referentialIntegrity ? '' : `referentialIntegrity = "${referentialIntegrity}"`
+
+  const schemaHeader = /* Prisma */ `
+generator client {
+  provider = "prisma-client-js"
+  previewFeatures = [${previewFeatures}]
+}
+
+datasource db {
+  provider = "${provider}"
+  ${
+    PLANETSCALE && provider === Providers.MYSQL
+      ? `url = "mysql://root:root@127.0.0.1:33807/PRISMA_DB_NAME"`
+      : `url = env("DATABASE_URI_${provider}")`
+  }
+  ${referentialIntegrityLine}
+}
+  `
+
+  let referentialActionLine = ''
+  if (referentialActions.onUpdate && referentialActions.onUpdate !== 'DEFAULT') {
+    referentialActionLine += `, onUpdate: ${referentialActions.onUpdate}`
+  }
+  if (referentialActions.onDelete && referentialActions.onDelete !== 'DEFAULT') {
+    referentialActionLine += `, onDelete: ${referentialActions.onDelete}`
+  }
+
+  const manyToManySQLExplicit = /* Prisma */ `
+model PostManyToMany {
+  id         ${id}
+  categories CategoriesOnPostsManyToMany[]
+  published   Boolean?
+}
+
+model CategoryManyToMany {
+  id    ${id}
+  posts CategoriesOnPostsManyToMany[]
+  published   Boolean?
+}
+
+model CategoriesOnPostsManyToMany {
+  post       PostManyToMany     @relation(fields: [postId], references: [id]${referentialActionLine})
+  postId     String
+  category   CategoryManyToMany @relation(fields: [categoryId], references: [id]${referentialActionLine})
+  categoryId String
+
+  @@id([postId, categoryId])
+}
+`
+
+  const manyToManySQLImplicit = /* Prisma */ `
+model PostManyToMany {
+  id         String        @id 
+  categories CategoryManyToMany[]
+  published   Boolean?
+}
+
+model CategoryManyToMany {
+  id    String    @id 
+  posts PostManyToMany[]
+  published   Boolean?
+}
+`
+
+  const manyToManyMongoDB = /* Prisma */ `
+model PostManyToMany {
+  id          String     @id @map("_id")
+  categoryIDs String[]
+  categories  CategoryManyToMany[] @relation(fields: [categoryIDs], references: [id])
+  published   Boolean?
+}
+
+model CategoryManyToMany {
+  id      String   @id @map("_id") 
+  postIDs String[]
+  posts   PostManyToMany[]   @relation(fields: [postIDs], references: [id])
+  published   Boolean?
+}
+`
+
+  return /* Prisma */ `
+${schemaHeader}
+
+//
+// 1:1 relation
+//
+model UserOneToOne {
+  id      ${id}
+  profile ProfileOneToOne?
+  enabled Boolean?
+}
+model ProfileOneToOne {
+  id       ${id}
+  user     UserOneToOne @relation(fields: [userId], references: [id]${referentialActionLine})
+  userId   String @unique
+  enabled Boolean?
+}
+
+//
+// 1:n relation
+//
+model UserOneToMany {
+  id    ${id}
+  posts PostOneToMany[]
+  enabled Boolean?
+}
+model PostOneToMany {
+  id        ${id}
+  author    UserOneToMany @relation(fields: [authorId], references: [id]${referentialActionLine})
+  authorId  String
+}
+
+//
+// m:n relation
+//
+${provider === Providers.MONGODB ? manyToManyMongoDB : manyToManySQLExplicit}
+  `
+})