aboutsummaryrefslogtreecommitdiff
path: root/node_modules/discord.js/src/sharding/ShardingManager.js
diff options
context:
space:
mode:
authorAlee14 <alee14498@gmail.com>2017-03-26 15:18:10 -0400
committerAlee14 <alee14498@gmail.com>2017-03-26 15:18:10 -0400
commit29433e2f7dbd0e4a73d3c78ffe1005b922fb5982 (patch)
treeaa0ad3fe59468cbe452ee597e914839b68c01436 /node_modules/discord.js/src/sharding/ShardingManager.js
parent878fefb4c4e1f12b804ae5c0def433fa873f4c8b (diff)
downloadAleeBot-29433e2f7dbd0e4a73d3c78ffe1005b922fb5982.tar.gz
AleeBot-29433e2f7dbd0e4a73d3c78ffe1005b922fb5982.tar.bz2
AleeBot-29433e2f7dbd0e4a73d3c78ffe1005b922fb5982.zip
Don't mind me i'm adding the discord.js files
Diffstat (limited to 'node_modules/discord.js/src/sharding/ShardingManager.js')
-rw-r--r--node_modules/discord.js/src/sharding/ShardingManager.js193
1 files changed, 193 insertions, 0 deletions
diff --git a/node_modules/discord.js/src/sharding/ShardingManager.js b/node_modules/discord.js/src/sharding/ShardingManager.js
new file mode 100644
index 0000000..671b5d7
--- /dev/null
+++ b/node_modules/discord.js/src/sharding/ShardingManager.js
@@ -0,0 +1,193 @@
+const path = require('path');
+const fs = require('fs');
+const EventEmitter = require('events').EventEmitter;
+const mergeDefault = require('../util/MergeDefault');
+const Shard = require('./Shard');
+const Collection = require('../util/Collection');
+const fetchRecommendedShards = require('../util/FetchRecommendedShards');
+
+/**
+ * This is a utility class that can be used to help you spawn shards of your Client. Each shard is completely separate
+ * from the other. The Shard Manager takes a path to a file and spawns it under the specified amount of shards safely.
+ * If you do not select an amount of shards, the manager will automatically decide the best amount.
+ * @extends {EventEmitter}
+ */
+class ShardingManager extends EventEmitter {
+ /**
+ * @param {string} file Path to your shard script file
+ * @param {Object} [options] Options for the sharding manager
+ * @param {number|string} [options.totalShards='auto'] Number of shards to spawn, or "auto"
+ * @param {boolean} [options.respawn=true] Whether shards should automatically respawn upon exiting
+ * @param {string[]} [options.shardArgs=[]] Arguments to pass to the shard script when spawning
+ * @param {string} [options.token] Token to use for automatic shard count and passing to shards
+ */
+ constructor(file, options = {}) {
+ super();
+ options = mergeDefault({
+ totalShards: 'auto',
+ respawn: true,
+ shardArgs: [],
+ token: null,
+ }, options);
+
+ /**
+ * Path to the shard script file
+ * @type {string}
+ */
+ this.file = file;
+ if (!file) throw new Error('File must be specified.');
+ if (!path.isAbsolute(file)) this.file = path.resolve(process.cwd(), file);
+ const stats = fs.statSync(this.file);
+ if (!stats.isFile()) throw new Error('File path does not point to a file.');
+
+ /**
+ * Amount of shards that this manager is going to spawn
+ * @type {number|string}
+ */
+ this.totalShards = options.totalShards;
+ if (this.totalShards !== 'auto') {
+ if (typeof this.totalShards !== 'number' || isNaN(this.totalShards)) {
+ throw new TypeError('Amount of shards must be a number.');
+ }
+ if (this.totalShards < 1) throw new RangeError('Amount of shards must be at least 1.');
+ if (this.totalShards !== Math.floor(this.totalShards)) {
+ throw new RangeError('Amount of shards must be an integer.');
+ }
+ }
+
+ /**
+ * Whether shards should automatically respawn upon exiting
+ * @type {boolean}
+ */
+ this.respawn = options.respawn;
+
+ /**
+ * An array of arguments to pass to shards.
+ * @type {string[]}
+ */
+ this.shardArgs = options.shardArgs;
+
+ /**
+ * Token to use for obtaining the automatic shard count, and passing to shards
+ * @type {?string}
+ */
+ this.token = options.token ? options.token.replace(/^Bot\s*/i, '') : null;
+
+ /**
+ * A collection of shards that this manager has spawned
+ * @type {Collection<number, Shard>}
+ */
+ this.shards = new Collection();
+ }
+
+ /**
+ * Spawns a single shard.
+ * @param {number} id The ID of the shard to spawn. **This is usually not necessary.**
+ * @returns {Promise<Shard>}
+ */
+ createShard(id = this.shards.size) {
+ const shard = new Shard(this, id, this.shardArgs);
+ this.shards.set(id, shard);
+ /**
+ * Emitted upon launching a shard
+ * @event ShardingManager#launch
+ * @param {Shard} shard Shard that was launched
+ */
+ this.emit('launch', shard);
+ return Promise.resolve(shard);
+ }
+
+ /**
+ * Spawns multiple shards.
+ * @param {number} [amount=this.totalShards] Number of shards to spawn
+ * @param {number} [delay=5500] How long to wait in between spawning each shard (in milliseconds)
+ * @returns {Promise<Collection<number, Shard>>}
+ */
+ spawn(amount = this.totalShards, delay = 5500) {
+ if (amount === 'auto') {
+ return fetchRecommendedShards(this.token).then(count => {
+ this.totalShards = count;
+ return this._spawn(count, delay);
+ });
+ } else {
+ if (typeof amount !== 'number' || isNaN(amount)) throw new TypeError('Amount of shards must be a number.');
+ if (amount < 1) throw new RangeError('Amount of shards must be at least 1.');
+ if (amount !== Math.floor(amount)) throw new TypeError('Amount of shards must be an integer.');
+ return this._spawn(amount, delay);
+ }
+ }
+
+ /**
+ * Actually spawns shards, unlike that poser above >:(
+ * @param {number} amount Number of shards to spawn
+ * @param {number} delay How long to wait in between spawning each shard (in milliseconds)
+ * @returns {Promise<Collection<number, Shard>>}
+ * @private
+ */
+ _spawn(amount, delay) {
+ return new Promise(resolve => {
+ if (this.shards.size >= amount) throw new Error(`Already spawned ${this.shards.size} shards.`);
+ this.totalShards = amount;
+
+ this.createShard();
+ if (this.shards.size >= this.totalShards) {
+ resolve(this.shards);
+ return;
+ }
+
+ if (delay <= 0) {
+ while (this.shards.size < this.totalShards) this.createShard();
+ resolve(this.shards);
+ } else {
+ const interval = setInterval(() => {
+ this.createShard();
+ if (this.shards.size >= this.totalShards) {
+ clearInterval(interval);
+ resolve(this.shards);
+ }
+ }, delay);
+ }
+ });
+ }
+
+ /**
+ * Send a message to all shards.
+ * @param {*} message Message to be sent to the shards
+ * @returns {Promise<Shard[]>}
+ */
+ broadcast(message) {
+ const promises = [];
+ for (const shard of this.shards.values()) promises.push(shard.send(message));
+ return Promise.all(promises);
+ }
+
+ /**
+ * Evaluates a script on all shards, in the context of the Clients.
+ * @param {string} script JavaScript to run on each shard
+ * @returns {Promise<Array>} Results of the script execution
+ */
+ broadcastEval(script) {
+ const promises = [];
+ for (const shard of this.shards.values()) promises.push(shard.eval(script));
+ return Promise.all(promises);
+ }
+
+ /**
+ * Fetches a Client property value of each shard.
+ * @param {string} prop Name of the Client property to get, using periods for nesting
+ * @returns {Promise<Array>}
+ * @example
+ * manager.fetchClientValues('guilds.size').then(results => {
+ * console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`);
+ * }).catch(console.error);
+ */
+ fetchClientValues(prop) {
+ if (this.shards.size === 0) return Promise.reject(new Error('No shards have been spawned.'));
+ if (this.shards.size !== this.totalShards) return Promise.reject(new Error('Still spawning shards.'));
+ const promises = [];
+ for (const shard of this.shards.values()) promises.push(shard.fetchClientValue(prop));
+ return Promise.all(promises);
+ }
+}
+
+module.exports = ShardingManager;