test(client): Add cockroachdb blog tests (#10772)

.buildkite/publish/docker-compose.yml

@@ -29,6 +29,8 @@ services:
       - TEST_MSSQL_SHADOWDB_JDBC_URI_MIGRATE=sqlserver://mssql:1433;database=tests-migrate-shadowdb;user=SA;password=Pr1sm4_Pr1sm4;trustServerCertificate=true;
       # MongoDB
       - TEST_MONGO_URI=mongodb://root:prisma@mongo:27017/tests?authSource=admin
+      # CockroachDB
+      - TEST_COCKROACH_URI=postgresql://prisma@cockroachdb:26257/
       # Other vars !\ If not defined, they cannot be accessed
       # TODO: do an env var cleanup?
       - NPM_TOKEN
@@ -58,6 +60,7 @@ services:
       - mssql
       - mongo
       - mongo-seed
+      - cockroachdb
 
   postgres:
     image: postgres:10
@@ -138,12 +141,18 @@ services:
     links:
       - mongo
 
+  cockroachdb:
+    image: prismagraphql/build:cockroach-custom
+    restart: always
+    command: start-single-node --insecure
+    ports:
+      - '26257:26257'
+
 volumes:
   postgres:
   postgres_isolated:
   mysql:
   mysql_isolated:
   mariadb:
   mssql:
-
 # TODO: investigate why isolated containers aren't used in the tests

.buildkite/test/docker-compose.14.yml

@@ -29,6 +29,8 @@ services:
       - TEST_MSSQL_SHADOWDB_JDBC_URI_MIGRATE=sqlserver://mssql:1433;database=tests-migrate-shadowdb;user=SA;password=Pr1sm4_Pr1sm4;trustServerCertificate=true;
       # MongoDB
       - TEST_MONGO_URI=mongodb://root:prisma@mongo:27017/tests?authSource=admin
+      # CockroachDB
+      - TEST_COCKROACH_URI=postgresql://prisma@cockroachdb:26257/
       # Other vars
       - BUILDKITE
       - BUILDKITE_PARALLEL_JOB
@@ -48,6 +50,7 @@ services:
       - mssql
       - mongo
       - mongo-seed
+      - cockroachdb
 
   postgres:
     image: postgres:10
@@ -128,6 +131,13 @@ services:
     links:
       - mongo
 
+  cockroachdb:
+    image: prismagraphql/build:cockroach-custom
+    restart: always
+    command: start-single-node --insecure
+    ports:
+      - '26257:26257'
+
 volumes:
   postgres:
   postgres_isolated:

.github/workflows/test.yml

@@ -130,7 +130,7 @@ jobs:
         run: |
           echo "PRISMA_CLIENT_ENGINE_TYPE=${{ matrix.queryEngine }}" >> $GITHUB_ENV
 
-      - run: docker-compose -f docker/docker-compose.yml up --detach postgres postgres_isolated mysql mysql_isolated mssql
+      - run: docker-compose -f docker/docker-compose.yml up --detach postgres postgres_isolated mysql mysql_isolated mssql cockroachdb
 
       - name: Cache .pnpm-store # From https://pnpm.io/continuous-integration
         uses: actions/cache@v1

TESTING.md

@@ -27,6 +27,8 @@ export TEST_MSSQL_JDBC_URI_MIGRATE="sqlserver://localhost:1433;database=tests-mi
 export TEST_MSSQL_SHADOWDB_JDBC_URI_MIGRATE="sqlserver://localhost:1433;database=tests-migrate-shadowdb;user=SA;password=Pr1sm4_Pr1sm4;trustServerCertificate=true;"
 
 export TEST_MONGO_URI="mongodb://root:prisma@localhost:27017/tests?authSource=admin"
+
+export TEST_COCKROACH_URI=postgresql://prisma@localhost:26257/
 ```
 
 - Load the environnment variables with:

docker/docker-compose.yml

@@ -14,6 +14,7 @@ services:
   # Outside Docker
   # - TEST_POSTGRES_URI_MIGRATE=postgres://prisma:prisma@localhost:5432/tests-migrate
   # - TEST_POSTGRES_URI=postgres://prisma:prisma@localhost:5432/tests
+  # - TEST_COCKROACH_URI=postgresql://prisma@localhost:26257/
   # - TEST_POSTGRES_ISOLATED_URI=postgres://prisma:prisma@localhost:5435/tests
   # - TEST_MYSQL_URI=mysql://prisma:prisma@localhost:3306/tests
   # - TEST_MYSQL_ISOLATED_URI=mysql://prisma:prisma@localhost:3307/tests
@@ -46,6 +47,13 @@ services:
     ports:
       - '5435:5432'
 
+  cockroachdb:
+    image: prismagraphql/build:cockroach-custom
+    restart: always
+    command: start-single-node --insecure
+    ports:
+      - '26257:26257'
+
   mysql:
     image: mysql:8.0
     command: --default-authentication-plugin=mysql_native_password

packages/client/src/__tests__/integration/happy/blog-env-cockroachdb/__snapshots__/test.ts.snap

@@ -0,0 +1,11 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Blog fixture: Cockroachdb $queryRaw $queryRaw(string) error 1`] = `
+\`$queryRaw\` is a tag function, please use it like the following:
+\`\`\`
+const result = await prisma.$queryRaw\`SELECT * FROM User WHERE id = \${1} OR email = \${'user@email.com'};\`
+\`\`\`
+
+Or read our docs at https://www.prisma.io/docs/concepts/components/prisma-client/raw-database-access#queryraw
+
+`;

packages/client/src/__tests__/integration/happy/blog-env-cockroachdb/schema.prisma

@@ -0,0 +1,36 @@
+datasource db {
+  provider = "cockroachdb"
+  url      = env("TEST_COCKROACH_URI")
+}
+
+generator client {
+  provider        = "prisma-client-js"
+  previewFeatures = ["cockroachdb"]
+}
+
+// / User model comment
+model User {
+  id    String  @id @default(uuid())
+  email String  @unique
+  // / name comment
+  name  String?
+  posts Post[]
+}
+
+model Post {
+  id        String    @id @default(cuid())
+  createdAt DateTime  @default(now())
+  updatedAt DateTime  @updatedAt
+  published Boolean
+  title     String
+  content   String?
+  jsonData  Json?
+  coinflips Boolean[]
+  authorId  String?
+  author    User?     @relation(fields: [authorId], references: [id])
+}
+
+enum Role {
+  USER
+  ADMIN
+}

packages/client/src/__tests__/integration/happy/blog-env-cockroachdb/setup.sql

@@ -0,0 +1,32 @@
+DROP TYPE IF EXISTS "Role";
+CREATE TYPE "Role" AS ENUM ('USER', 'ADMIN');
+DROP TABLE IF EXISTS "public"."Post" CASCADE;
+CREATE TABLE "public"."Post" (
+    "id" text NOT NULL,
+    "createdAt" timestamp(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" timestamp(3) NOT NULL DEFAULT '1970-01-01 00:00:00'::timestamp without time zone,
+    "published" boolean NOT NULL DEFAULT false,
+    "title" text NOT NULL,
+    "content" text,
+    "authorId" text,
+    "jsonData" jsonb,
+    "coinflips" _bool,
+    PRIMARY KEY ("id")
+);
+DROP TABLE IF EXISTS "public"."User" CASCADE;
+CREATE TABLE "public"."User" (
+    "id" text,
+    "email" text NOT NULL,
+    "name" text,
+    PRIMARY KEY ("id")
+);
+CREATE UNIQUE INDEX "User.email" ON "public"."User"("email");
+ALTER TABLE "public"."Post"
+ADD FOREIGN KEY ("authorId") REFERENCES "public"."User"("id") ON DELETE
+SET NULL ON UPDATE CASCADE;
+INSERT INTO "public"."User" (email, id, name)
+VALUES (
+        'a@a.de',
+        '576eddf9-2434-421f-9a86-58bede16fd95',
+        'Alice'
+    );