Moved benchmark to its own directory and added multicore testing + a README

back/package.json

@@ -41,7 +41,6 @@
     "@types/jsonwebtoken": "^8.3.8",
     "@types/socket.io": "^2.1.4",
     "@types/uuidv4": "^5.0.0",
-    "artillery": "^1.6.1",
     "body-parser": "^1.19.0",
     "express": "^4.17.1",
     "generic-type-guard": "^3.2.0",

back/socketio-load-test.yaml

@@ -1,50 +0,0 @@
-config:
-  target: "http://api.workadventure.localhost/"
-  socketio:
-    transports: ["websocket"]
-    query:
-      token: "test"
-  phases:
-    - duration: 10
-      arrivalRate: 10
-    - duration: 10
-      arrivalRate: 10
-  processor: "./socketioLoadTest.js"
-scenarios:
-  - name: "Connect and send a bunch of messages"
-    weight: 90
-    engine: "socketio"
-    flow:
-      #- loop:
-      #- emit:
-      #    channel: "connection"
-      #    data: "hello world!"
-      #- think: 5
-      - emit:
-          channel: "set-player-details"
-          data:
-            name: 'TEST'
-            characterLayers: ['male3']
-      - think: 1
-      - emit:
-          channel: "join-room"
-          data:
-            roomId: 'global__api.workadventure.localhost/map/files/Floor0/floor0'
-            position:
-              x: 783
-              y: 170
-              direction: 'down'
-              moving: false
-      - think: 1
-      - loop:
-        - function: "setYRandom"
-        - emit:
-            channel: "user-position"
-            data:
-              x: "{{ x }}"
-              y: "{{ y }}"
-              direction: 'down'
-              moving: false
-        - think: 1
-        count: 10
-      - think: 10

back/socketioLoadTest.js

@@ -1,15 +0,0 @@
-/* This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
-
-'use strict';
-
-module.exports = {
-    setYRandom
-};
-
-function setYRandom(context, events, done) {
-    context.vars.x = (883 +  Math.round(Math.random() * 300));
-    context.vars.y = (270 +  Math.round(Math.random() * 300));
-    return done();
-}

back/src/Controller/IoSocketController.ts

@@ -4,7 +4,7 @@ import * as http from "http";
 import {MessageUserPosition, Point} from "../Model/Websocket/MessageUserPosition"; //TODO fix import by "_Model/.."
 import {ExSocketInterface} from "../Model/Websocket/ExSocketInterface"; //TODO fix import by "_Model/.."
 import Jwt, {JsonWebTokenError} from "jsonwebtoken";
-import {SECRET_KEY, MINIMUM_DISTANCE, GROUP_RADIUS} from "../Enum/EnvironmentVariable"; //TODO fix import by "_Enum/..."
+import {SECRET_KEY, MINIMUM_DISTANCE, GROUP_RADIUS, ALLOW_ARTILLERY} from "../Enum/EnvironmentVariable"; //TODO fix import by "_Enum/..."
 import {World} from "../Model/World";
 import {Group} from "_Model/Group";
 import {UserInterface} from "_Model/UserInterface";
@@ -67,12 +67,19 @@ export class IoSocketController {
                 return next(new Error('Authentication error'));
             }
             if(socket.handshake.query.token === 'test'){
-                (socket as ExSocketInterface).token = socket.handshake.query.token;
-                (socket as ExSocketInterface).userId = uuid();
-                console.log((socket as ExSocketInterface).userId);
-                next();
-                return;
+                if (ALLOW_ARTILLERY) {
+                    (socket as ExSocketInterface).token = socket.handshake.query.token;
+                    (socket as ExSocketInterface).userId = uuid();
+                    (socket as ExSocketInterface).isArtillery = true;
+                    console.log((socket as ExSocketInterface).userId);
+                    next();
+                    return;
+                } else {
+                    console.warn("In order to perform a load-testing test on this environment, you must set the ALLOW_ARTILLERY environment variable to 'true'");
+                    next();
+                }
             }
+            (socket as ExSocketInterface).isArtillery = false;
             if(this.searchClientByToken(socket.handshake.query.token)){
                 console.error('An authentication error happened, a user tried to connect while its token is already connected.');
                 return next(new Error('Authentication error'));
@@ -201,7 +208,7 @@ export class IoSocketController {
                         }
                         return new MessageUserPosition(user.id, player.name, player.characterLayers, player.position);
                     }).filter((item: MessageUserPosition|null) => item !== null);
-                    //answerFn(listOfUsers);
+                    answerFn(listOfUsers);
                 } catch (e) {
                     console.error('An error occurred on "join_room" event');
                     console.error(e);
@@ -285,7 +292,10 @@ export class IoSocketController {
                 const Client = (socket as ExSocketInterface);
                 Client.name = playerDetails.name;
                 Client.characterLayers = playerDetails.characterLayers;
-                //answerFn(Client.userId);
+                // Artillery fails when receiving an acknowledgement that is not a JSON object
+                if (!Client.isArtillery) {
+                    answerFn(Client.userId);
+                }
             });
 
             socket.on(SockerIoEvent.SET_SILENT, (silent: unknown) => {

back/src/Enum/EnvironmentVariable.ts

@@ -2,10 +2,12 @@ const SECRET_KEY = process.env.SECRET_KEY || "THECODINGMACHINE_SECRET_KEY";
 const URL_ROOM_STARTED = "/Floor0/floor0.json";
 const MINIMUM_DISTANCE = process.env.MINIMUM_DISTANCE ? Number(process.env.MINIMUM_DISTANCE) : 64;
 const GROUP_RADIUS = process.env.GROUP_RADIUS ? Number(process.env.GROUP_RADIUS) : 48;
+const ALLOW_ARTILLERY = process.env.ALLOW_ARTILLERY ? process.env.ALLOW_ARTILLERY == 'true' : false;
 
 export {
     SECRET_KEY,
     URL_ROOM_STARTED,
     MINIMUM_DISTANCE,
-    GROUP_RADIUS
+    GROUP_RADIUS,
+    ALLOW_ARTILLERY
 }

back/src/Model/Websocket/ExSocketInterface.ts

@@ -11,4 +11,5 @@ export interface ExSocketInterface extends Socket, Identificable {
     name: string;
     characterLayers: string[];
     position: PointInterface;
+    isArtillery: boolean; // Whether this socket is opened by Artillery for load testing (hack)
 }