@rbxts/tether 1.2.0 → 1.2.1

package/README.md

@@ -24,28 +24,26 @@ export interface MessageData {
     readonly n: DataType.u8;
   };
   [Message.Packed]: DataType.Packed<{
-    boolean1: boolean;
-    boolean2: boolean;
-    boolean3: boolean;
-    boolean4: boolean;
-    boolean5: boolean;
-    boolean6: boolean;
-    boolean7: boolean;
-    boolean8: boolean;
+    readonly boolean1: boolean;
+    readonly boolean2: boolean;
+    readonly boolean3: boolean;
+    readonly boolean4: boolean;
+    readonly boolean5: boolean;
+    readonly boolean6: boolean;
+    readonly boolean7: boolean;
+    readonly boolean8: boolean;
   }>;
 }
 ```
 
 > [!CAUTION]
-> Every single message kind must implement an interface for it's data (in the example that would be the object with the `foo` and `bar` fields). Message serialization (as well as your message itself) will not work if you don't do this.
+> Every single message kind must implement an interface for it's data (in the example that would be the object types in `MessageData`). Message serialization (as well as your message itself) will not work if you don't do this.
 
 ### Server
 ```ts
 import { Message, messaging } from "shared/messaging";
 
-messaging.server.on(Message.Test, (player, data) => {
-  print(player, "sent data:", data);
-});
+messaging.server.on(Message.Test, (player, data) => print(player, "sent data:", data));
 ```
 
 ### Client
@@ -116,7 +114,7 @@ Drop, delay, or modify requests
 import type { ClientMiddleware } from "@rbxts/tether";
 
 export function logClient(): ClientMiddleware {
-  return message => (player, data) => print(`[LOG]: Sent message '${message}' to player ${player} with data:`, data);
+  return message => (player, ctx) => print(`[LOG]: Sent message '${message}' to player ${player} with data:`, ctx.data);
 }
 ```
 
@@ -125,7 +123,7 @@ export function logClient(): ClientMiddleware {
 import type { ServerMiddleware } from "@rbxts/tether";
 
 export function logServer(): ServerMiddleware {
-  return message => data => print(`[LOG]: Sent message '${message}' to server with data:`, data);
+  return message => ctx => print(`[LOG]: Sent message '${message}' to server with data:`, ctx.data);
 }
 ```
 
@@ -152,7 +150,7 @@ import type { ServerMiddleware } from "@rbxts/tether";
 
 export function incrementNumberData(): ServerMiddleware<number> {
   // sets the data to be used by the any subsequent middlewares as well as sent through the remote
-  return () => (data, updateData) => updateData(data + 1);
+  return () => ({ data, updateData }) => updateData(data + 1);
 }
 ```
 
@@ -166,7 +164,8 @@ messaging.middleware
   // only allows requests to the server every 5 seconds,
   // drops any requests that occur within 5 seconds of each other
   .useServer(Message.Test, BuiltinMiddlewares.rateLimit(5)) 
-  .useShared(Message.Packed, () => (_, __, getRawData) => print("Packed object size:", buffer.len(getRawData()))); // will be just one byte!
+  // will be just one byte!
+  .useShared(Message.Packed, () => ctx => print("Packed object size:", buffer.len(ctx.getRawData().buffer)));
   // logs every message fired
   .useServerGlobal(logServer())
   .useClientGlobal(logClient())
@@ -185,14 +184,14 @@ export interface MessageData {
     readonly n: DataType.u8;
   };
   [Message.Packed]: DataType.Packed<{
-    boolean1: boolean;
-    boolean2: boolean;
-    boolean3: boolean;
-    boolean4: boolean;
-    boolean5: boolean;
-    boolean6: boolean;
-    boolean7: boolean;
-    boolean8: boolean;
+    readonly boolean1: boolean;
+    readonly boolean2: boolean;
+    readonly boolean3: boolean;
+    readonly boolean4: boolean;
+    readonly boolean5: boolean;
+    readonly boolean6: boolean;
+    readonly boolean7: boolean;
+    readonly boolean8: boolean;
   }>;
 }
 ```

package/out/builtin-middlewares.d.ts

@@ -11,6 +11,14 @@ export declare namespace BuiltinMiddlewares {
      * @returns A shared middleware that will simulate a ping
      */
     function simulatePing(pingInMs: number): SharedMiddleware;
+    /**
+     * Creates a shared middleware that will check if a message packet exceeds the given maximum size in bytes
+     *
+     * @param maxBytes The maximum size of the packet in bytes
+     * @param throwError Whether the middleware should throw an error if the packet exceeds the maximum size, or simply drop the request
+     * @returns A shared middleware that will check if a message packet exceeds the given maximum size
+     */
+    function maxPacketSize(maxBytes: number, throwError?: boolean): SharedMiddleware;
     /**
      * Creates a shared middleware that will drop any message that occurs within the given interval of the previous message
      *

package/out/builtin-middlewares.luau

@@ -24,6 +24,30 @@ do
 		end
 	end
 	_container.simulatePing = simulatePing
+	--[[
+		*
+		     * Creates a shared middleware that will check if a message packet exceeds the given maximum size in bytes
+		     *
+		     * @param maxBytes The maximum size of the packet in bytes
+		     * @param throwError Whether the middleware should throw an error if the packet exceeds the maximum size, or simply drop the request
+		     * @returns A shared middleware that will check if a message packet exceeds the given maximum size
+		     
+	]]
+	local function maxPacketSize(maxBytes, throwError)
+		if throwError == nil then
+			throwError = true
+		end
+		return function(message)
+			return function(ctx)
+				local rawData = ctx.getRawData()
+				local totalSize = buffer.len(rawData.buffer) + #rawData.blobs * BLOB_SIZE
+				if totalSize > maxBytes then
+					return if throwError then error(`[@rbxts/tether]: Message '{message}' exceeded maximum packet size of {maxBytes} bytes`) else DropRequest
+				end
+			end
+		end
+	end
+	_container.maxPacketSize = maxPacketSize
 	--[[
 		*
 		     * Creates a shared middleware that will drop any message that occurs within the given interval of the previous message
@@ -87,7 +111,9 @@ do
 	]]
 	local function debug(schema)
 		return function(message)
-			return function(data, _, getRawData)
+			return function(_param)
+				local data = _param.data
+				local getRawData = _param.getRawData
 				local rawData = getRawData()
 				local bufferSize = buffer.len(rawData.buffer)
 				local blobsSize = #rawData.blobs * BLOB_SIZE

package/out/message-emitter.d.ts

@@ -9,7 +9,7 @@ export declare class MessageEmitter<MessageData> extends Destroyable {
     private readonly serverCallbacks;
     private readonly serverFunctions;
     private readonly guards;
-    private serializers;
+    private readonly serializers;
     private serverEvents;
     private clientEvents;
     /** @metadata macro */

package/out/message-emitter.luau

@@ -61,11 +61,16 @@ do
 					return nil
 				end
 				task.spawn(function()
+					local ctx = {
+						data = data,
+						updateData = updateData,
+						getRawData = getPacket,
+					}
 					for _, globalMiddleware in self.middleware:getServerGlobal() do
 						if not self:validateData(message, data) then
 							return nil
 						end
-						local result = globalMiddleware(message)(data, updateData, getPacket)
+						local result = globalMiddleware(message)(ctx)
 						if result == DropRequest then
 							return nil
 						end
@@ -74,7 +79,7 @@ do
 						if not self:validateData(message, data) then
 							return nil
 						end
-						local result = middleware(message)(data, updateData, getPacket)
+						local result = middleware(message)(ctx)
 						if result == DropRequest then
 							return nil
 						end
@@ -140,11 +145,16 @@ do
 					return nil
 				end
 				task.spawn(function()
+					local ctx = {
+						data = data,
+						updateData = updateData,
+						getRawData = getPacket,
+					}
 					for _, globalMiddleware in self.middleware:getClientGlobal() do
 						if not self:validateData(message, data) then
 							return nil
 						end
-						local result = globalMiddleware(message)(player, data, updateData, getPacket)
+						local result = globalMiddleware(message)(player, ctx)
 						if result == DropRequest then
 							return nil
 						end
@@ -153,7 +163,7 @@ do
 						if not self:validateData(message, data) then
 							return nil
 						end
-						local result = middleware(message)(player, data, updateData, getPacket)
+						local result = middleware(message)(player, ctx)
 						if result == DropRequest then
 							return nil
 						end
@@ -180,12 +190,17 @@ do
 					return nil
 				end
 				task.spawn(function()
+					local ctx = {
+						data = data,
+						updateData = updateData,
+						getRawData = getPacket,
+					}
 					for _, globalMiddleware in self.middleware:getClientGlobal() do
 						for _1, player in Players:GetPlayers() do
 							if not self:validateData(message, data) then
 								return nil
 							end
-							local result = globalMiddleware(message)(player, data, updateData, getPacket)
+							local result = globalMiddleware(message)(player, ctx)
 							if result == DropRequest then
 								return nil
 							end
@@ -196,7 +211,7 @@ do
 							if not self:validateData(message, data) then
 								return nil
 							end
-							local result = middleware(message)(player, data, updateData, getPacket)
+							local result = middleware(message)(player, ctx)
 							if result == DropRequest then
 								return nil
 							end
@@ -244,7 +259,7 @@ do
 		self.janitor:Add(function()
 			table.clear(self.clientCallbacks)
 			table.clear(self.serverCallbacks)
-			self.serializers = nil
+			table.clear(self.serializers)
 			self.serverEvents = nil
 			self.clientEvents = nil
 		end)

package/out/middleware.d.ts

@@ -3,16 +3,19 @@ type DropRequestSymbol = symbol & {
     _drop_req?: undefined;
 };
 export declare const DropRequest: DropRequestSymbol;
-type UpdateDataFn<T> = (newData: T) => void;
-type GetRawDataFn = () => SerializedPacket;
 export type ClientMiddleware<Data = unknown> = {
     _client?: void;
-} & ((message: BaseMessage) => (player: Player | Player[], data: Readonly<Data>, updateData: UpdateDataFn<Data>, getRawData: GetRawDataFn) => DropRequestSymbol | void);
-export type ServerMiddleware<Data = unknown> = SharedMiddleware<Data> & {
+} & ((message: BaseMessage) => (player: Player | Player[], ctx: MiddlewareContext<Data>) => DropRequestSymbol | void);
+export type ServerMiddleware<Data = unknown> = {
     _server?: void;
-};
-export type SharedMiddleware<Data = unknown> = (message: BaseMessage) => (data: Readonly<Data>, updateData: UpdateDataFn<Data>, getRawData: GetRawDataFn) => DropRequestSymbol | void;
+} & SharedMiddleware<Data>;
+export type SharedMiddleware<Data = unknown> = (message: BaseMessage) => (ctx: MiddlewareContext<Data>) => DropRequestSymbol | void;
 export type Middleware<Data = unknown> = ServerMiddleware<Data> & ClientMiddleware<Data> & SharedMiddleware<Data>;
+export interface MiddlewareContext<Data = unknown> {
+    readonly data: Readonly<Data>;
+    updateData: (newData: Data) => void;
+    getRawData: () => SerializedPacket;
+}
 export declare class MiddlewareProvider<MessageData> {
     private readonly clientGlobalMiddlewares;
     private readonly serverGlobalMiddlewares;

package/out/middleware.luau

@@ -78,8 +78,8 @@ do
 		local _newValue = table.create(#_exp)
 		local _callback = function(middleware)
 			return function(message)
-				return function(_, data, updateData, getRawData)
-					return middleware(message)(data, updateData, getRawData)
+				return function(_, ctx)
+					return middleware(message)(ctx)
 				end
 			end
 		end
@@ -133,8 +133,8 @@ do
 		local _newValue = table.create(#_exp)
 		local _callback = function(middleware)
 			return function(message)
-				return function(_, data, updateData, getRawData)
-					return middleware(message)(data, updateData, getRawData)
+				return function(_, ctx)
+					return middleware(message)(ctx)
 				end
 			end
 		end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rbxts/tether",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "main": "out/init.lua",
   "scripts": {
     "build": "rbxtsc",