@dcl/ecs 7.28.1-34901226656.commit-44656ea → 7.28.1-34955459026.commit-7db2d46

package/dist/engine/lww-element-set-component-definition.js

@@ -30,16 +30,12 @@ export function createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, d
         }
     };
 }
-export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData) {
+const __GLOBAL_ENTITY = '__GLOBAL_ENTITY';
+export function createCrdtRuleValidator(timestamps, schema, data, lastSentData) {
     /**
-     * Process the received message only if the lamport number recieved is higher
-     * than the stored one. If its lower, we spread it to the network to correct the peer.
-     * If they are equal, the bigger raw data wins.
-  
-      * Returns the recieved data if the lamport number was bigger than ours.
-      * If it was an outdated message, then we return void
-      * @public
-      */
+     * Shared CRDT conflict resolution logic
+     * @public
+     */
     function crdtRuleForCurrentState(message) {
         const { entityId, timestamp } = message;
         const currentTimestamp = timestamps.get(entityId);
@@ -49,7 +45,6 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
         }
         // Outdated Message. Resend our state message through the wire.
         if (currentTimestamp > timestamp) {
-            // console.log('2', currentTimestamp, timestamp)
             return ProcessMessageResultType.StateOutdatedTimestamp;
         }
         // Deletes are idempotent
@@ -66,7 +61,6 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
             currentDataGreater = dataCompare(null, message.data);
         }
         // Same data, same timestamp. Weirdo echo message.
-        // console.log('3', currentDataGreater, writeBuffer.toBinary(), (message as any).data || null)
         if (currentDataGreater === 0) {
             return ProcessMessageResultType.NoChanges;
         }
@@ -75,10 +69,35 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
             return ProcessMessageResultType.StateOutdatedData;
         }
         else {
-            // Curent data is lower
+            // Current data is lower
             return ProcessMessageResultType.StateUpdatedData;
         }
     }
+    return crdtRuleForCurrentState;
+}
+export function createForceUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
+    /**
+     * Force update component state regardless of timestamp - used for server authoritative messages
+     */
+    return (msg) => {
+        const buffer = new ReadWriteByteBuffer(msg.data);
+        const deserializedValue = schema.deserialize(buffer);
+        data.set(msg.entityId, deserializedValue);
+        timestamps.set(msg.entityId, msg.timestamp);
+        return [null, deserializedValue];
+    };
+}
+export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData) {
+    /**
+     * Process the received message only if the lamport number recieved is higher
+     * than the stored one. If its lower, we spread it to the network to correct the peer.
+     * If they are equal, the bigger raw data wins.
+  
+      * Returns the recieved data if the lamport number was bigger than ours.
+      * If it was an outdated message, then we return void
+      * @public
+      */
+    const crdtRuleForCurrentState = createCrdtRuleValidator(timestamps, schema, data, lastSentData);
     return (msg) => {
         /* istanbul ignore next */
         if (msg.type !== CrdtMessageType.PUT_COMPONENT &&
@@ -96,7 +115,10 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
                 if (msg.type === CrdtMessageType.PUT_COMPONENT || msg.type === CrdtMessageType.PUT_COMPONENT_NETWORK) {
                     const buf = new ReadWriteByteBuffer(msg.data);
                     data.set(entity, schema.deserialize(buf));
-                    lastSentData.set(entity, new Uint8Array(msg.data));
+                    // do NOT seed lastSentData from an INCOMING message!!!!
+                    // seeding it from received bytes makes the engine
+                    // believe it already sent this state, which kills valid re-broadcasting 🧨
+                    lastSentData.delete(entity);
                 }
                 else {
                     data.delete(entity);
@@ -185,6 +207,7 @@ export function createComponentDefinitionFromSchema(componentName, componentId,
     const timestamps = new Map();
     const lastSentData = new Map();
     const onChangeCallbacks = new Map();
+    const validateCallbacks = new Map();
     return {
         get componentId() {
             return componentId;
@@ -201,12 +224,16 @@ export function createComponentDefinitionFromSchema(componentName, componentId,
             return data.has(entity);
         },
         deleteFrom(entity, markAsDirty = true) {
+            // Presence, not truthiness: a component defined from a primitive schema can
+            // legitimately hold 0, false or an empty string, and deleting one must still
+            // return the value that was there.
+            const had = data.has(entity);
             const component = data.get(entity);
             if (data.delete(entity) && markAsDirty) {
                 dirtyIterator.add(entity);
             }
             lastSentData.delete(entity);
-            return component || null;
+            return had ? component : null;
         },
         entityDeleted(entity, markAsDirty) {
             if (data.delete(entity) && markAsDirty) {
@@ -215,19 +242,20 @@ export function createComponentDefinitionFromSchema(componentName, componentId,
             lastSentData.delete(entity);
         },
         getOrNull(entity) {
-            const component = data.get(entity);
-            return component ? deepReadonly(component) : null;
+            // Presence, not truthiness: a component defined from a primitive schema
+            // can legitimately hold 0, false or an empty string.
+            if (!data.has(entity))
+                return null;
+            return deepReadonly(data.get(entity));
         },
         get(entity) {
-            const component = data.get(entity);
-            if (!component) {
+            if (!data.has(entity)) {
                 throw new Error(`[getFrom] Component ${componentName} for entity #${entity} not found`);
             }
-            return deepReadonly(component);
+            return deepReadonly(data.get(entity));
         },
         create(entity, value) {
-            const component = data.get(entity);
-            if (component) {
+            if (data.has(entity)) {
                 throw new Error(`[create] Component ${componentName} for ${entity} already exists`);
             }
             const usedValue = value === undefined ? schema.create() : schema.extend ? schema.extend(value) : value;
@@ -243,21 +271,22 @@ export function createComponentDefinitionFromSchema(componentName, componentId,
             return usedValue;
         },
         getMutableOrNull(entity) {
-            const component = data.get(entity);
-            if (!component) {
+            // Presence, not truthiness, so a falsy primitive value is still mutable.
+            if (!data.has(entity)) {
                 return null;
             }
             dirtyIterator.add(entity);
-            return component;
+            return data.get(entity);
         },
         getOrCreateMutable(entity, value) {
-            const component = data.get(entity);
-            if (!component) {
+            // Presence, not truthiness: a stored 0/false/'' must not be treated as absent,
+            // which would send this through create() and throw "already exists".
+            if (!data.has(entity)) {
                 return this.create(entity, value);
             }
             else {
                 dirtyIterator.add(entity);
-                return component;
+                return data.get(entity);
             }
         },
         getMutable(entity) {
@@ -279,7 +308,39 @@ export function createComponentDefinitionFromSchema(componentName, componentId,
         },
         getCrdtUpdates: createGetCrdtMessagesForLww(componentId, timestamps, dirtyIterator, schema, data, lastSentData),
         updateFromCrdt: createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData),
+        __forceUpdateFromCrdt: createForceUpdateLwwFromCrdt(componentId, timestamps, schema, data),
+        __dry_run_updateFromCrdt: createCrdtRuleValidator(timestamps, schema, data, lastSentData),
         dumpCrdtStateToBuffer: createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, data),
+        validateBeforeChange(entityOrCb, cb) {
+            if (arguments.length === 1) {
+                // Second overload: just callback (global validation)
+                validateCallbacks.set(__GLOBAL_ENTITY, entityOrCb);
+            }
+            else {
+                if (cb) {
+                    validateCallbacks.set(entityOrCb, cb);
+                }
+            }
+        },
+        __run_validateBeforeChange(entity, newValue, senderAddress, createdBy) {
+            const cb = entity && validateCallbacks.get(entity);
+            const globalCb = validateCallbacks.get(__GLOBAL_ENTITY);
+            const currentValue = data.get(entity);
+            const value = { entity, currentValue, newValue, senderAddress, createdBy };
+            const globalResult = globalCb?.(value) ?? true;
+            const entityResult = (globalResult && cb?.(value)) ?? true;
+            return globalResult && entityResult;
+        },
+        getCrdtState(entity) {
+            const componentData = data.get(entity);
+            const timestamp = timestamps.get(entity);
+            if (componentData && timestamp !== undefined) {
+                const buffer = new ReadWriteByteBuffer();
+                schema.serialize(deepReadonly(componentData), buffer);
+                return { data: buffer.toBinary(), timestamp };
+            }
+            return null;
+        },
         onChange(entity, cb) {
             const cbs = onChangeCallbacks.get(entity) ?? [];
             cbs.push(cb);

package/dist/engine/readonly.d.ts

@@ -16,7 +16,7 @@ export type DeepReadonlyObject<T> = {
 /**
  * @public
  */
-export type ReadonlyPrimitive = number | string | number[] | string[] | boolean | boolean[];
+export type ReadonlyPrimitive = number | string | boolean;
 /**
  * @public
  */

package/dist/engine/readonly.js

@@ -2,5 +2,15 @@
  * @internal
  */
 export function deepReadonly(val) {
+    // A component can be defined straight from a primitive or array schema, not
+    // only from a Map, which is why this is no longer constrained to an object.
+    // Spreading those threw the value away: a number came back as {}, an array
+    // as an object keyed by index.
+    if (val === null || typeof val !== 'object') {
+        return val;
+    }
+    if (Array.isArray(val)) {
+        return Object.freeze([...val]);
+    }
     return Object.freeze({ ...val });
 }

package/dist/index.d.ts

@@ -16,7 +16,7 @@ export * from './systems/triggerArea';
 export * from './systems/physics';
 export * from './engine/entity';
 export * from './components/types';
-import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, AvatarShapeComponentDefinitionExtended, AvatarEquippedDataComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended, TouchScreenControlsComponentDefinitionExtended } from './components/types';
+import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended, ICreatedBy, TouchScreenControlsComponentDefinitionExtended } from './components/types';
 import { NameComponent } from './components/manual/Name';
 import { TagsComponentDefinitionExtended } from './components/manual/Tags';
 export declare const Transform: TransformComponentExtended;
@@ -27,8 +27,6 @@ export declare const AudioStream: AudioStreamComponentDefinitionExtended;
 export declare const Material: MaterialComponentDefinitionExtended;
 export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
 export declare const MeshCollider: MeshColliderComponentDefinitionExtended;
-export declare const AvatarShape: AvatarShapeComponentDefinitionExtended;
-export declare const AvatarEquippedData: AvatarEquippedDataComponentDefinitionExtended;
 export declare const Name: NameComponent;
 export declare const Tags: TagsComponentDefinitionExtended;
 export declare const Tween: TweenComponentDefinitionExtended;
@@ -54,6 +52,7 @@ export declare const NetworkEntity: INetowrkEntity;
  * Tag a entity to be syncronized through comms
  */
 export declare const NetworkParent: INetowrkParent;
+export declare const CreatedBy: ICreatedBy;
 export * from './components/generated/global.gen';
 export * from './components/generated/types.gen';
 export * from './serialization/crdt';

package/dist/index.js

@@ -31,9 +31,6 @@ export const AudioStream = /* @__PURE__*/ components.AudioStream(engine);
 export const Material = /* @__PURE__*/ components.Material(engine);
 export const MeshRenderer = /* @__PURE__*/ components.MeshRenderer(engine);
 export const MeshCollider = /* @__PURE__*/ components.MeshCollider(engine);
-export const AvatarShape = /* @__PURE__*/ components.AvatarShape(engine);
-export const AvatarEquippedData = 
-/* @__PURE__*/ components.AvatarEquippedData(engine);
 export const Name = components.Name(engine);
 export const Tags = components.Tags(engine);
 export const Tween = /* @__PURE__*/ components.Tween(engine);
@@ -61,6 +58,7 @@ export const NetworkEntity = /* @__PURE__*/ components.NetworkEntity(engine);
  * Tag a entity to be syncronized through comms
  */
 export const NetworkParent = /* @__PURE__*/ components.NetworkParent(engine);
+export const CreatedBy = /* @__PURE__*/ components.CreatedBy(engine);
 // export components for global engine
 export * from './components/generated/global.gen';
 export * from './components/generated/types.gen';

package/dist/schemas/OneOf.js

@@ -1,3 +1,5 @@
+/** Reserved case index for a value whose case was never selected. */
+const NO_CASE = 0;
 export const IOneOf = (specs) => {
     const specKeys = Object.keys(specs);
     const keyToIndex = specKeys.reduce((dict, key, index) => {
@@ -10,12 +12,22 @@ export const IOneOf = (specs) => {
     }, {});
     return {
         serialize({ $case, value }, builder) {
+            // `create()` selects no case, so a field the scene never set arrives here
+            // with an undefined `$case`. Index 0 is free, cases start at 1.
+            if ($case === undefined) {
+                builder.writeUint8(NO_CASE);
+                return;
+            }
             const _value = keyToIndex[$case.toString()] + 1;
             builder.writeUint8(_value);
             specs[$case].serialize(value, builder);
         },
         deserialize(reader) {
-            const $case = specKeys[reader.readInt8() - 1];
+            const caseIndex = reader.readInt8();
+            if (caseIndex === NO_CASE) {
+                return {};
+            }
+            const $case = specKeys[caseIndex - 1];
             const value = specs[$case].deserialize(reader);
             return { $case, value };
         },

package/dist/serialization/crdt/authoritativePutComponent.d.ts

@@ -0,0 +1,15 @@
+import { Entity } from '../../engine/entity';
+import { ByteBuffer } from '../ByteBuffer';
+import { AuthoritativePutComponentMessage } from './types';
+/**
+ * @public
+ */
+export declare namespace AuthoritativePutComponentOperation {
+    const MESSAGE_HEADER_LENGTH = 16;
+    /**
+     * Call this function for an optimal writing data passing the ByteBuffer
+     *  already allocated
+     */
+    function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
+    function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
+}

package/dist/serialization/crdt/authoritativePutComponent.js

@@ -0,0 +1,47 @@
+import { CrdtMessageProtocol } from './crdtMessageProtocol';
+import { CrdtMessageType, CRDT_MESSAGE_HEADER_LENGTH } from './types';
+/**
+ * @public
+ */
+export var AuthoritativePutComponentOperation;
+(function (AuthoritativePutComponentOperation) {
+    AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH = 16;
+    /**
+     * Call this function for an optimal writing data passing the ByteBuffer
+     *  already allocated
+     */
+    function write(entity, timestamp, componentId, data, buf) {
+        // reserve the beginning
+        const startMessageOffset = buf.incrementWriteOffset(CRDT_MESSAGE_HEADER_LENGTH + AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH);
+        // write body
+        buf.writeBuffer(data, false);
+        const messageLength = buf.currentWriteOffset() - startMessageOffset;
+        // Write CrdtMessage header
+        buf.setUint32(startMessageOffset, messageLength);
+        buf.setUint32(startMessageOffset + 4, CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT);
+        // Write ComponentOperation header
+        buf.setUint32(startMessageOffset + 8, entity);
+        buf.setUint32(startMessageOffset + 12, componentId);
+        buf.setUint32(startMessageOffset + 16, timestamp);
+        const newLocal = messageLength - AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH - CRDT_MESSAGE_HEADER_LENGTH;
+        buf.setUint32(startMessageOffset + 20, newLocal);
+    }
+    AuthoritativePutComponentOperation.write = write;
+    function read(buf) {
+        const header = CrdtMessageProtocol.readHeader(buf);
+        if (!header) {
+            return null;
+        }
+        if (header.type !== CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT) {
+            throw new Error('AuthoritativePutComponentOperation tried to read another message type.');
+        }
+        return {
+            ...header,
+            entityId: buf.readUint32(),
+            componentId: buf.readUint32(),
+            timestamp: buf.readUint32(),
+            data: buf.readBuffer()
+        };
+    }
+    AuthoritativePutComponentOperation.read = read;
+})(AuthoritativePutComponentOperation || (AuthoritativePutComponentOperation = {}));

package/dist/serialization/crdt/index.d.ts

@@ -7,3 +7,4 @@ export * from './network/deleteComponentNetwork';
 export * from './network/deleteEntityNetwork';
 export * from './types';
 export * from './crdtMessageProtocol';
+export * from './authoritativePutComponent';

package/dist/serialization/crdt/index.js

@@ -7,3 +7,4 @@ export * from './network/deleteComponentNetwork';
 export * from './network/deleteEntityNetwork';
 export * from './types';
 export * from './crdtMessageProtocol';
+export * from './authoritativePutComponent';

package/dist/serialization/crdt/types.d.ts

@@ -11,7 +11,8 @@ export declare enum CrdtMessageType {
     PUT_COMPONENT_NETWORK = 5,
     DELETE_COMPONENT_NETWORK = 6,
     DELETE_ENTITY_NETWORK = 7,
-    MAX_MESSAGE_TYPE = 8
+    AUTHORITATIVE_PUT_COMPONENT = 8,
+    MAX_MESSAGE_TYPE = 9
 }
 /**
  * Min length = 8 bytes
@@ -48,6 +49,23 @@ export type PutNetworkComponentMessageBody = Omit<PutComponentMessageBody, 'type
     type: CrdtMessageType.PUT_COMPONENT_NETWORK;
     networkId: number;
 };
+/**
+ * Server authoritative message - identical to PutComponentMessageBody but with forced processing
+ * Min. length = header (8 bytes) + 16 bytes = 24 bytes
+ *
+ * @param entity - Uint32 number of the entity
+ * @param componentId - Uint32 number of id
+ * @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
+ * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
+ * @public
+ */
+export type AuthoritativePutComponentMessageBody = {
+    type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
+    entityId: Entity;
+    componentId: number;
+    timestamp: number;
+    data: Uint8Array;
+};
 /**
  * Min. length = header (8 bytes) + 16 bytes = 24 bytes
  *
@@ -114,6 +132,10 @@ export type AppendValueMessage = CrdtMessageHeader & AppendValueMessageBody;
  * @public
  */
 export type PutComponentMessage = CrdtMessageHeader & PutComponentMessageBody;
+/**
+ * @public
+ */
+export type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
 /**
  * @public
  */
@@ -137,7 +159,7 @@ export type DeleteEntityNetworkMessage = CrdtMessageHeader & DeleteEntityNetwork
 /**
  * @public
  */
-export type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
+export type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
 /**
  * @public
  */
@@ -145,7 +167,7 @@ export type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComp
 /**
  * @public
  */
-export type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
+export type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
 export declare enum ProcessMessageResultType {
     /**
      * Typical message and new state set.

package/dist/serialization/crdt/types.js

@@ -13,7 +13,9 @@ export var CrdtMessageType;
     CrdtMessageType[CrdtMessageType["PUT_COMPONENT_NETWORK"] = 5] = "PUT_COMPONENT_NETWORK";
     CrdtMessageType[CrdtMessageType["DELETE_COMPONENT_NETWORK"] = 6] = "DELETE_COMPONENT_NETWORK";
     CrdtMessageType[CrdtMessageType["DELETE_ENTITY_NETWORK"] = 7] = "DELETE_ENTITY_NETWORK";
-    CrdtMessageType[CrdtMessageType["MAX_MESSAGE_TYPE"] = 8] = "MAX_MESSAGE_TYPE";
+    // Server authoritative operation - forces component state regardless of timestamp
+    CrdtMessageType[CrdtMessageType["AUTHORITATIVE_PUT_COMPONENT"] = 8] = "AUTHORITATIVE_PUT_COMPONENT";
+    CrdtMessageType[CrdtMessageType["MAX_MESSAGE_TYPE"] = 9] = "MAX_MESSAGE_TYPE";
 })(CrdtMessageType || (CrdtMessageType = {}));
 /**
  * @public

package/dist/systems/crdt/index.d.ts

@@ -1,7 +1,6 @@
 import { Entity } from '../../engine/entity';
 import type { ComponentDefinition } from '../../engine';
 import { CrdtMessageType } from '../../serialization/crdt/types';
-export declare const LIVEKIT_MAX_SIZE = 12;
 /**
  * @public
  */