본문 바로가기

장 실습: 서버의 배포 점검 자동화하기

회원가입·로그인·권한을 아홉 요청으로 확인하는 스크립트를 만들고, 실패와 서버 종료 처리를 직접 점검합니다.

배포 전략과 운영 고려사항에서는 새 서버를 준비하고 핵심 기능을 확인한 뒤 요청을 보내는 순서를 살펴보았습니다. 이번에는 16장에서 만든 서버를 대상으로 그 확인을 반복할 수 있는 스크립트를 만듭니다.

이 실습을 마치면 다음을 할 수 있습니다.

  • API의 상태 코드와 공개 응답 필드를 자동으로 확인합니다.
  • 잘못된 응답을 일부러 만들어 점검 스크립트가 실패하는지 확인합니다.
  • 종료 신호를 받은 서버의 처리 결과를 확인합니다.

시작 상태

check-users.mjs와 check-auth.mjs는 상태 코드를 사람이 읽어야 했습니다. 이것을 기대와 다르면 스스로 실패를 알리는 점검 스크립트로 바꾸고, 서버가 종료 신호를 받으면 정리 작업을 거치게 고칩니다. 데이터베이스 컨테이너가 켜져 있고 packages/server에 인증·인가와 서버 실행까지의 코드와 CI/CD 파이프라인 구축 연습 4의 HealthController가 있는 상태에서 시작하며, 명령은 모두 packages/server에서 실행합니다.

완성 조건

  • packages/server/check-release.mjs가 아래 아홉 가지를 차례로 확인하고, 항목마다 PASS나 FAIL을 한 줄씩 출력합니다.
  • 하나라도 실패하면 종료 코드가 1이 됩니다. 자동화 도구는 이 종료 코드로 단계의 성공과 실패를 판단합니다.
  • 서버의 주소를 명령의 첫 인수로 받고, 없으면 http://localhost:4100을 씁니다. 실행할 때마다 새 이메일로 가입하므로 몇 번을 실행해도 결과가 같습니다.
  • 빌드한 서버를 node dist/main.js로 실행한 뒤 Ctrl+C로 끝내면 Server is shutting down (SIGINT)가 출력됩니다.
번호요청기대하는 결과
1GET /health200, status가 ok
2새 이메일로 POST /auth/register201, 본문의 키가 id, email, name뿐
3isAdmin: true를 넣은 POST /auth/register400
4틀린 비밀번호로 POST /auth/login401
5올바른 비밀번호로 POST /auth/login200, 문자열 accessToken
6받은 토큰으로 GET /auth/profile200, 키가 세 개뿐이고 email이 가입한 값
7토큰 없이 GET /auth/profile401
8받은 토큰으로 GET /users403
9토큰 없이 GET /users401

힌트: check-auth.mjs의 send가 출력하는 대신 상태 코드와 본문을 돌려주게 고칩니다. 키가 세 개뿐인지는 Object.keys의 결과를 정렬해 비교합니다. 종료 코드는 process.exitCode에, 첫 인수는 process.argv[2]에 있습니다. 종료 신호는 main.ts에서 app.enableShutdownHooks()를 부르고 AppModule이 OnApplicationShutdown을 구현하게 합니다.

1단계: 요청의 성공 조건을 코드로 적기

기존 check-auth.mjs의 send가 상태 코드와 본문을 돌려주게 바꾸고, 위 표를 위에서 아래로 검사합니다. check 함수는 결과를 PASS 또는 FAIL로 출력하면서 검사한 개수와 통과한 개수를 셉니다. 파일 끝에서 둘이 다르면 process.exitCode = 1을 설정합니다.

체크포인트: npm run start:dev로 서버를 켜고 다른 터미널에서 node check-release.mjs를 실행하면 아홉 줄 모두 PASS이고, 마지막 줄은 9개 가운데 9개 통과입니다.

2단계: 응답에 필드를 섞어 실패 확인하기

auth.controller.ts의 profile에서 잠시 return toPublicUser(req.user);를 return req.user;로 바꿉니다. 점검 스크립트를 다시 실행해 공개 응답에 섞인 isAdmin을 찾는지 봅니다.

체크포인트: 여섯째 검사만 FAIL이고 9개 가운데 8개 통과입니다. 코드를 되돌린 뒤 아홉 검사가 모두 통과하는지 확인합니다.

3단계: 서버의 종료 처리 연결하기

main.ts의 app.listen 앞에 app.enableShutdownHooks()를 넣습니다. AppModule은 기존 @Module 설정을 유지하면서 OnApplicationShutdown을 구현하고, onApplicationShutdown에서 종료 신호를 출력하게 합니다.

체크포인트: 개발 서버를 멈추고 npm run build 뒤 node dist/main.js로 실행합니다. Ctrl+C로 끝낼 때 Server is shutting down (SIGINT)가 출력되어야 합니다.

완성 파일

점검 스크립트와 종료 처리 파일 전체 보기

점검 스크립트의 전체입니다.

packages/server/check-release.mjs
const base = process.argv[2] ?? "http://localhost:4100";
const publicKeys = ["email", "id", "name"];
let passed = 0;
let total = 0;

async function send(method, path, { body, token } = {}) {
  const headers = { "Content-Type": "application/json" };
  if (token) headers.Authorization = `Bearer ${token}`;
  const response = await fetch(base + path, {
    method,
    headers,
    body: body === undefined ? undefined : JSON.stringify(body),
  });
  const text = await response.text();
  let data = null;
  try {
    data = JSON.parse(text);
  } catch {
    data = null;
  }
  return { status: response.status, data };
}

function check(name, ok) {
  total += 1;
  if (ok) passed += 1;
  console.log(`${ok ? "PASS" : "FAIL"} ${name}`);
}

function hasOnlyPublicFields(value) {
  return (
    typeof value === "object" &&
    value !== null &&
    JSON.stringify(Object.keys(value).sort()) === JSON.stringify(publicKeys)
  );
}

const account = {
  email: `smoke-${Date.now()}@example.com`,
  password: "local-practice-password",
  name: "점검용",
};

const health = await send("GET", "/health");
check("상태 확인이 200과 ok를 돌려준다", health.status === 200 && health.data?.status === "ok");

const registered = await send("POST", "/auth/register", { body: account });
check("가입이 201과 공개 필드만 돌려준다", registered.status === 201 && hasOnlyPublicFields(registered.data));

const forged = await send("POST", "/auth/register", {
  body: { ...account, email: `forged-${account.email}`, isAdmin: true },
});
check("isAdmin을 넣은 가입은 400이다", forged.status === 400);

const wrong = await send("POST", "/auth/login", {
  body: { email: account.email, password: "wrong-password" },
});
check("틀린 비밀번호의 로그인은 401이다", wrong.status === 401);

const login = await send("POST", "/auth/login", {
  body: { email: account.email, password: account.password },
});
const token = typeof login.data?.accessToken === "string" ? login.data.accessToken : "";
check("로그인이 200과 토큰을 돌려준다", login.status === 200 && token !== "");

const profile = await send("GET", "/auth/profile", { token });
check(
  "프로필이 200과 공개 필드만 돌려준다",
  profile.status === 200 && hasOnlyPublicFields(profile.data) && profile.data.email === account.email,
);

const anonymous = await send("GET", "/auth/profile");
check("토큰 없는 프로필은 401이다", anonymous.status === 401);

const forbidden = await send("GET", "/users", { token });
check("일반 사용자의 /users는 403이다", forbidden.status === 403);

const unauthorized = await send("GET", "/users");
check("토큰 없는 /users는 401이다", unauthorized.status === 401);

console.log(`${total}개 가운데 ${passed}개 통과`);
if (passed !== total) process.exitCode = 1;

Date.now()는 실행할 때마다 다른 숫자를 주므로 이메일이 겹치지 않습니다. hasOnlyPublicFields는 정렬한 키 이름이 email, id, name과 정확히 같은지 비교하므로, 첫 글에서 타입만으로는 막지 못한다고 확인한 isAdmin이나 password의 노출을 실행 중인 서버의 응답으로 잡습니다.

종료 처리는 두 파일을 고칩니다. 아래는 서버 시작 글의 설정을 유지하고 app.listen 앞에 종료 훅을 더한 main.ts 전체입니다.

packages/server/src/main.ts
import { ValidationPipe } from "@nestjs/common";
import { NestFactory } from "@nestjs/core";
import { AppModule } from "./app.module";

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  app.useGlobalPipes(
    new ValidationPipe({
      whitelist: true,
      forbidNonWhitelisted: true,
      transform: true,
    }),
  );

  app.enableCors({
    origin: process.env.CORS_ORIGIN ?? "http://localhost:3000",
    methods: "GET,HEAD,PUT,PATCH,POST,DELETE",
    credentials: true,
  });

  const port = Number(process.env.PORT ?? 4100);
  app.enableShutdownHooks();
  await app.listen(port);
  console.log(`Server is running on http://localhost:${port}`);
}
void bootstrap();

app.module.ts는 기존 데이터베이스·인증 모듈과 상태 확인 경로를 유지하면서 OnApplicationShutdown을 구현합니다. 인증 글의 AuthModule과 CI/CD 글의 HealthController까지 합친 전체 파일입니다.

packages/server/src/app.module.ts
import { Module } from "@nestjs/common";
import type { OnApplicationShutdown } from "@nestjs/common";
import { ConfigModule } from "@nestjs/config";
import { TypeOrmModule } from "@nestjs/typeorm";
import { UserModule } from "./user/user.module";
import { AuthModule } from "./auth/auth.module";
import { HealthController } from "./health/health.controller";

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      envFilePath: ".env",
    }),
    TypeOrmModule.forRoot({
      type: "postgres",
      host: process.env.DATABASE_HOST,
      port: Number.parseInt(process.env.DATABASE_PORT ?? "5432", 10),
      username: process.env.DATABASE_USER,
      password: process.env.DATABASE_PASSWORD,
      database: process.env.DATABASE_NAME,
      entities: [__dirname + "/**/*.entity{.ts,.js}"],
      synchronize: process.env.NODE_ENV === "development",
      logging: process.env.NODE_ENV === "development",
    }),
    UserModule,
    AuthModule,
  ],
  controllers: [HealthController],
})
export class AppModule implements OnApplicationShutdown {
  onApplicationShutdown(signal?: string): void {
    console.log(`Server is shutting down (${signal})`);
  }
}

HealthController는 앞 글에서 만든 다음 파일을 그대로 사용합니다.

packages/server/src/health/health.controller.ts
import { Controller, Get } from "@nestjs/common";

@Controller("health")
export class HealthController {
  @Get()
  check(): { status: "ok" } {
    return { status: "ok" };
  }
}

implements OnApplicationShutdown을 적어 두면 메서드 이름을 onAplicationShutdown처럼 잘못 썼을 때 TS2420으로 드러납니다. 이름이 틀린 메서드는 NestJS가 부르지 않으므로, 이 진단이 없으면 정리 작업이 조용히 빠집니다.

npm run start:dev로 서버를 켜고 다른 터미널에서 node check-release.mjs를 실행합니다.

PASS 상태 확인이 200과 ok를 돌려준다
PASS 가입이 201과 공개 필드만 돌려준다
PASS isAdmin을 넣은 가입은 400이다
PASS 틀린 비밀번호의 로그인은 401이다
PASS 로그인이 200과 토큰을 돌려준다
PASS 프로필이 200과 공개 필드만 돌려준다
PASS 토큰 없는 프로필은 401이다
PASS 일반 사용자의 /users는 403이다
PASS 토큰 없는 /users는 401이다
9개 가운데 9개 통과

스크립트가 실패를 잡는지도 확인합니다. auth.controller.ts의 profile 메서드에서 return toPublicUser(req.user);를 return req.user;로 바꾸면, AuthenticatedUser가 PublicUserDto의 세 필드를 모두 가지므로 컴파일은 통과합니다. 스크립트를 다시 실행하면 응답에 isAdmin이 섞여 여섯째 줄만 FAIL로 바뀌고 마지막 줄이 9개 가운데 8개 통과가 됩니다. 코드를 되돌리고 다시 모두 통과하는 것을 확인합니다.

마지막으로 개발 서버를 멈추고 npm run build 뒤 node dist/main.js로 서버를 켭니다. Server is running 줄이 보이면 Ctrl+C를 누르고, Server is shutting down (SIGINT)가 출력되며 프로세스가 끝나면 완성입니다.

다를 때 먼저 볼 곳

증상먼저 볼 곳
첫 줄이 FAIL이다CI/CD 파이프라인 구축의 연습 4에서 만든 HealthController와 AppModule의 controllers
스크립트가 출력 없이 오류로 끝난다서버가 켜져 있는지, 인수로 준 주소
여덟째 줄이 FAIL이다UserController의 @Roles("admin")과 가드의 순서
Ctrl+C에 종료 문구가 나오지 않는다enableShutdownHooks()를 app.listen 앞에 불렀는지, node dist/main.js로 실행했는지

더 해 보기

과제를 마쳤다면 다음 기능을 스스로 더해 보세요.

  • CI/CD 파이프라인 구축의 배포 작업 끝에 이 스크립트를 배포한 서버의 주소로 실행하는 단계를 더합니다. 종료 코드가 1이면 그 단계가 실패하므로 배포의 실패가 워크플로에 드러납니다.
  • 서버의 public-user.dto.ts에 다시 적은 PublicUserDto를 지우고 shared의 타입을 직접 쓰게 바꿉니다. npm의 workspaces로 패키지를 연결하고, 서버의 빌드와 Dockerfile이 shared를 함께 읽도록 고쳐야 합니다.

이것으로 16장과 타입스크립트 교재를 마칩니다. 첫 글에서 타입을 붙여도 비밀번호가 그대로 출력되는 것을 본 뒤, 서버의 toPublicUser와 클라이언트의 parsePublicUser, 점검 스크립트로 같은 약속을 세 번 확인했습니다. 타입은 코드가 약속을 어기지 않게 돕고, 바깥에서 들어오고 나가는 값은 실행 중에 확인합니다. 다시 훑어보려면 타입스크립트 교재의 목차에서 필요한 장을 골라 읽어 보세요.