Riešenie chyby „Chýbajúci štartovací skript“ v Node.js v rámci Docker

Spustenie Node.js Backend v Docker: Sprievodca riešením problémov

Pri pokuse o spustenie sa vyskytla chyba Backend Node.js vnútri a Docker kontajner môže byť frustrujúce, najmä ak je to kvôli jednoduchej správe „Chýbajúci štartovací skript“. Táto chyba sa často vyskytuje, keď NPM nemôže nájsť správny štartovací príkaz vo vašom nastavení. Ak vás to zasiahlo, nie ste sami!

V mnohých prípadoch sa problém scvrkáva na nesprávne cesty alebo nesprávne zarovnané konfigurácie medzi súbormi package.json a nastaveniami Docker. Pri riešení je ľahké prehliadnuť malý detail viacstupňové zostavy, kontajnerizácia a konfiguračné súbory. Keď som sám čelil tomuto problému, môžem povedať, že jeho oprava často zahŕňa kontrolu umiestnenia a skriptov každého súboru.

Napríklad som raz nasadil backend a neskôr som si uvedomil, že môj priečinok dist nebol správne namapovaný, čo spôsobilo zlyhanie príkazu štart. Jednoduché vylepšenia môžu tieto problémy vyriešiť, no nájsť ten správny si vyžaduje trpezlivosť 🔍. Kontrola, či sú všetky závislosti a skripty správne namapované, môže ušetriť hodiny ladenia.

V tejto príručke sa ponoríme do niekoľkých praktických krokov na opravu tejto chyby, najmä ak prevádzkujete svoj backend spolu s databázou, ako je DynamoDB v Dockeri. Poďme spoločne vyriešiť chybu „chýbajúci štartovací skript“, aby váš backend fungoval hladko!

Konfigurácia Docker pre Node.js a pripojenie k databáze

Vo vyššie uvedenom príklade nastavenie Docker využíva viacstupňové zostavenie, ktoré je užitočné na vytváranie efektívnych kontajnerov pripravených na výrobu. Prvá fáza, definovaná ako „staviteľ“, nainštaluje závislosti a skompiluje súbor TypeScript súbory do JavaScriptu v dist priečinok. Tento krok zaisťuje, že skompilovaný kód je pripravený na produkciu bez zbytočných závislostí vývoja. Po vytvorení druhá fáza (runtime) skopíruje iba skompilované súbory a produkčné závislosti, čím sa minimalizuje veľkosť kontajnera. Toto nastavenie je obzvlášť užitočné, ak často nasadzujete do cloudových prostredí, kde sa počíta každý kúsok optimalizácie! 🚀

The WORKDIR príkaz v oboch fázach nastaví pracovný adresár kontajnera na /app. To zjednodušuje cesty k súborom a organizuje všetky operácie okolo tohto adresára. V nadväznosti na to KOPÍROVAŤ inštrukcie presúvajú konkrétne súbory z hostiteľského počítača do kontajnera. V prvej fáze sa skopírujú súbory package*.json a tsconfig.json, aby sa umožnila inštalácia závislosti a kompilácia TypeScript, a SPUSTITE inštaláciu npm a RUN npm spustiť zostavenie príkazy zabezpečujú, že je všetko správne nastavené. Toto nastavenie pomáha predchádzať problémom, ako sú chýbajúce spúšťacie skripty, tým, že sa ubezpečíte, že všetky súbory sú správne skopírované a nakonfigurované.

The docker-compose.yml súbor spája backend s DynamoDB, čo je nevyhnutné pre lokálne testovanie a vývoj. The závisí_na možnosť povie Dockerovi, aby spustil DynamoDB pred backendovou službou, čím zaistí, že databáza je pripravená na akékoľvek pokusy o pripojenie z backendu. V scenároch reálneho sveta môže absencia takéhoto nastavenia závislosti viesť k problémom s pripojením, keď sa backend spustí pred databázou, čo vedie k frustrujúcim chybám. The zdravotná prehliadka príkaz otestuje, či je DynamoDB dosiahnuteľný pomocou príkazu ping na koncový bod, pričom to zopakuje, kým sa nevytvorí pripojenie. Táto úroveň spracovania chýb šetrí čas tým, že zabezpečuje spustenie služieb v správnom poradí 🕒.

Nakoniec sme v súbore package.json definovali súbor začať skript ako node dist/server.js. Tento príkaz zaisťuje, že NPM presne vie, ktorý súbor sa má spustiť v kontajneri, čo pomáha vyhnúť sa chybe „chýbajúci štartovací skript“. K dispozícii je tiež príkaz na zostavenie na kompiláciu kódu TypeScript a čistý príkaz na odstránenie priečinka dist, čím sa zabezpečí, že každé nasadenie začne znova. Pomocou skriptov npm, ako sú tieto, je nastavenie spoľahlivejšie, najmä ak je zapojený Docker, pretože ponúka predvídateľné cesty a akcie. Táto komplexná konfigurácia skriptov Docker, Docker Compose a NPM spolupracuje na vytvorení zjednodušeného pracovného postupu od vývoja po produkciu.

# Dockerfile
FROM node:18 AS builder
WORKDIR /app
# Copy necessary config files and install dependencies
COPY package*.json tsconfig.json ./
RUN npm install
# Copy all source files and build the project
COPY . .
RUN npm run build
# Production stage
FROM node:18-alpine
WORKDIR /app
COPY --from=builder /app/package*.json ./
RUN npm install --omit=dev
COPY --from=builder /app/dist ./dist
EXPOSE 3001
# Adjust command to start the server
CMD ["node", "dist/server.js"]

# docker-compose.yml
version: "3.9"
services:
  backend:
    build:
      context: .
      dockerfile: Dockerfile
    ports:
      - "3001:3001"
    environment:
      PORT: 3001
    depends_on:
      - dynamodb
    command: ["npm", "run", "start"]
  dynamodb:
    image: amazon/dynamodb-local
    ports:
      - "8001:8000"
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8000"]
      interval: 10s
      timeout: 5s
      retries: 5

{
  "name": "backend",
  "version": "1.0.0",
  "main": "dist/server.js",
  "scripts": {
    "build": "tsc",
    "start": "node dist/server.js",
    "dev": "nodemon --exec ts-node src/server.ts",
    "clean": "rimraf dist"
  }
}

// test/deployment.test.js
const fs = require('fs');
describe('Deployment Tests', () => {
  test('dist folder exists', () => {
    expect(fs.existsSync('./dist')).toBe(true);
  });
  test('start script exists in package.json', () => {
    const packageJson = require('../package.json');
    expect(packageJson.scripts.start).toBe("node dist/server.js");
  });
  test('Dockerfile has correct CMD', () => {
    const dockerfile = fs.readFileSync('./Dockerfile', 'utf8');
    expect(dockerfile).toMatch(/CMD \["node", "dist\/server.js"\]/);
  });
});

Zabezpečenie správneho kopírovania súborov a štruktúry v Docker pre projekty Node.js

Pri práci s aplikáciami Node.js v Dockeri je jedným z kľúčových aspektov zabezpečenie správneho kopírovania a štruktúrovania všetkých potrebných súborov v kontajneri. Vo viacstupňových zostavách, ako je príklad vyššie, má každá fáza špecifický účel. Počiatočná fáza, „staviteľ“, sa zaoberá kompiláciou TypeScript do JavaScriptu a pripravuje súbor dist priečinok. V druhej fáze sú zahrnuté iba produkčné súbory, čím sa znižuje veľkosť kontajnera a optimalizuje sa nasadenie. Tento prístup nielenže znižuje zbytočné nafúknutie, ale tiež zvyšuje bezpečnosť vynechaním vývojových nástrojov.

Základným aspektom Docker pre Node.js je organizácia package.json a spustiť skript presne. Jasným zadaním ciest v súbore Dockerfile a zabezpečením správneho nastavenia príkazu štart package.jsonminimalizujete chyby, ako napríklad „Chýbajúci spúšťací skript“. Je tiež dôležité potvrdiť, že Docker vie, kde by mal byť každý súbor, najmä v zložitých nastaveniach zahŕňajúcich viacero služieb alebo priečinkov. Napríklad pomocou príkazu COPY na pridanie iba dist priečinok a potrebné konfigurácie do finálneho kontajnera zaisťujú, že v produkcii sú dostupné len nevyhnutné súbory 📂.

Ak chcete skontrolovať stav svojich služieb, docker-compose.yml súbor používa kontrolu stavu na overenie pripravenosti databázy. Definovaním závislostí zaisťujeme, že sa backendová služba nespustí, kým databáza nezačne reagovať, čím sa zabráni problémom s pripojením súvisiacim s načasovaním. Toto nastavenie je obzvlášť výhodné v reálnych aplikáciách, kde je pripojenie k databáze životne dôležité. Bez tejto štruktúry sa môžu služby pokúsiť pripojiť skôr, ako budú spustené ostatné služby, čo môže viesť k chybám behu a potenciálnemu výpadku pre používateľov 🔄.