NestJS Docker kļūda: modulis @nestjs/cli/bin/nest.js nav atrasts

Docker problēmu novēršana NestJS mikropakalpojumos

Izstrādājot a NestJS uz mikropakalpojumiem balstīta RestAPI, pakalpojumu palaišana Docker konteinerā dažkārt var izraisīt neparedzētas problēmas. Viena no šādām problēmām rodas, ja Docker nevar atrast @nestjs/cli/bin/nest.js modulis, neļaujot pakalpojumam darboties.

Šī problēma ir īpaši nomākta, ja jau esat iestatījis vairākus pakalpojumus, piemēram, autentifikāciju un rezervācijas, un strādājat, lai nodrošinātu to nevainojamu darbību attiecīgajos konteineros. Saskaroties ar a MODULE_NOT_FOUND kļūda var apturēt attīstību un prasīt tūlītēju problēmu novēršanu.

Problēma bieži ir saistīta ar to, kā Docker konteinerā tiek apstrādātas atkarības, īpaši, ja tiek izmantots a mezgls: augstkalnu bāzes attēlu un pakotņu pārvaldniekiem patīk pnpm. Kļūdu žurnāls parasti norāda uz trūkstošu moduli konteinerā node_modules direktorijā, kas ietekmē pakalpojuma startēšanas procesu.

Šajā rokasgrāmatā mēs apskatīsim šīs kļūdas izplatītākos cēloņus, apspriedīsim iespējamos risinājumus un sniegsim ieteikumus tās novēršanai, nodrošinot, ka jūsu NestJS pakalpojumi darbojas, kā paredzēts Docker vidē.

Izpratne par Docker un NestJS CLI integrāciju

Pirmais piemēros sniegtais Dockerfile ir vērsts uz to, lai atrisinātu MODULE_NOT_FOUND kļūda, kas saistīta ar NestJS CLI, palaižot tādus pakalpojumus kā aut un atrunas. Tas tiek panākts, nodrošinot nepieciešamo globālo atkarību uzstādīšanu gan izstrādes, gan ražošanas posmā. Dockerfile sākas, izmantojot vieglo svaru mezgls: augstkalnu attēlu, kas palīdz samazināt kopējo attēla izmēru. Pēc tam tas instalē pakotņu pārvaldnieku pnpm un NestJS CLI globāli, lai nodrošinātu, ka visi nepieciešamie moduļi ir pieejami vidē.

Kad CLI un pakotņu pārvaldnieks ir instalēts, skripts kopē nepieciešamos failus, piemēram, pack.json un konfigurācijas faili, kas ir būtiski, lai instalētu projekta atkarības. Pēc atkarību instalēšanas projekts tiek veidots, izmantojot komandu pnpm palaist veidot, kas apkopo avota kodu izplatāmā formātā. Šis solis ir nepieciešams, jo apkopotā produkcija tiks izmantota galīgajā ražošanas vidē, izvairoties no nevajadzīgām pieskaitāmām izmaksām no izstrādes rīkiem.

Otrajā Dockerfile posmā tiek izmantots daudzpakāpju veidošanas process. Šajā posmā apkopotā izstrādes posma izvade tiek pārkopēta uz jaunu ražošanas vidi, nodrošinot, ka gala attēls ir viegls un optimizēts veiktspējai. Šī metode palīdz saglabāt ražošanas attēlu mazu un drošu, jo tajā ir tikai tas, kas nepieciešams lietojumprogrammas palaišanai. To darot, sistēma novērš iespējamo konfliktu vai problēmu, kas saistītas ar izstrādes atkarībām, iekļaušanu ražošanas vidē.

Lai palaistu lietojumprogrammu, CMD direktīva norāda galveno izpildāmo failu, kas parasti atrodas dist direktorijā pēc veidošanas procesa. Docker konteiners palaiž komandu mezgls dist/apps/auth/main.js (vai Rezervācijas/main.js citam pakalpojumam), nodrošinot, ka mikropakalpojums tiek izpildīts pareizajā vidē. Šī pieeja ļauj mērogot mikropakalpojumu arhitektūru, jo katru pakalpojumu var izolēt savā konteinerā ar pareizi pārvaldītām atkarībām. Vispārējā iestatīšana nodrošina, ka Docker efektīvi palaiž NestJS pakalpojumus, atrisinot izplatītās CLI problēmas, kas radušās konteinerizācijas laikā.

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

Mezglu moduļu apstrāde dockerized NestJS pakalpojumos

Strādājot ar mikropakalpojumu arhitektūru NestJS, viens no svarīgākajiem aspektiem ir nodrošināt, lai jūsu atkarības tiktu pareizi instalētas un pārvaldītas Docker konteineros. Dockerized vide dažkārt var sarežģīt apstrādi node_modules, it īpaši, ja tiek izmantotas vairākpakāpju versijas, kas var izraisīt tādas kļūdas kā "Nevar atrast moduli @nestjs/cli/bin/nest.js". Šī kļūda parasti rodas, ja globālie moduļi, piemēram, @nestjs/cli nav pareizi uzstādīti konteinerā.

Lai no tā izvairītos, ir svarīgi Dockerfile strukturēt tā, lai visi nepieciešamie moduļi būtu pieejami gan izstrādes, gan ražošanas stadijās. Viens izplatīts risinājums ir tieši instalēt NestJS CLI abos posmos, lai izvairītos no problēmām, kas saistītas ar trūkstošiem binārajiem failiem, izpildot komandas, piemēram, nest start vai nest build. Šī metode nodrošina konsekvenci dažādās vidēs neatkarīgi no tā, vai izmantojat pnpm, npm vai dziju.

Turklāt, izmantojot tādus rīkus kā pnpm var optimizēt Docker attēla izmēru un atkarības instalēšanas procesu. Tomēr jums ir arī jānodrošina, lai pnpm tiktu instalēts globāli, jo daudzi izstrādātāji saskaras ar problēmām, pārslēdzoties starp dažādiem pakotņu pārvaldniekiem Docker konteineros. Strukturējiet daudzpakāpju būvējumus tā, lai tiktu izmantoti tikai būtiskie faili (piemēram, mape dist un node_modules) tiek pārkopēti uz ražošanas posmu, var palīdzēt racionalizēt izvietošanas procesu un izvairīties no izplatītām kļūdām, kas saistītas ar trūkstošiem moduļiem.