Feat: handle terminate signal

src/@types/global.d.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2021-2023 mtripg6666tdr
+ * 
+ * This file is part of mtripg6666tdr/Discord-SimpleMusicBot. 
+ * (npm package name: 'discord-music-bot' / repository url: <https://github.com/mtripg6666tdr/Discord-SimpleMusicBot> )
+ * 
+ * mtripg6666tdr/Discord-SimpleMusicBot is free software: you can redistribute it and/or modify it 
+ * under the terms of the GNU General Public License as published by the Free Software Foundation, 
+ * either version 3 of the License, or (at your option) any later version.
+ *
+ * mtripg6666tdr/Discord-SimpleMusicBot is distributed in the hope that it will be useful, 
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
+ * See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with mtripg6666tdr/Discord-SimpleMusicBot. 
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+// eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable no-var */
+import type { Worker } from "worker_threads";
+
+declare global {
+  var workerThread:Worker;
+}

src/AudioSource/youtube/spawner.ts

@@ -26,6 +26,7 @@ import { type exportableYouTube, YouTube } from "..";
 import Util from "../../Util";
 
 const worker = isMainThread ? new Worker(path.join(__dirname, "./worker.js")).on("error", console.error) : null;
+global.workerThread = worker;
 
 export type WithId<T> = T & {id:string};
 export type spawnerJobMessage = spawnerGetInfoMessage | spawnerSearchMessage;
@@ -60,12 +61,14 @@ export type workerLoggingMessage = {
 };
 
 type jobCallback = (callback:workerMessage & {id: string}) => void;
-const jobQueue = worker && new Map<string, {
+type jobQueueContent = {
   callback: jobCallback,
   start: number,
-}>();
+};
+const jobQueue = worker && new Map<string, jobQueueContent>();
 
 if(worker){
+  worker.unref();
   worker.on("message", (message:WithId<workerMessage>) => {
     if(message.type === "log"){
       Util.logger.log(message.data, message.level);

src/AudioSource/youtube/stream.ts

@@ -84,7 +84,7 @@ export function createRefreshableYTLiveStream(info:ytdl.videoInfo, options:ytdl.
         stream.updatePlaylist(await refresher());
         Util.logger.log("playlist updated");
       }
-    }, 60 * 60 * 1000);
+    }, 60 * 60 * 1000).unref();
   });
   stream.once("close", () => {
     clearInterval(timeout);

src/AudioSource/youtube/worker.ts

@@ -26,6 +26,8 @@ import * as ytsr from "ytsr";
 import { YouTube } from ".";
 import Util from "../../Util";
 
+parentPort.unref();
+
 function postMessage(message:workerMessage|WithId<workerMessage>){
   parentPort.postMessage(message);
 }

src/Commands/bulkdelete.ts

@@ -81,7 +81,7 @@ export default class BulkDelete extends BaseCommand {
       await reply.edit(messages.length + "件見つかりました。削除を実行します。");
       await options.client.deleteMessages(message.channel.id, messages.map(msg => msg.id), `${message.member.username}#${message.member.discriminator}により${count}件のメッセージの削除が要求されたため。`);
       await reply.edit(":sparkles:完了!(このメッセージは自動的に消去されます)");
-      setTimeout(() => reply.delete().catch(() => {}), 10 * 1000);
+      setTimeout(() => reply.delete().catch(() => {}), 10 * 1000).unref();
     }
     catch(er){
       Util.logger.log(er, "error");

src/Commands/effect.ts

@@ -45,7 +45,7 @@ export default class Effect extends BaseCommand {
         embeds: [embed.toEris()],
         components: [messageActions]
       });
-      setTimeout(() => reply.edit({components: []}), 5 * 60 * 1000);
+      setTimeout(() => reply.edit({components: []}), 5 * 60 * 1000).unref();
     }
     catch(e){
       Util.logger.log(e, "error");

src/Component/PlayManager.ts

@@ -488,7 +488,7 @@ export class PlayManager extends ServerManagerBase {
             this.onStreamFailed();
           })
         ;
-      });
+      }).unref();
     }else{
       this._errorReportChannel?.createMessage(":tired_face:曲の再生に失敗しました...。" + (this._errorCount + 1 >= this.retryLimit ? "スキップします。" : "再試行します。"));
       this.onStreamFailed();
@@ -560,7 +560,7 @@ export class PlayManager extends ServerManagerBase {
         ;
       }
       this.disconnect();
-    }, 10 * 60 * 1000);
+    }, 10 * 60 * 1000).unref();
     this._finishTimeout = true;
     const playHandler = () => {
       clearTimeout(timer);

src/Component/backupper/httpBased.ts

@@ -316,6 +316,10 @@ export class HttpBackupper extends Backupper {
       ;
     });
   }
+
+  destroy(){
+    /* empty */
+  }
 }
 
 type getResult = {

src/Component/backupper/index.ts

@@ -51,4 +51,8 @@ export abstract class Backupper extends LogEmitter {
    * バックアップ済みのキューのデータを取得します
    */
   abstract getQueueDataFromBackup(guildids:string[]):Promise<Map<string, YmxFormat>>;
+  /**
+   * サーバーとの接続を破棄します
+   */
+  abstract destroy():void|Promise<void>;
 }

src/Component/backupper/mongodb.ts

@@ -174,4 +174,9 @@ export class MongoBackupper extends Backupper {
       return null;
     }
   }
+
+  async destroy(){
+    await this.client.close();
+    this.collections = null;
+  }
 }

src/Component/streams/normalizer.ts

@@ -41,7 +41,7 @@ export class Normalizer extends Readable {
           this.pauseOrigin();
         }
       });
-    });
+    }).unref();
     this.origin.once("end", () => this.push(null));
     this.origin.on("error", er => this.destroy(er));
 

src/Structure/GuildDataContainer.ts

@@ -366,7 +366,7 @@ export class GuildDataContainer extends LogEmitter {
    */
   async playFromURL(message:CommandMessage, rawArg:string, first:boolean = true, cancellable:boolean = false){
     const t = Util.time.timer.start("MusicBot#PlayFromURL");
-    setTimeout(() => message.suppressEmbeds(true).catch(e => this.Log(Util.general.StringifyObject(e), "warn")), 4000);
+    setTimeout(() => message.suppressEmbeds(true).catch(e => this.Log(Util.general.StringifyObject(e), "warn")), 4000).unref();
     if(rawArg.match(/^https?:\/\/(www\.|canary\.|ptb\.)?discord(app)?\.com\/channels\/[0-9]+\/[0-9]+\/[0-9]+$/)){
       // Discordメッセへのリンクならば
       const smsg = await message.reply("🔍メッセージを取得しています...");

src/Util/general.ts

@@ -147,7 +147,7 @@ export function waitForEnteringState(predicate:()=>boolean, timeout:number = 10
           resolve(Date.now() - startTime);
         }
       }
-    }, timeStep);
+    }, timeStep).unref();
   });
 }
 
@@ -156,7 +156,7 @@ export function waitForEnteringState(predicate:()=>boolean, timeout:number = 10
  * @param time 待機時間（ミリ秒単位）
  */
 export function wait(time:number){
-  return new Promise<void>(resolve => setTimeout(resolve, time));
+  return new Promise<void>(resolve => setTimeout(resolve, time).unref());
 }
 
 const UUID_TEMPLATE = "10000000-1000-4000-8000-100000000000";

src/Util/log.ts

@@ -28,6 +28,7 @@ export type LoggerType = (content:string, level?:LogLevels)=>void;
 
 class LogStore {
   private readonly loggingStream = null as fs.WriteStream;
+  private destroyed = false;
 
   constructor(){
     if(config.debug && isMainThread){
@@ -36,26 +37,20 @@ class LogStore {
         fs.mkdirSync(path.join(__dirname, dirPath));
       }
       this.loggingStream = fs.createWriteStream(path.join(__dirname, `${dirPath}/log-${Date.now()}.log`));
-      const onExit = () => {
-        if(!this.loggingStream.destroyed){
-          this.loggingStream.write(Buffer.from(`INFO  ${new Date().toISOString()} [Logger] detect process exiting, closing stream...`));
-          this.loggingStream.destroy();
-        }
-      };
-      process.on("exit", onExit);
-      process.on("SIGINT", onExit);
     }
   }
 
   log:boolean = true;
   maxLength = 30;
+
   private readonly _data:string[] = [];
   get data():Readonly<LogStore["_data"]>{
     return this._data;
   }
 
   // eslint-disable-next-line @typescript-eslint/no-shadow
   addLog(level:LogLevels, log:string){
+    if(this.destroyed) return;
     if(level !== "debug"){
       this._data.push(`${level[0].toUpperCase()}:${log}`);
       if(this.data.length > this.maxLength){
@@ -78,6 +73,15 @@ class LogStore {
       }\r\n`));
     }
   }
+
+  destroy(){
+    if(this.destroyed) return;
+    this.destroyed = true;
+    if(!this.loggingStream.destroyed){
+      this.loggingStream.write(Buffer.from(`INFO  ${new Date().toISOString()} [Logger] detect process exiting, closing stream...`));
+      this.loggingStream.destroy();
+    }
+  }
 }
 
 export const logStore = new LogStore();

src/bot.ts

@@ -74,6 +74,8 @@ export class MusicBot extends MusicBotBase {
       .on("voiceChannelLeave", this.onVoiceChannelLeave.bind(this))
       .on("voiceChannelSwitch", this.onVoiceChannelSwitch.bind(this))
       .on("error", this.onError.bind(this))
+      .on("debug", this.onDebug.bind(this))
+      .on("warn", this.onWarn.bind(this))
     ;
   }
 
@@ -147,8 +149,8 @@ export class MusicBot extends MusicBotBase {
     // Set main tick
     setTimeout(() => {
       this.maintenanceTick();
-      setInterval(this.maintenanceTick.bind(this), 1 * 60 * 1000);
-    }, 10 * 1000);
+      setInterval(this.maintenanceTick.bind(this), 1 * 60 * 1000).unref();
+    }, 10 * 1000).unref();
     this.Log("Interval jobs set up successfully");
 
     // Command instance preparing
@@ -499,7 +501,7 @@ export class MusicBot extends MusicBotBase {
               this._client.createMessage(server.boundTextChannel, ":postbox: 長時間使用しなかったため、終了します").catch(e => this.Log(e, "error"));
               server.player.disconnect();
             }
-          }, 10 * 60 * 1000);
+          }, 10 * 60 * 1000).unref();
           const playHandler = () => clearTimeout(timer);
           server.player.once("playCalled", playHandler);
           server.player.once("disconnect", playHandler);
@@ -519,15 +521,23 @@ export class MusicBot extends MusicBotBase {
 
   private async onError(er:Error){
     Util.logger.log(er, "error");
-    this.Log("Attempt reconnecting after waiting for a while...");
-    await Util.general.wait(3000);
-    this.client.connect()
-      .then(() => Util.logger.log("Reconnected!"))
-      .catch(_er => {
-        this.Log(_er);
-        Util.logger.log("Reconnect attempt failed");
-      })
-    ;
+    if(er.message?.startsWith("Invalid token")){
+      this.Log("Invalid token detected. Please ensure that you set the correct token. You can also re-generate new token for your bot.");
+      process.exit(1);
+    }else{
+      this.Log("Attempt reconnecting after waiting for a while...");
+      this._client.disconnect({
+        reconnect: "auto",
+      });
+    }
+  }
+
+  private onDebug(message:string, id?:number){
+    this.Log(`${message} (ID: ${id || "NaN"})`, "debug");
+  }
+
+  private onWarn(message:string, id?:number){
+    this.Log(`${message} (ID: ${id || "NaN"})`, "warn");
   }
 
   /**
@@ -541,6 +551,19 @@ export class MusicBot extends MusicBotBase {
     if(debugLogStoreLength) Util.logger.logStore.maxLength = debugLogStoreLength;
   }
 
+  async stop(){
+    this.Log("Shutting down the bot...");
+    this._client.removeAllListeners();
+    this._client.on("error", () => {});
+    if(this._backupper){
+      this.Log("Shutting down the db...");
+      await this._backupper.destroy();
+    }
+    this._client.disconnect({
+      reconnect: false,
+    });
+  }
+
   /**
    * コマンドを実行する際にランナーに渡す引数を生成します
    * @param options コマンドのパース済み引数