@dcl/ecs 7.31.1-40962203448.commit-c68a75f → 7.31.1-41472004640.commit-3147448
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.
- package/dist/components/generated/component-names.gen.js +0 -3
- package/dist/components/generated/global.gen.d.ts +0 -6
- package/dist/components/generated/global.gen.js +0 -3
- package/dist/components/generated/index.gen.d.ts +0 -12
- package/dist/components/generated/index.gen.js +0 -15
- package/dist/components/generated/types.gen.d.ts +0 -1
- package/dist/components/generated/types.gen.js +0 -2
- package/dist/components/index.d.ts +5 -0
- package/dist/components/index.js +5 -2
- package/dist/components/manual/CreatedBy.d.ts +9 -0
- package/dist/components/manual/CreatedBy.js +8 -0
- package/dist/components/manual/Transform.d.ts +9 -0
- package/dist/components/manual/Transform.js +3 -3
- package/dist/components/types.d.ts +1 -0
- package/dist/engine/component.d.ts +52 -1
- package/dist/engine/grow-only-value-set-component-definition.js +45 -2
- package/dist/engine/lww-element-set-component-definition.d.ts +3 -1
- package/dist/engine/lww-element-set-component-definition.js +68 -13
- package/dist/index.d.ts +2 -1
- package/dist/index.js +1 -0
- package/dist/serialization/crdt/authoritativePutComponent.d.ts +15 -0
- package/dist/serialization/crdt/authoritativePutComponent.js +47 -0
- package/dist/serialization/crdt/index.d.ts +1 -0
- package/dist/serialization/crdt/index.js +1 -0
- package/dist/serialization/crdt/types.d.ts +25 -3
- package/dist/serialization/crdt/types.js +3 -1
- package/dist/systems/crdt/index.d.ts +0 -1
- package/dist/systems/crdt/index.js +76 -143
- package/dist/systems/crdt/types.d.ts +10 -0
- package/dist-cjs/components/generated/component-names.gen.js +0 -3
- package/dist-cjs/components/generated/global.gen.d.ts +0 -6
- package/dist-cjs/components/generated/global.gen.js +2 -5
- package/dist-cjs/components/generated/index.gen.d.ts +0 -12
- package/dist-cjs/components/generated/index.gen.js +2 -20
- package/dist-cjs/components/generated/types.gen.d.ts +0 -1
- package/dist-cjs/components/generated/types.gen.js +0 -2
- package/dist-cjs/components/index.d.ts +5 -0
- package/dist-cjs/components/index.js +7 -3
- package/dist-cjs/components/manual/CreatedBy.d.ts +9 -0
- package/dist-cjs/components/manual/CreatedBy.js +10 -0
- package/dist-cjs/components/manual/Transform.d.ts +9 -0
- package/dist-cjs/components/manual/Transform.js +3 -3
- package/dist-cjs/components/types.d.ts +1 -0
- package/dist-cjs/engine/component.d.ts +52 -1
- package/dist-cjs/engine/grow-only-value-set-component-definition.js +44 -1
- package/dist-cjs/engine/lww-element-set-component-definition.d.ts +3 -1
- package/dist-cjs/engine/lww-element-set-component-definition.js +71 -14
- package/dist-cjs/index.d.ts +2 -1
- package/dist-cjs/index.js +2 -1
- package/dist-cjs/serialization/crdt/authoritativePutComponent.d.ts +15 -0
- package/dist-cjs/serialization/crdt/authoritativePutComponent.js +50 -0
- package/dist-cjs/serialization/crdt/index.d.ts +1 -0
- package/dist-cjs/serialization/crdt/index.js +1 -0
- package/dist-cjs/serialization/crdt/types.d.ts +25 -3
- package/dist-cjs/serialization/crdt/types.js +3 -1
- package/dist-cjs/systems/crdt/index.d.ts +0 -1
- package/dist-cjs/systems/crdt/index.js +76 -166
- package/dist-cjs/systems/crdt/types.d.ts +10 -0
- package/package.json +2 -2
- package/dist/components/generated/EnvironmentFog.gen.d.ts +0 -1
- package/dist/components/generated/EnvironmentFog.gen.js +0 -25
- package/dist/components/generated/Skybox.gen.d.ts +0 -1
- package/dist/components/generated/Skybox.gen.js +0 -25
- package/dist/components/generated/Sun.gen.d.ts +0 -1
- package/dist/components/generated/Sun.gen.js +0 -25
- package/dist/components/generated/pb/decentraland/common/gradient.gen.d.ts +0 -36
- package/dist/components/generated/pb/decentraland/common/gradient.gen.js +0 -89
- package/dist/components/generated/pb/decentraland/sdk/components/environment_fog.gen.d.ts +0 -28
- package/dist/components/generated/pb/decentraland/sdk/components/environment_fog.gen.js +0 -51
- package/dist/components/generated/pb/decentraland/sdk/components/skybox.gen.d.ts +0 -93
- package/dist/components/generated/pb/decentraland/sdk/components/skybox.gen.js +0 -228
- package/dist/components/generated/pb/decentraland/sdk/components/sun.gen.d.ts +0 -37
- package/dist/components/generated/pb/decentraland/sdk/components/sun.gen.js +0 -70
- package/dist/serialization/crdt/network/utils.d.ts +0 -9
- package/dist/serialization/crdt/network/utils.js +0 -60
- package/dist-cjs/components/generated/EnvironmentFog.gen.d.ts +0 -1
- package/dist-cjs/components/generated/EnvironmentFog.gen.js +0 -28
- package/dist-cjs/components/generated/Skybox.gen.d.ts +0 -1
- package/dist-cjs/components/generated/Skybox.gen.js +0 -28
- package/dist-cjs/components/generated/Sun.gen.d.ts +0 -1
- package/dist-cjs/components/generated/Sun.gen.js +0 -28
- package/dist-cjs/components/generated/pb/decentraland/common/gradient.gen.d.ts +0 -36
- package/dist-cjs/components/generated/pb/decentraland/common/gradient.gen.js +0 -95
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/environment_fog.gen.d.ts +0 -28
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/environment_fog.gen.js +0 -57
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/skybox.gen.d.ts +0 -93
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/skybox.gen.js +0 -234
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/sun.gen.d.ts +0 -37
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/sun.gen.js +0 -76
- package/dist-cjs/serialization/crdt/network/utils.d.ts +0 -9
- package/dist-cjs/serialization/crdt/network/utils.js +0 -67
|
@@ -30,16 +30,12 @@ export function createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, d
|
|
|
30
30
|
}
|
|
31
31
|
};
|
|
32
32
|
}
|
|
33
|
-
|
|
33
|
+
const __GLOBAL_ENTITY = '__GLOBAL_ENTITY';
|
|
34
|
+
export function createCrdtRuleValidator(timestamps, schema, data, lastSentData) {
|
|
34
35
|
/**
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
* Returns the recieved data if the lamport number was bigger than ours.
|
|
40
|
-
* If it was an outdated message, then we return void
|
|
41
|
-
* @public
|
|
42
|
-
*/
|
|
36
|
+
* Shared CRDT conflict resolution logic
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
43
39
|
function crdtRuleForCurrentState(message) {
|
|
44
40
|
const { entityId, timestamp } = message;
|
|
45
41
|
const currentTimestamp = timestamps.get(entityId);
|
|
@@ -49,7 +45,6 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
|
|
|
49
45
|
}
|
|
50
46
|
// Outdated Message. Resend our state message through the wire.
|
|
51
47
|
if (currentTimestamp > timestamp) {
|
|
52
|
-
// console.log('2', currentTimestamp, timestamp)
|
|
53
48
|
return ProcessMessageResultType.StateOutdatedTimestamp;
|
|
54
49
|
}
|
|
55
50
|
// Deletes are idempotent
|
|
@@ -66,7 +61,6 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
|
|
|
66
61
|
currentDataGreater = dataCompare(null, message.data);
|
|
67
62
|
}
|
|
68
63
|
// Same data, same timestamp. Weirdo echo message.
|
|
69
|
-
// console.log('3', currentDataGreater, writeBuffer.toBinary(), (message as any).data || null)
|
|
70
64
|
if (currentDataGreater === 0) {
|
|
71
65
|
return ProcessMessageResultType.NoChanges;
|
|
72
66
|
}
|
|
@@ -75,10 +69,35 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
|
|
|
75
69
|
return ProcessMessageResultType.StateOutdatedData;
|
|
76
70
|
}
|
|
77
71
|
else {
|
|
78
|
-
//
|
|
72
|
+
// Current data is lower
|
|
79
73
|
return ProcessMessageResultType.StateUpdatedData;
|
|
80
74
|
}
|
|
81
75
|
}
|
|
76
|
+
return crdtRuleForCurrentState;
|
|
77
|
+
}
|
|
78
|
+
export function createForceUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
|
|
79
|
+
/**
|
|
80
|
+
* Force update component state regardless of timestamp - used for server authoritative messages
|
|
81
|
+
*/
|
|
82
|
+
return (msg) => {
|
|
83
|
+
const buffer = new ReadWriteByteBuffer(msg.data);
|
|
84
|
+
const deserializedValue = schema.deserialize(buffer);
|
|
85
|
+
data.set(msg.entityId, deserializedValue);
|
|
86
|
+
timestamps.set(msg.entityId, msg.timestamp);
|
|
87
|
+
return [null, deserializedValue];
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData) {
|
|
91
|
+
/**
|
|
92
|
+
* Process the received message only if the lamport number recieved is higher
|
|
93
|
+
* than the stored one. If its lower, we spread it to the network to correct the peer.
|
|
94
|
+
* If they are equal, the bigger raw data wins.
|
|
95
|
+
|
|
96
|
+
* Returns the recieved data if the lamport number was bigger than ours.
|
|
97
|
+
* If it was an outdated message, then we return void
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
const crdtRuleForCurrentState = createCrdtRuleValidator(timestamps, schema, data, lastSentData);
|
|
82
101
|
return (msg) => {
|
|
83
102
|
/* istanbul ignore next */
|
|
84
103
|
if (msg.type !== CrdtMessageType.PUT_COMPONENT &&
|
|
@@ -96,7 +115,10 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
|
|
|
96
115
|
if (msg.type === CrdtMessageType.PUT_COMPONENT || msg.type === CrdtMessageType.PUT_COMPONENT_NETWORK) {
|
|
97
116
|
const buf = new ReadWriteByteBuffer(msg.data);
|
|
98
117
|
data.set(entity, schema.deserialize(buf));
|
|
99
|
-
lastSentData
|
|
118
|
+
// do NOT seed lastSentData from an INCOMING message!!!!
|
|
119
|
+
// seeding it from received bytes makes the engine
|
|
120
|
+
// believe it already sent this state, which kills valid re-broadcasting 🧨
|
|
121
|
+
lastSentData.delete(entity);
|
|
100
122
|
}
|
|
101
123
|
else {
|
|
102
124
|
data.delete(entity);
|
|
@@ -185,6 +207,7 @@ export function createComponentDefinitionFromSchema(componentName, componentId,
|
|
|
185
207
|
const timestamps = new Map();
|
|
186
208
|
const lastSentData = new Map();
|
|
187
209
|
const onChangeCallbacks = new Map();
|
|
210
|
+
const validateCallbacks = new Map();
|
|
188
211
|
return {
|
|
189
212
|
get componentId() {
|
|
190
213
|
return componentId;
|
|
@@ -285,7 +308,39 @@ export function createComponentDefinitionFromSchema(componentName, componentId,
|
|
|
285
308
|
},
|
|
286
309
|
getCrdtUpdates: createGetCrdtMessagesForLww(componentId, timestamps, dirtyIterator, schema, data, lastSentData),
|
|
287
310
|
updateFromCrdt: createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData),
|
|
311
|
+
__forceUpdateFromCrdt: createForceUpdateLwwFromCrdt(componentId, timestamps, schema, data),
|
|
312
|
+
__dry_run_updateFromCrdt: createCrdtRuleValidator(timestamps, schema, data, lastSentData),
|
|
288
313
|
dumpCrdtStateToBuffer: createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, data),
|
|
314
|
+
validateBeforeChange(entityOrCb, cb) {
|
|
315
|
+
if (arguments.length === 1) {
|
|
316
|
+
// Second overload: just callback (global validation)
|
|
317
|
+
validateCallbacks.set(__GLOBAL_ENTITY, entityOrCb);
|
|
318
|
+
}
|
|
319
|
+
else {
|
|
320
|
+
if (cb) {
|
|
321
|
+
validateCallbacks.set(entityOrCb, cb);
|
|
322
|
+
}
|
|
323
|
+
}
|
|
324
|
+
},
|
|
325
|
+
__run_validateBeforeChange(entity, newValue, senderAddress, createdBy) {
|
|
326
|
+
const cb = entity && validateCallbacks.get(entity);
|
|
327
|
+
const globalCb = validateCallbacks.get(__GLOBAL_ENTITY);
|
|
328
|
+
const currentValue = data.get(entity);
|
|
329
|
+
const value = { entity, currentValue, newValue, senderAddress, createdBy };
|
|
330
|
+
const globalResult = globalCb?.(value) ?? true;
|
|
331
|
+
const entityResult = (globalResult && cb?.(value)) ?? true;
|
|
332
|
+
return globalResult && entityResult;
|
|
333
|
+
},
|
|
334
|
+
getCrdtState(entity) {
|
|
335
|
+
const componentData = data.get(entity);
|
|
336
|
+
const timestamp = timestamps.get(entity);
|
|
337
|
+
if (componentData && timestamp !== undefined) {
|
|
338
|
+
const buffer = new ReadWriteByteBuffer();
|
|
339
|
+
schema.serialize(deepReadonly(componentData), buffer);
|
|
340
|
+
return { data: buffer.toBinary(), timestamp };
|
|
341
|
+
}
|
|
342
|
+
return null;
|
|
343
|
+
},
|
|
289
344
|
onChange(entity, cb) {
|
|
290
345
|
const cbs = onChangeCallbacks.get(entity) ?? [];
|
|
291
346
|
cbs.push(cb);
|
package/dist/index.d.ts
CHANGED
|
@@ -16,7 +16,7 @@ export * from './systems/triggerArea';
|
|
|
16
16
|
export * from './systems/physics';
|
|
17
17
|
export * from './engine/entity';
|
|
18
18
|
export * from './components/types';
|
|
19
|
-
import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended, TouchScreenControlsComponentDefinitionExtended } from './components/types';
|
|
19
|
+
import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended, ICreatedBy, TouchScreenControlsComponentDefinitionExtended } from './components/types';
|
|
20
20
|
import { NameComponent } from './components/manual/Name';
|
|
21
21
|
import { TagsComponentDefinitionExtended } from './components/manual/Tags';
|
|
22
22
|
export declare const Transform: TransformComponentExtended;
|
|
@@ -52,6 +52,7 @@ export declare const NetworkEntity: INetowrkEntity;
|
|
|
52
52
|
* Tag a entity to be syncronized through comms
|
|
53
53
|
*/
|
|
54
54
|
export declare const NetworkParent: INetowrkParent;
|
|
55
|
+
export declare const CreatedBy: ICreatedBy;
|
|
55
56
|
export * from './components/generated/global.gen';
|
|
56
57
|
export * from './components/generated/types.gen';
|
|
57
58
|
export * from './serialization/crdt';
|
package/dist/index.js
CHANGED
|
@@ -58,6 +58,7 @@ export const NetworkEntity = /* @__PURE__*/ components.NetworkEntity(engine);
|
|
|
58
58
|
* Tag a entity to be syncronized through comms
|
|
59
59
|
*/
|
|
60
60
|
export const NetworkParent = /* @__PURE__*/ components.NetworkParent(engine);
|
|
61
|
+
export const CreatedBy = /* @__PURE__*/ components.CreatedBy(engine);
|
|
61
62
|
// export components for global engine
|
|
62
63
|
export * from './components/generated/global.gen';
|
|
63
64
|
export * from './components/generated/types.gen';
|
|
@@ -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,47 @@
|
|
|
1
|
+
import { CrdtMessageProtocol } from './crdtMessageProtocol';
|
|
2
|
+
import { CrdtMessageType, CRDT_MESSAGE_HEADER_LENGTH } from './types';
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export var AuthoritativePutComponentOperation;
|
|
7
|
+
(function (AuthoritativePutComponentOperation) {
|
|
8
|
+
AuthoritativePutComponentOperation.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, timestamp, componentId, data, buf) {
|
|
14
|
+
// reserve the beginning
|
|
15
|
+
const startMessageOffset = buf.incrementWriteOffset(CRDT_MESSAGE_HEADER_LENGTH + AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH);
|
|
16
|
+
// write body
|
|
17
|
+
buf.writeBuffer(data, false);
|
|
18
|
+
const messageLength = buf.currentWriteOffset() - startMessageOffset;
|
|
19
|
+
// Write CrdtMessage header
|
|
20
|
+
buf.setUint32(startMessageOffset, messageLength);
|
|
21
|
+
buf.setUint32(startMessageOffset + 4, CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT);
|
|
22
|
+
// Write ComponentOperation header
|
|
23
|
+
buf.setUint32(startMessageOffset + 8, entity);
|
|
24
|
+
buf.setUint32(startMessageOffset + 12, componentId);
|
|
25
|
+
buf.setUint32(startMessageOffset + 16, timestamp);
|
|
26
|
+
const newLocal = messageLength - AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH - CRDT_MESSAGE_HEADER_LENGTH;
|
|
27
|
+
buf.setUint32(startMessageOffset + 20, newLocal);
|
|
28
|
+
}
|
|
29
|
+
AuthoritativePutComponentOperation.write = write;
|
|
30
|
+
function read(buf) {
|
|
31
|
+
const header = CrdtMessageProtocol.readHeader(buf);
|
|
32
|
+
if (!header) {
|
|
33
|
+
return null;
|
|
34
|
+
}
|
|
35
|
+
if (header.type !== CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT) {
|
|
36
|
+
throw new Error('AuthoritativePutComponentOperation tried to read another message type.');
|
|
37
|
+
}
|
|
38
|
+
return {
|
|
39
|
+
...header,
|
|
40
|
+
entityId: buf.readUint32(),
|
|
41
|
+
componentId: buf.readUint32(),
|
|
42
|
+
timestamp: buf.readUint32(),
|
|
43
|
+
data: buf.readBuffer()
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
AuthoritativePutComponentOperation.read = read;
|
|
47
|
+
})(AuthoritativePutComponentOperation || (AuthoritativePutComponentOperation = {}));
|
|
@@ -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
|
-
|
|
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.
|
|
@@ -13,7 +13,9 @@ export var CrdtMessageType;
|
|
|
13
13
|
CrdtMessageType[CrdtMessageType["PUT_COMPONENT_NETWORK"] = 5] = "PUT_COMPONENT_NETWORK";
|
|
14
14
|
CrdtMessageType[CrdtMessageType["DELETE_COMPONENT_NETWORK"] = 6] = "DELETE_COMPONENT_NETWORK";
|
|
15
15
|
CrdtMessageType[CrdtMessageType["DELETE_ENTITY_NETWORK"] = 7] = "DELETE_ENTITY_NETWORK";
|
|
16
|
-
|
|
16
|
+
// Server authoritative operation - forces component state regardless of timestamp
|
|
17
|
+
CrdtMessageType[CrdtMessageType["AUTHORITATIVE_PUT_COMPONENT"] = 8] = "AUTHORITATIVE_PUT_COMPONENT";
|
|
18
|
+
CrdtMessageType[CrdtMessageType["MAX_MESSAGE_TYPE"] = 9] = "MAX_MESSAGE_TYPE";
|
|
17
19
|
})(CrdtMessageType || (CrdtMessageType = {}));
|
|
18
20
|
/**
|
|
19
21
|
* @public
|
|
@@ -1,24 +1,17 @@
|
|
|
1
1
|
import { EntityState } from '../../engine/entity';
|
|
2
2
|
import { ReadWriteByteBuffer } from '../../serialization/ByteBuffer';
|
|
3
|
-
import { AppendValueOperation, CrdtMessageProtocol
|
|
3
|
+
import { AppendValueOperation, CrdtMessageProtocol } from '../../serialization/crdt';
|
|
4
4
|
import { DeleteComponent } from '../../serialization/crdt/deleteComponent';
|
|
5
5
|
import { DeleteEntity } from '../../serialization/crdt/deleteEntity';
|
|
6
6
|
import { PutComponentOperation } from '../../serialization/crdt/putComponent';
|
|
7
|
+
import { AuthoritativePutComponentOperation } from '../../serialization/crdt/authoritativePutComponent';
|
|
7
8
|
import { CrdtMessageType } from '../../serialization/crdt/types';
|
|
8
|
-
import { PutNetworkComponentOperation } from '../../serialization/crdt/network/putComponentNetwork';
|
|
9
|
-
import { NetworkEntity as defineNetworkEntity, NetworkParent as defineNetworkParent, Transform as defineTransform } from '../../components';
|
|
10
|
-
import * as networkUtils from '../../serialization/crdt/network/utils';
|
|
11
|
-
// NetworkMessages can only have a MAX_SIZE of 12kb. So we need to send it in chunks.
|
|
12
|
-
export const LIVEKIT_MAX_SIZE = 12;
|
|
13
9
|
/**
|
|
14
10
|
* @internal
|
|
15
11
|
*/
|
|
16
12
|
export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
17
13
|
const transports = [];
|
|
18
|
-
//
|
|
19
|
-
const NetworkEntity = defineNetworkEntity(engine);
|
|
20
|
-
const NetworkParent = defineNetworkParent(engine);
|
|
21
|
-
const Transform = defineTransform(engine);
|
|
14
|
+
// No network components needed - pure CRDT processing only
|
|
22
15
|
// Messages that we received at transport.onMessage waiting to be processed
|
|
23
16
|
const receivedMessages = [];
|
|
24
17
|
// Messages already processed by the engine but that we need to broadcast to other transports.
|
|
@@ -43,27 +36,20 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
43
36
|
if (header.type === CrdtMessageType.DELETE_COMPONENT) {
|
|
44
37
|
message = DeleteComponent.read(buffer);
|
|
45
38
|
}
|
|
46
|
-
else if (header.type === CrdtMessageType.DELETE_COMPONENT_NETWORK) {
|
|
47
|
-
message = DeleteComponentNetwork.read(buffer);
|
|
48
|
-
}
|
|
49
39
|
else if (header.type === CrdtMessageType.PUT_COMPONENT) {
|
|
50
40
|
message = PutComponentOperation.read(buffer);
|
|
51
41
|
}
|
|
52
|
-
else if (header.type === CrdtMessageType.
|
|
53
|
-
message =
|
|
42
|
+
else if (header.type === CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT) {
|
|
43
|
+
message = AuthoritativePutComponentOperation.read(buffer);
|
|
54
44
|
}
|
|
55
45
|
else if (header.type === CrdtMessageType.DELETE_ENTITY) {
|
|
56
46
|
message = DeleteEntity.read(buffer);
|
|
57
47
|
}
|
|
58
|
-
else if (header.type === CrdtMessageType.DELETE_ENTITY_NETWORK) {
|
|
59
|
-
message = DeleteEntityNetwork.read(buffer);
|
|
60
|
-
}
|
|
61
48
|
else if (header.type === CrdtMessageType.APPEND_VALUE) {
|
|
62
49
|
message = AppendValueOperation.read(buffer);
|
|
63
|
-
// Unknown message, we skip it
|
|
64
50
|
}
|
|
65
51
|
else {
|
|
66
|
-
//
|
|
52
|
+
// Unknown message, we skip it (including NETWORK messages)
|
|
67
53
|
buffer.incrementReadOffset(header.length);
|
|
68
54
|
}
|
|
69
55
|
if (message) {
|
|
@@ -85,20 +71,12 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
85
71
|
return messagesToProcess;
|
|
86
72
|
}
|
|
87
73
|
/**
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
74
|
+
* Reserved-range entities (root/player/camera + avatars, entity number <
|
|
75
|
+
* RESERVED_STATIC_ENTITIES) are host-owned: only a transport flagged with
|
|
76
|
+
* `allowReservedEntities` (the host/renderer) may mutate or delete them.
|
|
91
77
|
*/
|
|
92
|
-
function
|
|
93
|
-
|
|
94
|
-
if (hasNetworkId) {
|
|
95
|
-
for (const [entityId, network] of engine.getEntitiesWith(NetworkEntity)) {
|
|
96
|
-
if (network.networkId === msg.networkId && network.entityId === msg.entityId) {
|
|
97
|
-
return { entityId, network };
|
|
98
|
-
}
|
|
99
|
-
}
|
|
100
|
-
}
|
|
101
|
-
return { entityId: msg.entityId };
|
|
78
|
+
function isTrustedForReservedEntities(transportId) {
|
|
79
|
+
return transportId !== undefined && !!transports[transportId]?.allowReservedEntities;
|
|
102
80
|
}
|
|
103
81
|
/**
|
|
104
82
|
* This fn will be called on every tick.
|
|
@@ -108,46 +86,68 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
108
86
|
const messagesToProcess = getMessages(receivedMessages);
|
|
109
87
|
const entitiesShouldBeCleaned = [];
|
|
110
88
|
for (const msg of messagesToProcess) {
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
89
|
+
// Simple CRDT processing - no network logic
|
|
90
|
+
if (msg.type === CrdtMessageType.DELETE_ENTITY) {
|
|
91
|
+
// Reject an inbound DELETE_ENTITY on a reserved entity from an untrusted
|
|
92
|
+
// transport (a comms peer, or a scene-added transport). The allocator half
|
|
93
|
+
// is already guarded (engine.removeEntity is a no-op on this range); this
|
|
94
|
+
// closes the receive-side half.
|
|
95
|
+
const isReserved = engine.entityContainer.getEntityState(msg.entityId) === EntityState.Reserved;
|
|
96
|
+
if (isReserved && !isTrustedForReservedEntities(msg.transportId)) {
|
|
97
|
+
continue;
|
|
98
|
+
}
|
|
99
|
+
entitiesShouldBeCleaned.push(msg.entityId);
|
|
120
100
|
broadcastMessages.push(msg);
|
|
121
101
|
}
|
|
122
102
|
else {
|
|
123
|
-
const entityState = engine.entityContainer.getEntityState(entityId);
|
|
124
|
-
// Skip updates from removed
|
|
103
|
+
const entityState = engine.entityContainer.getEntityState(msg.entityId);
|
|
104
|
+
// Skip updates from removed entities
|
|
125
105
|
if (entityState === EntityState.Removed)
|
|
126
106
|
continue;
|
|
127
|
-
//
|
|
107
|
+
// Reject component operations (PUT/DELETE/APPEND, including AUTHORITATIVE_PUT
|
|
108
|
+
// which bypasses timestamps entirely) on reserved entities from untrusted
|
|
109
|
+
// transports. Dropping before updateFromCrdt keeps local LWW timestamps
|
|
110
|
+
// unpoisoned by forged high timestamps, and also prevents the
|
|
111
|
+
// unknown-component rebroadcast below from relaying forged reserved-entity
|
|
112
|
+
// data to other transports (including the renderer).
|
|
113
|
+
if (entityState === EntityState.Reserved && !isTrustedForReservedEntities(msg.transportId))
|
|
114
|
+
continue;
|
|
115
|
+
// Entities with unknown state should update its entity state
|
|
128
116
|
if (entityState === EntityState.Unknown) {
|
|
129
|
-
engine.entityContainer.updateUsedEntity(entityId);
|
|
130
|
-
}
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
if (
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
117
|
+
engine.entityContainer.updateUsedEntity(msg.entityId);
|
|
118
|
+
}
|
|
119
|
+
// Only process component-related messages (not DELETE_ENTITY)
|
|
120
|
+
if ('componentId' in msg) {
|
|
121
|
+
const component = engine.getComponentOrNull(msg.componentId);
|
|
122
|
+
if (component) {
|
|
123
|
+
// Handle authoritative messages differently - they force the state regardless of timestamp
|
|
124
|
+
const tryUpdate = () => {
|
|
125
|
+
try {
|
|
126
|
+
return msg.type === CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT
|
|
127
|
+
? component.__forceUpdateFromCrdt(msg)
|
|
128
|
+
: component.updateFromCrdt(msg);
|
|
129
|
+
}
|
|
130
|
+
catch (e) {
|
|
131
|
+
console.error('[receiveMessages] ERROR processing message', msg, e);
|
|
132
|
+
return null;
|
|
133
|
+
}
|
|
134
|
+
};
|
|
135
|
+
const result = tryUpdate();
|
|
136
|
+
if (!result)
|
|
137
|
+
continue;
|
|
138
|
+
const [conflictMessage, value] = result;
|
|
139
|
+
if (!conflictMessage) {
|
|
140
|
+
// Add message to broadcast queue when no conflict
|
|
141
|
+
broadcastMessages.push(msg);
|
|
142
|
+
onProcessEntityComponentChange && onProcessEntityComponentChange(msg.entityId, msg.type, component, value);
|
|
143
|
+
}
|
|
139
144
|
}
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
145
|
+
else {
|
|
146
|
+
// Component not found - still broadcast for editor compatibility
|
|
147
|
+
/* istanbul ignore next */
|
|
143
148
|
broadcastMessages.push(msg);
|
|
144
|
-
onProcessEntityComponentChange && onProcessEntityComponentChange(entityId, msg.type, component, value);
|
|
145
149
|
}
|
|
146
150
|
}
|
|
147
|
-
else {
|
|
148
|
-
// TODO: test this line, it is fundammental to make the editor work
|
|
149
|
-
broadcastMessages.push(msg);
|
|
150
|
-
}
|
|
151
151
|
}
|
|
152
152
|
}
|
|
153
153
|
// the last stage of the syncrhonization is to delete the entities
|
|
@@ -161,16 +161,17 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
161
161
|
}
|
|
162
162
|
}
|
|
163
163
|
/**
|
|
164
|
-
*
|
|
164
|
+
* Simple CRDT message broadcasting - no network-specific logic
|
|
165
165
|
*/
|
|
166
166
|
async function sendMessages(entitiesDeletedThisTick) {
|
|
167
|
-
//
|
|
167
|
+
// Get messages from broadcast queue and component updates
|
|
168
168
|
const crdtMessages = getMessages(broadcastMessages);
|
|
169
169
|
const buffer = new ReadWriteByteBuffer();
|
|
170
|
+
// Generate CRDT messages from component updates
|
|
170
171
|
for (const component of engine.componentsIter()) {
|
|
171
172
|
for (const message of component.getCrdtUpdates()) {
|
|
172
173
|
const offset = buffer.currentWriteOffset();
|
|
173
|
-
//
|
|
174
|
+
// Only create messages if there's a transport that will handle it
|
|
174
175
|
if (transports.some((t) => t.filter(message))) {
|
|
175
176
|
if (message.type === CrdtMessageType.PUT_COMPONENT) {
|
|
176
177
|
PutComponentOperation.write(message.entityId, message.timestamp, message.componentId, message.data, buffer);
|
|
@@ -194,7 +195,7 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
194
195
|
}
|
|
195
196
|
}
|
|
196
197
|
}
|
|
197
|
-
//
|
|
198
|
+
// Handle deleted entities
|
|
198
199
|
for (const entityId of entitiesDeletedThisTick) {
|
|
199
200
|
const offset = buffer.currentWriteOffset();
|
|
200
201
|
DeleteEntity.write(entityId, buffer);
|
|
@@ -205,87 +206,19 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
205
206
|
});
|
|
206
207
|
onProcessEntityComponentChange && onProcessEntityComponentChange(entityId, CrdtMessageType.DELETE_ENTITY);
|
|
207
208
|
}
|
|
208
|
-
//
|
|
209
|
-
const
|
|
210
|
-
|
|
211
|
-
const __NetworkMessagesBuffer = [];
|
|
212
|
-
const transportIndex = Number(index);
|
|
213
|
-
const transport = transports[transportIndex];
|
|
214
|
-
const isRendererTransport = transport.type === 'renderer';
|
|
215
|
-
const isNetworkTransport = transport.type === 'network';
|
|
216
|
-
// Reset Buffer for each Transport
|
|
217
|
-
transportBuffer.resetBuffer();
|
|
218
|
-
const buffer = new ReadWriteByteBuffer();
|
|
219
|
-
// Then we send all the new crdtMessages that the transport needs to process
|
|
209
|
+
// Simple transport broadcasting - no network-specific transforms
|
|
210
|
+
for (const transport of transports) {
|
|
211
|
+
const transportBuffer = new ReadWriteByteBuffer();
|
|
220
212
|
for (const message of crdtMessages) {
|
|
221
213
|
// Avoid echo messages
|
|
222
|
-
if (message.transportId ===
|
|
214
|
+
if (message.transportId === transports.indexOf(transport))
|
|
223
215
|
continue;
|
|
224
|
-
//
|
|
225
|
-
if (
|
|
226
|
-
|
|
227
|
-
// Check if adding this message would exceed the size limit
|
|
228
|
-
const currentBufferSize = transportBuffer.toBinary().byteLength;
|
|
229
|
-
const messageSize = message.messageBuffer.byteLength;
|
|
230
|
-
if (isNetworkTransport && (currentBufferSize + messageSize) / 1024 > LIVEKIT_MAX_SIZE) {
|
|
231
|
-
// If the current buffer has content, save it as a chunk
|
|
232
|
-
if (currentBufferSize > 0) {
|
|
233
|
-
__NetworkMessagesBuffer.push(transportBuffer.toCopiedBinary());
|
|
234
|
-
transportBuffer.resetBuffer();
|
|
235
|
-
}
|
|
236
|
-
// If the message itself is larger than the limit, we need to handle it specially
|
|
237
|
-
// For now, we'll skip it to prevent infinite loops
|
|
238
|
-
if (messageSize / 1024 > LIVEKIT_MAX_SIZE) {
|
|
239
|
-
console.error(`Message too large (${messageSize} bytes), skipping message for entity ${message.entityId}`);
|
|
240
|
-
continue;
|
|
241
|
-
}
|
|
216
|
+
// Check if transport wants this message
|
|
217
|
+
if (transport.filter(message)) {
|
|
218
|
+
transportBuffer.writeBuffer(message.messageBuffer, false);
|
|
242
219
|
}
|
|
243
|
-
const { entityId } = findNetworkId(message);
|
|
244
|
-
const transformNeedsFix = 'componentId' in message &&
|
|
245
|
-
message.componentId === Transform.componentId &&
|
|
246
|
-
Transform.has(entityId) &&
|
|
247
|
-
NetworkParent.has(entityId) &&
|
|
248
|
-
NetworkEntity.has(entityId);
|
|
249
|
-
// If there was a LOCAL change in the transform. Add the parent to that transform
|
|
250
|
-
if (isRendererTransport && message.type === CrdtMessageType.PUT_COMPONENT && transformNeedsFix) {
|
|
251
|
-
const parent = findNetworkId(NetworkParent.get(entityId));
|
|
252
|
-
const transformData = networkUtils.fixTransformParent(message, Transform.get(entityId), parent.entityId);
|
|
253
|
-
const offset = buffer.currentWriteOffset();
|
|
254
|
-
PutComponentOperation.write(entityId, message.timestamp, message.componentId, transformData, buffer);
|
|
255
|
-
transportBuffer.writeBuffer(buffer.buffer().subarray(offset, buffer.currentWriteOffset()), false);
|
|
256
|
-
continue;
|
|
257
|
-
}
|
|
258
|
-
if (isRendererTransport && networkUtils.isNetworkMessage(message)) {
|
|
259
|
-
// If it's the renderer transport and its a NetworkMessage, we need to fix the entityId field and convert it to a known Message.
|
|
260
|
-
// PUT_NETWORK_COMPONENT -> PUT_COMPONENT
|
|
261
|
-
let transformData = 'data' in message ? message.data : new Uint8Array();
|
|
262
|
-
if (transformNeedsFix) {
|
|
263
|
-
const parent = findNetworkId(NetworkParent.get(entityId));
|
|
264
|
-
transformData = networkUtils.fixTransformParent(message, Transform.get(entityId), parent.entityId);
|
|
265
|
-
}
|
|
266
|
-
networkUtils.networkMessageToLocal({ ...message, data: transformData }, entityId, buffer, transportBuffer);
|
|
267
|
-
// Iterate the next message
|
|
268
|
-
continue;
|
|
269
|
-
}
|
|
270
|
-
// If its a network transport and its a PUT_COMPONENT that has a NetworkEntity component, we need to send this message
|
|
271
|
-
// through comms with the EntityID and NetworkID from ther NetworkEntity so everyone can recieve this message and map to their custom entityID.
|
|
272
|
-
if (isNetworkTransport && !networkUtils.isNetworkMessage(message)) {
|
|
273
|
-
const networkData = NetworkEntity.getOrNull(message.entityId);
|
|
274
|
-
// If it has networkData convert the message to PUT_NETWORK_COMPONENT.
|
|
275
|
-
if (networkData) {
|
|
276
|
-
networkUtils.localMessageToNetwork(message, networkData, buffer, transportBuffer);
|
|
277
|
-
// Iterate the next message
|
|
278
|
-
continue;
|
|
279
|
-
}
|
|
280
|
-
}
|
|
281
|
-
// Common message
|
|
282
|
-
transportBuffer.writeBuffer(message.messageBuffer, false);
|
|
283
|
-
}
|
|
284
|
-
if (isNetworkTransport && transportBuffer.currentWriteOffset()) {
|
|
285
|
-
__NetworkMessagesBuffer.push(transportBuffer.toBinary());
|
|
286
220
|
}
|
|
287
|
-
|
|
288
|
-
await transport.send(message);
|
|
221
|
+
await transport.send(transportBuffer.toBinary());
|
|
289
222
|
}
|
|
290
223
|
}
|
|
291
224
|
/**
|