#23: Reorg Discord Service Bindings/Structure

package.json

@@ -8,6 +8,7 @@
   },
   "scripts": {
     "start": "node src/server/server.js",
+    "inspect": "node --inspect src/server/server.js",
     "test": "echo \"Error: no test specified\" && exit 1",
     "migrate": "npx prisma migrate dev && npx prisma generate",
     "reset": "rm -rf ./prisma/disco.db* ./prisma/migrations && npx prisma migrate dev --name init"

src/shared/CoreService.js → src/core/CoreService.js

@@ -13,7 +13,7 @@ class CoreService {
     }
     CoreService._instance = this;
     this._bindLogging();
-    this._prisma = new PrismaClient();
+    this._prisma = null;
     this._app = null;
     this._server = null;
     this._client = null;
@@ -22,7 +22,7 @@ class CoreService {
     this._bindModels();
     this._bindMethods();
     this._bindSockets();
-    this.shutdownServer = this.generateTerminator()
+    this._initDiscordClient();
   }
 
   static get instance() {
@@ -35,7 +35,7 @@ class CoreService {
   get client() {
     if (!this._client) {
       this.logger.info('Attaching DiscordJS to core-service');
-      this._client = require('../bot/bot')(this);
+      this._client = require('./bot/bot')(this);
     }
     return this._client;
   }
@@ -52,11 +52,20 @@ class CoreService {
     if (!this._server) {
       this.logger.info('Attaching Http Server to core-service');
       this._server = http.createServer(this.app.callback());
+
+      // SETTING EVENT HANDLERS FOR ON SHUTDOWN
+      process.on('SIGINT', (e) => this.shutdownServer('SIGNINT', e));
+      process.on('SIGTERM', (e) => this.shutdownServer('SIGTERM', e,));
+      process.on('uncaughtException', (e) => this.uncaughtShutdown('uncaughtException', e));
     }
     return this._server;
   }
 
   get prisma() {
+    if (!this._prisma) {
+      this.logger.info('Generating Prisma Cli Instance');
+      this._prisma = new PrismaClient();
+    }
     return this._prisma;
   }
 
@@ -78,9 +87,15 @@ class CoreService {
       ctx.core = this;
       await next();
     });
-    this.autoStartBot();
     return app;
   }
+
+  _initDiscordClient() {
+    this.logger.info('Initializing Discord Bot');
+    const clientInstance = this.client;
+    this.autoStartBot();
+    return clientInstance;
+  }
 
   _bindModels() {
     require('./models')(this);

src/bot/bot.js → src/core/bot/bot.js

@@ -2,9 +2,9 @@ const { Client } = require('discord.js');
 const intentManager = require('./managers/intentManager');
 const eventManager = require('./managers/eventManager');
 
-function generateClient(coreService) {
+function generateClient(core) {
     const client = new Client(intentManager());
-    client.core = coreService;
+    client.core = core;
     eventManager(client);
     return client;
 }

src/bot/managers/events/ready.js → src/core/bot/managers/events/ready.js

@@ -1,16 +1,12 @@
 const { Events } = require('discord.js');
 
-
-async function registerBotOnReady(client) {
-  await client.core.refreshBotInfo(true);
-  await client.core.updateServerSortOrder();
-}
-
 module.exports = {
 	name: Events.ClientReady,
 	once: false,
 	async execute(client) {
-    await registerBotOnReady(client);
+    const core = client.core;
+    await core.refreshBotInfo(true);
+    await core.updateServerSortOrder();
     global.logger.info(`Logged in as ${client.user.tag}!`);
 	},
 };

src/shared/methods/discord/botMethods.js → src/core/methods/discord/afterAuth.js

@@ -1,20 +1,16 @@
 module.exports = {
   async getDiscordServers() {
     const servers = [];
-    const isReady = this.client.isReady();
-    if (isReady) {
-      const foundServers = await this.client.guilds.fetch();
-      this.logger.debug('Discord servers found: ', foundServers.toJSON());
-      foundServers.each(async (foundServer) => {
-        const guildInfo = {
-          server_name: foundServer.name,
-          server_id: foundServer.id,
-          server_avatar_url: foundServer.iconURL()
-        };
-        this.logger.debug('PUSHING SERVER TO UPSERT: ', guildInfo);
-        servers.push(guildInfo);
-      });
-    }
+    const foundServers = await this.client.guilds.fetch();
+    foundServers.each(async (foundServer) => {
+      const guildInfo = {
+        server_name: foundServer.name,
+        server_id: foundServer.id,
+        server_avatar_url: foundServer.iconURL()
+      };
+      logger.debug('Fetch Discord Servers, Upserting to DB: ', guildInfo);
+      servers.push(guildInfo);
+    });
     return servers;
   },
 
@@ -41,12 +37,6 @@ module.exports = {
     await this.updatePowerState(powerOn, discordBot)
   },
 
-  async getInviteLink() {
-    const discordBot = await this.discordBot.get();
-    const inviteLink = discordBot.bot_invite_link;
-    return inviteLink;
-  },
-
   async setInviteLink() {
     const inviteLink = this.client.generateInvite({ scopes: ['bot'] });
     return await this.discordBot.update({ bot_invite_link: inviteLink });
@@ -61,16 +51,4 @@ module.exports = {
     });
   },
 
-  async updatePowerState(powerOn, discordBotInst = null) {
-    const discordBot = discordBotInst || await this.discordBot.get();
-    this.logger.debug('Changing Discord Bot Power State: ', discordBot);
-    await this.emitCompiled([
-      'nav/user/buttons/botPowerButton.pug',
-      'nav/user/userBoxInfo.pug',
-      'nav/servers/addServer.pug'
-    ], {
-      discordBot,
-      state: await this.state.update({ discord_state: powerOn })
-    });
-  }
-}
+};

src/shared/methods/discord/botController.js → src/core/methods/discord/controller.js

@@ -43,4 +43,4 @@ module.exports = {
       return false;
     }
   }
-}
+};

src/core/methods/discord/index.js

@@ -0,0 +1,27 @@
+const _ = require('lodash');
+
+
+function rejectInvocation(method) {
+  this.logger.warn('CALLING CLIENT METHODS BEFORE LOGIN');
+  console.trace(method);
+  return {};
+}
+
+function requireClientLogin(modulePath) {
+  const moduleObj = require(modulePath);
+  return _.mapValues(moduleObj, (method) => {
+    return function(...args) {
+      if (this.client && this.client.isReady()) {
+        return method.apply(this, args);
+      } else {
+        return rejectInvocation(method);
+      }
+    };
+  });
+}
+
+module.exports = {
+  ...require('./methods'),
+  ...require('./controller'),
+  ...requireClientLogin('./afterAuth')
+};

src/core/methods/discord/methods.js

@@ -0,0 +1,20 @@
+module.exports = {
+  async updatePowerState(powerOn, discordBotInst = null) {
+    this.logger.debug('Changing Discord Bot Power State: ', discordBot);
+    const discordBot = discordBotInst || await this.discordBot.get();
+    await this.emitCompiled([
+      'nav/user/buttons/botPowerButton.pug',
+      'nav/user/userBoxInfo.pug',
+      'nav/servers/addServer.pug'
+    ], {
+      discordBot,
+      state: await this.state.update({ discord_state: powerOn })
+    });
+  },
+
+  async getInviteLink() {
+    const discordBot = await this.discordBot.get();
+    const inviteLink = discordBot.bot_invite_link;
+    return inviteLink;
+  },
+};

src/core/methods/index.js

@@ -0,0 +1,8 @@
+const _ = require('lodash');
+
+module.exports = (core) => {
+  _.mixin(core, require('./websocket'));
+  _.mixin(core, require('./server'));
+  _.mixin(core, require('./rendering'));
+  _.mixin(core, require('./discord'));
+}

src/core/methods/rendering/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+  ...require('./serverBarRendering'),
+  ...require('./templateCompiler')
+};
+

src/core/methods/server/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('./processTerminator.js')
+};

src/core/methods/server/processTerminator.js

@@ -0,0 +1,19 @@
+const { createHttpTerminator } = require('http-terminator');
+const logger = global.logger;
+
+
+module.exports = {
+  async uncaughtShutdown(signal, e) {
+    logger.error(`Uncaught exception encountered\n...CHECK LOGS.`, signal, e);
+    console.trace(signal, e);
+  },
+  async shutdownServer(signal, e) {
+    logger.silly(`Received ${signal}\n${e}\n...Shutting down gracefully.`);
+    try {
+      const serverTerminator = createHttpTerminator({ server: this.server }).terminate();
+    } catch (error) {
+      logger.error('Failed to terminate server:', error);
+    }
+    process.exit();
+  }
+};

src/shared/methods/websocket/connections.js → src/core/methods/websocket/connections.js

@@ -1,7 +1,6 @@
 const uuid = require('uuid');
 
-
-module.exports = {
+module.exports =  {
   addClientWS(ws) {
     const id = uuid.v4();
     const color = Math.floor(Math.random() * 360);
@@ -22,4 +21,4 @@ module.exports = {
     this.logger.debug(compiledTemplate);
     await this.emit(compiledTemplate);
   }
-}
+};

src/core/methods/websocket/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+  ...require('./connections'),
+};
+

src/server/server.js

@@ -1,6 +1,5 @@
-const { app, server, logger } = require('../shared/CoreService');
+const { app, server } = require('../core/CoreService');
 const serve = require('koa-static');
-const views = require('koa-views');
 const bodyParser = require('koa-bodyparser');
 const errorHandler = require('./middlewares/errorHandler');
 const debugHandler = require('./middlewares/debugHandler');