NestJS Framework with Drizzle ORM

概要

本スキルは、Drizzle ORM を統合した NestJS のパターン集を提供し、本番環境対応のサーバーサイドアプリケーション構築をサポートします。CRUD モジュール、JWT 認証、データベース操作、マイグレーション、テスト、マイクロサービス、GraphQL 統合に対応しています。

使用場面

• NestJS で REST API または GraphQL サーバーを構築する場合
• JWT を使用した認証と認可をセットアップする場合
• Drizzle ORM でデータベース操作を実装する場合
• TCP/Redis トランスポートでマイクロサービスを作成する場合
• ユニットテストおよび統合テストを作成する場合
• drizzle-kit でデータベースマイグレーションを実行する場合

手順

1. 依存関係のインストール: npm i drizzle-orm pg && npm i -D drizzle-kit tsx
2. スキーマの定義: Drizzle テーブル定義を含む src/db/schema.ts を作成
3. DatabaseService の作成: NestJS プロバイダーとして Drizzle クライアントをインジェクト
4. CRUD モジュールの構築: Controller → Service → Repository パターン
5. バリデーションの追加: ValidationPipe で class-validator DTO を使用
6. ガード実装: ルート保護のため JWT/Roles ガードを作成
7. テスト作成: @nestjs/testing でリポジトリをモック
8. マイグレーション実行: npx drizzle-kit generate → SQL 確認 → npx drizzle-kit migrate

例

Drizzle を使用した完全な CRUD モジュール

// src/db/schema.ts
export const users = pgTable('users', {
  id: serial('id').primaryKey(),
  name: text('name').notNull(),
  email: text('email').notNull().unique(),
  createdAt: timestamp('created_at').defaultNow(),
});

// src/users/dto/create-user.dto.ts
export class CreateUserDto {
  @IsString() @IsNotEmpty() name: string;
  @IsEmail() email: string;
}

// src/users/user.repository.ts
@Injectable()
export class UserRepository {
  constructor(private db: DatabaseService) {}

  async findAll() {
    return this.db.database.select().from(users);
  }

  async create(data: typeof users.$inferInsert) {
    return this.db.database.insert(users).values(data).returning();
  }
}

// src/users/users.service.ts
@Injectable()
export class UsersService {
  constructor(private repo: UserRepository) {}

  async create(dto: CreateUserDto) {
    return this.repo.create(dto);
  }
}

// src/users/users.controller.ts
@Controller('users')
export class UsersController {
  constructor(private service: UsersService) {}

  @Post()
  create(@Body() dto: CreateUserDto) {
    return this.service.create(dto);
  }
}

// src/users/users.module.ts
@Module({
  controllers: [UsersController],
  providers: [UsersService, UserRepository, DatabaseService],
  exports: [UsersService],
})
export class UsersModule {}

JWT 認証ガード

@Injectable()
export class JwtAuthGuard implements CanActivate {
  constructor(private jwtService: JwtService) {}

  canActivate(context: ExecutionContext) {
    const token = context.switchToHttp().getRequest()
      .headers.authorization?.split(' ')[1];
    if (!token) return false;
    try {
      const decoded = this.jwtService.verify(token);
      context.switchToHttp().getRequest().user = decoded;
      return true;
    } catch {
      return false;
    }
  }
}

データベーストランザクション

async transferFunds(fromId: number, toId: number, amount: number) {
  return this.db.database.transaction(async (tx) => {
    await tx.update(accounts)
      .set({ balance: sql`${accounts.balance} - ${amount}` })
      .where(eq(accounts.id, fromId));
    await tx.update(accounts)
      .set({ balance: sql`${accounts.balance} + ${amount}` })
      .where(eq(accounts.id, toId));
  });
}

モックを使用したユニットテスト

describe('UsersService', () => {
  let service: UsersService;
  let repo: jest.Mocked<UserRepository>;

  beforeEach(async () => {
    const module = await Test.createTestingModule({
      providers: [
        UsersService,
        { provide: UserRepository, useValue: { findAll: jest.fn(), create: jest.fn() } },
      ],
    }).compile();
    service = module.get(UsersService);
    repo = module.get(UserRepository);
  });

  it('should create user', async () => {
    const dto = { name: 'John', email: 'john@example.com' };
    repo.create.mockResolvedValue({ id: 1, ...dto, createdAt: new Date() });
    expect(await service.create(dto)).toMatchObject(dto);
  });
});

制約と警告

• DTO 必須: 生オブジェクトを受け入れず、常に class-validator で DTO を使用
• トランザクション: トランザクションは短く保つ。ネストされたトランザクションは避ける
• ガード順序: JWT ガードは Roles ガードの前に実行する必要がある
• 環境変数: DATABASE_URL や JWT_SECRET をハードコードしない
• マイグレーション: スキーマ変更後、デプロイ前に drizzle-kit generate を実行
• 循環依存: forwardRef() の使用に注意。モジュール構造の再設計を推奨

ベストプラクティス

• グローバル ValidationPipe ですべての入力を検証
• 複数テーブル操作ではトランザクションを使用
• OpenAPI/Swagger デコレータで API ドキュメント化

参考資料

高度なパターンと詳細な例は以下で入手可能:

• references/reference.md - コアパターン、ガード、インターセプタ、マイクロサービス、GraphQL
• references/drizzle-reference.md - Drizzle ORM インストール、設定、クエリ
• references/workflow-optimization.md - 開発ワークフロー、並列実行戦略