@dcl/ecs 7.3.31 → 7.3.32

package/dist-cjs/systems/crdt/index.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.crdtSceneSystem = void 0;
 const entity_1 = require("../../engine/entity");
@@ -8,17 +31,22 @@ const deleteComponent_1 = require("../../serialization/crdt/deleteComponent");
 const deleteEntity_1 = require("../../serialization/crdt/deleteEntity");
 const putComponent_1 = require("../../serialization/crdt/putComponent");
 const types_1 = require("../../serialization/crdt/types");
+const putComponentNetwork_1 = require("../../serialization/crdt/network/putComponentNetwork");
+const components_1 = require("../../components");
+const networkUtils = __importStar(require("../../serialization/crdt/network/utils"));
 /**
  * @internal
  */
 function crdtSceneSystem(engine, onProcessEntityComponentChange) {
     const transports = [];
+    // Components that we used on this system
+    const NetworkEntity = (0, components_1.NetworkEntity)(engine);
+    const NetworkParent = (0, components_1.NetworkParent)(engine);
+    const Transform = (0, components_1.Transform)(engine);
     // Messages that we received at transport.onMessage waiting to be processed
     const receivedMessages = [];
     // Messages already processed by the engine but that we need to broadcast to other transports.
     const broadcastMessages = [];
-    // Messages receieved by a transport that were outdated. We need to correct them
-    const outdatedMessages = [];
     /**
      *
      * @param transportId tranport id to identiy messages
@@ -35,45 +63,41 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
             let header;
             while ((header = crdt_1.CrdtMessageProtocol.getHeader(buffer))) {
                 const offset = buffer.currentReadOffset();
+                let message = undefined;
                 if (header.type === types_1.CrdtMessageType.DELETE_COMPONENT) {
-                    const message = deleteComponent_1.DeleteComponent.read(buffer);
-                    receivedMessages.push({
-                        ...message,
-                        transportId,
-                        messageBuffer: buffer.buffer().subarray(offset, buffer.currentReadOffset())
-                    });
+                    message = deleteComponent_1.DeleteComponent.read(buffer);
+                }
+                else if (header.type === types_1.CrdtMessageType.DELETE_COMPONENT_NETWORK) {
+                    message = crdt_1.DeleteComponentNetwork.read(buffer);
                 }
                 else if (header.type === types_1.CrdtMessageType.PUT_COMPONENT) {
-                    const message = putComponent_1.PutComponentOperation.read(buffer);
-                    receivedMessages.push({
-                        ...message,
-                        transportId,
-                        messageBuffer: buffer.buffer().subarray(offset, buffer.currentReadOffset())
-                    });
+                    message = putComponent_1.PutComponentOperation.read(buffer);
+                }
+                else if (header.type === types_1.CrdtMessageType.PUT_COMPONENT_NETWORK) {
+                    message = putComponentNetwork_1.PutNetworkComponentOperation.read(buffer);
                 }
                 else if (header.type === types_1.CrdtMessageType.DELETE_ENTITY) {
-                    const message = deleteEntity_1.DeleteEntity.read(buffer);
-                    receivedMessages.push({
-                        ...message,
-                        transportId,
-                        messageBuffer: buffer.buffer().subarray(offset, buffer.currentReadOffset())
-                    });
+                    message = deleteEntity_1.DeleteEntity.read(buffer);
+                }
+                else if (header.type === types_1.CrdtMessageType.DELETE_ENTITY_NETWORK) {
+                    message = crdt_1.DeleteEntityNetwork.read(buffer);
                 }
                 else if (header.type === types_1.CrdtMessageType.APPEND_VALUE) {
-                    const message = crdt_1.AppendValueOperation.read(buffer);
-                    receivedMessages.push({
-                        ...message,
-                        transportId,
-                        messageBuffer: buffer.buffer().subarray(offset, buffer.currentReadOffset())
-                    });
+                    message = crdt_1.AppendValueOperation.read(buffer);
                     // Unknown message, we skip it
                 }
                 else {
                     // consume the message
                     buffer.incrementReadOffset(header.length);
                 }
+                if (message) {
+                    receivedMessages.push({
+                        ...message,
+                        transportId,
+                        messageBuffer: buffer.buffer().subarray(offset, buffer.currentReadOffset())
+                    });
+                }
             }
-            // TODO: do something if buffler.len>0
         };
     }
     /**
@@ -84,46 +108,61 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
         const messagesToProcess = value.splice(0, value.length);
         return messagesToProcess;
     }
+    /**
+     * Find the local entityId associated to the network component message.
+     * It's a mapping Network -> to Local
+     * If it's not a network message, return the entityId received by the message
+     */
+    function findNetworkId(msg) {
+        const hasNetworkId = 'networkId' in msg;
+        if (hasNetworkId) {
+            for (const [entityId, network] of engine.getEntitiesWith(NetworkEntity)) {
+                if (network.networkId === msg.networkId && network.entityId === msg.entityId) {
+                    return { entityId, network };
+                }
+            }
+        }
+        return { entityId: msg.entityId };
+    }
     /**
      * This fn will be called on every tick.
      * Process all the messages queue received by the transport
      */
     async function receiveMessages() {
         const messagesToProcess = getMessages(receivedMessages);
-        const bufferForOutdated = new ByteBuffer_1.ReadWriteByteBuffer();
         const entitiesShouldBeCleaned = [];
         for (const msg of messagesToProcess) {
-            if (msg.type === types_1.CrdtMessageType.DELETE_ENTITY) {
-                entitiesShouldBeCleaned.push(msg.entityId);
+            let { entityId, network } = findNetworkId(msg);
+            // We receive a new Entity. Create the localEntity and map it to the NetworkEntity component
+            if (networkUtils.isNetworkMessage(msg) && !network) {
+                entityId = engine.addEntity();
+                network = { entityId: msg.entityId, networkId: msg.networkId };
+                NetworkEntity.createOrReplace(entityId, network);
+            }
+            if (msg.type === types_1.CrdtMessageType.DELETE_ENTITY || msg.type === types_1.CrdtMessageType.DELETE_ENTITY_NETWORK) {
+                entitiesShouldBeCleaned.push(entityId);
                 broadcastMessages.push(msg);
             }
             else {
-                const entityState = engine.entityContainer.getEntityState(msg.entityId);
+                const entityState = engine.entityContainer.getEntityState(entityId);
                 // Skip updates from removed entityes
                 if (entityState === entity_1.EntityState.Removed)
                     continue;
                 // Entities with unknown entities should update its entity state
                 if (entityState === entity_1.EntityState.Unknown) {
-                    engine.entityContainer.updateUsedEntity(msg.entityId);
+                    engine.entityContainer.updateUsedEntity(entityId);
                 }
                 const component = engine.getComponentOrNull(msg.componentId);
                 /* istanbul ignore else */
                 if (component) {
-                    const [conflictMessage, value] = component.updateFromCrdt(msg);
-                    if (conflictMessage) {
-                        const offset = bufferForOutdated.currentWriteOffset();
-                        if (conflictMessage.type === types_1.CrdtMessageType.PUT_COMPONENT) {
-                            putComponent_1.PutComponentOperation.write(msg.entityId, conflictMessage.timestamp, conflictMessage.componentId, conflictMessage.data, bufferForOutdated);
-                        }
-                        else if (conflictMessage.type === types_1.CrdtMessageType.DELETE_COMPONENT) {
-                            deleteComponent_1.DeleteComponent.write(msg.entityId, component.componentId, conflictMessage.timestamp, bufferForOutdated);
-                        }
-                        outdatedMessages.push({
-                            ...msg,
-                            messageBuffer: bufferForOutdated.buffer().subarray(offset, bufferForOutdated.currentWriteOffset())
-                        });
+                    if (msg.type === types_1.CrdtMessageType.PUT_COMPONENT &&
+                        component.componentId === Transform.componentId &&
+                        NetworkEntity.has(entityId) &&
+                        NetworkParent.has(entityId)) {
+                        msg.data = networkUtils.fixTransformParent(msg);
                     }
-                    else {
+                    const [conflictMessage, value] = component.updateFromCrdt({ ...msg, entityId });
+                    if (!conflictMessage) {
                         // Add message to transport queue to be processed by others transports
                         broadcastMessages.push(msg);
                         onProcessEntityComponentChange && onProcessEntityComponentChange(msg.entityId, msg.type, component, value);
@@ -137,12 +176,6 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
         }
         // the last stage of the syncrhonization is to delete the entities
         for (const entity of entitiesShouldBeCleaned) {
-            // If we tried to resend outdated message and the entity was deleted before, we avoid sending them.
-            for (let i = outdatedMessages.length - 1; i >= 0; i--) {
-                if (outdatedMessages[i].entityId === entity && outdatedMessages[i].type !== types_1.CrdtMessageType.DELETE_ENTITY) {
-                    outdatedMessages.splice(i, 1);
-                }
-            }
             for (const definition of engine.componentsIter()) {
                 // TODO: check this with pato/pravus
                 definition.entityDeleted(entity, true);
@@ -157,7 +190,6 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
     async function sendMessages(entitiesDeletedThisTick) {
         // CRDT Messages will be the merge between the recieved transport messages and the new crdt messages
         const crdtMessages = getMessages(broadcastMessages);
-        const outdatedMessagesBkp = getMessages(outdatedMessages);
         const buffer = new ByteBuffer_1.ReadWriteByteBuffer();
         for (const component of engine.componentsIter()) {
             for (const message of component.getCrdtUpdates()) {
@@ -202,25 +234,58 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
         for (const index in transports) {
             const transportIndex = Number(index);
             const transport = transports[transportIndex];
+            const isRendererTransport = transport.type === 'renderer';
+            const isNetworkTransport = transport.type === 'network';
             transportBuffer.resetBuffer();
-            // First we need to send all the messages that were outdated from a transport
-            // So we can fix their crdt state
-            for (const message of outdatedMessagesBkp) {
-                if (message.transportId === transportIndex &&
-                    // TODO: This is an optimization, the state should converge anyway, whatever the message is sent.
-                    // Avoid sending multiple messages for the same entity-componentId
-                    !crdtMessages.find((m) => m.entityId === message.entityId &&
-                        // TODO: as any, with multiple type of messages, it should have many checks before the check for similar messages
-                        m.componentId &&
-                        m.componentId === message.componentId)) {
-                    transportBuffer.writeBuffer(message.messageBuffer, false);
-                }
-            }
+            const buffer = new ByteBuffer_1.ReadWriteByteBuffer();
             // Then we send all the new crdtMessages that the transport needs to process
             for (const message of crdtMessages) {
-                if (message.transportId !== transportIndex && transport.filter(message)) {
-                    transportBuffer.writeBuffer(message.messageBuffer, false);
+                // Avoid echo messages
+                if (message.transportId === transportIndex)
+                    continue;
+                // Redundant message for the transport
+                if (!transport.filter(message))
+                    continue;
+                const { entityId } = findNetworkId(message);
+                const transformNeedsFix = 'componentId' in message &&
+                    message.componentId === Transform.componentId &&
+                    Transform.has(entityId) &&
+                    NetworkParent.has(entityId) &&
+                    NetworkEntity.has(entityId);
+                // If there was a LOCAL change in the transform. Add the parent to that transform
+                if (isRendererTransport && message.type === types_1.CrdtMessageType.PUT_COMPONENT && transformNeedsFix) {
+                    const parent = findNetworkId(NetworkParent.get(entityId));
+                    const transformData = networkUtils.fixTransformParent(message, Transform.get(entityId), parent.entityId);
+                    const offset = buffer.currentWriteOffset();
+                    putComponent_1.PutComponentOperation.write(entityId, message.timestamp, message.componentId, transformData, buffer);
+                    transportBuffer.writeBuffer(buffer.buffer().subarray(offset, buffer.currentWriteOffset()), false);
+                    continue;
+                }
+                if (isRendererTransport && networkUtils.isNetworkMessage(message)) {
+                    // If it's the renderer transport and its a NetworkMessage, we need to fix the entityId field and convert it to a known Message.
+                    // PUT_NETWORK_COMPONENT -> PUT_COMPONENT
+                    let transformData = 'data' in message ? message.data : new Uint8Array();
+                    if (transformNeedsFix) {
+                        const parent = findNetworkId(NetworkParent.get(entityId));
+                        transformData = networkUtils.fixTransformParent(message, Transform.get(entityId), parent.entityId);
+                    }
+                    networkUtils.networkMessageToLocal({ ...message, data: transformData }, entityId, buffer, transportBuffer);
+                    // Iterate the next message
+                    continue;
+                }
+                // If its a network transport and its a PUT_COMPONENT that has a NetworkEntity component, we need to send this message
+                // through comms with the EntityID and NetworkID from ther NetworkEntity so everyone can recieve this message and map to their custom entityID.
+                if (isNetworkTransport && !networkUtils.isNetworkMessage(message)) {
+                    const networkData = NetworkEntity.getOrNull(message.entityId);
+                    // If it has networkData convert the message to PUT_NETWORK_COMPONENT.
+                    if (networkData) {
+                        networkUtils.localMessageToNetwork(message, networkData, buffer, transportBuffer);
+                        // Iterate the next message
+                        continue;
+                    }
                 }
+                // Common message
+                transportBuffer.writeBuffer(message.messageBuffer, false);
             }
             const message = transportBuffer.currentWriteOffset() ? transportBuffer.toBinary() : new Uint8Array([]);
             await transport.send(message);

package/dist-cjs/systems/crdt/types.d.ts

@@ -1,4 +1,4 @@
-import { CrdtMessageBody } from '../../serialization/crdt/types';
+import { CrdtMessageBody, CrdtNetworkMessageBody } from '../../serialization/crdt/types';
 /**
  * @public
  */
@@ -6,6 +6,13 @@ export type ReceiveMessage = CrdtMessageBody & {
     transportId?: number;
     messageBuffer: Uint8Array;
 };
+/**
+ * @public
+ */
+export type ReceiveNetworkMessage = CrdtNetworkMessageBody & {
+    transportId?: number;
+    messageBuffer: Uint8Array;
+};
 /**
  * @public
  */
@@ -17,4 +24,5 @@ export type Transport = {
     send(message: Uint8Array): Promise<void>;
     onmessage?(message: Uint8Array): void;
     filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
+    type?: string;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/ecs",
   "description": "Decentraland ECS",
-  "version": "7.3.31",
+  "version": "7.3.32",
   "author": "DCL",
   "bugs": "https://github.com/decentraland/ecs/issues",
   "files": [
@@ -33,5 +33,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "5f044c65cc86498ef4a73f87e0082c070b9730f5"
+  "commit": "11a21816f9bf404c90ba02782ad7e359262a909d"
 }