New slack bot integration #691

New message format for slack bot integration
Changed the data displayed in message

Author: Persijn Kwekkeboom

src/main/resources/lib/office-league-report.js

@@ -15,23 +15,23 @@ eventLib.listener({
         storeLib.refresh();
         var game = storeLib.getGameById(event.data.gameId);
         if (game) {
-            var baseUrl = app.config['officeleague.baseUrl'] || 'http://localhost:8080/portal/draft/office-league/app';
-            var gameJson = createGameJson(game, baseUrl);
+            var baseUrl = app.config['officeleague.baseUrl'] || 'localhost:8080/webapp/com.enonic.app.officeleague';
+            var gameData = createGameData(game, baseUrl);
             eventLib.send({
                 type: OFFICE_LEAGUE_GAME_REPORT_EVENT_ID,
                 distributed: false,
                 data: {
-                    game: JSON.stringify(gameJson) //TODO Bug in eventLib
+                    game: JSON.stringify(gameData) //TODO Bug in eventLib
                 }
             });
         }
     }
 });
 
-var createGameJson = function (game, baseUrl) {
-    var gameJson = {
+const createGameData = function (game, baseUrl) {
+    const gameData = {
         gameId: game._id,
-        gameUrl: url(baseUrl, '/games/' + game._id),
+        url: url(baseUrl, '/games/' + game._id),
         finished: game.finished,
         startTime: game.time,
         modifiedTime: game._timestamp,
@@ -54,7 +54,7 @@ var createGameJson = function (game, baseUrl) {
     };
 
     var league = storeLib.getLeagueById(game.leagueId);
-    gameJson.league = createLeagueJson(league, baseUrl);
+    gameData.league = createLeagueJson(league, baseUrl);
 
     var p, gp, playerJson, player, leaguePlayer;
     for (p = 0; p < game.gamePlayers.length; p++) {
@@ -64,14 +64,14 @@ var createGameJson = function (game, baseUrl) {
 
         playerJson = createPlayerJson(player, gp, leaguePlayer, baseUrl);
         playerJson.ranking = storeLib.getRankingForPlayerLeague(gp.playerId, game.leagueId);
-        gameJson.players[playerJson.playerId] = playerJson;
+        gameData.players[p] = playerJson;
 
         if (gp.side === 'red') {
-            gameJson.sides.red.totalScore += gp.score;
-            gameJson.sides.blue.totalScore += gp.scoreAgainst;
+            gameData.sides.red.totalScore += gp.score;
+            gameData.sides.blue.totalScore += gp.scoreAgainst;
         } else if (gp.side === 'blue') {
-            gameJson.sides.blue.totalScore += gp.score;
-            gameJson.sides.red.totalScore += gp.scoreAgainst;
+            gameData.sides.blue.totalScore += gp.score;
+            gameData.sides.red.totalScore += gp.scoreAgainst;
         }
     }
 
@@ -83,12 +83,12 @@ var createGameJson = function (game, baseUrl) {
 
         teamJson = createTeamJson(team, gt, leagueTeam, baseUrl);
         teamJson.ranking = storeLib.getRankingForTeamLeague(gt.teamId, game.leagueId);
-        gameJson.teams[teamJson.teamId] = teamJson;
+        gameData.teams[t] = teamJson;
     }
     var winPoints = (league.rules || {}).pointsToWin || 10;
-    setExpectedScore(gameJson, winPoints);
+    setExpectedScore(gameData, winPoints);
 
-    return gameJson;
+    return createNewMessage(gameData);
 };
 
 var createTeamJson = function (team, gameTeam, leagueTeam, baseUrl) {
@@ -159,4 +159,154 @@ var avg = function (numberArray) {
 
 var url = function (baseUrl, relUrl) {
     return baseUrl + relUrl;
-};
+};
+
+function createNewMessage(data) {
+    if (data.finished) {
+        return createFinishedGameMessage(data);
+    } else {
+        return createNewGameMessage(data);
+    }
+}
+
+/**
+ * Formats the finished game to a slack message format
+ */
+function createFinishedGameMessage(data) {
+    const message = {
+        "blocks": []
+    };
+
+    message.blocks.push(
+        {
+            "type": "header",
+            "text": {
+                "type": "plain_text",
+                "text": `Game finished in ${data.league.name}`
+            }
+        }
+    );
+
+    return message;
+}
+
+/**
+ * Formats the new game to a slack message format
+ * @returns Object
+ */
+function createNewGameMessage(data) {
+    const message = {
+        "blocks": []
+    };
+
+    message.blocks.push(
+        {
+            "type": "header",
+            "text": {
+                "type": "plain_text",
+                "text": `New game in  ${data.league.name}`
+            }
+        }
+    );
+    if (Array.isArray(data.teams) && data.teams.length > 0) {
+        message.blocks.push(
+            createTeamSection(data.teams[1], [data.players[0], data.players[2]]),
+            createVsTeamSection(data.players),
+            createTeamSection(data.teams[0], [data.players[1], data.players[3]])
+        );
+    } else {
+        message.blocks.push(
+            createPlayerSection(data.players[0]),
+            createVsPlayerSection(data.players),
+            createPlayerSection(data.players[1])
+        );
+    }
+
+    return message;
+}
+
+function createVsTeamSection(data) {
+    return {
+        "type": "context",
+        "elements": [
+            {
+                "type": "image",
+                "image_url": `${players[0].imageUrl}`,
+                "alt_text": `Profile image of ${players[0].name}`
+            },
+            {
+                "type": "image",
+                "image_url": `${players[2].imageUrl}`,
+                "alt_text": `Profile image of ${players[2].name}`
+            },
+            {
+                "type": "mrkdwn",
+                "text": "*VS*"
+            },
+            {
+                "type": "image",
+                "image_url": `${players[1].imageUrl}`,
+                "alt_text": `Profile image of ${players[1].name}`
+            },
+            {
+                "type": "image",
+                "image_url": `${players[3].imageUrl}`,
+                "alt_text": `Profile image of ${players[3].name}`
+            }
+        ]
+    };
+}
+
+function createVsPlayerSection(players) {
+    return {
+        "type": "context",
+        "elements": [
+            {
+                "type": "mrkdwn",
+                "text": "*VS*"
+            }
+        ]
+    };
+}
+
+function createPlayerSection(player) {
+    return {
+        "type": "section",
+        "fields": [
+            {
+                "type": "mrkdwn",
+                "text": `*${player.name}* ${player.rating}`
+            },
+        ],
+        "accessory": {
+            "type": "image",
+            "image_url": `${player.imageUrl}`,
+            "alt_text": `Profile image of ${player.name}`
+        }
+    }
+}
+
+function createTeamSection(teamData, players) {
+    return {
+        "type": "section",
+        "text": {
+            "type": "mrkdwn",
+            "text": `*${teamData.name}*`
+        },
+        "fields": [
+            {
+                "type": "mrkdwn",
+                "text": `*${players[0].name}* ${players[0].rating}`
+            },
+            {
+                "type": "mrkdwn",
+                "text": `*${players[1].name}* ${players[1].rating}`
+            }
+        ],
+        "accessory": {
+            "type": "image",
+            "image_url": `${teamData.imageUrl}`,
+            "alt_text": `Profile image for ${teamData.name}`
+        }
+    };
+}

src/main/resources/lib/webhooks.js

@@ -6,6 +6,9 @@ var httpClient = require('/lib/http-client');
 var OFFICE_LEAGUE_GAME_REPORT_EVENT_ID = reportLib.OFFICE_LEAGUE_GAME_REPORT_EVENT_ID;
 var UUID = Java.type('java.util.UUID');
 
+/**
+ * Setup an event listner so the webhook can handle the data
+ */
 exports.setupWebHooks = function () {
     eventLib.listener({
         type: 'custom.' + OFFICE_LEAGUE_GAME_REPORT_EVENT_ID,
@@ -22,7 +25,11 @@ exports.setupWebHooks = function () {
     });
 };
 
-var processGameWebhooks = function (game) {
+/***
+ * Goes over all webhooks and tried processes the games
+ * @param game -- Json data of the current game event
+*/
+const processGameWebhooks = function (game) {
     var urls = [];
     for (var key in app.config) {
         if (key.indexOf('webhooks.server.') === 0 && key.endsWith('.url')) {
@@ -31,19 +38,24 @@ var processGameWebhooks = function (game) {
     }
 
     for (var u = 0; u < urls.length; u++) {
-        try {
+        /* try { */
             processGameWebhook(game, urls[u]);
-        } catch (e) {
+       /*  } catch (e) {
             log.warning('Error posting to webhook: ' + urls[u]);
             if (e.printStackTrace) {
                 e.printStackTrace();
             }
-        }
+        } */
     }
 };
 
-var processGameWebhook = function (gameJson, url) {
-    var event = {
+/***
+ * Creates the message data and send it to the the url
+ * @param gameJson json data of the game
+ * @param url url to the webhook where the game data will be sent
+ */
+const processGameWebhook = function (gameJson, url) {
+    const event = {
         id: "evt_" + randomId(),
         event: "game.updated",
         created: Math.floor(new Date().getTime() / 1000),
@@ -52,17 +64,18 @@ var processGameWebhook = function (gameJson, url) {
         }
     };
 
-    var response = httpClient.request({
-        url: url,
+    // log.info(JSON.stringify(gameJson, null, 4));
+
+    const response = httpClient.request({
+        url,
         method: 'POST',
         contentType: 'application/json',
-        body: JSON.stringify(event),
-        headers: {
-            'Content-Type': 'application/json'
-        }
+        body: JSON.stringify(gameJson),
     });
 
     if (response.status >= 300 || response.status < 200) {
+        // log.info(JSON.stringify(gameJson, null, 4));
+        // log.info(JSON.stringify(response, null, 4));
         log.info('Error posting webhook to [' + url + ']: ' + response.status + ' ' + response.message);
     }
 };

src/main/resources/main.js

@@ -20,4 +20,5 @@ if (!app.config['skip-test-data']) {
 maintenanceTaskLib.launchGameGCTask();
 
 webhooks.setupWebHooks();
-gameNotifications.setupPushNotifications();
+// Currently not working
+// gameNotifications.setupPushNotifications();