@dcl/ecs 7.24.3 → 7.24.4-28592331167.commit-697ce9e

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createComponentDefinitionFromSchema = exports.createGetCrdtMessagesForLww = exports.createUpdateLwwFromCrdt = exports.createDumpLwwFunctionFromCrdt = exports.incrementTimestamp = void 0;
+exports.createComponentDefinitionFromSchema = exports.createGetCrdtMessagesForLww = exports.createUpdateLwwFromCrdt = exports.createForceUpdateLwwFromCrdt = exports.createCrdtRuleValidator = exports.createDumpLwwFunctionFromCrdt = exports.incrementTimestamp = void 0;
 const ByteBuffer_1 = require("../serialization/ByteBuffer");
 const crdt_1 = require("../serialization/crdt");
 const utils_1 = require("../systems/crdt/utils");
@@ -35,16 +35,12 @@ function createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, data) {
     };
 }
 exports.createDumpLwwFunctionFromCrdt = createDumpLwwFunctionFromCrdt;
-function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData) {
+const __GLOBAL_ENTITY = '__GLOBAL_ENTITY';
+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);
@@ -54,7 +50,6 @@ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSent
         }
         // Outdated Message. Resend our state message through the wire.
         if (currentTimestamp > timestamp) {
-            // console.log('2', currentTimestamp, timestamp)
             return crdt_1.ProcessMessageResultType.StateOutdatedTimestamp;
         }
         // Deletes are idempotent
@@ -71,7 +66,6 @@ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSent
             currentDataGreater = (0, utils_1.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 crdt_1.ProcessMessageResultType.NoChanges;
         }
@@ -80,10 +74,37 @@ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSent
             return crdt_1.ProcessMessageResultType.StateOutdatedData;
         }
         else {
-            // Curent data is lower
+            // Current data is lower
             return crdt_1.ProcessMessageResultType.StateUpdatedData;
         }
     }
+    return crdtRuleForCurrentState;
+}
+exports.createCrdtRuleValidator = createCrdtRuleValidator;
+function createForceUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
+    /**
+     * Force update component state regardless of timestamp - used for server authoritative messages
+     */
+    return (msg) => {
+        const buffer = new ByteBuffer_1.ReadWriteByteBuffer(msg.data);
+        const deserializedValue = schema.deserialize(buffer);
+        data.set(msg.entityId, deserializedValue);
+        timestamps.set(msg.entityId, msg.timestamp);
+        return [null, deserializedValue];
+    };
+}
+exports.createForceUpdateLwwFromCrdt = createForceUpdateLwwFromCrdt;
+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 !== crdt_1.CrdtMessageType.PUT_COMPONENT &&
@@ -101,7 +122,10 @@ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSent
                 if (msg.type === crdt_1.CrdtMessageType.PUT_COMPONENT || msg.type === crdt_1.CrdtMessageType.PUT_COMPONENT_NETWORK) {
                     const buf = new ByteBuffer_1.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);
@@ -192,6 +216,7 @@ function createComponentDefinitionFromSchema(componentName, componentId, schema)
     const timestamps = new Map();
     const lastSentData = new Map();
     const onChangeCallbacks = new Map();
+    const validateCallbacks = new Map();
     return {
         get componentId() {
             return componentId;
@@ -286,7 +311,39 @@ function createComponentDefinitionFromSchema(componentName, componentId, schema)
         },
         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 ByteBuffer_1.ReadWriteByteBuffer();
+                schema.serialize((0, readonly_1.deepReadonly)(componentData), buffer);
+                return { data: buffer.toBinary(), timestamp };
+            }
+            return null;
+        },
         onChange(entity, cb) {
             const cbs = onChangeCallbacks.get(entity) ?? [];
             cbs.push(cb);

package/dist-cjs/index.d.ts

@@ -15,7 +15,7 @@ export * from './systems/triggerArea';
 export * from './systems/physics';
 export * from './engine/entity';
 export * from './components/types';
-import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended } from './components/types';
+import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended, ICreatedBy } from './components/types';
 import { NameComponent } from './components/manual/Name';
 import { TagsComponentDefinitionExtended } from './components/manual/Tags';
 export declare const Transform: TransformComponentExtended;
@@ -50,6 +50,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-cjs/index.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.ParticleSystem = exports.TriggerArea = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.Tags = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.AudioStream = exports.AudioAnalysis = exports.AudioSource = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
+exports.CreatedBy = exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.ParticleSystem = exports.TriggerArea = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.Tags = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.AudioStream = exports.AudioAnalysis = exports.AudioSource = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
 // The order of the following imports matters. Please do not auto-sort
 __exportStar(require("./engine"), exports);
 __exportStar(require("./schemas"), exports);
@@ -84,6 +84,7 @@ exports.NetworkEntity = components.NetworkEntity(initialization_1.engine);
  * Tag a entity to be syncronized through comms
  */
 exports.NetworkParent = components.NetworkParent(initialization_1.engine);
+exports.CreatedBy = components.CreatedBy(initialization_1.engine);
 // export components for global engine
 __exportStar(require("./components/generated/global.gen"), exports);
 __exportStar(require("./components/generated/types.gen"), exports);

package/dist-cjs/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-cjs/serialization/crdt/authoritativePutComponent.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthoritativePutComponentOperation = void 0;
+const crdtMessageProtocol_1 = require("./crdtMessageProtocol");
+const types_1 = require("./types");
+/**
+ * @public
+ */
+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(types_1.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, types_1.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 - types_1.CRDT_MESSAGE_HEADER_LENGTH;
+        buf.setUint32(startMessageOffset + 20, newLocal);
+    }
+    AuthoritativePutComponentOperation.write = write;
+    function read(buf) {
+        const header = crdtMessageProtocol_1.CrdtMessageProtocol.readHeader(buf);
+        if (!header) {
+            return null;
+        }
+        if (header.type !== types_1.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 = exports.AuthoritativePutComponentOperation || (exports.AuthoritativePutComponentOperation = {}));

package/dist-cjs/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-cjs/serialization/crdt/index.js

@@ -23,3 +23,4 @@ __exportStar(require("./network/deleteComponentNetwork"), exports);
 __exportStar(require("./network/deleteEntityNetwork"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./crdtMessageProtocol"), exports);
+__exportStar(require("./authoritativePutComponent"), exports);

package/dist-cjs/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-cjs/serialization/crdt/types.js

@@ -16,7 +16,9 @@ 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 = exports.CrdtMessageType || (exports.CrdtMessageType = {}));
 /**
  * @public

package/dist-cjs/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
  */