@axpecter/lync 1.5.0 → 1.5.2

package/README.md

@@ -13,7 +13,7 @@
 
 ```toml
 [dependencies]
-Lync = "axp3cter/lync@1.5.0"
+Lync = "axp3cter/lync@1.5.2"
 ```
 
 **npm (roblox-ts)**
@@ -85,12 +85,12 @@ local Players = game:GetService("Players")
 
 local alive = Lync.createGroup("alive")
 
-Lync.onSend(function(data, name)
+Lync.onSend(function(data, name, player)
     print("[out]", name)
     return data
 end)
 
-Lync.onDrop(function(player, reason, name)
+Lync.onDrop(function(player, reason, name, data)
     warn(player.Name, "dropped", name, reason)
 end)
 
@@ -125,7 +125,7 @@ Net.Hit:listen(function(data, player)
     }, Lync.except(target))
 end)
 
-Net.Ping:listen(function()
+Net.Ping:listen(function(request, player)
     return os.clock()
 end)
 ```
@@ -163,7 +163,7 @@ end
 | | What it does |
 |:---------|:------------|
 | `Lync.start()` | Sets up transport. Server creates remotes, client connects. Call once after all definitions. |
-| `Lync.VERSION` | `"1.5.0"` |
+| `Lync.VERSION` | `"1.5.2"` |
 
 ## Packets
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@axpecter/lync",
-    "version": "1.5.0",
+    "version": "1.5.2",
     "description": "Buffer networking for Roblox. Delta compression, XOR framing, built-in security.",
     "main": "src/init.luau",
     "types": "src/index.d.ts",

package/src/api/Packet.luau

@@ -41,31 +41,28 @@ type PacketFields = {
     _signal: Signal.Signal,
 }
 
--- Shared methods(both contexts)
-local SharedImpl = {}
+-- Server-only metatable. Single send() dispatches on target type.
+local ServerImpl = {}
+ServerImpl.__index = ServerImpl
+
+export type Packet = typeof(setmetatable({} :: PacketFields, ServerImpl))
 
-function SharedImpl.listen(self: Packet, callback: (...any) -> ()): Connection
+function ServerImpl.listen(self: Packet, callback: (...any) -> ()): Connection
     return self._signal:connect(callback)
 end
 
-function SharedImpl.once(self: Packet, callback: (...any) -> ()): Connection
+function ServerImpl.once(self: Packet, callback: (...any) -> ()): Connection
     return self._signal:once(callback)
 end
 
-function SharedImpl.wait(self: Packet): ...any
+function ServerImpl.wait(self: Packet): ...any
     return self._signal:wait()
 end
 
-function SharedImpl.disconnectAll(self: Packet): ()
+function ServerImpl.disconnectAll(self: Packet): ()
     self._signal:disconnectAll()
 end
 
--- Server-only metatable. Single send() dispatches on target type.
-local ServerImpl = setmetatable({}, { __index = SharedImpl })
-ServerImpl.__index = ServerImpl
-
-export type Packet = typeof(setmetatable({} :: PacketFields, ServerImpl))
-
 local function checkDeltaMode(self: Packet, mode: number): ()
     if not self._isDelta then
         return
@@ -127,9 +124,25 @@ end
 table.freeze(ServerImpl)
 
 -- Client-only metatable. Has send(), no target needed.
-local ClientImpl = setmetatable({}, { __index = SharedImpl })
+local ClientImpl = {}
 ClientImpl.__index = ClientImpl
 
+function ClientImpl.listen(self: Packet, callback: (...any) -> ()): Connection
+    return self._signal:connect(callback)
+end
+
+function ClientImpl.once(self: Packet, callback: (...any) -> ()): Connection
+    return self._signal:once(callback)
+end
+
+function ClientImpl.wait(self: Packet): ...any
+    return self._signal:wait()
+end
+
+function ClientImpl.disconnectAll(self: Packet): ()
+    self._signal:disconnectAll()
+end
+
 function ClientImpl.send(self: Packet, data: any): ()
     clientWrite(self._id, self._name, self._codec, data, self._isUnreliable)
 end

package/src/api/Query.luau

@@ -28,6 +28,7 @@ type PendingQuery = {
     thread: thread?,
     callback: ((data: any) -> ())?,
     timeout: thread?,
+    source: Player?,
 }
 
 local _pending = {} :: { [number]: PendingQuery }
@@ -60,12 +61,17 @@ local function releaseCorrelation(): ()
     _activeCount -= 1
 end
 
-local function completeQuery(id: number, data: any): ()
+local function completeQuery(id: number, data: any, source: Player?): ()
     local entry = _pending[id]
     if not entry then
         return
     end
 
+    -- Reject responses from wrong player (prevents correlation spoofing)
+    if source ~= nil and entry.source ~= nil and source ~= entry.source then
+        return
+    end
+
     _pending[id] = nil
     releaseCorrelation()
 
@@ -110,7 +116,7 @@ local function requestMulti(self: Query, players: { Player }, data: any): { [Pla
     if count == 1 then
         local correlation = allocCorrelation()
         local thread = coroutine.running()
-        local entry: PendingQuery = { thread = thread, timeout = nil }
+        local entry: PendingQuery = { thread = thread, timeout = nil, source = players[1] }
         _pending[correlation] = entry
 
         Server.writeQuery(
@@ -154,6 +160,7 @@ local function requestMulti(self: Query, players: { Player }, data: any): { [Pla
                 end
             end,
             timeout = nil,
+            source = player,
         }
 
         _pending[correlation] = entry
@@ -196,12 +203,18 @@ function QueryImpl.listen(self: Query, callback: (...any) -> any): Connection
     if IS_SERVER then
         return self._reqReg.signal:connect(
             function(request: any, player: Player, correlation: number): ()
-                local ok, response = pcall(callback, request, player)
-                if not ok then
-                    warn(`[Lync] Query handler error on "{respName}": {response}`)
+                local results = table.pack(pcall(callback, request, player))
+                if not results[1] then
+                    warn(`[Lync] Query handler error on "{respName}": {results[2]}`)
+                    Server.writeQueryNil(player, respId, respName, correlation)
+                    return
                 end
 
-                if ok and response ~= nil then
+                local response = if results.n > 2
+                    then table.move(results, 2, results.n, 1, table.create(results.n - 1))
+                    else results[2]
+
+                if response ~= nil then
                     Server.writeQuery(player, respId, respName, correlation, respCodec, response)
                 else
                     Server.writeQueryNil(player, respId, respName, correlation)
@@ -211,12 +224,18 @@ function QueryImpl.listen(self: Query, callback: (...any) -> any): Connection
     else
         return self._reqReg.signal:connect(
             function(request: any, _player: Player?, correlation: number): ()
-                local ok, response = pcall(callback, request)
-                if not ok then
-                    warn(`[Lync] Query handler error on "{respName}": {response}`)
+                local results = table.pack(pcall(callback, request))
+                if not results[1] then
+                    warn(`[Lync] Query handler error on "{respName}": {results[2]}`)
+                    Client.writeQueryNil(respId, respName, correlation)
+                    return
                 end
 
-                if ok and response ~= nil then
+                local response = if results.n > 2
+                    then table.move(results, 2, results.n, 1, table.create(results.n - 1))
+                    else results[2]
+
+                if response ~= nil then
                     Client.writeQuery(respId, respName, correlation, respCodec, response)
                 else
                     Client.writeQueryNil(respId, respName, correlation)
@@ -251,7 +270,7 @@ function QueryImpl.requestFrom(self: Query, player: Player, data: any): any
 
     local correlation = allocCorrelation()
     local thread = coroutine.running()
-    local entry: PendingQuery = { thread = thread, timeout = nil }
+    local entry: PendingQuery = { thread = thread, timeout = nil, source = player }
     _pending[correlation] = entry
 
     Server.writeQuery(player, self._reqReg.id, self._name, correlation, self._reqReg.codec, data)
@@ -307,8 +326,8 @@ function QueryModule.define(name: string, config: QueryConfig<any, any>): Query
         config.validate
     )
 
-    respSignal:connect(function(resp: any, correlation: number): ()
-        completeQuery(correlation, resp)
+    respSignal:connect(function(resp: any, source: Player?, correlation: number): ()
+        completeQuery(correlation, resp, source)
     end)
 
     return setmetatable({

package/src/api/Signal.luau

@@ -91,6 +91,10 @@ SignalImpl.__index = SignalImpl
 export type Signal = typeof(setmetatable({} :: SignalFields, SignalImpl))
 
 local function addEntry(self: Signal, callback: (...any) -> (), isOnce: boolean): Connection
+    if type(callback) ~= "function" then
+        error("[Lync] Expected function, got " .. type(callback))
+    end
+
     local count = self._count + 1
     self._count = count
 

package/src/index.d.ts

@@ -186,11 +186,11 @@ export interface Namespace {
     ): Connection;
     onSend(
         this: Namespace,
-        handler: (data: unknown, name: string, player: Player | undefined) => unknown | undefined,
+        handler: (data: unknown, name: string, player: Player | undefined) => unknown | DropSentinel | undefined,
     ): () => void;
     onReceive(
         this: Namespace,
-        handler: (data: unknown, name: string, player: Player | undefined) => unknown | undefined,
+        handler: (data: unknown, name: string, player: Player | undefined) => unknown | DropSentinel | undefined,
     ): () => void;
     disconnectAll(this: Namespace): void;
     destroy(this: Namespace): void;

package/src/init.luau

@@ -104,7 +104,7 @@ end
 -- Public --------------------------------------------------------------
 
 local Lync = {
-    VERSION = "1.5.0",
+    VERSION = "1.5.2",
 
     -- Lifecycle
     start = start,

package/src/transport/Reader.luau

@@ -141,7 +141,7 @@ function Reader.process(
                 if kind == KIND_REQUEST then
                     querySignal:fire(nil, player, correlationId)
                 else
-                    querySignal:fire(nil, correlationId)
+                    querySignal:fire(nil, player, correlationId)
                 end
                 continue
             end
@@ -166,7 +166,7 @@ function Reader.process(
             if kind == KIND_REQUEST then
                 querySignal:fire(final, player, correlationId)
             else
-                querySignal:fire(final, correlationId)
+                querySignal:fire(final, player, correlationId)
             end
         end
     end