Помилка NestJS Docker: модуль @nestjs/cli/bin/nest.js не знайдено

Усунення несправностей Docker у мікросервісах NestJS

Під час розробки a NestJS RestAPI на основі мікросервісів, запуск служб у контейнері Docker іноді може призвести до несподіваних проблем. Одна з таких проблем виникає, коли Docker не може знайти @nestjs/cli/bin/nest.js модуль, що перешкоджає запуску служби.

Ця проблема особливо засмучує, коли ви вже налаштували кілька служб, наприклад автентифікацію та резервування, і працюєте над тим, щоб забезпечити їх безперебійну роботу у відповідних контейнерах. Зустріч з a MODULE_NOT_FOUND помилка може зупинити розробку та вимагати негайного усунення несправностей.

Проблема часто пов’язана з тим, як обробляються залежності в контейнері Docker, особливо під час використання a вузол: альпійський базовий образ і менеджери пакетів, як pnpm. Журнал помилок зазвичай вказує на відсутній модуль у контейнері node_modules каталог, який впливає на процес запуску служби.

У цьому посібнику ми розглянемо поширені причини цієї помилки, обговоримо можливі рішення та надамо рекомендації щодо її усунення, гарантуючи належну роботу ваших служб NestJS у середовищах Docker.

Розуміння інтеграції Docker і NestJS CLI

Перший файл Docker, наданий у прикладах, зосереджується на вирішенні MODULE_NOT_FOUND помилка, пов’язана з NestJS CLI під час запуску таких служб, як авт і бронювання. Це досягається шляхом забезпечення встановлення необхідних глобальних залежностей як на етапі розробки, так і на етапі виробництва. Dockerfile починається з використання полегшеного вузол: альпійський зображення, що допомагає зменшити загальний розмір зображення. Потім він встановлює менеджер пакетів pnpm і NestJS CLI глобально, щоб гарантувати, що всі необхідні модулі доступні в середовищі.

Після встановлення CLI та менеджера пакунків сценарій копіює необхідні файли, наприклад package.json і файли конфігурації, які є критичними для встановлення залежностей проекту. Після встановлення залежностей проект збирається за допомогою команди pnpm запустіть збірку, який компілює вихідний код у формат для розповсюдження. Цей крок необхідний, тому що скомпільований вихід буде використано в кінцевому робочому середовищі, уникаючи непотрібних витрат на інструменти розробки.

На другому етапі Dockerfile використовується багатоетапний процес збирання. На цьому етапі скомпільований вихід зі стадії розробки копіюється в свіже робоче середовище, гарантуючи, що кінцеве зображення є легким і оптимізованим для продуктивності. Цей метод допомагає зберігати робочий образ невеликим і безпечним, оскільки він містить лише те, що необхідно для запуску програми. Завдяки цьому система запобігає потенційним конфліктам або проблемам, пов’язаним із залежностями розробки, включеними у виробниче середовище.

Щоб керувати запуском програми, CMD директива вказує головний файл для виконання, який зазвичай знаходиться в відст після процесу збирання. Контейнер Docker виконує команду вузол dist/apps/auth/main.js (або reserves/main.js для іншої служби), гарантуючи, що мікрослужба виконується в правильному середовищі. Цей підхід дозволяє масштабувати архітектуру мікросервісу, оскільки кожну службу можна ізолювати у власному контейнері з належним керуванням усіма залежностями. Загальне налаштування гарантує, що Docker ефективно запускає служби NestJS, вирішуючи поширені проблеми CLI, які виникають під час контейнеризації.

// 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
    });
  });
});

Обробка модулів вузлів у Dockerized NestJS Services

Під час роботи з архітектурою мікросервісів у NestJS одним із критичних аспектів є забезпечення правильного встановлення та керування вашими залежностями в контейнерах Docker. Докеризовані середовища іноді можуть ускладнити обробку node_modules, особливо під час використання багатоетапних збірок, що може призвести до таких помилок «Не вдається знайти модуль @nestjs/cli/bin/nest.js». Ця помилка зазвичай виникає, коли глобальні модулі, такі як @nestjs/cli неправильно встановлені всередині контейнера.

Щоб уникнути цього, важливо структурувати Dockerfile таким чином, щоб усі необхідні модулі були присутні як на етапі розробки, так і на етапі виробництва. Одним із поширених рішень є явне встановлення NestJS CLI на обох етапах, щоб уникнути будь-яких проблем, пов’язаних із відсутніми двійковими файлами під час виконання таких команд, як nest start або nest build. Цей метод забезпечує узгодженість у різних середовищах, незалежно від того, використовуєте ви pnpm, npm або yarn.

Крім того, використовуючи такі інструменти, як pnpm може оптимізувати розмір образу Docker і процес встановлення залежностей. Однак ви також повинні переконатися, що pnpm встановлено глобально, оскільки багато розробників стикаються з проблемами під час перемикання між різними менеджерами пакетів у контейнерах Docker. Структурування ваших багатоетапних збірок таким чином, щоб лише важливі файли (наприклад, папка dist і node_modules), скопійовані на стадію виробництва, можуть допомогти спростити процес розгортання та уникнути типових помилок, пов’язаних із відсутніми модулями.