@dcl/ecs 7.0.6-3808988484.commit-63d3e2c → 7.0.6-3823801200.commit-32470bd

package/dist/engine/index.d.ts

@@ -1,4 +1,5 @@
 import { ByteBuffer } from '../serialization/ByteBuffer';
+import { OnChangeFunction } from '../systems/crdt';
 import { ComponentDefinition } from './component';
 import { Entity } from './entity';
 import { SystemItem } from './systems';
@@ -6,8 +7,14 @@ import type { IEngine } from './types';
 export * from './input';
 export * from './readonly';
 export * from './types';
-export { Entity, ByteBuffer, ComponentDefinition, SystemItem };
+export { Entity, ByteBuffer, ComponentDefinition, SystemItem, OnChangeFunction };
 /**
  * @public
  */
-export declare function Engine(): IEngine;
+export declare type IEngineOptions = {
+    onChangeFunction: OnChangeFunction;
+};
+/**
+ * @public
+ */
+export declare function Engine(options?: IEngineOptions): IEngine;

package/dist/engine/index.js

@@ -106,6 +106,9 @@ function preEngine() {
     function getSystems() {
         return systems.getSystems();
     }
+    function componentsIter() {
+        return componentsDefinition.values();
+    }
     function removeComponentDefinition(componentId) {
         componentsDefinition.delete(componentId);
     }
@@ -142,15 +145,16 @@ function preEngine() {
         getComponentOrNull,
         removeComponentDefinition,
         removeEntityWithChildren,
-        registerCustomComponent
+        registerCustomComponent,
+        componentsIter
     };
 }
 /**
  * @public
  */
-export function Engine() {
+export function Engine(options) {
     const engine = preEngine();
-    const crdtSystem = crdtSceneSystem(engine);
+    const crdtSystem = crdtSceneSystem(engine, options?.onChangeFunction || null);
     async function update(dt) {
         await crdtSystem.receiveMessages();
         for (const system of engine.getSystems()) {
@@ -176,6 +180,7 @@ export function Engine() {
         getComponent: engine.getComponent,
         getComponentOrNull: engine.getComponentOrNull,
         removeComponentDefinition: engine.removeComponentDefinition,
+        componentsIter: engine.componentsIter,
         update,
         RootEntity: 0,
         PlayerEntity: 1,

package/dist/engine/types.d.ts

@@ -173,4 +173,8 @@ export declare type IEngine = {
      * @param transport - transport which changes its onmessage to process CRDT messages
      */
     addTransport(transport: Transport): void;
+    /**
+     * Iterator of registered components
+     */
+    componentsIter(): Iterable<ComponentDefinition<unknown>>;
 };

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

@@ -1,10 +1,15 @@
-import type { IEngine } from '../../engine';
+import type { ComponentDefinition, IEngine } from '../../engine';
 import { Entity } from '../../engine/entity';
+import WireMessage from '../../serialization/wireMessage';
 import { Transport } from './types';
-export declare function crdtSceneSystem(engine: Pick<IEngine, 'getComponentOrNull' | 'getComponent' | 'componentsDefinition'>): {
+/**
+ * @public
+ */
+export declare type OnChangeFunction = (entity: Entity, component: ComponentDefinition<any>, operation: WireMessage.Enum) => void;
+export declare function crdtSceneSystem(engine: Pick<IEngine, 'getComponentOrNull' | 'getComponent' | 'componentsIter'>, onProcessEntityComponentChange: OnChangeFunction | null): {
     getCrdt: () => import("@dcl/crdt").State<Uint8Array>;
-    sendMessages: (dirtyEntities: Map<Entity, Set<number>>) => Promise<void>;
+    sendMessages: (dirtyEntities: Map<ComponentDefinition<unknown>, Array<Entity>>) => Promise<void>;
     receiveMessages: () => Promise<void>;
     addTransport: (transport: Transport) => void;
-    updateState: () => Map<Entity, Set<number>>;
+    updateState: () => Map<ComponentDefinition<unknown>, Entity[]>;
 };

package/dist/systems/crdt/index.js

@@ -2,7 +2,7 @@ import { crdtProtocol } from '@dcl/crdt';
 import { createByteBuffer } from '../../serialization/ByteBuffer';
 import { ComponentOperation as Message } from '../../serialization/crdt/componentOperation';
 import WireMessage from '../../serialization/wireMessage';
-export function crdtSceneSystem(engine) {
+export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
     const transports = [];
     // CRDT Client
     const crdtClient = crdtProtocol();
@@ -106,34 +106,38 @@ export function crdtSceneSystem(engine) {
                     const data = createByteBuffer(opts);
                     component.upsertFromBinary(message.entity, data, false);
                 }
+                onProcessEntityComponentChange &&
+                    onProcessEntityComponentChange(entity, component, type);
             }
         }
     }
-    function getDirtyMap() {
-        const dirtySet = new Map();
-        for (const [componentId, definition] of engine.componentsDefinition) {
-            for (const entity of definition.dirtyIterator()) {
-                if (!dirtySet.has(entity)) {
-                    dirtySet.set(entity, new Set());
-                }
-                dirtySet.get(entity).add(componentId);
-            }
-        }
-        return dirtySet;
-    }
     /**
      * Updates CRDT state of the current engine dirty components
+     *
+     * TODO: optimize this function allocations using a bitmap
+     * TODO: unify this function with sendMessages
      */
     function updateState() {
-        const dirtyEntities = getDirtyMap();
-        for (const [entity, componentsId] of getDirtyMap()) {
-            for (const componentId of componentsId) {
-                const component = engine.getComponent(componentId);
+        const dirtyMap = new Map();
+        for (const component of engine.componentsIter()) {
+            let entitySet = null;
+            for (const entity of component.dirtyIterator()) {
+                if (!entitySet) {
+                    entitySet = [];
+                    dirtyMap.set(component, entitySet);
+                }
+                entitySet.push(entity);
+                // TODO: reuse shared writer to prevent extra allocations of toBinary
                 const componentValue = component.toBinaryOrNull(entity)?.toBinary() ?? null;
-                crdtClient.createEvent(entity, componentId, componentValue);
+                // TODO: do not emit event if componentValue equals the value didn't change
+                crdtClient.createEvent(entity, component._id, componentValue);
+                onProcessEntityComponentChange &&
+                    onProcessEntityComponentChange(entity, component, componentValue === null
+                        ? WireMessage.Enum.DELETE_COMPONENT
+                        : WireMessage.Enum.PUT_COMPONENT);
             }
         }
-        return dirtyEntities;
+        return dirtyMap;
     }
     /**
      * Iterates the dirty map and generates crdt messages to be send
@@ -143,19 +147,18 @@ export function crdtSceneSystem(engine) {
         const crdtMessages = getMessages(broadcastMessages);
         const outdatedMessagesBkp = getMessages(outdatedMessages);
         const buffer = createByteBuffer();
-        for (const [entity, componentsId] of dirtyEntities) {
-            for (const componentId of componentsId) {
+        for (const [component, entities] of dirtyEntities) {
+            for (const entity of entities) {
                 // Component will be always defined here since dirtyMap its an iterator of engine.componentsDefinition
-                const component = engine.getComponent(componentId);
                 const { timestamp } = crdtClient
                     .getState()
                     .get(entity)
-                    .get(componentId);
+                    .get(component._id);
                 const offset = buffer.currentWriteOffset();
                 const type = WireMessage.getType(component, entity);
                 const transportMessage = {
                     type,
-                    componentId,
+                    componentId: component._id,
                     entity,
                     timestamp
                 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/ecs",
-  "version": "7.0.6-3808988484.commit-63d3e2c",
+  "version": "7.0.6-3823801200.commit-32470bd",
   "description": "Decentraland ECS",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
@@ -27,7 +27,7 @@
     "ts-proto": "^1.112.0"
   },
   "dependencies": {
-    "@dcl/crdt": "7.0.6-3808988484.commit-63d3e2c",
+    "@dcl/crdt": "7.0.6-3823801200.commit-32470bd",
     "@dcl/js-runtime": "file:../js-runtime",
     "@dcl/protocol": "^1.0.0-3808528053.commit-d66d462"
   },
@@ -41,5 +41,5 @@
     "displayName": "ECS",
     "tsconfig": "./tsconfig.json"
   },
-  "commit": "63d3e2c15a5a2d09285eca1b08d3832a12f75f13"
+  "commit": "32470bdb44a9d3c8663f432e0d3262a09c4201cf"
 }