Fix Typings, add spawnOptions, more consistency to kill Message

Author: meister03

package.json

@@ -1,6 +1,6 @@
 {
     "name": "discord-hybrid-sharding",
-    "version": "1.7.1",
+    "version": "1.7.2",
     "description": "The first package which combines sharding manager & internal sharding to save a lot of resources, which allows clustering!",
     "main": "index.js",
     "types": "./typings.d.ts",

src/Core/Cluster.js

@@ -174,14 +174,14 @@ class Cluster extends EventEmitter {
         this.thread.kill(options);
         this.manager.heartbeat?.clusters.get(this.id)?.stop();
         this.restarts.cleanup();
-        this._handleExit(false);
+        this._handleExit(false, options);
     }
     /**
      * Kills and restarts the cluster's process/worker.
      * @param {ClusterRespawnOptions} [options] Options for respawning the cluster
      * @returns {Promise<Child>}
      */
-    async respawn({ delay = 500, timeout = 30000 } = {}) {
+    async respawn({ delay = 500, timeout = 30000 } = this.manager.spawnOptions) {
         if (this.thread) this.kill({ force: true });
         if (delay > 0) await Util.delayFor(delay);
         this.manager.heartbeat?.clusters.get(this.id)?.stop();
@@ -269,21 +269,28 @@ class Cluster extends EventEmitter {
      * @param {boolean} [respawn=this.manager.respawn] Whether to spawn the cluster again
      * @private
      */
-    _handleExit(respawn = this.manager.respawn) {
+    _handleExit(respawn = this.manager.respawn, options = {}) {
         /**
          * Emitted upon the cluster's child process/worker exiting.
          * @event Cluster#death
          * @param {Child|Worker} process Child process/worker that exited
          */
         this.emit('death', this.thread.process);
-        this.manager._debug(
-            '[DEATH] Cluster died, attempting respawn | Restarts Left: ' + (this.restarts.max - this.restarts.current),
-            this.id,
-        );
+        if (respawn) {
+            this.manager._debug(
+                '[DEATH] Cluster died, attempting respawn | Restarts Left: ' +
+                    (this.restarts.max - this.restarts.current),
+                this.id,
+            );
+        } else {
+            this.manager._debug('[KILL] Cluster killed with reason: ' + (options.reason || 'not given'), this.id);
+        }
 
         this.ready = false;
         this.thread = null;
 
+        if (!respawn) return;
+
         if (this.restarts.current >= this.restarts.max)
             this.manager._debug(
                 '[ATTEMPTED_RESPAWN] Attempted Respawn Declined | Max Restarts have been exceeded',

src/Core/ClusterManager.js

@@ -33,6 +33,7 @@ class ClusterManager extends EventEmitter {
      * @param {number} [options.restarts.max] Maximum amount of restarts a cluster can have in the interval
      * @param {object} [options.queue] Control the Spawn Queue
      * @param {boolean} [options.queue.auto=true] Whether the spawn queue be automatically managed
+     * @param {Object} [options.spawnOptions] Options to pass to the spawn,respawn method
      */
     constructor(file, options = {}) {
         super();
@@ -55,6 +56,10 @@ class ClusterManager extends EventEmitter {
                 },
                 clusterData: {},
                 clusterOptions: {},
+                spawnOptions: {
+                    delay: 7000,
+                    timeout: -1,
+                },
             },
             options,
         );
@@ -227,6 +232,8 @@ class ClusterManager extends EventEmitter {
         this._debug(`[START] Cluster Manager has been initialized`);
 
         this.promise = new PromiseHandler();
+
+        this.spawnOptions = options.spawnOptions;
     }
     /**
      * Spawns multiple internal shards.
@@ -237,7 +244,7 @@ class ClusterManager extends EventEmitter {
      * before resolving. (-1 or Infinity for no wait)
      * @returns {Promise<Collection<number, Cluster>>}
      */
-    async spawn({ amount = this.totalShards, delay = 7000, timeout = -1 } = {}) {
+    async spawn({ amount = this.totalShards, delay, timeout } = this.spawnOptions) {
         if (delay < 7000) {
             process.emitWarning(
                 `Spawn Delay (delay: ${delay}) is smaller than 7s, this can cause global rate limits on /gateway/bot`,

src/Plugins/HeartbeatSystem.js

@@ -26,7 +26,7 @@ class HeartbeatManager {
         this.clusters.get(cluster.id).stop(reason);
         this.manager._debug(`[Heartbeat_MISSING] ${reason}`, cluster.id);
         if (cluster.restarts.current < cluster.restarts.max) {
-            cluster.respawn({ auto: true });
+            cluster.respawn({ auto: true, ...this.manager.spawnOptions });
             this.manager._debug('[Heartbeat_MISSING] Attempted Respawn', cluster.id);
         } else {
             this.manager._debug('[Heartbeat_MISSING] Respawn Rejected | Max Restarts of Cluster Reached', cluster.id);

src/Plugins/ReCluster.js

@@ -111,7 +111,7 @@ class ReClusterManager {
                         if (switchClusterAfterReady) {
                             const oldCluster = this.manager.clusters.get(clusterId);
                             if (oldCluster) {
-                                oldCluster.kill({ force: true });
+                                oldCluster.kill({ force: true, reason: 'Reclusterig' });
                                 oldClusters.delete(clusterId);
                             }
                             this.manager.clusters.set(clusterId, cluster);
@@ -131,7 +131,7 @@ class ReClusterManager {
         if (oldClusters.size) {
             this.manager._debug('[↻][ReClustering] Killing old clusters');
             for (let [id, cluster] of oldClusters) {
-                cluster.kill({ force: true });
+                cluster.kill({ force: true, reason: 'Reclusterig' });
                 this.manager._debug(`[↻][ReClustering][${id}] Killed OldCluster`);
                 this.manager.clusters.delete(id);
             }
@@ -146,7 +146,7 @@ class ReClusterManager {
                 const cluster = newClusters.get(clusterId);
                 const oldCluster = this.manager.clusters.get(clusterId);
                 if (oldCluster) {
-                    oldCluster.kill({ force: true });
+                    oldCluster.kill({ force: true, reason: 'Reclusterig' });
                     oldClusters.delete(clusterId);
                 }
                 this.manager.clusters.set(clusterId, cluster);

typings.d.ts

@@ -140,6 +140,7 @@ declare module 'discord-hybrid-sharding' {
         public clusterList: number[];
         public keepAlive: keepAliveOptions;
         public queue: Queue;
+        public spawnOptions: ClusterSpawnOptions;
         public recluster?: ReClusterManager;
         public heartbeat?: HeartbeatManager;
         public broadcast(message: any): Promise<Cluster[]>;