bancho.js 0.10.0-rc.9 → 0.10.1

package/CHANGELOG.md

@@ -2,6 +2,55 @@
 
 ## Version 0.10
 
+### Version 0.10.1
+
+- **BanchoLobby: Fix beatmap never being refreshed from API**
+
+### Version 0.10.0
+
+#### Highlights
+
+- **BREAKING CHANGES**
+  - BanchoChannel#channelMembers is now a Map instead of a plain object.
+  - Following rate-limiting refactoring (see highlights below), the `limiterPublic` BanchoClient option is no longer supported.  
+    Realistically this should never have been implemented, as bots are not supposed to ever send messages publicly (understand public channels like #osu, or every channel that are not PMs and multiplayer lobbies).
+  - The mods array is now initialized to `null` in `BanchoLobby`'s constructor instead of an empty array.
+
+- **BanchoUser instances are now garbage-collected**  
+  If you joined public channels like #osu, you will eventually get hundreds of thousands users registered, which inevitably caused some out-of-memory issues.  
+  We fixed them by garbage-collecting these instances when they are no longer referenced anywhere, by using [`WeakRef`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakRef).  
+  Support was also added using [`weak-value-map`](https://github.com/amapili/weak-value-map) as a peer dependency, which looks to be more memory-efficient but it is considered experimental. Probably only useful if you're running Node.js >= 10 < 14.6.0.
+
+- **Implement the IRC QUIT command**  
+  Bancho doesn't emit `PART` when users are disconnecting without leaving channels first. This fixes users that were never marked as having left channels they were part of when disconnecting.
+
+- **Rate-limiting has been refactored**  
+  We're now using a much simpler implementation based on a FIFO queue with rate-limiting.  
+  Default rate limits for both user and bot accounts have been fine-tuned.
+
+- **New `BanchoLobby` features:**
+  - New `banPlayer` method (using `!mp ban`)
+  - New `setName` method (using `!mp name`)
+  - New `gamemode` property (updated when referees use `!mp map` with gamemode id, or using `setMap` of course)
+  - When a player leaves the lobby (`playerLeft` event), the subsequent `updateSettings` call will emit `allPlayersReady` if all remaining players are ready.
+    This works around a lack of reporting from Bancho when every player is ready, except the one who has just left, though it is not automatic and you do have to call `updateSettings` yourself.
+
+- **Add support for ACTION events (/me messages)**
+  See https://git.cartooncraft.fr/ThePooN/bancho.js/-/commit/e3636e427d4d00ce79b89b31b751d3e733622b75
+
+- **Misc. bug fixes and minor improvements (eg. typings)**  
+  See the changelog for dev versions below.
+
+### Version 0.10.0-rc.11
+
+- Fix stats with players who have non-decimal global accuracy
+
+### Version 0.10.0-rc.10
+
+- Switch to an actually FIFO rate-limiting library  
+  The new implementation is actually correct now...
+- Fine-tune rate limits again for user and bot accounts
+
 ### Version 0.10.0-rc.9
 
 - Updated all dependencies, fixing security issues (in dev dependencies)

package/README.md

@@ -3,7 +3,7 @@
 [![NPM](https://nodei.co/npm/bancho.js.png?compact=true)](https://nodei.co/npm/bancho.js/)  
 [![pipeline status](https://git.cartooncraft.fr/ThePooN/bancho.js/badges/master/pipeline.svg)](https://git.cartooncraft.fr/ThePooN/bancho.js/commits/master)
 
-## Current release: 0.10.0-rc.9
+## Current release: 0.10.1
 
 # Introduction
 

package/lib/BanchoClient.js

@@ -7,7 +7,8 @@ const BanchoMultiplayerChannel = require("./BanchoMultiplayerChannel");
 const ConnectStates = require("./Enums/ConnectStates");
 const IrcCommands = require("./Enums/IrcCommands");
 const Nodesu = require("nodesu");
-const RateLimiter = require("limiter").RateLimiter;
+const RateLimiterMemory = require("rate-limiter-flexible").RateLimiterMemory;
+const RateLimiterQueue = require("rate-limiter-flexible").RateLimiterQueue;
 const PrivateMessage = require("./PrivateMessage");
 const ChannelMessage = require("./ChannelMessage");
 
@@ -44,7 +45,7 @@ class BanchoClient extends EventEmitter {
 				this.osuApi = new Nodesu.Client(apiKey, {
 					parseData: true
 				});
-			this.rateLimiter = new RateLimiter({ tokensPerInterval: limiterPrivate, interval: limiterTimespan });
+			this.rateLimiter = new RateLimiterQueue(new RateLimiterMemory({ points: limiterPrivate, duration: limiterTimespan / 1000 }));
 		}
 		else if(typeof optionsOrUsername == "object") {
 			/**
@@ -61,8 +62,8 @@ class BanchoClient extends EventEmitter {
 			const options = {
 				host: "irc.ppy.sh",
 				port: 6667,
-				limiterTimespan: 10000,
-				limiterPrivate: 5,
+				limiterTimespan: 12500,
+				limiterPrivate: 9,
 				limiterPublic: undefined,
 				botAccount: false,
 			};
@@ -80,9 +81,9 @@ class BanchoClient extends EventEmitter {
 						process.emitWarning("You have set both deprecated custom rate limits and `botAccount`. The default bot accounts limits will take precedence. This warning will be removed in v1.0.0.");
 				}
 
-				const limiterPrivate = options.botAccount ? 300 : options.limiterPrivate;
-				const limiterTimespan = options.botAccount ? 60000 : options.limiterTimespan;
-				options.rateLimiter = new RateLimiter({ tokensPerInterval: limiterPrivate, interval: limiterTimespan });
+				const limiterPrivate = options.botAccount ? 298 : options.limiterPrivate;
+				const limiterTimespan = options.botAccount ? 62500 : options.limiterTimespan;
+				options.rateLimiter = new RateLimiterQueue(new RateLimiterMemory({ points: limiterPrivate, duration: limiterTimespan / 1000 }));
 			}
 
 			this.username = options.username;

package/lib/BanchoMessage.js

@@ -27,7 +27,7 @@ class BanchoMessage {
 	
 	/**
 	 * The content of this message
-	 * @type {string}
+	 * @returns {string}
 	 */
 	get content() {
 		return this.message;
@@ -35,7 +35,7 @@ class BanchoMessage {
 
 	/**
 	 * Tries to parse this message as an ACTION (/me message).
-	 * @returns {[string]}
+	 * @returns {string}
 	 */
 	getAction() {
 		const action = actionRegex.exec(this.message);

package/lib/Multiplayer/BanchoLobby.js

@@ -138,8 +138,8 @@ class BanchoLobby extends EventEmitter {
 				case "playerChangedBeatmap":
 				case "refereeChangedBeatmap":
 				case "beatmapFromSettings":
-					this.beatmapId = ret.id;
 					if(ret.id != this.beatmapId) {
+						this.beatmapId = ret.id;
 						this.beatmap = null;
 						for(const player of this.slots)
 							if(player != null)

package/lib/StatsCommand/BanchoBotStatsCommand.js

@@ -45,10 +45,10 @@ class BanchoBotStatsCommand {
 			}
 		};
 		const accuracyListener = (msg) => {
-			const m = /Accuracy: (\d+)\.(\d+)%/.exec(msg.message);
+			const m = /Accuracy: (\d+(\.\d+)?)%/.exec(msg.message);
 			if(m) {
 				// Accuracy returned by !stats are inaccurate so we're simply setting it in the return object instead.
-				this.return.accuracy = Number(m[1] + "." + m[2]);
+				this.return.accuracy = Number(m[1]);
 				this.resolve(this.return);
 				this._removeListeners();
 			}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bancho.js",
-  "version": "0.10.0-rc.9",
+  "version": "0.10.1",
   "description": "Interface with Bancho over IRC, made easy and reliable",
   "main": "index.js",
   "types": "index.d.ts",
@@ -35,8 +35,8 @@
     "weak-value-map": "^1.0.1"
   },
   "dependencies": {
-    "limiter": "^2.1.0",
-    "nodesu": "^0.7.2"
+    "nodesu": "^0.7.2",
+    "rate-limiter-flexible": "^2.3.12"
   },
   "peerDependencies": {
     "weak-value-map": "^1.0.1"