Welcome to nestjs-graphql-prisma-hr 👋

NestJS, GraphQL, Prisma, MySQL, Typescript, Jest, Supertest를 이용한 HR API

Prerequisites

• node >=18.17.1
• npm >=9.6.7

Install

$ npm install

Usage

# development mode
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit and contract tests under src/**/*.spec.ts
$ npm run test

# unit tests with watch mode
$ npm run test:watch

# unit tests with coverage
$ npm run test:cov

# mocked resolver e2e tests under test/*.e2e-spec.ts
$ npm run test:e2e

# DB-backed release-gate e2e tests against a migrated and seeded MySQL database
$ npm run test:e2e:db

# production build
$ npm run build

# typecheck without emitting files
$ npx tsc --noEmit --pretty false

# eslint check; note package script runs eslint with --fix
$ npx eslint "{src,apps,libs,test}/**/*.ts"

Test scope

• npm run test runs Jest with rootDir: src. It includes unit tests and contract tests such as:
  • src/common/graphql-schema-contract.spec.ts for the public GraphQL schema snapshot and high-risk schema assertions.
  • src/common/nullability-contract.spec.ts for Prisma-backed GraphQL and DTO nullability expectations.
  • src/common/utils/prisma-mutation-services.spec.ts and src/common/utils/prisma-query-policy-services.spec.ts for cross-service Prisma behavior.
• npm run test:e2e runs the resolver e2e specs in test/*.e2e-spec.ts. These tests intentionally use mocked domain services plus a mocked PrismaService through test/e2e-test-utils.ts, so they do not require DATABASE_URL or a running MySQL instance. They verify GraphQL/resolver wiring and request bootstrap behavior, not real database persistence.
• npm run test:e2e:db runs test/*.db-e2e.ts against the real AppModule, real PrismaService, and the DATABASE_URL MySQL database. It does not mock domain services or Prisma. This profile is intended as an explicit release gate for Prisma/MySQL integration behavior.

DB-backed e2e profile

The DB-backed profile requires a dedicated, migrated, and seeded MySQL database. Do not point this command at a shared production database because the test creates and removes a temporary user.

# example setup for a disposable database
$ export DATABASE_URL="mysql://root:password@127.0.0.1:3306/hrms_e2e"
$ export JWT_SECRET="test-secret"
$ npx prisma migrate deploy
$ npx prisma db seed
$ npm run test:e2e:db

The DB-backed test logs in with the seeded alice@prisma.io account, runs protected GraphQL operations with a real JWT, verifies real user persistence, and asserts that passwords are not exposed in GraphQL responses.

GraphQL schema snapshot

The committed GraphQL schema snapshot lives at:

src/common/__snapshots__/graphql-schema-contract.spec.ts.snap

Use it as a schema-diff gate when changing public GraphQL contracts:

# run the schema contract test
$ npm test -- --runInBand src/common/graphql-schema-contract.spec.ts

# intentionally update the snapshot after reviewing the schema diff
$ npm test -- --runInBand src/common/graphql-schema-contract.spec.ts -u

The schema contract test builds the resolver schema without starting the database-backed AppModule. It snapshots a lexicographically sorted schema and asserts key contracts directly, including:

• User.password is not exposed on the public User object type.
• loginUser remains present as the auth mutation entrypoint.
• Top-level list queries expose skip and take.
• Relation list fields expose skip and take.

Update the snapshot only when the GraphQL contract change is intentional and the diff has been reviewed.

Other commands

# generate prisma client
$ npx prisma generate

# database migration
$ npx prisma db seed --preview-feature

# run migration
$ npx prisma migrate dev -name init

# revert migration
$ npx run migrate reset

.env file

PORT=3000
DATABASE_URL="mysql://username:password@localhost:3306//hrms?schema=public"
JWT_SECRET=MDBjMWJlMzc4M2JhNGExY2FmNTRkZmU0NjlhNTRjYmY=

Author

👤 Changhoon Jee chjee71@gmail.com

• Github: @chjee

Show your support

Give a ⭐️ if this project helped you!

---

This README was generated with ❤️ by readme-md-generator