Никога не трябва да стартирате директно срещу Node.js в производството. Може би.

Понякога се чудя дали изобщо знам много за нещо.

Само преди няколко седмици разговарях с приятел, който спомена отвън, „никога няма да стартирате приложение директно срещу Node в производството“.

Кимнах енергично, за да сигнализирам, че също никога няма да се сблъскам с Node в производството, защото ... хахаха ... .всеки знаят това. Но аз не знаех това! Трябваше ли да знам това?! ?? ПОВЕЧЕ ДОПУСКА ЛИ ДА ПРОГРАМИРАМ?

Ако трябваше да нарисувам диаграма на Вен на това, което знам, срещу това, което чувствам, както всички останали знаят, това би изглеждало така ...

Между другото, тази малка точка става все по-малка, колкото повече остарявам.

Има по-добра диаграма, създадена от Алисия Лиу, която някак промени живота ми. Тя казва, че е по-скоро така ...

Обичам тази диаграма толкова много, защото искам тя да е истина. Не искам да прекарам остатъка от живота си като мъничка, свиваща се синя точка на незначителност.

ТАКА ДРАМАТИЧЕН. Обвинявайте Пандора. Не контролирам какво ще се играе по-нататък, докато пиша тази статия и Dashboard Confessional е наркотик за хелува.

Е, ако приемем, че диаграмата на Алисия е вярна, бих искал да споделя с вас това, което сега знам за стартирането на приложения на Node в производството. Може би нашите относителни диаграми на Вен не се припокриват по този въпрос.

Първо, нека се обърнем към твърдението „никога не стартирайте приложения директно срещу Node в производството“.

Никога не изпълнявайте директно срещу Node в производството

Може би. Но може би не. Нека да поговорим за мотивите зад това твърдение. Първо, нека да разгледаме защо не.

Да кажем, че имаме прост Express сървър. Най-простият Express сървър, за който се сещам ...

const express = require("express"); const app = express(); const port = process.env.PORT || 3000; // viewed at //localhost:3000 app.get("/", function(req, res) { res.send("Again I Go Unnoticed"); }); app.listen(port, () => console.log(`Example app listening on port ${port}!`));

Бихме изпълнили това със стартов скрипт във package.jsonфайла.

"scripts": { "dev": "npx supervisor index.js", "start": "node index.js" }

Тук има нещо като два проблема. Първият е проблем за развитието, а вторият е производствен проблем.

Проблемът с разработката е, че когато променяме кода, трябва да спрем и да стартираме приложението, за да вземем промените.

За да решим това, обикновено използваме някакъв мениджър на процеса на Node като supervisorили nodemon. Тези пакети ще наблюдават нашия проект и ще рестартират нашия сървър, когато правим промени. Обикновено правя това по този начин ...

"scripts": { "dev": "npx supervisor index.js", "start": "node index.js"}

След това бягам npm run dev. Имайте предвид, че аз работя npx supervisorтук, което ми позволява да използвам supervisorпакета, без да се налага да го инсталирам. I ❤️ 2019. Предимно.

Другият ни проблем е, че все още работим директно срещу Node и вече казахме, че това е лошо и сега предстои да разберем защо.

Тук ще добавя друг маршрут, който се опитва да прочете файл от диск, който не съществува. Това е грешка, която лесно може да се появи във всяко приложение от реалния свят.

const express = require("express"); const app = express(); const fs = require("fs"); const port = process.env.PORT || 3000; // viewed at //localhost:3000 app.get("/", function(req, res) { res.send("Again I Go Unnoticed"); }); app.get("/read", function(req, res) { // this does not exist fs.createReadStream("my-self-esteem.txt"); }); app.listen(port, () => console.log(`Example app listening on port ${port}!`));

Ако стартираме това директно срещу Node с npm startи read отидем до крайната точка, получаваме грешка, защото този файл не съществува.

Кое - нищо страшно, нали? Това е една грешка. Случва се.

НЕ. Голяма работа. Ако се върнете към терминала си, ще видите, че приложението е напълно свалено.

Което означава, че ако се върнете в браузъра и се опитате да отидете до основния URL на сайта, ще получите същата страница за грешка. Една грешка в един метод свали приложението за всички .

Това е лошо. Като наистина лошо. Това е една от основните причини, поради които хората казват „никога да не работи директно срещу Node в производството“ .

ДОБРЕ. И така, ако не можем да стартираме Node в производството, какъв е правилният начин да стартираме Node в производството?

Опции за производствен възел

Имаме няколко възможности.

Един от тях би бил просто да използваме нещо като supervisorили nodemonв производството по същия начин, по който ги използваме в dev. Това би свършило работа, но тези инструменти са малко по-леки. По-добър вариант е нещо, наречено pm2.

pm2 спасяването

pm2 е Node процес мениджър, който има много камбани и свирки. Подобно на всичко останало „JavaScript“, вие го инсталирате (глобално) от npm- или можете просто да използвате npxотново. Не искам да ти казвам как да живееш живота си.

Има много начини да стартирате приложението си с pm2. Най-простият начин е просто да се обадите pm2 startна вашата входна точка.

"scripts": { "start": "pm2 start index.js", "dev": "npx supervisor index.js" },

И ще видите нещо подобно в терминала ...

That’s our process running in the background monitored by pm2. If you visit the read endpoint and crash the application, pm2 will automatically restart it. You won’t see any of that in the terminal because it’s running in the background. If you want to watch pm2 do its thing, you gotta run pm2 log 0. The 0 is the ID of the process we want to see logs for.

There we go! You can see pm2 restart the application when it goes down because of our unhandled error.

We can also pull out our dev command and have pm2 watch files for us and restart on any changes.

"scripts": { "start": "pm2 start index.js --watch", "dev": "npx supervisor index.js" },

Note that because pm2 runs things in the background, you can’t just ctrl+c your way out of a running pm2 process. You have to stop it by passing the ID or the name.

pm2 stop 0

pm2 stop index

Also, note that pm2 retains a reference to the process so you can restart it.

If you want to delete that process reference, you need to run pm2 delete. You can stop and delete a process in one command with delete.

pm2 delete index

We can also use pm2 to run multiple processes of our application. pm2 will automatically balance the load across those instances.

Multiple processes with pm2 fork mode

pm2 has a ton of configuration options and those are contained in an “ecosystem” file. To create one, run pm2 init. You’ll get something like this…

module.exports = { apps: [ { name: "Express App", script: "index.js", instances: 4, autorestart: true, watch: true, max_memory_restart: "1G", env: { NODE_ENV: "development" }, env_production: { NODE_ENV: "production" } } ] };

I’m going to ignore the “deploy” section in this article because I have no idea what it does.

The “apps” section is where you define the apps you want pm2 to run and monitor. You can run more than one. A lot of these configuration settings are probably self-explanatory. The one that I want to focus on here is the instances setting.

pm2 can run multiple instances of your application. You can pass in a number of instances that you want to run and pm2 will spin up that many. So if we wanted to run 4 instances, we could have the following configuration file.

module.exports = { apps: [ { name: "Express App", script: "index.js", instances: 4, autorestart: true, watch: true, max_memory_restart: "1G", env: { NODE_ENV: "development" }, env_production: { NODE_ENV: "production" } } ] };

Then we just run it with pm2 start.

pm2 is now running in “cluster” mode. Each of these processes is running on a different CPU on my machine, depending on how many cores I have. If we wanted to run a process for each core without knowing how many cores we have, we can just pass the max parameter to the instances value.

{ ... instances: "max", ... }

Let’s find out how many cores I’ve got in this machine.

8 CORES! Holy crap. I’m gonna install Subnautica on my Microsoft issued machine. Don’t tell them I said that.

The good thing about running processes on separate CPU’s is that if you have a process that runs amok and takes up 100% of the CPU, the others will still function. If you pass in more instances than you have cores, pm2 will double up processes on CPU’s as necessary.

You can do a WHOLE lot more with pm2, including monitoring and otherwise wrangling those pesky environment variables.

One other item of note: if for some reason you want pm2 to run your npm start script, you can do that by running npm as the process and passing the -- start. The space before the “start” is super important here.

pm2 start npm -- start

In Azure AppService, we include pm2 by default in the background. If you want to use pm2 in Azure, you don’t need to include it in your package.json file. You can just add an ecosystem file and you’re good to go.

OK! Now that we’ve learned all about pm2, let’s talk about why you may not want to use it and it might indeed be ok to run directly against Node.

Running directly against Node in production

I had some questions on this so I reached out to Tierney Cyren who is part of the enormous orange circle of knowledge, especially when it comes to Node.

Tierney pointed out a few drawbacks to using Node based process managers like pm2.

The main reason is that you shouldn’t use Node to monitor Node. You don’t want to use the thing that you are monitoring to monitor that thing. It’s kind of like you asking my teenage son to supervise himself on a Friday night: Will that end badly? It might, and it might not. But you’re about to find out the hard way.

Tierney recommends that you not have a Node process manager running your application at all. Instead, have something at a higher level which watches multiple separate instances of your application. For example, an ideal setup would be if you had a Kubernetes cluster with your app running on separate containers. Kubernetes can then monitor those containers and if any of them go down, it can bring them back and report on their health.

In this case, you can run directly against Node because you are monitoring at a higher level.

As it turns out, Azure is already doing this. If we don’t push a pm2 ecosystem file to Azure, it will start the application with our package.json file start script and we can run directly against Node.

"scripts": { "start": "node index.js" }

In this case, we are running directly against Node and it’s OK. If the application were to crash, you’ll notice that it comes back. That’s because in Azure, your app runs in a container. Azure is orchestrating the container in which your app is running and knows when it faceplants.

But you still only have one instance here. It takes the container a second to come back online after it crashes meaning that there could be a few seconds of downtime for your users.

Ideally, you would want more than one container running. The solution to this would be to deploy multiple instances of your application to multiple Azure AppService sites and then use Azure Front Door to load balance the apps behind a single IP address. Front Door will know when a container is down and will route traffic to other healthy instances of your application.

Azure Front Door Service | Microsoft Azure

Deliver, protect and track the performance of your globally distributed microservice applications with Azure Front Door…azure.microsoft.com

systemd

Another suggestion that Tierney had is to run Node with systemd. I don’t understand too much (or anything at all) about systemd and I’ve already messed this phrasing up once already, so I’ll let Tierney say it in his own words…

Тази опция е възможна само ако имате достъп до Linux във вашето внедряване и контролирате начина, по който Node се стартира на ниво услуга. Ако изпълнявате процеса си Node.js в отдавна работеща Linux VM, като Azure VM, вие сте на добро място да стартирате Node.js с systemd. Ако просто внедрявате файловете си в услуга като Azure AppService или Heroku или се изпълнявате в контейнеризирана среда като Azure Container Instance, вероятно трябва да се отклонявате от тази опция.

Стартиране на вашето приложение Node.js със Systemd - част 1

Написахте следващото страхотно приложение в Node и сте готови да го пуснете в света. Което означава, че можете да ... nodesource.com

Node.js работни нишки

Tierney also wants you to know that Worker Threads are coming in Node. This will allow you to start your app on multiple “workers” (threads) thusly negating the need for something like pm2. Maybe. I don’t know. I didn’t really read the article.

Node.js v11.14.0 Documentation

The worker_threads module enables the use of threads that execute JavaScript in parallel. To access it: const worker =…nodejs.org

Be an Adult

Tierney’s last suggestion was to just handle the error and write some tests like an adult. But who has time for that?

The tiny circle abides

Now you know most of what is in the tiny blue circle. The rest is just useless facts about emo bands and beer.

For more information on pm2, Node and Azure, check out the following resources…

  • //pm2.keymetrics.io/
  • Node.js deployment on VS Code
  • Deploy a simple Node site to Azure