Merge pull request #2 from DouglasNeuroInformatics/prisma-module

Author: joshunrau

package.json

@@ -34,6 +34,7 @@
   "scripts": {
     "build": "tsc",
     "build:docs": "typedoc",
+    "db:generate": "prisma generate",
     "format": "prettier --write src",
     "lint": "tsc --noEmit && eslint --fix src",
     "prepare": "husky",
@@ -45,6 +46,7 @@
     "@nestjs/core": "^10.2.3",
     "@nestjs/platform-express": "^10.2.5",
     "@nestjs/testing": "^10.2.5",
+    "@prisma/client": "^5.21.1",
     "express": "^4.18.2",
     "mongodb": "^6.3.0",
     "reflect-metadata": "^0.1.13",
@@ -76,6 +78,7 @@
     "eslint": "^8.52.0",
     "husky": "^9.0.11",
     "prettier": "^3.2.5",
+    "prisma": "^5.19.1",
     "typedoc": "^0.26.4",
     "typescript": "~5.5.3",
     "unplugin-swc": "^1.4.4",

pnpm-lock.yaml

@@ -0,0 +1,15 @@
+generator client {
+  provider      = "prisma-client-js"
+  binaryTargets = ["native"]
+}
+
+datasource db {
+  provider = "mongodb"
+  url      = env("_")
+}
+
+model User {
+  id    String  @id @default(auto()) @map("_id") @db.ObjectId
+  email String  @unique
+  name  String?
+}

prisma/schema.prisma

@@ -2,3 +2,10 @@ export * from './crypto/crypto.config.js';
 export * from './crypto/crypto.module.js';
 export * from './crypto/crypto.service.js';
 export * from './logging/logging.module.js';
+export * from './prisma/prisma.config.js';
+export * from './prisma/prisma.decorators.js';
+export * from './prisma/prisma.factory.js';
+export * from './prisma/prisma.module.js';
+export * from './prisma/prisma.service.js';
+export * from './prisma/prisma.types.js';
+export * from './prisma/prisma.utils.js';

src/modules/index.ts

@@ -0,0 +1,23 @@
+import { ConfigurableModuleBuilder } from '@nestjs/common';
+import type { Prisma } from '@prisma/client';
+
+type PrismaModuleOptions = Prisma.PrismaClientOptions;
+
+const { ASYNC_OPTIONS_TYPE, ConfigurableModuleClass, MODULE_OPTIONS_TOKEN, OPTIONS_TYPE } =
+  new ConfigurableModuleBuilder<PrismaModuleOptions>({
+    moduleName: 'Prisma'
+  })
+    .setClassMethodName('forRoot')
+    .setExtras({}, (definition) => ({
+      ...definition,
+      global: true
+    }))
+    .build();
+
+export {
+  ASYNC_OPTIONS_TYPE as PRISMA_ASYNC_OPTIONS_TYPE,
+  ConfigurableModuleClass as ConfigurablePrismaModule,
+  MODULE_OPTIONS_TOKEN as PRISMA_MODULE_OPTIONS_TOKEN,
+  OPTIONS_TYPE as PRISMA_OPTIONS_TYPE
+};
+export type { PrismaModuleOptions };

src/modules/prisma/prisma.config.ts

@@ -0,0 +1,8 @@
+import { Inject } from '@nestjs/common';
+import type { Prisma } from '@prisma/client';
+
+import { getModelToken } from './prisma.utils.js';
+
+export const InjectModel = <T extends Prisma.ModelName>(modelName: T): ParameterDecorator & PropertyDecorator => {
+  return Inject(getModelToken(modelName));
+};

src/modules/prisma/prisma.decorators.ts

@@ -0,0 +1,21 @@
+import { Injectable } from '@nestjs/common';
+import { Prisma, PrismaClient } from '@prisma/client';
+
+export const PRISMA_CLIENT_TOKEN = 'PRISMA_CLIENT';
+
+@Injectable()
+export class PrismaFactory {
+  static createClient(options: Prisma.PrismaClientOptions) {
+    return new PrismaClient(options).$extends({
+      model: {
+        $allModels: {
+          async exists<T>(this: T, where: Prisma.Args<T, 'findFirst'>['where']): Promise<boolean> {
+            const context = Prisma.getExtensionContext(this);
+            const result = await (context as PrismaClient[Lowercase<Prisma.ModelName>]).findFirst({ where });
+            return result !== null;
+          }
+        }
+      }
+    });
+  }
+}

src/modules/prisma/prisma.factory.ts

@@ -0,0 +1,61 @@
+import { type DynamicModule, Module } from '@nestjs/common';
+import type { Prisma } from '@prisma/client';
+
+import {
+  ConfigurablePrismaModule,
+  PRISMA_ASYNC_OPTIONS_TYPE,
+  PRISMA_MODULE_OPTIONS_TOKEN,
+  PRISMA_OPTIONS_TYPE,
+  type PrismaModuleOptions
+} from './prisma.config.js';
+import { PRISMA_CLIENT_TOKEN, PrismaFactory } from './prisma.factory.js';
+import { PrismaService } from './prisma.service.js';
+import { getModelToken } from './prisma.utils.js';
+
+import type { ExtendedPrismaClient } from './prisma.types.js';
+
+@Module({})
+export class PrismaModule extends ConfigurablePrismaModule {
+  static forFeature<T extends Prisma.ModelName>(modelName: T): DynamicModule {
+    const modelToken = getModelToken(modelName);
+    return {
+      exports: [modelToken],
+      module: PrismaModule,
+      providers: [
+        {
+          inject: [PRISMA_CLIENT_TOKEN],
+          provide: modelToken,
+          useFactory: (client: ExtendedPrismaClient) => {
+            return client[modelName.toLowerCase() as Lowercase<T>];
+          }
+        }
+      ]
+    };
+  }
+
+  static forRoot(options: typeof PRISMA_OPTIONS_TYPE) {
+    return this.createModule(super.forRoot(options));
+  }
+
+  static forRootAsync(options: typeof PRISMA_ASYNC_OPTIONS_TYPE) {
+    return this.createModule(super.forRootAsync(options));
+  }
+
+  private static createModule({ exports = [], providers = [], ...base }: DynamicModule): DynamicModule {
+    return {
+      ...base,
+      exports: [...exports, PRISMA_CLIENT_TOKEN, PrismaService],
+      providers: [
+        ...providers,
+        PrismaService,
+        {
+          inject: [PRISMA_MODULE_OPTIONS_TOKEN],
+          provide: PRISMA_CLIENT_TOKEN,
+          useFactory: (options: PrismaModuleOptions) => {
+            return PrismaFactory.createClient(options);
+          }
+        }
+      ]
+    };
+  }
+}

src/modules/prisma/prisma.module.ts

@@ -0,0 +1,36 @@
+import { Inject, Injectable, InternalServerErrorException } from '@nestjs/common';
+import type { OnApplicationShutdown, OnModuleInit } from '@nestjs/common';
+
+import { PRISMA_CLIENT_TOKEN } from './prisma.factory.js';
+
+import type { ExtendedPrismaClient } from './prisma.types.js';
+
+@Injectable()
+export class PrismaService implements OnModuleInit, OnApplicationShutdown {
+  constructor(@Inject(PRISMA_CLIENT_TOKEN) public readonly client: ExtendedPrismaClient) {}
+
+  async dropDatabase() {
+    const result = await this.client.$runCommandRaw({ dropDatabase: 1 });
+    if (result.ok !== 1) {
+      throw new InternalServerErrorException('Failed to drop database: raw mongodb command returned unexpected value', {
+        cause: result
+      });
+    }
+  }
+
+  async getDbStats() {
+    return (await this.client.$runCommandRaw({ dbStats: 1 })) as {
+      collections: number;
+      db: string;
+      objects: number;
+    };
+  }
+
+  async onApplicationShutdown() {
+    await this.client.$disconnect();
+  }
+
+  async onModuleInit() {
+    await this.client.$connect();
+  }
+}

src/modules/prisma/prisma.service.ts

@@ -0,0 +1,7 @@
+import type { Prisma } from '@prisma/client';
+
+import type { PrismaFactory } from './prisma.factory.js';
+
+export type ExtendedPrismaClient = ReturnType<(typeof PrismaFactory)['createClient']>;
+
+export type Model<T extends Prisma.ModelName> = ExtendedPrismaClient[`${Uncapitalize<T>}`];

src/modules/prisma/prisma.types.ts

@@ -0,0 +1,5 @@
+import type { Prisma } from '@prisma/client';
+
+export function getModelToken<T extends Prisma.ModelName>(modelName: T) {
+  return modelName + 'PrismaModel';
+}