Merge pull request #419 from Lichess4545/new-slack-api

New slack api

Author: lakinwecker

.github/workflows/build.yml

@@ -3,30 +3,30 @@
 name: Build
 
 on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+    build:
+        runs-on: ubuntu-latest
 
-    steps:
-      - uses: actions/checkout@v2
+        steps:
+            - uses: actions/checkout@v2
 
-      - uses: actions/setup-node@v2
-        with:
-          node-version: '12'
+            - uses: actions/setup-node@v2
+              with:
+                  node-version: '22'
 
-      - name: Install packages
-        run: yarn install
+            - name: Install packages
+              run: yarn install
 
-      - name: Build project
-        run: yarn build
+            - name: Build project
+              run: yarn build
 
-      - name: Run TSLint
-        run: yarn lint
+            - name: Run TSLint
+              run: yarn lint
 
-      - name: Run tests
-        run: yarn test
+            - name: Run tests
+              run: yarn test

.gitignore

@@ -26,3 +26,5 @@ build
 .yarnrc
 .env
 .idea
+local.env
+copilot-instructions.md

README.md

@@ -1,23 +1,36 @@
-# CHESSTER [![Build Status](https://github.com/Lichess4545/Chesster/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/Lichess4545/Chesster/actions/workflows/build.yml) [![Test Coverage](https://codeclimate.com/github/Lichess4545/Chesster/badges/coverage.svg)](https://codeclimate.com/github/Lichess4545/Chesster/coverage) 
+# CHESSTER [![Build Status](https://github.com/Lichess4545/Chesster/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/Lichess4545/Chesster/actions/workflows/build.yml) [![Test Coverage](https://codeclimate.com/github/Lichess4545/Chesster/badges/coverage.svg)](https://codeclimate.com/github/Lichess4545/Chesster/coverage)
+
 ## Introduction
+
 This bot was created to help moderate the Lichess45+45 league.
 
 It has a simple interface that integrates our Slack team, with Lichess and Website HTTP API.
 
 ## Installation
+
 0. Clone this repo
 1. Install vagrant
 2. Use the included Vagrantfile to bring up the environment - `vagrant up`, `vagrant ssh`, and `cd chesster`
 3. Install the yarn modules - `yarn install --dev`
 4. Generate a classic bot token in your Slack Team's Services and Customization.
 5. Generate a heltour token from Heltour's Administration interfaces.
-6. Add both to your `.env`:
+6. Create environment variables. Note that these names are a big mess because they grew organically, we need to standardize them. Add these to your `.env`:
     ```
-    CHESSTER_4545_SLACK_TOKEN="xoxb-<token>"
+    adminSlack app secrets: Make these for your adminSlack bot and add them.
+    ADMIN_SLACK_APP_TOKEN="xapp-<token>"
     CHESSTER_CHESSTER_SLACK_TOKEN="xoxb-<token>"
-    CHESSTER_HELTOUR_TOKEN="<token>"
+    ADMIN_SLACK_SIGNING_SECRET="<token>"
+    ADMIN_SLACK_BOT_TOKEN="xoxb-<token>"
+
+
+    Chesster app stuff: Make these for your Chesster bot and add them.
+    CHESSTER_HELTOUR_TOKEN="<token>" -- generate this from heltour in the API Keys section
     CHESSTER_LICHESS_TOKEN="<token>"
+    SLACK_APP_TOKEN="xapp-<token>"
+    SLACK_APP_BOT_TOKEN="xoxb-<token>"
+    SLACK_SIGNING_SECRET="<token>"s
     ```
+
 7. Migrate databases: `yarn run migrate config/testconfig.js`
 8. Install your bot's token in the start script, start_chesster.
 9. Start the bot. `yarn run start`
@@ -26,10 +39,11 @@ It has a simple interface that integrates our Slack team, with Lichess and Websi
 
 Run these before submitting a PR:
 
-- `yarn test`
-- `yarn run lint`
+-   `yarn test`
+-   `yarn run lint`
 
 ## Website Integration
+
 This bot utilizes the heltour api from this repo: https://github.com/cyanfish/heltour/
 You will need to create a token from an installation of this app in order to access and manipulate data.
 

config/config.js

@@ -1,15 +1,27 @@
 // NOTE: None of these files are committed and for good reason.
-//       You must provide your own.
+// You must provide your own.
 const dotenv = require('dotenv')
 dotenv.config()
 let db = require('./db.js')
-let _4545_SLACK_TOKEN =
-    process.env.CHESSTER_4545_SLACK_TOKEN || "It won't work without this token"
-let CHESSTER_SLACK_TOKEN =
-    process.env.CHESSTER_CHESSTER_SLACK_TOKEN ||
+
+let LICHESS_4545_APP_TOKEN =
+    process.env.LICHESS_4545_APP_TOKEN || "It won't work without this token"
+let LICHESS_4545_SIGNING_SECRET =
+    process.env.LICHESS_4545_SIGNING_SECRET ||
     "It won't work without this token"
+let LICHESS_4545_BOT_TOKEN =
+    process.env.LICHESS_4545_BOT_TOKEN || "It won't work without this token"
+
+let FORWARD_APP_TOKEN =
+    process.env.FORWARD_APP_TOKEN || "It won't work without this token"
+let FORWARD_SIGNING_SECRET =
+    process.env.FORWARD_SIGNING_SECRET || "It won't work without this token"
+let FORWARD_BOT_TOKEN =
+    process.env.FORWARD_BOT_TOKEN || "It won't work without this token"
+
 let HELTOUR_TOKEN =
     process.env.CHESSTER_HELTOUR_TOKEN || "It won't work without this token"
+
 let LICHESS_TOKEN =
     process.env.CHESSTER_LICHESS_TOKEN || "It won't work without this token"
 
@@ -21,9 +33,18 @@ var config = {
     watcherBaseURL: 'https://lichess.org/api/stream/games-by-users',
     watcherToken: LICHESS_TOKEN,
 
+    // These are never actually used, the variables are accessed another way
     slackTokens: {
-        lichess4545: _4545_SLACK_TOKEN,
-        chesster: CHESSTER_SLACK_TOKEN,
+        lichess4545: {
+            token: LICHESS_4545_BOT_TOKEN,
+            signingSecret: LICHESS_4545_SIGNING_SECRET,
+            appToken: LICHESS_4545_APP_TOKEN,
+        },
+        forwarding: {
+            token: FORWARD_BOT_TOKEN,
+            signingSecret: FORWARD_SIGNING_SECRET,
+            appToken: FORWARD_APP_TOKEN,
+        },
     },
     winston: {
         domain: 'chesster',
@@ -278,7 +299,7 @@ var config = {
         chess960scheduling: 'chess960',
     },
     messageForwarding: {
-        channelId: 'G3D6N2HNF',
+        channelId: 'C08HZL49YH0',
     },
     pingMods: {
         C0VCCPMJ8: ['U0J2J60F8'],

config/db.js

@@ -3,6 +3,7 @@ var config = {
         name: 'chesster',
         username: 'chesster',
         password: 'scrappypulpitgourdehinders',
+        database: 'chesster',
         host: 'localhost',
         dialect: 'postgres',
         logging: false,

config/testconfig.js

@@ -3,16 +3,28 @@
 const UNSTABLE_BOT_ID = 'C016G6T5QTW'
 const UNSTABLE_BOT_LONEWOLF_ID = 'C015V92UJUX'
 
+const LONEWOLF_GAMES_CHANNEL_ID = 'C08JZJNU8UC'
+const LONEWOLF_SCHEDULING_CHANNEL_ID = 'C08K6E8MJNM'
+
+const CHESS960_GAMES_CHANNEL_ID = 'C08KHN4FTUY'
+const CHESS960_SCHEDULING_CHANNEL_ID = 'C08JPSKRF2S'
+
+// This is in the glbert-test slack
+const TEAM_GAMES_CHANNEL_ID = 'C08HXSVUH26'
+
 let config = require('./config.js')
-config['watcherBaseURL'] = 'https://lichess.dev/api/stream/games-by-users'
+
+config['watcherBaseURL'] = 'https://lichess.org/api/stream/games-by-users'
 config['winston']['channel'] = '#modster-logging'
 config['winston']['handleExceptions'] = false
 
 config['welcome']['channel'] = 'dev-testing-lonewolf'
 
+const heltourToken = config['heltour']['token']
+
 let heltour = {
-    baseEndpoint: 'http://localhost:8000/api/',
-    token: config['heltour']['token']
+    baseEndpoint: 'http://127.0.0.1:8000/api/',
+    token: config['heltour']['token'],
 }
 let leagues = ['45+45', 'lonewolf', 'blitzbattle', 'chess960']
 config['heltour'] = heltour
@@ -23,30 +35,41 @@ leagues.map((k) => {
     }
 })
 
-config['leagues']['45+45']['scheduling']['channel'] = 'dev-testing'
-config['leagues']['45+45']['results']['channel'] = 'dev-testing'
-config['leagues']['45+45']['results']['channelId'] = UNSTABLE_BOT_ID
-config['leagues']['45+45']['gamelinks']['channel'] = 'dev-testing'
-config['leagues']['45+45']['gamelinks']['channelId'] = UNSTABLE_BOT_ID
+config['leagues']['45+45']['scheduling']['channel'] = 'team-scheduling'
+// TODO events API: This was 'dev-testing' in the original config
+config['leagues']['45+45']['results']['channel'] = 'team-games'
+config['leagues']['45+45']['results']['channelId'] = TEAM_GAMES_CHANNEL_ID
+// TODO events API: This was 'dev-testing' in the original config
+config['leagues']['45+45']['gamelinks']['channel'] = 'team-games'
+config['leagues']['45+45']['gamelinks']['channelId'] = TEAM_GAMES_CHANNEL_ID
 config['leagues']['45+45']['alternate']['channelId'] = UNSTABLE_BOT_ID
-config['leagues']['lonewolf']['scheduling']['channel'] = 'dev-testing-lonewolf'
-config['leagues']['lonewolf']['results']['channel'] = 'dev-testing-lonewolf'
-config['leagues']['lonewolf']['results']['channelId'] = UNSTABLE_BOT_LONEWOLF_ID
-config['leagues']['lonewolf']['gamelinks']['channel'] = 'dev-testing-lonewolf'
-config['leagues']['lonewolf']['gamelinks'][
-    'channelId'
-] = UNSTABLE_BOT_LONEWOLF_ID
+config['leagues']['lonewolf']['scheduling']['channel'] = 'lonewolf-scheduling'
+config['leagues']['lonewolf']['results']['channel'] = 'lonewolf-games'
+config['leagues']['lonewolf']['results']['channelId'] =
+    LONEWOLF_GAMES_CHANNEL_ID
+config['leagues']['lonewolf']['gamelinks']['channel'] = 'lonewolf-games'
+config['leagues']['lonewolf']['gamelinks']['channelId'] =
+    LONEWOLF_GAMES_CHANNEL_ID
+// Events API todo: I added this in becaue there was nothing for 960, not sure if it's needed
+config['leagues']['chess960']['scheduling']['channel'] = 'chess960scheduling'
+config['leagues']['chess960']['scheduling']['channelId'] =
+    CHESS960_SCHEDULING_CHANNEL_ID
+config['leagues']['chess960']['results']['channel'] = 'chess960games'
+config['leagues']['chess960']['results']['channelId'] =
+    CHESS960_GAMES_CHANNEL_ID
+config['leagues']['chess960']['gamelinks']['channel'] = 'chess960games'
 
 config['channelMap'][UNSTABLE_BOT_ID] = '45+45'
 config['channelMap']['dev-testing'] = '45+45'
 config['channelMap']['dev-testing-lonewolf'] = 'lonewolf'
 config['channelMap']['dev-testing-blitz'] = 'blitz'
 config['channelMap'][UNSTABLE_BOT_LONEWOLF_ID] = 'lonewolf'
 
-config['messageForwarding']['channelId'] = 'G3FJXJ0C9'
+config['messageForwarding']['channelId'] = 'C08HZL49YH0'
 config['pingMods'] = {
-    "C016G6T5QTW": [ // #dev-testing
-        "U0164C6FXLK" // @lakinwecker
+    C016G6T5QTW: [
+        // #dev-testing
+        'U0164C6FXLK', // @lakinwecker
     ],
 }
 

package.json

@@ -7,8 +7,9 @@
         "test": "test"
     },
     "dependencies": {
+        "@slack/bolt": "^4.2.0",
         "@slack/rtm-api": "^5.0.3",
-        "@slack/web-api": "^5.8.0",
+        "@slack/web-api": "^7.9.1",
         "@types/fast-levenshtein": "^0.0.1",
         "async": "^3.2.2",
         "chai": "^4.2.0",
@@ -21,7 +22,7 @@
         "logform": "^2.1.2",
         "moment": "^2.29.4",
         "moment-timezone": "^0.5.35",
-        "pg": "^7.8.2",
+        "pg": "^8.11.3",
         "pg-hstore": "^2.3.3",
         "q": "^1.5.1",
         "sequelize": "^5.21.5",
@@ -42,7 +43,7 @@
         "@types/chai": "^4.2.10",
         "@types/lodash": "^4.14.149",
         "@types/mocha": "^7.0.2",
-        "@types/node": "^13.9.0",
+        "@types/node": "^22.13.14",
         "@types/q": "^1.5.2",
         "@types/triple-beam": "^1.3.0",
         "@types/validator": "^12.0.1",
@@ -52,7 +53,7 @@
         "newtype-ts": "^0.3.4",
         "nyc": "^15.1.0",
         "ts-node": "^8.8.1",
-        "typescript": "^3.8.3"
+        "typescript": "^5.8.2"
     },
     "scripts": {
         "build": "node_modules/typescript/bin/tsc",