Repository navigation
Cheeto v1.1.0
This release fixes defects found while rebuilding the documentation against the compiler, and makes every documented feature do what it says. The wire format changed; regenerate both modules together, as always.
Upgrading from 1.0
Some fixes make code that worked by accident stop working. Check these before you publish:
- Register every policy name. Unregistered policies now drop every packet on their endpoints. The built-in names such as
damageandadminno longer exist. Runcheeto --doctorto list every policy, policy group and auth name your schema uses, and register each one withSecurity.RegisterPolicy,Security.RegisterPolicyGrouporUseAuth. - Swap
CFramecomponents if you followed the old docs.CFrame<A, B>now means positionA, rotationB. The 1.0 docs said to writeCFrame<f16, i16>for an integer position; that now gives integer rotations and a half-precision position. WriteCFrame<i16, f16>instead. This one fails silently, so search your schema forCFrame<. - Delete
ProtocolVersion,ProtocolModeandAcceptProtocolVersion1. These lines no longer compile. - Move access fields off server-sent endpoints.
Auth,Policy,PolicyGroup,CooldownSeconds,Idempotencyand the constraint fields onFrom: Serverevents and on channels are now compile errors. They never worked there: the client dropped every packet. - Keep integers in range. A value outside its type, such as
300for au8, now raises at the call site instead of arriving wrapped. - Commit
cheeto.lock. Endpoint ids now come from it. Run--write-lockonce after upgrading; the 1.0 lock format is ignored until you do. - Expect answers to dropped calls.
Invokenow raisesThe server rejected "Name": <reason>for a call the server drops, instead of waiting for its timeout. Handler errors raiseHandlerError.
Security
- Unregistered policies and policy groups now drop every packet and warn once. The built-in policy names (
admin,currency,damageand the rest), which admitted every connected player, are gone: register a rule for each name your schema uses.--doctorlists them. RequirePoliciesacceptsPolicy,PolicyGrouporAuth, as--doctorand--strictalways did.- Constraints are enforced by the runtime:
RequireTeam,RequireZone,RequireMatchandRequireCharacterStatebefore decoding;MaxDistance,RequireOwnership,RequireObjectHandle,RequireServerKnownIdandRequireInventoryOwnershipafter. NewSecurity.SetZone,GetZone,RegisterKnownId,ForgetKnownIdandSetInventoryResolver. - The handshake carries a fingerprint of the wire layout instead of
schema-<Version>, the server sends it to every player, and the server stops decoding players on another schema.IncompatiblePeerAction = Kickkicks them. Idempotencyworks withoutPredict: client events and functions carry a sequence number, and replayed packets are dropped.Auth,Policy, constraint and idempotency fields on server-sent events and channels are compile errors instead of rules the client could never satisfy.- Decoy remotes share the real remotes' name format and both classes.
Security.SetRateLimitchanges an endpoint's or a remote's rate limit at runtime.
Fixed
- A broadcast could hand one player's pending batch buffer to another and overwrite its unsent messages.
- A server module with two or more state channels exceeded Luau's 200-local limit and failed to load.
- Backpressure counted bytes for broadcasts and unreliable sends that were never released, eventually shedding every low-priority broadcast.
- A send whose serialization raised left half a frame in the batch.
- Generated invokes ignored the security profile's timeout and
Configure; they now use the runtime value. - A call or prediction the server dropped was never answered. It now gets the drop reason, so
Invokefails fast and predictions roll back. - Prediction ids wrapping past 65,535 were dropped as stale.
CFrame<A, B>applied position and rotation the wrong way round.- Integers outside their type's range were silently wrapped (300 as a
u8arrived as 44); they now raise.Color3channels clamp. f16NaN decoded as a large finite number.- Per-endpoint
MaxPacketBytesmeasured the whole packet instead of the event. - String dictionaries desynchronized when a broadcast was copied into players' batches.
- Polled events were queued before their payload checks ran.
- Canonicalization rejected legitimate map keys (struct, negative, fractional and sparse keys).
--check-lockfailed on CRLF checkouts.
Added
WireId,ReservedIdandDeprecatedIdare honoured, andcheeto.lockkeeps ids stable across reorders and removals, with removed endpoints kept as retired.ReliabilityMode = LatestandCoalesceKeysend only the last value per recipient per frame;ReliabilityMode = Sequenceddrops out-of-order packets (OutOfOrder).- Unreliable events are batched per recipient per frame (
BatchUnreliable). - Channel
InterestandScopevaluesParty,Match,Team,CellandOwnerwork, withSetScope,PatchScopeandFlushScope. UseColonmakes endpoint methods callable with:.map {[K]: V}(Min..Max)bounds a map's entry count;type X = SomeStructaliases any declared type.- A function's
Onreturns a function that unbinds the handler. - TypeScript definitions cover channels,
Predict,FireGroup,Futureresults and the runtime API, and are type-checked in CI. --benchmarkand--load-simmeasure the generated code instead of estimating it.- New drop reasons
CooldownandOutOfOrder.
Removed
- The
ProtocolVersion,ProtocolModeandAcceptProtocolVersion1options, which now fail with "was removed". Cheeto has one wire format. Protocol.Info()no longer reportsLocalProtocolVersionorProtocolMode; it reportsWireFormatandSchemaHash.
Changed
SyncValidationis on by default only in theDevelopmentprofile.