expose players components (ADR-245) and set deprecation apis

packages/@dcl/ecs/src/engine/component.ts

@@ -169,6 +169,12 @@ export interface LastWriteWinElementSetComponentDefinition<T> extends BaseCompon
    * @param val - The initial value if it doesn't exist
    */
   getOrCreateMutable(entity: Entity, initialValue?: T): T
+
+  /**
+   * @internal
+   * @returns a set with entities changed
+   */
+  getEntitiesUpdatedFromCrdt(): Set<Entity>
 }
 /**
  * @public
@@ -190,7 +196,7 @@ export interface GrowOnlyValueSetComponentDefinition<T> extends BaseComponent<T>
    * @param val - The final value. The Set will freeze the value, it won't be editable from
    * the script.
    */
-  addValue(entity: Entity, val: DeepReadonly<T>): DeepReadonlySet<T>
+  addValue(entity: Entity, val: DeepReadonly<T>, ts: number): DeepReadonlySet<T>
 
   /**
    * Get the readonly component of the entity (to mutate it, use getMutable instead),
@@ -199,6 +205,12 @@ export interface GrowOnlyValueSetComponentDefinition<T> extends BaseComponent<T>
    * @returns
    */
   get(entity: Entity): DeepReadonlySet<T>
+
+  /**
+   * @internal
+   * @returns a map with entities as key and how many values was appended to the set as value
+   */
+  getEntitiesUpdatedFromCrdt(): Map<Entity, number>
 }
 
 /**

packages/@dcl/ecs/src/engine/grow-only-value-set-component-definition.ts

@@ -28,7 +28,7 @@
  */
 export type ValueSetOptions<T> = {
   // function that returns a timestamp from the value
-  timestampFunction: (value: DeepReadonly<T>) => number
+  timestampFunction?: (value: DeepReadonly<T>) => number
   // max elements to store in memory, ordered by timestamp
   maxElements: number
 }
@@ -48,6 +48,7 @@
   }
   const data = new Map<Entity, InternalDatastructure>()
   const dirtyIterator = new Set<Entity>()
+  const updatedFromCrdtIterator = new Map<Entity, number>()
   const queuedCommands: AppendValueMessageBody[] = []
 
   // only sort the array if the latest (N) element has a timestamp <= N-1
@@ -78,14 +79,14 @@
     }
   }
 
-  function append(entity: Entity, value: DeepReadonly<T>) {
+  function append(entity: Entity, value: DeepReadonly<T>, ts: number) {
     let row = data.get(entity)
     if (!row) {
       row = { raw: [], frozenSet: emptyReadonlySet as any }
       data.set(entity, row)
     }
     const usedValue = schema.extend ? (schema.extend(value) as DeepReadonly<T>) : value
-    const timestamp = options.timestampFunction(usedValue as any)
+    const timestamp = options.timestampFunction ? options.timestampFunction(usedValue as any) : ts
     if (__DEV__) {
       // only freeze the objects in dev mode to warn the developers because
       // it is an expensive operation
@@ -121,8 +122,8 @@
         return emptyReadonlySet as any
       }
     },
-    addValue(entity: Entity, rawValue: DeepReadonly<T>) {
-      const { set, value } = append(entity, rawValue)
+    addValue(entity: Entity, rawValue: DeepReadonly<T>, ts: number) {
+      const { set, value } = append(entity, rawValue, ts)
       dirtyIterator.add(entity)
       const buf = new ReadWriteByteBuffer()
       schema.serialize(value, buf)
@@ -148,12 +149,15 @@
     getCrdtUpdates() {
       // return a copy of the commands, and then clear the local copy
       dirtyIterator.clear()
+      updatedFromCrdtIterator.clear()
       return queuedCommands.splice(0, queuedCommands.length)
     },
     updateFromCrdt(_body) {
       if (_body.type === CrdtMessageType.APPEND_VALUE) {
         const buf = new ReadWriteByteBuffer(_body.data)
-        append(_body.entityId, schema.deserialize(buf) as DeepReadonly<T>)
+        append(_body.entityId, schema.deserialize(buf) as DeepReadonly<T>, _body.timestamp)
+
+        updatedFromCrdtIterator.set(_body.entityId, (updatedFromCrdtIterator.get(_body.entityId) || 0) + 1)
       }
       return [null, undefined]
     },
@@ -166,6 +170,9 @@
           AppendValueOperation.write(entity, 0, componentId, buf.toBinary(), buffer)
         }
       }
+    },
+    getEntitiesUpdatedFromCrdt(): Map<Entity, number> {
+      return updatedFromCrdtIterator
     }
   }
 

packages/@dcl/ecs/src/engine/lww-element-set-component-definition.ts

@@ -51,7 +51,8 @@
   componentId: number,
   timestamps: Map<Entity, number>,
   schema: Pick<ISchema<any>, 'serialize' | 'deserialize'>,
-  data: Map<Entity, unknown>
+  data: Map<Entity, unknown>,
+  updatedFromCrdtIterator: Set<Entity>
 ) {
   /**
    * Process the received message only if the lamport number recieved is higher
@@ -126,6 +127,7 @@
         } else {
           data.delete(entity)
         }
+        updatedFromCrdtIterator.add(entity)
 
         return [null, data.get(entity)]
       }
@@ -168,7 +170,8 @@
   timestamps: Map<Entity, number>,
   dirtyIterator: Set<Entity>,
   schema: Pick<ISchema<any>, 'serialize'>,
-  data: Map<Entity, unknown>
+  data: Map<Entity, unknown>,
+  updatedFromCrdtIterator: Set<Entity>
 ) {
   return function* () {
     for (const entity of dirtyIterator) {
@@ -198,6 +201,7 @@
       }
     }
     dirtyIterator.clear()
+    updatedFromCrdtIterator.clear()
   }
 }
 
@@ -211,6 +215,7 @@
 ): LastWriteWinElementSetComponentDefinition<T> {
   const data = new Map<Entity, T>()
   const dirtyIterator = new Set<Entity>()
+  const updatedFromCrdtIterator = new Set<Entity>()
   const timestamps = new Map<Entity, number>()
 
   return {
@@ -303,8 +308,18 @@
         yield entity
       }
     },
-    getCrdtUpdates: createGetCrdtMessagesForLww(componentId, timestamps, dirtyIterator, schema, data),
-    updateFromCrdt: createUpdateLwwFromCrdt(componentId, timestamps, schema, data),
+    getEntitiesUpdatedFromCrdt(): Set<Entity> {
+      return updatedFromCrdtIterator
+    },
+    getCrdtUpdates: createGetCrdtMessagesForLww(
+      componentId,
+      timestamps,
+      dirtyIterator,
+      schema,
+      data,
+      updatedFromCrdtIterator
+    ),
+    updateFromCrdt: createUpdateLwwFromCrdt(componentId, timestamps, schema, data, updatedFromCrdtIterator),
     dumpCrdtStateToBuffer: createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, data)
   }
 }