Lỗi Docker NestJS: Không tìm thấy mô-đun @nestjs/cli/bin/nest.js

Khắc phục sự cố Docker trong NestJS Microservices

Trong khi phát triển một NestJS RestAPI dựa trên microservice, việc chạy các dịch vụ trong vùng chứa Docker đôi khi có thể dẫn đến sự cố không mong muốn. Một vấn đề như vậy phát sinh khi Docker không thể tìm thấy @nestjs/cli/bin/nest.js mô-đun, ngăn chặn dịch vụ chạy.

Sự cố này đặc biệt khó chịu khi bạn đã thiết lập nhiều dịch vụ, chẳng hạn như xác thực và đặt chỗ, đồng thời đang nỗ lực đảm bảo chúng chạy trơn tru trong vùng chứa tương ứng. Gặp phải một MODULE_NOT_FOUND lỗi có thể cản trở quá trình phát triển và yêu cầu khắc phục sự cố ngay lập tức.

Vấn đề thường liên quan đến cách xử lý các phần phụ thuộc trong vùng chứa Docker, đặc biệt là khi sử dụng nút: núi cao quản lý gói và hình ảnh cơ sở như pnpm. Nhật ký lỗi thường trỏ đến một mô-đun bị thiếu trong vùng chứa nút_modules thư mục, điều này ảnh hưởng đến quá trình khởi động dịch vụ.

Trong hướng dẫn này, chúng tôi sẽ tìm hiểu các nguyên nhân phổ biến gây ra lỗi này, thảo luận về các giải pháp tiềm năng và đưa ra đề xuất để giải quyết, đảm bảo rằng các dịch vụ NestJS của bạn chạy như mong đợi trong môi trường Docker.

Tìm hiểu về tích hợp Docker và NestJS CLI

Dockerfile đầu tiên được cung cấp trong các ví dụ tập trung vào việc giải quyết các vấn đề MODULE_NOT_FOUND lỗi liên quan đến NestJS CLI khi chạy các dịch vụ như xác thực Và đặt chỗ. Điều này đạt được bằng cách đảm bảo rằng các phụ thuộc toàn cầu cần thiết được cài đặt trong cả giai đoạn phát triển và sản xuất. Dockerfile bắt đầu bằng cách sử dụng một tệp nhẹ nút: núi cao hình ảnh, giúp giảm kích thước hình ảnh tổng thể. Sau đó nó cài đặt trình quản lý gói pnpm và NestJS CLI trên toàn cầu để đảm bảo rằng tất cả các mô-đun cần thiết đều có sẵn trong môi trường.

Sau khi CLI và trình quản lý gói được cài đặt, tập lệnh sẽ sao chép các tệp cần thiết như gói.json và các tệp cấu hình rất quan trọng để cài đặt các phần phụ thuộc của dự án. Sau khi cài đặt xong các phần phụ thuộc, dự án sẽ được xây dựng bằng lệnh xây dựng chạy pnpm, biên dịch mã nguồn thành định dạng có thể phân phối được. Bước này là cần thiết vì kết quả đã biên dịch sẽ được sử dụng trong môi trường sản xuất cuối cùng, tránh các chi phí không cần thiết từ các công cụ phát triển.

Giai đoạn thứ hai của Dockerfile sử dụng quy trình xây dựng nhiều giai đoạn. Trong giai đoạn này, đầu ra được biên dịch từ giai đoạn phát triển sẽ được sao chép sang môi trường sản xuất mới, đảm bảo hình ảnh cuối cùng nhẹ và được tối ưu hóa cho hiệu suất. Phương pháp này giúp giữ cho hình ảnh sản xuất nhỏ gọn và an toàn vì nó chỉ chứa những thứ cần thiết để chạy ứng dụng. Bằng cách này, hệ thống sẽ ngăn chặn các xung đột hoặc vấn đề tiềm ẩn liên quan đến sự phụ thuộc phát triển được đưa vào môi trường sản xuất.

Để xử lý việc khởi động ứng dụng, CMD chỉ thị chỉ định tệp chính cần thực thi, tệp này thường nằm trong thư mục quận thư mục sau quá trình xây dựng. Docker container chạy lệnh nút dist/apps/auth/main.js (hoặc đặt chỗ/main.js đối với dịch vụ khác), đảm bảo rằng vi dịch vụ được thực thi trong môi trường chính xác. Cách tiếp cận này cho phép kiến ​​trúc vi dịch vụ có thể mở rộng quy mô vì mỗi dịch vụ có thể được tách biệt trong vùng chứa riêng với tất cả các phần phụ thuộc được quản lý hợp lý. Quá trình thiết lập tổng thể đảm bảo Docker chạy các dịch vụ NestJS một cách hiệu quả, giải quyết các sự cố CLI phổ biến gặp phải trong quá trình đưa vào vùng chứa.

// Dockerfile - Solution 1 (Ensure Global Dependencies are Installed)FROM node:alpine AS development
WORKDIR /usr/src/app
COPY package.json pnpm-lock.yaml tsconfig.json nest-cli.json ./
RUN npm install -g pnpm @nestjs/cli  # Install NestJS CLI globally
RUN pnpm install
COPY . .
RUN pnpm run build auth
FROM node:alpine AS production
WORKDIR /usr/src/app
COPY --from=development /usr/src/app/dist ./dist
CMD ["node", "dist/apps/auth/main.js"]

// Dockerfile - Solution 2 (Install CLI during both development and production stages)FROM node:alpine AS development
WORKDIR /usr/src/app
COPY package.json pnpm-lock.yaml tsconfig.json nest-cli.json ./
RUN npm install -g pnpm @nestjs/cli  # Install CLI in dev environment
RUN pnpm install
COPY . .
RUN pnpm run build reservations
FROM node:alpine AS production
WORKDIR /usr/src/app
COPY package.json pnpm-lock.yaml ./
RUN npm install -g pnpm @nestjs/cli --prod  # Install CLI in production too
COPY --from=development /usr/src/app/dist ./dist
CMD ["node", "dist/apps/reservations/main.js"]

// jest.config.js - Unit Testsmodule.exports = {
  testEnvironment: 'node',
  moduleFileExtensions: ['js', 'json', 'ts'],
  rootDir: './',
  testRegex: '.spec.ts$',
  transform: { '^.+\\.(t|j)s$': 'ts-jest' },
  coverageDirectory: './coverage',
};

// sample.spec.ts - Check if Nest CLI is available in the Docker containerdescribe('Nest CLI Module Check', () => {
  it('should have @nestjs/cli installed', async () => {
    const { exec } = require('child_process');
    exec('nest --version', (error, stdout, stderr) => {
      expect(stdout).toContain('Nest');  // Verify CLI presence
    });
  });
});

Xử lý các mô-đun nút trong các dịch vụ NestJS được Docker hóa

Khi làm việc với kiến ​​trúc microservice trong NestJS, một khía cạnh quan trọng là đảm bảo rằng các phần phụ thuộc của bạn được cài đặt và quản lý chính xác trong vùng chứa Docker. Môi trường được Docker hóa đôi khi có thể làm phức tạp việc xử lý nút_modules, đặc biệt khi sử dụng các bản dựng nhiều giai đoạn, điều này có thể dẫn đến các lỗi như "Không thể tìm thấy mô-đun @nestjs/cli/bin/nest.js". Lỗi này thường phát sinh khi các mô-đun toàn cầu như @nestjs/cli không được cài đặt đúng cách trong vùng chứa.

Để tránh điều này, điều quan trọng là phải cấu trúc Dockerfile theo cách đảm bảo tất cả các mô-đun cần thiết đều có mặt trong cả giai đoạn phát triển và sản xuất. Một giải pháp phổ biến là cài đặt rõ ràng NestJS CLI trong cả hai giai đoạn để tránh mọi vấn đề liên quan đến thiếu nhị phân khi chạy các lệnh như nest start hoặc nest build. Phương pháp này cung cấp tính nhất quán giữa các môi trường, cho dù bạn đang sử dụng pnpm, npm hay sợi.

Ngoài ra, sử dụng các công cụ như pnpm có thể tối ưu hóa kích thước hình ảnh Docker và quá trình cài đặt phụ thuộc. Tuy nhiên, bạn cũng phải đảm bảo rằng pnpm được cài đặt trên toàn cầu, vì nhiều nhà phát triển gặp phải vấn đề khi chuyển đổi giữa các trình quản lý gói khác nhau bên trong vùng chứa Docker. Cấu trúc các bản dựng nhiều giai đoạn của bạn để chỉ các tệp cần thiết (như thư mục dist và nút_modules) được sao chép sang giai đoạn sản xuất có thể giúp hợp lý hóa quy trình triển khai và tránh các lỗi phổ biến liên quan đến các mô-đun bị thiếu.