Add support for MongoDB

keystonejs · Sep 21, 2021 · a201b72 · a201b72
1 parent b0cba17
commit a201b72
Show file tree

Hide file tree

Showing 8 changed files with 513 additions and 14 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -108,11 +108,18 @@ jobs:
           POSTGRES_DB: test_db
         ports:
           - 5432:5432
+      mongodb:
+        image: mongo
+        env:
+          MONGO_INITDB_ROOT_USERNAME: keystone5
+          MONGO_INITDB_ROOT_PASSWORD: k3yst0n3
+        ports:
+        - 27017:27017
     strategy:
       fail-fast: false
       matrix:
         index: [0, 1, 2, 3, 4, 5, 6, 7, 8]
-        adapter: ['postgresql', 'sqlite']
+        adapter: ['postgresql', 'sqlite', 'mongodb']
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v2
@@ -153,7 +160,7 @@ jobs:
           CI_NODE_TOTAL: 9
           CI_NODE_INDEX: ${{ matrix.index }}
           TEST_ADAPTER: ${{ matrix.adapter }}
-          DATABASE_URL: ${{ matrix.adapter == 'sqlite' && 'file:./dev.db' || 'postgres://keystone5:k3yst0n3@localhost:5432/test_db' }}
+          DATABASE_URL: ${{ matrix.adapter == 'sqlite' && 'file:./dev.db' || matrix.adapter == 'postgresql' && 'postgres://keystone5:k3yst0n3@localhost:5432/test_db' || 'mongodb://keystone5:k3yst0n3@localhost:27017/test_db' }}
 
   non-api-tests:
     name: Package Unit Tests

diff --git a/packages/keystone/src/lib/config/initConfig.ts b/packages/keystone/src/lib/config/initConfig.ts
@@ -8,9 +8,9 @@ import { applyIdFieldDefaults } from './applyIdFieldDefaults';
 */
 
 export function initConfig(config: KeystoneConfig) {
-  if (!['postgresql', 'sqlite'].includes(config.db.provider)) {
+  if (!['postgresql', 'sqlite', 'mongodb'].includes(config.db.provider)) {
     throw new Error(
-      'Invalid db configuration. Please specify db.provider as either "sqlite" or "postgresql"'
+      'Invalid db configuration. Please specify db.provider as either "sqlite", "postgresql", or "mongodb"'
     );
   }
 

diff --git a/packages/keystone/src/lib/core/prisma-schema.ts b/packages/keystone/src/lib/core/prisma-schema.ts
@@ -206,14 +206,23 @@ export function printPrismaSchema(
 datasource ${provider} {
   url = env("DATABASE_URL")
   provider = "${provider}"
-}
+}\n\n`;
 
-generator client {
+  if (provider === 'mongodb') {
+    prismaSchema += `generator client {
   provider = "prisma-client-js"
-  output = "${clientDir}"${prismaFlags}
+  previewFeatures = ["mongoDb"]
+  output = "${clientDir}"
   engineType = "binary"
 }
 \n`;
+  } else {
+    prismaSchema += `generator client {
+    provider = "prisma-client-js"
+    output = "${clientDir}"
+  }
+  \n`;
+  }
   for (const [listKey, { resolvedDbFields }] of Object.entries(lists)) {
     prismaSchema += `model ${listKey} {`;
     for (const [fieldPath, field] of Object.entries(resolvedDbFields)) {
@@ -223,6 +232,9 @@ generator client {
       if (fieldPath === 'id') {
         assertDbFieldIsValidForIdField(listKey, field);
         prismaSchema += ' @id';
+        if (provider === 'mongodb') {
+          prismaSchema += ' @map("_id")';
+        }
       }
     }
     prismaSchema += `\n}\n`;

diff --git a/packages/keystone/src/types/config/index.ts b/packages/keystone/src/types/config/index.ts
@@ -57,7 +57,7 @@ export type DatabaseConfig = {
   useMigrations?: boolean;
   enableLogging?: boolean;
   idField?: IdFieldConfig;
-  provider: 'postgresql' | 'sqlite';
+  provider: 'postgresql' | 'sqlite' | 'mongodb';
   prismaPreviewFeatures?: string[]; // https://www.prisma.io/docs/concepts/components/preview-features
 };
 

diff --git a/packages/keystone/src/types/core.ts b/packages/keystone/src/types/core.ts
@@ -8,7 +8,7 @@ type FieldDefaultValueArgs<TGeneratedListTypes extends BaseGeneratedListTypes> =
   originalInput: TGeneratedListTypes['inputs']['create'];
 };
 
-export type DatabaseProvider = 'sqlite' | 'postgresql';
+export type DatabaseProvider = 'sqlite' | 'postgresql' | 'mongodb';
 
 export type FieldDefaultValue<T, TGeneratedListTypes extends BaseGeneratedListTypes> =
   | T

diff --git a/packages/keystone/src/types/filters/index.ts b/packages/keystone/src/types/filters/index.ts
@@ -1,5 +1,6 @@
 export * as postgresql from './providers/postgresql';
 export * as sqlite from './providers/sqlite';
+export * as mongodb from './providers/mongodb';
 
 type EntriesAssumingNoExtraProps<T> = {
   [Key in keyof T]-?: [Key, T[Key]];