Řešení chyby „Chybějící startovací skript“ v Node.js v Dockeru

Spuštění backendu Node.js v Dockeru: Průvodce řešením problémů

Při pokusu o spuštění došlo k chybě Backend Node.js uvnitř a Docker kontejner může být frustrující, zvláště když je to kvůli jednoduché zprávě „Chybí startovací skript“. Tato chyba se často vyskytuje, když NPM nemůže ve vašem nastavení najít správný příkaz pro spuštění. Pokud vás to zasáhlo, nejste sami!

V mnoha případech se problém scvrkává na nesprávné cesty nebo nesprávné konfigurace mezi nastavením package.json a Docker. Při jednání je snadné přehlédnout malý detail vícestupňové stavby, kontejnerizace a konfigurační soubory. Poté, co jsem tomuto problému čelil sám, mohu říci, že jeho oprava často zahrnuje kontrolu umístění a skriptů každého souboru.

Jednou jsem například nasadil backend a později jsem si uvědomil, že moje složka dist nebyla správně namapována, což způsobilo selhání příkazu start. Jednoduché vychytávky mohou tyto problémy vyřešit, ale najít ten správný vyžaduje trpělivost 🔍. Kontrola, zda jsou všechny závislosti a skripty správně namapovány, může ušetřit hodiny ladění.

V této příručce se ponoříme do několika praktických kroků pro opravu této chyby, zejména pokud provozujete backend vedle databáze, jako je DynamoDB v Dockeru. Pojďme společně vyřešit chybu „chybějícího spouštěcího skriptu“, aby váš backend fungoval hladce!

Konfigurace Dockeru pro Node.js a připojení k databázi

Ve výše uvedeném příkladu využívá nastavení Dockeru vícefázové sestavení, které je užitečné pro vytváření efektivních kontejnerů připravených k produkci. První fáze, definovaná jako „tvůrce“, nainstaluje závislosti a zkompiluje soubor TypeScript soubory do JavaScriptu v dist složku. Tento krok zajišťuje, že zkompilovaný kód je připraven k produkci bez zahrnutí zbytečných závislostí na vývoji. Po vytvoření druhá fáze (runtime) zkopíruje pouze zkompilované soubory a produkční závislosti, čímž se minimalizuje velikost kontejneru. Toto nastavení je zvláště užitečné, pokud často nasazujete do cloudových prostředí, kde se počítá každý kousek optimalizace! 🚀

The WORKDIR příkaz v obou fázích nastaví pracovní adresář kontejneru na /app. To zjednodušuje cesty k souborům a organizuje všechny operace kolem tohoto adresáře. V návaznosti na to KOPIE instrukce přesunou konkrétní soubory z hostitelského počítače do kontejneru. V první fázi se zkopírují soubory package*.json a tsconfig.json, aby se umožnila instalace závislostí a kompilace TypeScript, a SPUSTIT instalaci npm a RUN npm spustit sestavení příkazy zajišťují, že je vše správně nastaveno. Toto nastavení pomáhá vyhnout se problémům, jako jsou chybějící spouštěcí skripty, protože se ujistíte, že jsou všechny soubory správně zkopírovány a nakonfigurovány.

The docker-compose.yml soubor spojuje backend s DynamoDB, což je nezbytné pro místní testování a vývoj. The závisí_na volba říká Dockeru, aby spustil DynamoDB před backendovou službou, čímž zajistí, že databáze je připravena na jakékoli pokusy o připojení z backendu. V reálných scénářích může neexistence takového nastavení závislosti vést k problémům s připojením, když se backend spustí před databází, což má za následek frustrující chyby. The zdravotní prohlídka příkaz otestuje, zda je DynamoDB dosažitelná pomocí příkazu ping na koncový bod, a pokusí se to znovu, dokud nebude navázáno připojení. Tato úroveň zpracování chyb šetří čas tím, že zajišťuje spuštění služeb ve správném pořadí 🕒.

Nakonec jsme v package.json definovali start skript jako uzel dist/server.js. Tento příkaz zajišťuje, že NPM přesně ví, který soubor se má v kontejneru spustit, což pomáhá vyhnout se chybě „chybějící startovací skript“. K dispozici je také příkaz build pro kompilaci kódu TypeScript a příkaz clean pro odstranění složky dist, což zajišťuje, že každé nasazení začíná znovu. Použitím skriptů npm, jako jsou tyto, je nastavení spolehlivější, zvláště když je zapojen Docker, protože nabízí předvídatelné cesty a akce. Tato komplexní konfigurace skriptů Docker, Docker Compose a NPM společně vytváří zjednodušený pracovní postup od vývoje až po produkci.

# 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"\]/);
  });
});

Zajištění správného kopírování souborů a struktury v Dockeru pro projekty Node.js

Při práci s aplikacemi Node.js v Dockeru je jedním z klíčových aspektů zajištění správného zkopírování a struktury všech potřebných souborů v kontejneru. Ve vícestupňových sestavách, jako je příklad výše, má každá fáze specifický účel. Počáteční fáze, "builder", se stará o kompilaci TypeScriptu do JavaScriptu a připravuje dist složku. Ve druhé fázi jsou zahrnuty pouze produkční soubory, což snižuje velikost kontejneru a optimalizuje nasazení. Tento přístup nejen snižuje zbytečné nadýmání, ale také zvyšuje bezpečnost tím, že vynechává vývojové nástroje.

Základním aspektem Dockeru pro Node.js je organizace package.json a spustit skript přesně. Jasným zadáním cest v Dockerfile a zajištěním správného nastavení příkazu start v package.jsonminimalizujete chyby jako "Chybí startovací skript." Je také důležité potvrdit, že Docker ví, kde by měl být každý soubor, zejména ve složitých nastaveních zahrnujících více služeb nebo složek. Například pomocí příkazu COPY přidat pouze dist složka a potřebné konfigurace do finálního kontejneru zajistí, že v produkci budou dostupné pouze nezbytné soubory 📂.

Chcete-li zkontrolovat stav vašich služeb, docker-compose.yml soubor používá kontrolu stavu k ověření, zda je databáze připravena. Definováním závislostí zajistíme, že se služba back-endu nespustí, dokud databáze nezačne reagovat, a zabráníme tak problémům s připojením souvisejícím s načasováním. Toto nastavení je zvláště výhodné v aplikacích reálného světa, kde je konektivita databáze životně důležitá. Bez této struktury se mohou služby pokusit připojit dříve, než budou spuštěny ostatní služby, což vede k chybám běhu a potenciálním výpadkům uživatelů 🔄.