feat: Added auto-configuration process

Now it helps you set up credentials on first start/misconfiguration
rafaelpernil2 · Mar 25, 2022 · 5069eb5 · 5069eb5
1 parent ffafe35
commit 5069eb5
Show file tree

Hide file tree

Showing 9 changed files with 453 additions and 41 deletions.
diff --git a/config/tokens.template.json b/config/tokens.template.json
@@ -2,10 +2,10 @@
     "accessToken": "",
     "refreshToken": "",
     "scope": [
-        "channel:manage:redemptions",
-        "channel:read:redemptions",
+        "chat:read",
         "chat:edit",
-        "chat:read"
+        "channel:read:redemptions",
+        "channel:manage:redemptions"
     ],
     "expiresIn": 0,
     "obtainmentTimestamp": 0

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "twitch-midi-bot",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -27,11 +27,12 @@
     "@twurple/chat": "^5.0.18",
     "@twurple/eventsub": "^5.0.18",
     "@twurple/pubsub": "^5.0.18",
+    "chalk": "^4.1.2",
     "dotenv": "^16.0.0",
     "harmonics": "^1.1.0",
+    "jzz": "^1.4.5",
     "nanotimer": "^0.3.15",
-    "webmidi": "^3.0.15",
-    "jzz": "^1.4.5"
+    "webmidi": "^3.0.15"
   },
   "pkg": {
     "assets": [
@@ -47,6 +48,7 @@
   },
   "devDependencies": {
     "@types/nanotimer": "^0.3.0",
+    "@types/node": "^17.0.23",
     "@typescript-eslint/eslint-plugin": "^5.15.0",
     "@typescript-eslint/parser": "^5.15.0",
     "@vercel/ncc": "^0.33.3",
@@ -63,7 +65,8 @@
     "printWidth": 180,
     "trailingComma": "none",
     "singleQuote": true,
-    "tabWidth": 4
+    "tabWidth": 4,
+    "endOfLine": "auto"
   },
   "bin": "dist/index.js",
   "preferGlobal": true

diff --git a/src/configuration/constants.ts b/src/configuration/constants.ts
@@ -12,7 +12,8 @@ export const ERROR_MSG = {
     INSUFFICIENT_PERMISSIONS: "You don't have enough permissions to use this command, ask me or a mod to launch this command or subscribe to this channel",
     INVALID_SWEEP_RANGE: 'Invalid sweep range',
     TWITCH_API: 'Could not connect to Twitch',
-    INVALID_REWARD: 'Invalid MIDI command from reward, please review the configuration of this bot'
+    INVALID_REWARD: 'Invalid MIDI command from reward, please review the configuration of this bot',
+    BAD_SETUP_PROCESS: 'Bad setup, try again'
 };
 
 export const GLOBAL = {
@@ -33,8 +34,13 @@ export const CONFIG = {
     BOT_TOKENS_PATH: './config/bot-tokens.json',
     BROADCASTER_TOKENS_PATH: './config/broadcaster-tokens.json',
     REWARDS_PATH: './config/rewards.json',
+    DOT_ENV_PATH: '.env',
     DEFAULT_VOLUME: 0.8,
-    DEFAULT_TEMPO: 120
+    DEFAULT_TEMPO: 120,
+    LOCAL_SERVER_HOST: 'localhost',
+    LOCAL_SERVER_PORT: 8000,
+    REDIRECT_URI: 'http://localhost:8000',
+    TWITCH_BASE_AUTH_URL: 'https://id.twitch.tv/oauth2/'
 };
 
 export const COMMANDS = {

diff --git a/src/configuration/env-loader.ts b/src/configuration/env-loader.ts
@@ -1,25 +1,40 @@
 import { EnvObject } from '../types/env-object-type';
+import { ERROR_MSG, GLOBAL } from './constants';
 
-function getLoadedEnvVariables(): EnvObject {
-    const variablesToLoad: Partial<EnvObject> = {
-        CLIENT_ID: undefined,
-        CLIENT_SECRET: undefined,
-        BOT_ACCESS_TOKEN: undefined,
-        BOT_REFRESH_TOKEN: undefined,
-        BROADCASTER_ACCESS_TOKEN: undefined,
-        BROADCASTER_REFRESH_TOKEN: undefined,
-        TARGET_CHANNEL: undefined,
-        TARGET_MIDI_NAME: undefined,
-        TARGET_MIDI_CHANNEL: undefined,
-        REWARDS_MODE: undefined
-    };
-    const loadedVariables = Object.fromEntries(Object.entries(variablesToLoad).map(([key]) => [key, process.env[key]])) as EnvObject;
-    areVariablesValid(loadedVariables);
-    return loadedVariables;
+async function getLoadedEnvVariables(altSetupProcess?: () => Promise<EnvObject>): Promise<EnvObject> {
+    function getVariables() {
+        const variablesToLoad: Partial<EnvObject> = {
+            CLIENT_ID: undefined,
+            CLIENT_SECRET: undefined,
+            BOT_ACCESS_TOKEN: undefined,
+            BOT_REFRESH_TOKEN: undefined,
+            BROADCASTER_ACCESS_TOKEN: undefined,
+            BROADCASTER_REFRESH_TOKEN: undefined,
+            TARGET_CHANNEL: undefined,
+            TARGET_MIDI_NAME: undefined,
+            TARGET_MIDI_CHANNEL: undefined,
+            REWARDS_MODE: undefined
+        };
+        const loadedVariables = Object.fromEntries(Object.entries(variablesToLoad).map(([key]) => [key, process.env[key]])) as EnvObject;
+        areVariablesValid(loadedVariables);
+        return loadedVariables;
+    }
+
+    try {
+        return getVariables();
+    } catch (error) {
+        const loadedVariables = await altSetupProcess?.();
+        if (loadedVariables == null) {
+            throw new Error(ERROR_MSG.BAD_SETUP_PROCESS);
+        }
+        areVariablesValid(loadedVariables);
+        // Let's try again
+        return loadedVariables;
+    }
 }
 
 function areVariablesValid(loadedVariables: Record<string, string | undefined>): loadedVariables is EnvObject {
-    const invalidVariables = Object.entries(loadedVariables).filter(([, value]) => value == null);
+    const invalidVariables = Object.entries(loadedVariables).filter(([, value]) => value == null || value === GLOBAL.EMPTY_MESSAGE);
     for (const [key] of invalidVariables) {
         throw new Error(`This app cannot be executed, make sure you set a valid value for ${key} inside the .env file`);
     }