@colyseus/tools 0.15.41 → 0.15.43

package/README.md

@@ -7,19 +7,19 @@
   <a href="https://npmjs.com/package/colyseus">
     <img src="https://img.shields.io/npm/dm/colyseus.svg?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAHdElNRQfjAgETESWYxR33AAAAtElEQVQoz4WQMQrCQBRE38Z0QoTcwF4Qg1h4BO0sxGOk80iCtViksrIQRRBTewWxMI1mbELYjYu+4rPMDPtn12ChMT3gavb4US5Jym0tcBIta3oDHv4Gwmr7nC4QAxBrCdzM2q6XqUnm9m9r59h7Rc0n2pFv24k4ttGMUXW+sGELTJjSr7QDKuqLS6UKFChVWWuFkZw9Z2AAvAirKT+JTlppIRnd6XgaP4goefI2Shj++OnjB3tBmHYK8z9zAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDE5LTAyLTAxVDE4OjE3OjM3KzAxOjAwGQQixQAAACV0RVh0ZGF0ZTptb2RpZnkAMjAxOS0wMi0wMVQxODoxNzozNyswMTowMGhZmnkAAAAZdEVYdFNvZnR3YXJlAHd3dy5pbmtzY2FwZS5vcmeb7jwaAAAAAElFTkSuQmCC">
   </a>
-  <a href="https://github.com/colyseus/colyseus/discussions" title="Discuss on Forum">
-    <img src="https://img.shields.io/badge/discuss-on%20forum-brightgreen.svg?style=for-the-badge&colorB=0069b8&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAHdElNRQfjAgETDROxCNUzAAABB0lEQVQoz4WRvyvEARjGP193CnWRH+dHQmGwKZtFGcSmxHAL400GN95ktIpV2dzlLzDJgsGgGNRdDAzoQueS/PgY3HXHyT3T+/Y87/s89UANBKXBdoZo5J6L4K1K5ZxHfnjnlQUf3bKvkgy57a0r9hS3cXfMO1kWJMza++tj3Ac7/LY343x1NA9cNmYMwnSS/SP8JVFuSJmr44iFqvtmpjhmhBCrOOazCesq6H4P3bPBjFoIBydOk2bUA17I080Es+wSZ51B4DIA2zgjSpYcEe44Js01G0XjRcCU+y4ZMrDeLmfc9EnVd5M/o0VMeu6nJZxWJivLmhyw1WHTvrr2b4+2OFqra+ALwouTMDcqmjMAAAAldEVYdGRhdGU6Y3JlYXRlADIwMTktMDItMDFUMTg6MTM6MTkrMDE6MDAC9f6fAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDE5LTAyLTAxVDE4OjEzOjE5KzAxOjAwc6hGIwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAAASUVORK5CYII=" alt="Discussion forum" />
-  </a>
   <a href="http://chat.colyseus.io">
     <img src="https://img.shields.io/discord/525739117951320081.svg?style=for-the-badge&colorB=7581dc&logo=discord&logoColor=white">
   </a>
+  <a href="https://github.com/colyseus/colyseus/discussions" title="Discuss on Forum">
+    <img src="https://img.shields.io/badge/discuss-on%20forum-brightgreen.svg?style=for-the-badge&colorB=0069b8&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAHdElNRQfjAgETDROxCNUzAAABB0lEQVQoz4WRvyvEARjGP193CnWRH+dHQmGwKZtFGcSmxHAL400GN95ktIpV2dzlLzDJgsGgGNRdDAzoQueS/PgY3HXHyT3T+/Y87/s89UANBKXBdoZo5J6L4K1K5ZxHfnjnlQUf3bKvkgy57a0r9hS3cXfMO1kWJMza++tj3Ac7/LY343x1NA9cNmYMwnSS/SP8JVFuSJmr44iFqvtmpjhmhBCrOOazCesq6H4P3bPBjFoIBydOk2bUA17I080Es+wSZ51B4DIA2zgjSpYcEe44Js01G0XjRcCU+y4ZMrDeLmfc9EnVd5M/o0VMeu6nJZxWJivLmhyw1WHTvrr2b4+2OFqra+ALwouTMDcqmjMAAAAldEVYdGRhdGU6Y3JlYXRlADIwMTktMDItMDFUMTg6MTM6MTkrMDE6MDAC9f6fAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDE5LTAyLTAxVDE4OjEzOjE5KzAxOjAwc6hGIwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAAASUVORK5CYII=" alt="Discussion forum" />
+  </a>
   <h3>
     Multiplayer Framework for Node.js. <br /><a href="https://docs.colyseus.io/">View documentation</a>
   </h3>
 </div>
 
-Colyseus is an Authoritative Multiplayer Framework for Node.js, with clients
-available for the Web, Unity3d, Defold, Haxe, and Cocos. ([See official clients](#%EF%B8%8F-official-client-integration))
+Colyseus is an Authoritative Multiplayer Framework for Node.js, with SDKs
+available for the Web, Unity, Defold, Haxe, Cocos and Construct3. ([See official SDKs](https://docs.colyseus.io/client/))
 
 The project focuses on providing synchronizable data structures for realtime and
 turn-based games, matchmaking, and ease of usage both on the server-side and

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colyseus/tools",
-  "version": "0.15.41",
+  "version": "0.15.43",
   "description": "Colyseus Tools for Production",
   "input": "./src/index.ts",
   "main": "./build/index.js",
@@ -8,7 +8,8 @@
   "typings": "./build/index.d.ts",
   "bin": {
     "colyseus-system-boot": "system-boot.js",
-    "colyseus-post-deploy": "post-deploy.js"
+    "colyseus-post-deploy": "post-deploy.js",
+    "colyseus-report-stats": "report-stats.js"
   },
   "repository": {
     "type": "git",
@@ -35,14 +36,14 @@
     "@types/cors": "^2.8.10",
     "@types/dotenv": "^8.2.0",
     "uwebsockets-express": "^1.1.10",
-    "@colyseus/uwebsockets-transport": "^0.15.8"
+    "@colyseus/uwebsockets-transport": "^0.15.9"
   },
   "dependencies": {
     "node-os-utils": "^1.3.7",
     "cors": "^2.8.5",
     "dotenv": "^8.2.0",
     "express": "^4.16.2",
-    "@colyseus/core": "^0.15.48",
+    "@colyseus/core": "^0.15.52",
     "@colyseus/ws-transport": "^0.15.2"
   },
   "publishConfig": {

package/post-deploy.js

@@ -27,9 +27,14 @@ if (!CONFIG_FILE) {
 pm2.list(function(err, apps) {
   bailOnErr(err);
 
+  // TODO: flush previous logs (?)
+  // pm2.flush();
+
   if (apps.length === 0) {
+    //
     // first deploy
-    pm2.start(CONFIG_FILE, {...opts}, onAppRunning);
+    //
+    pm2.start(CONFIG_FILE, { ...opts }, () => onAppRunning());
 
   } else {
 
@@ -37,51 +42,84 @@ pm2.list(function(err, apps) {
     // detect if cwd has changed, and restart PM2 if it has
     //
     if (apps[0].pm2_env.pm_cwd !== pm2.cwd) {
-
       //
       // remove all and start again with new cwd
       //
-      pm2.delete('all', function(err) {
-
-        // kill & start again
-        pm2.kill(function() {
-          pm2.start(CONFIG_FILE, { ...opts }, onAppRunning);
-        });
-
-      });
+      restartAll();
 
     } else {
       //
       // reload existing apps
       //
-      pm2.reload(CONFIG_FILE, {...opts}, function(err, apps) {
-        bailOnErr(err);
-
-        const name = apps[0].name;
-
-        // scale app to use all CPUs available
-        if (apps.length !== maxCPU) {
-          pm2.scale(name, maxCPU, onAppRunning);
-
-        } else {
-          onAppRunning();
-        }
-      });
+      reloadAll();
     }
-
   }
 });
 
-function onAppRunning() {
+function onAppRunning(reloadedAppIds) {
+  // reset reloaded app stats
+  if (reloadedAppIds) {
+    resetAppStats(reloadedAppIds);
+  }
   updateColyseusBootService();
   updateAndReloadNginx();
 }
 
+function restartAll () {
+  pm2.delete('all', function (err) {
+    // kill & start again
+    pm2.kill(function () {
+      pm2.start(CONFIG_FILE, { ...opts }, () => onAppRunning());
+    });
+  });
+}
+
+function reloadAll(retry = 0) {
+  pm2.reload(CONFIG_FILE, { ...opts }, function (err, apps) {
+    if (err) {
+      //
+      // Retry in case of "Reload in progress" error.
+      //
+      if (err.message === 'Reload in progress' && retry < 5) {
+        console.warn(err.message, ", retrying...");
+        setTimeout(() => reloadAll(retry + 1), 1000);
+
+      } else {
+        bailOnErr(err);
+      }
+
+      return;
+    }
+
+    const name = apps[0].name;
+    const reloadedAppIds = apps.map(app => app.pm_id);
+
+    // scale app to use all CPUs available
+    if (apps.length !== maxCPU) {
+      pm2.scale(name, maxCPU, () => onAppRunning(reloadedAppIds));
+
+    } else {
+      onAppRunning(reloadedAppIds);
+    }
+  });
+}
+
+function resetAppStats (reloadedAppIds) {
+  reloadedAppIds.forEach((pm_id) => {
+    pm2.reset(pm_id, (err, _) => {
+      if (err) {
+        console.error(err);
+      } else {
+        console.log(`metrics re-set for app_id: ${pm_id}`);
+      }
+    });
+  });
+};
+
 function updateColyseusBootService() {
   //
   // Update colyseus-boot.service to use the correct paths for the application
   //
-
   const COLYSEUS_CLOUD_BOOT_SERVICE = '/etc/systemd/system/colyseus-boot.service';
 
   // ignore if no boot service found

package/report-stats.js

@@ -0,0 +1,164 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const net = require('net');
+const pm2 = require('pm2');
+
+const COLYSEUS_CLOUD_URL = `${process.env.ENDPOINT}/vultr/stats`;
+
+const FAILED_ATTEMPS_FILE = "/var/tmp/pm2-stats-attempts.txt";
+const FETCH_TIMEOUT = 7000;
+
+async function retryFailedAttempts() {
+  /**
+   * Retry cached failed attempts
+   */
+  if (!fs.existsSync(FAILED_ATTEMPS_FILE)) {
+    return;
+  }
+
+  // Retry up to last 30 attempts
+  const failedAttempts = fs.readFileSync(FAILED_ATTEMPS_FILE, "utf8").split("\n").slice(-30);
+
+  for (const body of failedAttempts) {
+    // skip if empty
+    if (!body) { continue; }
+
+    try {
+      await fetch(COLYSEUS_CLOUD_URL, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          "Authorization": `Bearer ${process.env.COLYSEUS_SECRET}`,
+          "ngrok-skip-browser-warning": "yes",
+        },
+        body,
+        signal: AbortSignal.timeout(FETCH_TIMEOUT)
+      });
+    } catch (e) {
+      console.error(e);
+    }
+  }
+
+  fs.unlinkSync(FAILED_ATTEMPS_FILE);
+}
+
+async function fetchRetry(url, options, retries = 3) {
+  try {
+    return await fetch(url, options)
+  } catch (err) {
+    if (retries === 1) throw err;
+    return await fetchRetry(url, options, retries - 1);
+  }
+};
+
+pm2.Client.executeRemote('getMonitorData', {}, async function(err, list) {
+  const aggregate = { ccu: 0, roomcount: 0, };
+  const apps = {};
+
+  await Promise.all(list.map(async (item) => {
+    const env = item.pm2_env;
+    const app_id = env.pm_id;
+    const uptime = new Date(env.pm_uptime); // uptime in milliseconds
+    const axm_monitor = env.axm_monitor;
+    const restart_time = env.restart_time;
+    const status = env.status; // 'online', 'stopped', 'stopping', 'waiting restart', 'launching', 'errored'
+    const node_version = env.node_version;
+
+    const monit = {
+      cpu: item.monit.cpu, // 0 ~ 100 (%)
+      memory: item.monit.memory / 1024 / 1024, // in MB
+    };
+
+    const version = {};
+    if (env.versioning) {
+      version.revision = env.versioning.revision;
+      version.comment = env.versioning.comment;
+      version.branch = env.versioning.branch;
+      version.update_time = env.versioning.update_time;
+    }
+
+    aggregate.ccu += axm_monitor.ccu?.value ?? 0;
+    aggregate.roomcount += axm_monitor.roomcount?.value ?? 0;
+
+    const custom_monitor = {};
+    for (const originalKey in axm_monitor) {
+      const key = (originalKey.indexOf(" ") !== -1)
+        ? axm_monitor[originalKey].type
+        : originalKey;
+      custom_monitor[key] = Number(axm_monitor[originalKey].value);
+    }
+
+    // check if process .sock file is active
+    const socket_is_active = await checkSocketIsActive(`/run/colyseus/${(2567 + env.NODE_APP_INSTANCE)}.sock`);
+
+    apps[app_id] = {
+      pid: item.pid,
+      uptime,
+      app_id,
+      status,
+      restart_time,
+      ...monit,
+      ...custom_monitor,
+      version,
+      node_version,
+      socket_is_active,
+    };
+  }));
+
+  const fetchipv4 = await fetch("http://169.254.169.254/v1.json");
+  const ip = (await fetchipv4.json()).interfaces[0].ipv4.address;
+
+  const body = {
+    version: 1,
+    ip,
+    time: new Date(),
+    aggregate,
+    apps,
+  };
+
+  console.log(body);
+
+  try {
+    const response = await fetchRetry(COLYSEUS_CLOUD_URL, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "Authorization": `Bearer ${process.env.COLYSEUS_SECRET}`,
+        "ngrok-skip-browser-warning": "yes",
+      },
+      body: JSON.stringify(body),
+      signal: AbortSignal.timeout(FETCH_TIMEOUT)
+    });
+
+    if (response.status !== 200) {
+      throw new Error(`Failed to send stats to Colyseus Cloud. Status: ${response.status}`);
+    }
+
+    console.log("OK");
+
+    // Only retry failed attempts if the current attempt was successful
+    await retryFailedAttempts();
+
+  } catch (e) {
+    console.error("Failed to send stats to Colyseus Cloud. ");
+
+    // cache failed attempts
+    fs.appendFileSync(FAILED_ATTEMPS_FILE, JSON.stringify(body) + "\n");
+
+  } finally {
+    process.exit();
+  }
+});
+
+function checkSocketIsActive(sockFilePath) {
+  return new Promise((resolve, _) => {
+    const client = net.createConnection({ path: sockFilePath, timeout: 5000 })
+      .on('connect', () => {
+        client.end(); // close the connection
+        resolve(true);
+      })
+      .on('error', () => resolve(false))
+      .on('timeout', () => resolve(false));
+  });
+}