Rozwiązywanie błędu „Brakujący skrypt startowy” w Node.js w Dockerze

Uruchamianie backendu Node.js w Dockerze: przewodnik rozwiązywania problemów

Wystąpił błąd podczas próby uruchomienia pliku Backend Node.js wewnątrz Kontener Dockera może być frustrujące, szczególnie gdy jest to spowodowane prostym komunikatem „Brak skryptu startowego”. Ten błąd często występuje, gdy NPM nie możesz znaleźć prawidłowego polecenia startu w konfiguracji. Jeśli zostałeś przez to dotknięty, nie jesteś sam!

W wielu przypadkach problem sprowadza się do nieprawidłowych ścieżek lub niedopasowanych konfiguracji między ustawieniami pakietu.json i Dockera. Podczas pracy łatwo przeoczyć drobny szczegół kompilacje wieloetapowe, konteneryzacji i plików konfiguracyjnych. Mając do czynienia z tym problemem, mogę powiedzieć, że jego naprawienie często wymaga sprawdzenia położenia każdego pliku i skryptów.

Na przykład kiedyś wdrożyłem backend i później zdałem sobie sprawę, że mój folder dist nie został poprawnie zmapowany, co spowodowało niepowodzenie polecenia Start. Proste poprawki mogą rozwiązać te problemy, ale znalezienie właściwej wymaga cierpliwości 🔍. Sprawdzanie, czy wszystkie zależności i skrypty są poprawnie odwzorowane, może zaoszczędzić wiele godzin debugowania.

W tym przewodniku omówimy kilka praktycznych kroków umożliwiających naprawienie tego błędu, szczególnie jeśli używasz backendu razem z bazą danych taką jak DynamoDB w Dockerze. Rozwiążmy wspólnie błąd „brakującego skryptu startowego”, aby Twój backend działał płynnie!

Konfiguracja Dockera dla Node.js i połączenia z bazą danych

W powyższym przykładzie konfiguracja Dockera wykorzystuje wieloetapową kompilację, co jest przydatne do tworzenia wydajnych kontenerów gotowych do produkcji. Pierwszy etap, zdefiniowany jako „konstruktor”, instaluje zależności i kompiluje plik Maszynopis pliki do JavaScript w formacie odl falcówka. Ten krok gwarantuje, że skompilowany kod będzie gotowy do produkcji bez uwzględniania niepotrzebnych zależności deweloperskich. Po zbudowaniu drugi etap (środowisko wykonawcze) kopiuje tylko skompilowane pliki i zależności produkcyjne, minimalizując rozmiar kontenera. Ta konfiguracja jest szczególnie przydatna, jeśli często wdrażasz rozwiązania w środowiskach chmurowych, w których liczy się każdy szczegół optymalizacji! 🚀

The KATALOG PRACY polecenie w obu etapach ustawia katalog roboczy kontenera na /app. Upraszcza to ścieżki plików i organizuje wszystkie operacje wokół tego katalogu. Następnie KOPIA instrukcje przenoszą określone pliki z komputera hosta do kontenera. W pierwszym etapie kopiowane są pliki package*.json i tsconfig.json, aby umożliwić instalację zależności i kompilację TypeScriptu, a Uruchom instalację npm I RUN npm uruchom kompilację polecenia zapewniają, że wszystko jest poprawnie skonfigurowane. Ta konfiguracja pomaga uniknąć problemów, takich jak brakujące skrypty startowe, poprzez upewnienie się, że wszystkie pliki są poprawnie skopiowane i skonfigurowane.

The docker-compose.yml plik łączy backend z DynamoDB, co jest niezbędne do lokalnego testowania i rozwoju. The zależy_od Opcja mówi Dockerowi, aby uruchomił DynamoDB przed usługą backendu, upewniając się, że baza danych jest gotowa na wszelkie próby połączenia z backendu. W rzeczywistych scenariuszach brak takiej konfiguracji zależności może prowadzić do problemów z łącznością, gdy backend uruchamia się przed bazą danych, co skutkuje frustrującymi błędami. The kontrola stanu zdrowia polecenie sprawdza, czy DynamoDB jest osiągalny, wysyłając polecenie ping do punktu końcowego i ponawiając próbę do czasu nawiązania połączenia. Ten poziom obsługi błędów oszczędza czas, zapewniając uruchomienie usług we właściwej kolejności 🕒.

Na koniec w package.json zdefiniowaliśmy plik start skrypt jako węzeł dist/server.js. To polecenie zapewnia, że ​​NPM dokładnie wie, który plik ma zostać uruchomiony w kontenerze, co pomaga uniknąć błędu „brakującego skryptu startowego”. Dostępna jest także komenda build służąca do kompilowania kodu TypeScript oraz komenda clean do usuwania folderu dist, co gwarantuje, że każde wdrożenie zacznie się od nowa. Używanie takich skryptów npm sprawia, że ​​konfiguracja jest bardziej niezawodna, zwłaszcza gdy zaangażowany jest Docker, ponieważ oferuje przewidywalne ścieżki i działania. Ta wszechstronna konfiguracja skryptów Docker, Docker Compose i NPM współpracuje ze sobą, tworząc usprawniony przepływ pracy od programowania do produkcji.

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

Zapewnienie prawidłowego kopiowania i struktury plików w Dockerze dla projektów Node.js

Podczas pracy z aplikacjami Node.js w Dockerze kluczową kwestią jest zapewnienie prawidłowego skopiowania i uporządkowania wszystkich niezbędnych plików w kontenerze. W kompilacjach wieloetapowych, jak w powyższym przykładzie, każdy etap ma określony cel. Początkowy etap, „builder”, zajmuje się kompilacją TypeScriptu do JavaScript i przygotowuje plik odl falcówka. W drugim etapie uwzględniane są tylko pliki produkcyjne, co zmniejsza rozmiar kontenera i optymalizuje wdrożenie. Takie podejście nie tylko zmniejsza niepotrzebne rozdęcie, ale także zwiększa bezpieczeństwo, pomijając narzędzia programistyczne.

Istotnym aspektem Dockera dla Node.js jest organizacja pakiet.json I uruchom skrypt dokładnie. Określając wyraźnie ścieżki w pliku Dockerfile i upewniając się, że polecenie start jest prawidłowo skonfigurowane pakiet.json, minimalizujesz błędy takie jak „Brakujący skrypt startowy”. Bardzo ważne jest również potwierdzenie, że Docker wie, gdzie powinien znajdować się każdy plik, szczególnie w złożonych konfiguracjach obejmujących wiele usług lub folderów. Na przykład, używając polecenia COPY, aby dodać tylko plik odl folderu i niezbędne konfiguracje do finalnego kontenera sprawia, że ​​w produkcji dostępne są tylko niezbędne pliki 📂.

Aby sprawdzić stan swoich usług, docker-compose.yml plik korzysta z kontroli stanu, aby sprawdzić, czy baza danych jest gotowa. Definiując zależności, zapewniamy, że usługa backendu nie zostanie uruchomiona, dopóki baza danych nie zacznie reagować, co zapobiega problemom z połączeniem związanym z synchronizacją. Taka konfiguracja jest szczególnie korzystna w rzeczywistych zastosowaniach, w których łączność z bazą danych jest niezbędna. Bez tej struktury usługi mogą próbować nawiązać połączenie, zanim inne usługi zostaną uruchomione, co może prowadzić do błędów w czasie wykonywania i potencjalnych przestojów użytkowników 🔄.