@dcl/ecs 7.20.1 → 7.20.2-22102228700.commit-61000fc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/dist/components/index.d.ts +5 -0
  2. package/dist/components/index.js +5 -2
  3. package/dist/components/manual/CreatedBy.d.ts +9 -0
  4. package/dist/components/manual/CreatedBy.js +8 -0
  5. package/dist/components/manual/Transform.d.ts +9 -0
  6. package/dist/components/manual/Transform.js +3 -3
  7. package/dist/components/types.d.ts +1 -0
  8. package/dist/engine/component.d.ts +52 -1
  9. package/dist/engine/grow-only-value-set-component-definition.js +45 -2
  10. package/dist/engine/lww-element-set-component-definition.d.ts +3 -1
  11. package/dist/engine/lww-element-set-component-definition.js +65 -12
  12. package/dist/index.d.ts +2 -1
  13. package/dist/index.js +1 -0
  14. package/dist/serialization/crdt/authoritativePutComponent.d.ts +15 -0
  15. package/dist/serialization/crdt/authoritativePutComponent.js +47 -0
  16. package/dist/serialization/crdt/index.d.ts +1 -0
  17. package/dist/serialization/crdt/index.js +1 -0
  18. package/dist/serialization/crdt/types.d.ts +25 -3
  19. package/dist/serialization/crdt/types.js +3 -1
  20. package/dist/systems/crdt/index.d.ts +0 -1
  21. package/dist/systems/crdt/index.js +55 -146
  22. package/dist-cjs/components/index.d.ts +5 -0
  23. package/dist-cjs/components/index.js +7 -3
  24. package/dist-cjs/components/manual/CreatedBy.d.ts +9 -0
  25. package/dist-cjs/components/manual/CreatedBy.js +10 -0
  26. package/dist-cjs/components/manual/Transform.d.ts +9 -0
  27. package/dist-cjs/components/manual/Transform.js +3 -3
  28. package/dist-cjs/components/types.d.ts +1 -0
  29. package/dist-cjs/engine/component.d.ts +52 -1
  30. package/dist-cjs/engine/grow-only-value-set-component-definition.js +44 -1
  31. package/dist-cjs/engine/lww-element-set-component-definition.d.ts +3 -1
  32. package/dist-cjs/engine/lww-element-set-component-definition.js +68 -13
  33. package/dist-cjs/index.d.ts +2 -1
  34. package/dist-cjs/index.js +2 -1
  35. package/dist-cjs/serialization/crdt/authoritativePutComponent.d.ts +15 -0
  36. package/dist-cjs/serialization/crdt/authoritativePutComponent.js +50 -0
  37. package/dist-cjs/serialization/crdt/index.d.ts +1 -0
  38. package/dist-cjs/serialization/crdt/index.js +1 -0
  39. package/dist-cjs/serialization/crdt/types.d.ts +25 -3
  40. package/dist-cjs/serialization/crdt/types.js +3 -1
  41. package/dist-cjs/systems/crdt/index.d.ts +0 -1
  42. package/dist-cjs/systems/crdt/index.js +55 -169
  43. package/package.json +2 -2
  44. package/dist/serialization/crdt/network/utils.d.ts +0 -9
  45. package/dist/serialization/crdt/network/utils.js +0 -60
  46. package/dist-cjs/serialization/crdt/network/utils.d.ts +0 -9
  47. package/dist-cjs/serialization/crdt/network/utils.js +0 -67
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.createComponentDefinitionFromSchema = exports.createGetCrdtMessagesForLww = exports.createUpdateLwwFromCrdt = exports.createDumpLwwFunctionFromCrdt = exports.incrementTimestamp = void 0;
3
+ exports.createComponentDefinitionFromSchema = exports.createGetCrdtMessagesForLww = exports.createUpdateLwwFromCrdt = exports.createForceUpdateLwwFromCrdt = exports.createCrdtRuleValidator = exports.createDumpLwwFunctionFromCrdt = exports.incrementTimestamp = void 0;
4
4
  const ByteBuffer_1 = require("../serialization/ByteBuffer");
5
5
  const crdt_1 = require("../serialization/crdt");
6
6
  const utils_1 = require("../systems/crdt/utils");
@@ -35,16 +35,12 @@ function createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, data) {
35
35
  };
36
36
  }
37
37
  exports.createDumpLwwFunctionFromCrdt = createDumpLwwFunctionFromCrdt;
38
- function createUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
38
+ const __GLOBAL_ENTITY = '__GLOBAL_ENTITY';
39
+ function createCrdtRuleValidator(timestamps, schema, data) {
39
40
  /**
40
- * Process the received message only if the lamport number recieved is higher
41
- * than the stored one. If its lower, we spread it to the network to correct the peer.
42
- * If they are equal, the bigger raw data wins.
43
-
44
- * Returns the recieved data if the lamport number was bigger than ours.
45
- * If it was an outdated message, then we return void
46
- * @public
47
- */
41
+ * Shared CRDT conflict resolution logic
42
+ * @public
43
+ */
48
44
  function crdtRuleForCurrentState(message) {
49
45
  const { entityId, timestamp } = message;
50
46
  const currentTimestamp = timestamps.get(entityId);
@@ -54,7 +50,6 @@ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
54
50
  }
55
51
  // Outdated Message. Resend our state message through the wire.
56
52
  if (currentTimestamp > timestamp) {
57
- // console.log('2', currentTimestamp, timestamp)
58
53
  return crdt_1.ProcessMessageResultType.StateOutdatedTimestamp;
59
54
  }
60
55
  // Deletes are idempotent
@@ -71,7 +66,6 @@ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
71
66
  currentDataGreater = (0, utils_1.dataCompare)(null, message.data);
72
67
  }
73
68
  // Same data, same timestamp. Weirdo echo message.
74
- // console.log('3', currentDataGreater, writeBuffer.toBinary(), (message as any).data || null)
75
69
  if (currentDataGreater === 0) {
76
70
  return crdt_1.ProcessMessageResultType.NoChanges;
77
71
  }
@@ -80,10 +74,38 @@ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
80
74
  return crdt_1.ProcessMessageResultType.StateOutdatedData;
81
75
  }
82
76
  else {
83
- // Curent data is lower
77
+ // Current data is lower
84
78
  return crdt_1.ProcessMessageResultType.StateUpdatedData;
85
79
  }
86
80
  }
81
+ return crdtRuleForCurrentState;
82
+ }
83
+ exports.createCrdtRuleValidator = createCrdtRuleValidator;
84
+ function createForceUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
85
+ /**
86
+ * Force update component state regardless of timestamp - used for server authoritative messages
87
+ */
88
+ return (msg) => {
89
+ console.log('[ BOEDO ] [ CASLA ] ', msg);
90
+ const buffer = new ByteBuffer_1.ReadWriteByteBuffer(msg.data);
91
+ const deserializedValue = schema.deserialize(buffer);
92
+ data.set(msg.entityId, deserializedValue);
93
+ timestamps.set(msg.entityId, msg.timestamp);
94
+ return [null, deserializedValue];
95
+ };
96
+ }
97
+ exports.createForceUpdateLwwFromCrdt = createForceUpdateLwwFromCrdt;
98
+ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
99
+ /**
100
+ * Process the received message only if the lamport number recieved is higher
101
+ * than the stored one. If its lower, we spread it to the network to correct the peer.
102
+ * If they are equal, the bigger raw data wins.
103
+
104
+ * Returns the recieved data if the lamport number was bigger than ours.
105
+ * If it was an outdated message, then we return void
106
+ * @public
107
+ */
108
+ const crdtRuleForCurrentState = createCrdtRuleValidator(timestamps, schema, data);
87
109
  return (msg) => {
88
110
  /* istanbul ignore next */
89
111
  if (msg.type !== crdt_1.CrdtMessageType.PUT_COMPONENT &&
@@ -178,6 +200,7 @@ function createComponentDefinitionFromSchema(componentName, componentId, schema)
178
200
  const dirtyIterator = new Set();
179
201
  const timestamps = new Map();
180
202
  const onChangeCallbacks = new Map();
203
+ const validateCallbacks = new Map();
181
204
  return {
182
205
  get componentId() {
183
206
  return componentId;
@@ -269,7 +292,39 @@ function createComponentDefinitionFromSchema(componentName, componentId, schema)
269
292
  },
270
293
  getCrdtUpdates: createGetCrdtMessagesForLww(componentId, timestamps, dirtyIterator, schema, data),
271
294
  updateFromCrdt: createUpdateLwwFromCrdt(componentId, timestamps, schema, data),
295
+ __forceUpdateFromCrdt: createForceUpdateLwwFromCrdt(componentId, timestamps, schema, data),
296
+ __dry_run_updateFromCrdt: createCrdtRuleValidator(timestamps, schema, data),
272
297
  dumpCrdtStateToBuffer: createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, data),
298
+ validateBeforeChange(entityOrCb, cb) {
299
+ if (arguments.length === 1) {
300
+ // Second overload: just callback (global validation)
301
+ validateCallbacks.set(__GLOBAL_ENTITY, entityOrCb);
302
+ }
303
+ else {
304
+ if (cb) {
305
+ validateCallbacks.set(entityOrCb, cb);
306
+ }
307
+ }
308
+ },
309
+ __run_validateBeforeChange(entity, newValue, senderAddress, createdBy) {
310
+ const cb = entity && validateCallbacks.get(entity);
311
+ const globalCb = validateCallbacks.get(__GLOBAL_ENTITY);
312
+ const currentValue = data.get(entity);
313
+ const value = { entity, currentValue, newValue, senderAddress, createdBy };
314
+ const globalResult = globalCb?.(value) ?? true;
315
+ const entityResult = (globalResult && cb?.(value)) ?? true;
316
+ return globalResult && entityResult;
317
+ },
318
+ getCrdtState(entity) {
319
+ const componentData = data.get(entity);
320
+ const timestamp = timestamps.get(entity);
321
+ if (componentData && timestamp !== undefined) {
322
+ const buffer = new ByteBuffer_1.ReadWriteByteBuffer();
323
+ schema.serialize((0, readonly_1.deepReadonly)(componentData), buffer);
324
+ return { data: buffer.toBinary(), timestamp };
325
+ }
326
+ return null;
327
+ },
273
328
  onChange(entity, cb) {
274
329
  const cbs = onChangeCallbacks.get(entity) ?? [];
275
330
  cbs.push(cb);
@@ -13,7 +13,7 @@ export * from './systems/tween';
13
13
  export * from './systems/triggerArea';
14
14
  export * from './engine/entity';
15
15
  export * from './components/types';
16
- import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended } from './components/types';
16
+ import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ICreatedBy } from './components/types';
17
17
  import { NameComponent } from './components/manual/Name';
18
18
  import { TagsComponentDefinitionExtended } from './components/manual/Tags';
19
19
  export declare const Transform: TransformComponentExtended;
@@ -46,6 +46,7 @@ export declare const NetworkEntity: INetowrkEntity;
46
46
  * Tag a entity to be syncronized through comms
47
47
  */
48
48
  export declare const NetworkParent: INetowrkParent;
49
+ export declare const CreatedBy: ICreatedBy;
49
50
  export * from './components/generated/global.gen';
50
51
  export * from './components/generated/types.gen';
51
52
  export * from './serialization/crdt';
package/dist-cjs/index.js CHANGED
@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
26
26
  return result;
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.TriggerArea = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.Tags = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.AudioStream = exports.AudioSource = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
29
+ exports.CreatedBy = exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.TriggerArea = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.Tags = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.AudioStream = exports.AudioSource = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
30
30
  // The order of the following imports matters. Please do not auto-sort
31
31
  __exportStar(require("./engine"), exports);
32
32
  __exportStar(require("./schemas"), exports);
@@ -79,6 +79,7 @@ exports.NetworkEntity = components.NetworkEntity(initialization_1.engine);
79
79
  * Tag a entity to be syncronized through comms
80
80
  */
81
81
  exports.NetworkParent = components.NetworkParent(initialization_1.engine);
82
+ exports.CreatedBy = components.CreatedBy(initialization_1.engine);
82
83
  // export components for global engine
83
84
  __exportStar(require("./components/generated/global.gen"), exports);
84
85
  __exportStar(require("./components/generated/types.gen"), exports);
@@ -0,0 +1,15 @@
1
+ import { Entity } from '../../engine/entity';
2
+ import { ByteBuffer } from '../ByteBuffer';
3
+ import { AuthoritativePutComponentMessage } from './types';
4
+ /**
5
+ * @public
6
+ */
7
+ export declare namespace AuthoritativePutComponentOperation {
8
+ const MESSAGE_HEADER_LENGTH = 16;
9
+ /**
10
+ * Call this function for an optimal writing data passing the ByteBuffer
11
+ * already allocated
12
+ */
13
+ function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
14
+ function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
15
+ }
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AuthoritativePutComponentOperation = void 0;
4
+ const crdtMessageProtocol_1 = require("./crdtMessageProtocol");
5
+ const types_1 = require("./types");
6
+ /**
7
+ * @public
8
+ */
9
+ var AuthoritativePutComponentOperation;
10
+ (function (AuthoritativePutComponentOperation) {
11
+ AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH = 16;
12
+ /**
13
+ * Call this function for an optimal writing data passing the ByteBuffer
14
+ * already allocated
15
+ */
16
+ function write(entity, timestamp, componentId, data, buf) {
17
+ // reserve the beginning
18
+ const startMessageOffset = buf.incrementWriteOffset(types_1.CRDT_MESSAGE_HEADER_LENGTH + AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH);
19
+ // write body
20
+ buf.writeBuffer(data, false);
21
+ const messageLength = buf.currentWriteOffset() - startMessageOffset;
22
+ // Write CrdtMessage header
23
+ buf.setUint32(startMessageOffset, messageLength);
24
+ buf.setUint32(startMessageOffset + 4, types_1.CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT);
25
+ // Write ComponentOperation header
26
+ buf.setUint32(startMessageOffset + 8, entity);
27
+ buf.setUint32(startMessageOffset + 12, componentId);
28
+ buf.setUint32(startMessageOffset + 16, timestamp);
29
+ const newLocal = messageLength - AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH - types_1.CRDT_MESSAGE_HEADER_LENGTH;
30
+ buf.setUint32(startMessageOffset + 20, newLocal);
31
+ }
32
+ AuthoritativePutComponentOperation.write = write;
33
+ function read(buf) {
34
+ const header = crdtMessageProtocol_1.CrdtMessageProtocol.readHeader(buf);
35
+ if (!header) {
36
+ return null;
37
+ }
38
+ if (header.type !== types_1.CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT) {
39
+ throw new Error('AuthoritativePutComponentOperation tried to read another message type.');
40
+ }
41
+ return {
42
+ ...header,
43
+ entityId: buf.readUint32(),
44
+ componentId: buf.readUint32(),
45
+ timestamp: buf.readUint32(),
46
+ data: buf.readBuffer()
47
+ };
48
+ }
49
+ AuthoritativePutComponentOperation.read = read;
50
+ })(AuthoritativePutComponentOperation = exports.AuthoritativePutComponentOperation || (exports.AuthoritativePutComponentOperation = {}));
@@ -7,3 +7,4 @@ export * from './network/deleteComponentNetwork';
7
7
  export * from './network/deleteEntityNetwork';
8
8
  export * from './types';
9
9
  export * from './crdtMessageProtocol';
10
+ export * from './authoritativePutComponent';
@@ -23,3 +23,4 @@ __exportStar(require("./network/deleteComponentNetwork"), exports);
23
23
  __exportStar(require("./network/deleteEntityNetwork"), exports);
24
24
  __exportStar(require("./types"), exports);
25
25
  __exportStar(require("./crdtMessageProtocol"), exports);
26
+ __exportStar(require("./authoritativePutComponent"), exports);
@@ -11,7 +11,8 @@ export declare enum CrdtMessageType {
11
11
  PUT_COMPONENT_NETWORK = 5,
12
12
  DELETE_COMPONENT_NETWORK = 6,
13
13
  DELETE_ENTITY_NETWORK = 7,
14
- MAX_MESSAGE_TYPE = 8
14
+ AUTHORITATIVE_PUT_COMPONENT = 8,
15
+ MAX_MESSAGE_TYPE = 9
15
16
  }
16
17
  /**
17
18
  * Min length = 8 bytes
@@ -48,6 +49,23 @@ export type PutNetworkComponentMessageBody = Omit<PutComponentMessageBody, 'type
48
49
  type: CrdtMessageType.PUT_COMPONENT_NETWORK;
49
50
  networkId: number;
50
51
  };
52
+ /**
53
+ * Server authoritative message - identical to PutComponentMessageBody but with forced processing
54
+ * Min. length = header (8 bytes) + 16 bytes = 24 bytes
55
+ *
56
+ * @param entity - Uint32 number of the entity
57
+ * @param componentId - Uint32 number of id
58
+ * @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
59
+ * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
60
+ * @public
61
+ */
62
+ export type AuthoritativePutComponentMessageBody = {
63
+ type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
64
+ entityId: Entity;
65
+ componentId: number;
66
+ timestamp: number;
67
+ data: Uint8Array;
68
+ };
51
69
  /**
52
70
  * Min. length = header (8 bytes) + 16 bytes = 24 bytes
53
71
  *
@@ -114,6 +132,10 @@ export type AppendValueMessage = CrdtMessageHeader & AppendValueMessageBody;
114
132
  * @public
115
133
  */
116
134
  export type PutComponentMessage = CrdtMessageHeader & PutComponentMessageBody;
135
+ /**
136
+ * @public
137
+ */
138
+ export type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
117
139
  /**
118
140
  * @public
119
141
  */
@@ -137,7 +159,7 @@ export type DeleteEntityNetworkMessage = CrdtMessageHeader & DeleteEntityNetwork
137
159
  /**
138
160
  * @public
139
161
  */
140
- export type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
162
+ export type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
141
163
  /**
142
164
  * @public
143
165
  */
@@ -145,7 +167,7 @@ export type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComp
145
167
  /**
146
168
  * @public
147
169
  */
148
- export type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
170
+ export type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
149
171
  export declare enum ProcessMessageResultType {
150
172
  /**
151
173
  * Typical message and new state set.
@@ -16,7 +16,9 @@ var CrdtMessageType;
16
16
  CrdtMessageType[CrdtMessageType["PUT_COMPONENT_NETWORK"] = 5] = "PUT_COMPONENT_NETWORK";
17
17
  CrdtMessageType[CrdtMessageType["DELETE_COMPONENT_NETWORK"] = 6] = "DELETE_COMPONENT_NETWORK";
18
18
  CrdtMessageType[CrdtMessageType["DELETE_ENTITY_NETWORK"] = 7] = "DELETE_ENTITY_NETWORK";
19
- CrdtMessageType[CrdtMessageType["MAX_MESSAGE_TYPE"] = 8] = "MAX_MESSAGE_TYPE";
19
+ // Server authoritative operation - forces component state regardless of timestamp
20
+ CrdtMessageType[CrdtMessageType["AUTHORITATIVE_PUT_COMPONENT"] = 8] = "AUTHORITATIVE_PUT_COMPONENT";
21
+ CrdtMessageType[CrdtMessageType["MAX_MESSAGE_TYPE"] = 9] = "MAX_MESSAGE_TYPE";
20
22
  })(CrdtMessageType = exports.CrdtMessageType || (exports.CrdtMessageType = {}));
21
23
  /**
22
24
  * @public
@@ -1,7 +1,6 @@
1
1
  import { Entity } from '../../engine/entity';
2
2
  import type { ComponentDefinition } from '../../engine';
3
3
  import { CrdtMessageType } from '../../serialization/crdt/types';
4
- export declare const LIVEKIT_MAX_SIZE = 12;
5
4
  /**
6
5
  * @public
7
6
  */
@@ -1,50 +1,20 @@
1
1
  "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
25
2
  Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.crdtSceneSystem = exports.LIVEKIT_MAX_SIZE = void 0;
3
+ exports.crdtSceneSystem = void 0;
27
4
  const entity_1 = require("../../engine/entity");
28
5
  const ByteBuffer_1 = require("../../serialization/ByteBuffer");
29
6
  const crdt_1 = require("../../serialization/crdt");
30
7
  const deleteComponent_1 = require("../../serialization/crdt/deleteComponent");
31
8
  const deleteEntity_1 = require("../../serialization/crdt/deleteEntity");
32
9
  const putComponent_1 = require("../../serialization/crdt/putComponent");
10
+ const authoritativePutComponent_1 = require("../../serialization/crdt/authoritativePutComponent");
33
11
  const types_1 = require("../../serialization/crdt/types");
34
- const putComponentNetwork_1 = require("../../serialization/crdt/network/putComponentNetwork");
35
- const components_1 = require("../../components");
36
- const networkUtils = __importStar(require("../../serialization/crdt/network/utils"));
37
- // NetworkMessages can only have a MAX_SIZE of 12kb. So we need to send it in chunks.
38
- exports.LIVEKIT_MAX_SIZE = 12;
39
12
  /**
40
13
  * @internal
41
14
  */
42
15
  function crdtSceneSystem(engine, onProcessEntityComponentChange) {
43
16
  const transports = [];
44
- // Components that we used on this system
45
- const NetworkEntity = (0, components_1.NetworkEntity)(engine);
46
- const NetworkParent = (0, components_1.NetworkParent)(engine);
47
- const Transform = (0, components_1.Transform)(engine);
17
+ // No network components needed - pure CRDT processing only
48
18
  // Messages that we received at transport.onMessage waiting to be processed
49
19
  const receivedMessages = [];
50
20
  // Messages already processed by the engine but that we need to broadcast to other transports.
@@ -69,27 +39,20 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
69
39
  if (header.type === types_1.CrdtMessageType.DELETE_COMPONENT) {
70
40
  message = deleteComponent_1.DeleteComponent.read(buffer);
71
41
  }
72
- else if (header.type === types_1.CrdtMessageType.DELETE_COMPONENT_NETWORK) {
73
- message = crdt_1.DeleteComponentNetwork.read(buffer);
74
- }
75
42
  else if (header.type === types_1.CrdtMessageType.PUT_COMPONENT) {
76
43
  message = putComponent_1.PutComponentOperation.read(buffer);
77
44
  }
78
- else if (header.type === types_1.CrdtMessageType.PUT_COMPONENT_NETWORK) {
79
- message = putComponentNetwork_1.PutNetworkComponentOperation.read(buffer);
45
+ else if (header.type === types_1.CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT) {
46
+ message = authoritativePutComponent_1.AuthoritativePutComponentOperation.read(buffer);
80
47
  }
81
48
  else if (header.type === types_1.CrdtMessageType.DELETE_ENTITY) {
82
49
  message = deleteEntity_1.DeleteEntity.read(buffer);
83
50
  }
84
- else if (header.type === types_1.CrdtMessageType.DELETE_ENTITY_NETWORK) {
85
- message = crdt_1.DeleteEntityNetwork.read(buffer);
86
- }
87
51
  else if (header.type === types_1.CrdtMessageType.APPEND_VALUE) {
88
52
  message = crdt_1.AppendValueOperation.read(buffer);
89
- // Unknown message, we skip it
90
53
  }
91
54
  else {
92
- // consume the message
55
+ // Unknown message, we skip it (including NETWORK messages)
93
56
  buffer.incrementReadOffset(header.length);
94
57
  }
95
58
  if (message) {
@@ -110,22 +73,6 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
110
73
  const messagesToProcess = value.splice(0, value.length);
111
74
  return messagesToProcess;
112
75
  }
113
- /**
114
- * Find the local entityId associated to the network component message.
115
- * It's a mapping Network -> to Local
116
- * If it's not a network message, return the entityId received by the message
117
- */
118
- function findNetworkId(msg) {
119
- const hasNetworkId = 'networkId' in msg;
120
- if (hasNetworkId) {
121
- for (const [entityId, network] of engine.getEntitiesWith(NetworkEntity)) {
122
- if (network.networkId === msg.networkId && network.entityId === msg.entityId) {
123
- return { entityId, network };
124
- }
125
- }
126
- }
127
- return { entityId: msg.entityId };
128
- }
129
76
  /**
130
77
  * This fn will be called on every tick.
131
78
  * Process all the messages queue received by the transport
@@ -134,46 +81,52 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
134
81
  const messagesToProcess = getMessages(receivedMessages);
135
82
  const entitiesShouldBeCleaned = [];
136
83
  for (const msg of messagesToProcess) {
137
- let { entityId, network } = findNetworkId(msg);
138
- // We receive a new Entity. Create the localEntity and map it to the NetworkEntity component
139
- if (networkUtils.isNetworkMessage(msg) && !network) {
140
- entityId = engine.addEntity();
141
- network = { entityId: msg.entityId, networkId: msg.networkId };
142
- NetworkEntity.createOrReplace(entityId, network);
143
- }
144
- if (msg.type === types_1.CrdtMessageType.DELETE_ENTITY || msg.type === types_1.CrdtMessageType.DELETE_ENTITY_NETWORK) {
145
- entitiesShouldBeCleaned.push(entityId);
84
+ // Simple CRDT processing - no network logic
85
+ if (msg.type === types_1.CrdtMessageType.DELETE_ENTITY) {
86
+ entitiesShouldBeCleaned.push(msg.entityId);
146
87
  broadcastMessages.push(msg);
147
88
  }
148
89
  else {
149
- const entityState = engine.entityContainer.getEntityState(entityId);
150
- // Skip updates from removed entityes
90
+ const entityState = engine.entityContainer.getEntityState(msg.entityId);
91
+ // Skip updates from removed entities
151
92
  if (entityState === entity_1.EntityState.Removed)
152
93
  continue;
153
- // Entities with unknown entities should update its entity state
94
+ // Entities with unknown state should update its entity state
154
95
  if (entityState === entity_1.EntityState.Unknown) {
155
- engine.entityContainer.updateUsedEntity(entityId);
156
- }
157
- const component = engine.getComponentOrNull(msg.componentId);
158
- /* istanbul ignore else */
159
- if (component) {
160
- if (msg.type === types_1.CrdtMessageType.PUT_COMPONENT &&
161
- component.componentId === Transform.componentId &&
162
- NetworkEntity.has(entityId) &&
163
- NetworkParent.has(entityId)) {
164
- msg.data = networkUtils.fixTransformParent(msg);
96
+ engine.entityContainer.updateUsedEntity(msg.entityId);
97
+ }
98
+ // Only process component-related messages (not DELETE_ENTITY)
99
+ if ('componentId' in msg) {
100
+ const component = engine.getComponentOrNull(msg.componentId);
101
+ if (component) {
102
+ // Handle authoritative messages differently - they force the state regardless of timestamp
103
+ const tryUpdate = () => {
104
+ try {
105
+ return msg.type === types_1.CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT
106
+ ? component.__forceUpdateFromCrdt(msg)
107
+ : component.updateFromCrdt(msg);
108
+ }
109
+ catch (e) {
110
+ console.error('[receiveMessages] ERROR processing message', msg, e);
111
+ return null;
112
+ }
113
+ };
114
+ const result = tryUpdate();
115
+ if (!result)
116
+ continue;
117
+ const [conflictMessage, value] = result;
118
+ if (!conflictMessage) {
119
+ // Add message to broadcast queue when no conflict
120
+ broadcastMessages.push(msg);
121
+ onProcessEntityComponentChange && onProcessEntityComponentChange(msg.entityId, msg.type, component, value);
122
+ }
165
123
  }
166
- const [conflictMessage, value] = component.updateFromCrdt({ ...msg, entityId });
167
- if (!conflictMessage) {
168
- // Add message to transport queue to be processed by others transports
124
+ else {
125
+ // Component not found - still broadcast for editor compatibility
126
+ /* istanbul ignore next */
169
127
  broadcastMessages.push(msg);
170
- onProcessEntityComponentChange && onProcessEntityComponentChange(entityId, msg.type, component, value);
171
128
  }
172
129
  }
173
- else {
174
- // TODO: test this line, it is fundammental to make the editor work
175
- broadcastMessages.push(msg);
176
- }
177
130
  }
178
131
  }
179
132
  // the last stage of the syncrhonization is to delete the entities
@@ -187,16 +140,17 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
187
140
  }
188
141
  }
189
142
  /**
190
- * Iterates the dirty map and generates crdt messages to be send
143
+ * Simple CRDT message broadcasting - no network-specific logic
191
144
  */
192
145
  async function sendMessages(entitiesDeletedThisTick) {
193
- // CRDT Messages will be the merge between the recieved transport messages and the new crdt messages
146
+ // Get messages from broadcast queue and component updates
194
147
  const crdtMessages = getMessages(broadcastMessages);
195
148
  const buffer = new ByteBuffer_1.ReadWriteByteBuffer();
149
+ // Generate CRDT messages from component updates
196
150
  for (const component of engine.componentsIter()) {
197
151
  for (const message of component.getCrdtUpdates()) {
198
152
  const offset = buffer.currentWriteOffset();
199
- // Avoid creating messages if there is no transport that will handle it
153
+ // Only create messages if there's a transport that will handle it
200
154
  if (transports.some((t) => t.filter(message))) {
201
155
  if (message.type === types_1.CrdtMessageType.PUT_COMPONENT) {
202
156
  putComponent_1.PutComponentOperation.write(message.entityId, message.timestamp, message.componentId, message.data, buffer);
@@ -220,7 +174,7 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
220
174
  }
221
175
  }
222
176
  }
223
- // After all updates, I execute the DeletedEntity messages
177
+ // Handle deleted entities
224
178
  for (const entityId of entitiesDeletedThisTick) {
225
179
  const offset = buffer.currentWriteOffset();
226
180
  deleteEntity_1.DeleteEntity.write(entityId, buffer);
@@ -231,87 +185,19 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
231
185
  });
232
186
  onProcessEntityComponentChange && onProcessEntityComponentChange(entityId, types_1.CrdtMessageType.DELETE_ENTITY);
233
187
  }
234
- // Send CRDT messages to transports
235
- const transportBuffer = new ByteBuffer_1.ReadWriteByteBuffer();
236
- for (const index in transports) {
237
- const __NetworkMessagesBuffer = [];
238
- const transportIndex = Number(index);
239
- const transport = transports[transportIndex];
240
- const isRendererTransport = transport.type === 'renderer';
241
- const isNetworkTransport = transport.type === 'network';
242
- // Reset Buffer for each Transport
243
- transportBuffer.resetBuffer();
244
- const buffer = new ByteBuffer_1.ReadWriteByteBuffer();
245
- // Then we send all the new crdtMessages that the transport needs to process
188
+ // Simple transport broadcasting - no network-specific transforms
189
+ for (const transport of transports) {
190
+ const transportBuffer = new ByteBuffer_1.ReadWriteByteBuffer();
246
191
  for (const message of crdtMessages) {
247
- // Check if adding this message would exceed the size limit
248
- const currentBufferSize = transportBuffer.toBinary().byteLength;
249
- const messageSize = message.messageBuffer.byteLength;
250
- if (isNetworkTransport && (currentBufferSize + messageSize) / 1024 > exports.LIVEKIT_MAX_SIZE) {
251
- // If the current buffer has content, save it as a chunk
252
- if (currentBufferSize > 0) {
253
- __NetworkMessagesBuffer.push(transportBuffer.toCopiedBinary());
254
- transportBuffer.resetBuffer();
255
- }
256
- // If the message itself is larger than the limit, we need to handle it specially
257
- // For now, we'll skip it to prevent infinite loops
258
- if (messageSize / 1024 > exports.LIVEKIT_MAX_SIZE) {
259
- console.error(`Message too large (${messageSize} bytes), skipping message for entity ${message.entityId}`);
260
- continue;
261
- }
262
- }
263
192
  // Avoid echo messages
264
- if (message.transportId === transportIndex)
265
- continue;
266
- // Redundant message for the transport
267
- if (!transport.filter(message))
268
- continue;
269
- const { entityId } = findNetworkId(message);
270
- const transformNeedsFix = 'componentId' in message &&
271
- message.componentId === Transform.componentId &&
272
- Transform.has(entityId) &&
273
- NetworkParent.has(entityId) &&
274
- NetworkEntity.has(entityId);
275
- // If there was a LOCAL change in the transform. Add the parent to that transform
276
- if (isRendererTransport && message.type === types_1.CrdtMessageType.PUT_COMPONENT && transformNeedsFix) {
277
- const parent = findNetworkId(NetworkParent.get(entityId));
278
- const transformData = networkUtils.fixTransformParent(message, Transform.get(entityId), parent.entityId);
279
- const offset = buffer.currentWriteOffset();
280
- putComponent_1.PutComponentOperation.write(entityId, message.timestamp, message.componentId, transformData, buffer);
281
- transportBuffer.writeBuffer(buffer.buffer().subarray(offset, buffer.currentWriteOffset()), false);
193
+ if (message.transportId === transports.indexOf(transport))
282
194
  continue;
195
+ // Check if transport wants this message
196
+ if (transport.filter(message)) {
197
+ transportBuffer.writeBuffer(message.messageBuffer, false);
283
198
  }
284
- if (isRendererTransport && networkUtils.isNetworkMessage(message)) {
285
- // If it's the renderer transport and its a NetworkMessage, we need to fix the entityId field and convert it to a known Message.
286
- // PUT_NETWORK_COMPONENT -> PUT_COMPONENT
287
- let transformData = 'data' in message ? message.data : new Uint8Array();
288
- if (transformNeedsFix) {
289
- const parent = findNetworkId(NetworkParent.get(entityId));
290
- transformData = networkUtils.fixTransformParent(message, Transform.get(entityId), parent.entityId);
291
- }
292
- networkUtils.networkMessageToLocal({ ...message, data: transformData }, entityId, buffer, transportBuffer);
293
- // Iterate the next message
294
- continue;
295
- }
296
- // If its a network transport and its a PUT_COMPONENT that has a NetworkEntity component, we need to send this message
297
- // through comms with the EntityID and NetworkID from ther NetworkEntity so everyone can recieve this message and map to their custom entityID.
298
- if (isNetworkTransport && !networkUtils.isNetworkMessage(message)) {
299
- const networkData = NetworkEntity.getOrNull(message.entityId);
300
- // If it has networkData convert the message to PUT_NETWORK_COMPONENT.
301
- if (networkData) {
302
- networkUtils.localMessageToNetwork(message, networkData, buffer, transportBuffer);
303
- // Iterate the next message
304
- continue;
305
- }
306
- }
307
- // Common message
308
- transportBuffer.writeBuffer(message.messageBuffer, false);
309
- }
310
- if (isNetworkTransport && transportBuffer.currentWriteOffset()) {
311
- __NetworkMessagesBuffer.push(transportBuffer.toBinary());
312
199
  }
313
- const message = isNetworkTransport ? __NetworkMessagesBuffer : transportBuffer.toBinary();
314
- await transport.send(message);
200
+ await transport.send(transportBuffer.toBinary());
315
201
  }
316
202
  }
317
203
  /**