fix: audio source retrigger deduplication (#1382)

Author: pravusjif

packages/@dcl/ecs/src/components/extended/AudioSource.ts

@@ -11,11 +11,13 @@ export interface AudioSourceComponentDefinitionExtended
   /**
    * @public
    *
-   * Set playing=true the sound `$name`
-   * @param entity - entity with AudioSource component
+   * Play the sound `src` on the given entity. Creates the AudioSource component
+   * if it does not yet exist. Always emits a CRDT PUT, so repeated calls with
+   * identical parameters reliably retrigger playback.
+   * @param entity - target entity (AudioSource will be created if missing)
    * @param src - the path to the sound to play
    * @param resetCursor - the sound starts at 0 or continues from the current cursor position
-   * @returns true in successful playing, false if it doesn't find the AudioSource component
+   * @returns always true; retained for backwards compatibility
    */
   playSound(entity: Entity, src: string, resetCursor?: boolean): boolean
 
@@ -38,13 +40,14 @@ export function defineAudioSourceComponent(
   return {
     ...theComponent,
     playSound(entity: Entity, src: string, resetCursor: boolean = true): boolean {
-      // Get the mutable to modify
-      const audioSource = theComponent.getMutableOrNull(entity)
-      if (!audioSource) return false
+      const existing = theComponent.getOrNull(entity)
 
-      audioSource.audioClipUrl = src
-      audioSource.playing = true
-      audioSource.currentTime = resetCursor ? 0 : audioSource.currentTime
+      theComponent.createOrReplace(entity, {
+        ...existing,
+        audioClipUrl: src,
+        playing: true,
+        currentTime: resetCursor ? 0 : existing?.currentTime ?? 0
+      })
 
       return true
     },

test/ecs/components/AudioSource.spec.ts

@@ -1,4 +1,5 @@
 import { Engine, components } from '../../../packages/@dcl/ecs/src'
+import { CrdtMessageType } from '../../../packages/@dcl/ecs/src/serialization/crdt/types'
 import { testComponentSerialization } from './assertion'
 
 describe('Generated AudioSource ProtoBuf', () => {
@@ -38,8 +39,9 @@ describe('Generated AudioSource ProtoBuf', () => {
       playing: true
     })
 
-    expect(AudioSource.playSound(entityWithoutAudioSource, 'some-src')).toBe(false)
+    // stopSound on an entity without AudioSource is a no-op.
     expect(AudioSource.stopSound(entityWithoutAudioSource)).toBe(false)
+    expect(AudioSource.getOrNull(entityWithoutAudioSource)).toBeNull()
 
     // play sound with new "src" & reset cursor
     expect(AudioSource.playSound(entity, 'other-src', true)).toBe(true)
@@ -60,4 +62,52 @@ describe('Generated AudioSource ProtoBuf', () => {
     expect(AudioSource.stopSound(entity, true)).toBe(true)
     expect(AudioSource.getOrNull(entity)).toStrictEqual({ audioClipUrl: 'other-src', playing: false, currentTime: 0 })
   })
+
+  it('should create the AudioSource component on entities that do not yet have one when playSound is called', () => {
+    const newEngine = Engine()
+    const AudioSource = components.AudioSource(newEngine)
+    const entity = newEngine.addEntity()
+
+    // Entity has no AudioSource component yet.
+    expect(AudioSource.getOrNull(entity)).toBeNull()
+
+    // playSound must create it and start playback.
+    expect(AudioSource.playSound(entity, 'fresh.mp3')).toBe(true)
+    expect(AudioSource.getOrNull(entity)).toStrictEqual({
+      audioClipUrl: 'fresh.mp3',
+      playing: true,
+      currentTime: 0
+    })
+
+    // And it must emit a CRDT PUT so the renderer hears about it.
+    const messages = Array.from(AudioSource.getCrdtUpdates())
+    expect(messages).toHaveLength(1)
+    expect(messages[0].type).toBe(CrdtMessageType.PUT_COMPONENT)
+  })
+
+  it('should emit a CRDT PUT on every playSound call, even with identical parameters (retrigger)', () => {
+    const newEngine = Engine()
+    const AudioSource = components.AudioSource(newEngine)
+    const entity = newEngine.addEntity()
+
+    AudioSource.create(entity, { audioClipUrl: 'a.mp3', playing: false })
+
+    // Flush initial create
+    const createMessages = Array.from(AudioSource.getCrdtUpdates())
+    expect(createMessages).toHaveLength(1)
+    expect(createMessages[0].type).toBe(CrdtMessageType.PUT_COMPONENT)
+
+    // First playSound call
+    expect(AudioSource.playSound(entity, 'a.mp3')).toBe(true)
+    const firstPlayMessages = Array.from(AudioSource.getCrdtUpdates())
+    expect(firstPlayMessages).toHaveLength(1)
+    expect(firstPlayMessages[0].type).toBe(CrdtMessageType.PUT_COMPONENT)
+
+    // Second playSound call with identical parameters — must still emit a PUT
+    expect(AudioSource.playSound(entity, 'a.mp3')).toBe(true)
+    const secondPlayMessages = Array.from(AudioSource.getCrdtUpdates())
+    expect(secondPlayMessages).toHaveLength(1)
+    expect(secondPlayMessages[0].type).toBe(CrdtMessageType.PUT_COMPONENT)
+  })
+
 })

test/snapshots/production-bundles/with-main-function.ts.crdt

@@ -38,4 +38,4 @@ CALL onUpdate(0.1)
   OPCODES ~= 5k
   MALLOC_COUNT = 13
   ALIVE_OBJS_DELTA ~= 0.00k
-  MEMORY_USAGE_COUNT ~= 2964.64k bytes
+  MEMORY_USAGE_COUNT ~= 2964.74k bytes