Løser "Manglende startskript"-feilen i Node.js i Docker

Starte Node.js Backend i Docker: En feilsøkingsveiledning

Oppstår en feil når du prøver å kjøre din Node.js-backend inne i a Docker container kan være frustrerende, spesielt når det er på grunn av en enkel "Mangler startskript"-melding. Denne feilen oppstår ofte når NPM finner ikke riktig startkommando i oppsettet ditt. Hvis du har blitt rammet av dette, er du ikke alene!

I mange tilfeller koker problemet ned til feil baner eller feiljusterte konfigurasjoner mellom innstillingene for package.json og Docker. Det er lett å overse en liten detalj når du arbeider med flertrinnsbygg, containerisering og konfigurasjonsfiler. Etter å ha møtt dette problemet selv, kan jeg si at å fikse det ofte innebærer å sjekke hver fils plassering og skript.

For eksempel distribuerte jeg en gang en backend og innså senere at dist-mappen min ikke var riktig kartlagt, noe som førte til at startkommandoen mislyktes. Enkle justeringer kan løse disse problemene, men å finne den rette krever tålmodighet. Å sjekke om alle avhengigheter og skript er riktig kartlagt kan spare timer med feilsøking.

I denne veiledningen vil vi dykke ned i noen praktiske trinn for å fikse denne feilen, spesielt hvis du kjører backend sammen med en database som DynamoDB i Docker. La oss feilsøke feilen "manglende startskript" sammen for å få backend til å fungere problemfritt!

Docker-konfigurasjon for Node.js og databasetilkobling

I eksemplet ovenfor utnytter Docker-oppsettet en flertrinnsbygging, som er nyttig for å lage effektive produksjonsklare containere. Det første trinnet, definert som "bygger", installerer avhengigheter og kompilerer TypeScript filer til JavaScript i dist mappe. Dette trinnet sikrer at den kompilerte koden er klar for produksjon uten å inkludere unødvendige dev-avhengigheter. Når den er bygget, kopierer det andre trinnet (runtime) bare de kompilerte filene og produksjonsavhengighetene, og minimerer beholderstørrelsen. Dette oppsettet er spesielt nyttig hvis du ofte distribuerer til skymiljøer der hver bit av optimalisering teller! 🚀

De WORKDIR kommandoen i begge trinn setter beholderens arbeidskatalog til /app. Dette forenkler filstier og organiserer alle operasjoner rundt denne katalogen. Etter det, KOPIERE instruksjoner flytter spesifikke filer fra vertsmaskinen til beholderen. I det første trinnet kopieres pakke*.json-filer og tsconfig.json for å tillate avhengighetsinstallasjon og TypeScript-kompilering, og KJØR npm installasjon og KJØR npm kjøre bygg kommandoer sikrer at alt er satt opp riktig. Dette oppsettet hjelper til med å unngå problemer som manglende startskript ved å sørge for at alle filene er riktig kopiert og konfigurert.

De docker-compose.yml fil kobler backend med DynamoDB, som er avgjørende for lokal testing og utvikling. De avhenger_på alternativet ber Docker om å starte DynamoDB før backend-tjenesten, og sikrer at databasen er klar for alle tilkoblingsforsøk fra backend. I virkelige scenarier kan det å ikke ha et slikt avhengighetsoppsett føre til tilkoblingsproblemer når backend starter før databasen, noe som resulterer i frustrerende feil. De helsesjekk kommando tester om DynamoDB er tilgjengelig ved å pinge endepunktet, og prøver på nytt til en tilkobling er opprettet. Dette nivået av feilhåndtering sparer tid ved å sikre at tjenestene starter i riktig rekkefølge 🕒.

Til slutt, i package.json, har vi definert start skript som node dist/server.js. Denne kommandoen sikrer at NPM vet nøyaktig hvilken fil som skal kjøres i beholderen, og hjelper til med å unngå feilen "manglende startskript". Det er også en byggekommando for å kompilere TypeScript-kode og en ren kommando for å fjerne dist-mappen, som sikrer at hver distribusjon starter på nytt. Å bruke npm-skript som disse gjør oppsettet mer pålitelig, spesielt når Docker er involvert, siden det tilbyr forutsigbare stier og handlinger. Denne omfattende konfigurasjonen av Docker-, Docker Compose- og NPM-skript fungerer sammen for å skape en strømlinjeformet arbeidsflyt for utvikling til produksjon.

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

Sikre riktig filkopiering og struktur i Docker for Node.js-prosjekter

Når du arbeider med Node.js-applikasjoner i Docker, er en viktig faktor å sikre at alle nødvendige filer er korrekt kopiert og strukturert i beholderen. I flertrinnsbygg, som eksempelet ovenfor, har hvert trinn et spesifikt formål. Den innledende fasen, "bygger", håndterer kompilering av TypeScript til JavaScript og forbereder dist mappe. I det andre trinnet er bare produksjonsfiler inkludert, noe som reduserer beholderstørrelsen og optimaliserer distribusjonen. Denne tilnærmingen reduserer ikke bare unødvendig oppblåsthet, men forbedrer også sikkerheten ved å utelate utviklingsverktøy.

Et viktig aspekt ved Docker for Node.js er å organisere package.json og start skriptet nøyaktig. Ved å spesifisere stier tydelig i Dockerfilen og sikre at startkommandoen er riktig konfigurert i package.json, minimerer du feil som «Mangler startskript». Det er også viktig å bekrefte at Docker vet hvor hver fil skal være, spesielt i komplekse oppsett som involverer flere tjenester eller mapper. Bruk for eksempel COPY-kommandoen til å bare legge til dist mappe og nødvendige konfigurasjoner til den endelige beholderen sikrer at kun viktige filer er tilgjengelige i produksjonen 📂.

For å sjekke helsen til tjenestene dine, docker-compose.yml filen bruker en helsesjekk for å bekrefte at databasen er klar. Ved å definere avhengigheter sikrer vi at backend-tjenesten ikke starter før databasen er responsiv, og forhindrer tidsrelaterte tilkoblingsproblemer. Dette oppsettet er spesielt gunstig i virkelige applikasjoner der databasetilkobling er avgjørende. Uten denne strukturen kan tjenester prøve å koble seg til før andre tjenester er oppe, noe som fører til kjøretidsfeil og potensiell nedetid for brukere 🔄.