Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/friendly-cycles-flow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@segment/analytics-signals': patch
---

Fix bug where in vanilla React environments, the onChange events would error due to circular references.
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
import { createInteractionSignal } from '../../../../types/factories'
import { SignalEmitter } from '../../../emitter'
import { OnChangeGenerator } from '../change-gen'

describe('OnChangeGenerator', () => {
let onChangeGenerator: OnChangeGenerator
let emitter: SignalEmitter
let unregister: () => void
beforeEach(() => {
onChangeGenerator = new OnChangeGenerator()
emitter = new SignalEmitter()
})

afterEach(() => {
unregister()
})

it('should emit a signal on change event', async () => {
const emitSpy = jest.spyOn(emitter, 'emit')
const target = document.createElement('input')
target.type = 'text'
target.value = 'new value'

const event = new Event('change', { bubbles: true })
Object.defineProperty(event, 'target', { value: target })

unregister = onChangeGenerator.register(emitter)
document.dispatchEvent(event)

expect(emitSpy).toHaveBeenCalledWith(
createInteractionSignal({
eventType: 'change',
listener: 'onchange',
target: expect.any(Object),
change: { value: 'new value' },
})
)
})

it('should not emit a signal for ignored elements', () => {
const emitSpy = jest.spyOn(emitter, 'emit')
const target = document.createElement('input')
target.type = 'password'

const event = new Event('change', { bubbles: true })
Object.defineProperty(event, 'target', { value: target })

unregister = onChangeGenerator.register(emitter)
document.dispatchEvent(event)

expect(emitSpy).not.toHaveBeenCalled()
})

it('should not emit a signal for elements handled by mutation observer', () => {
const emitSpy = jest.spyOn(emitter, 'emit')
const target = document.createElement('input')
target.type = 'text'
target.setAttribute('value', 'initial value')

const event = new Event('change', { bubbles: true })
Object.defineProperty(event, 'target', { value: target })

unregister = onChangeGenerator.register(emitter)
document.dispatchEvent(event)

expect(emitSpy).not.toHaveBeenCalled()
})

it('should emit a signal with selectedOptions for select elements', () => {
const emitSpy = jest.spyOn(emitter, 'emit')
const target = document.createElement('select')
const option1 = document.createElement('option')
option1.value = 'value1'
option1.label = 'label1'
option1.selected = true
const option2 = document.createElement('option')
option2.value = 'value2'
option2.label = 'label2'
target.append(option1, option2)

const event = new Event('change', { bubbles: true })
Object.defineProperty(event, 'target', { value: target })

unregister = onChangeGenerator.register(emitter)
document.dispatchEvent(event)

expect(emitSpy).toHaveBeenCalledWith(
createInteractionSignal({
eventType: 'change',
listener: 'onchange',
target: expect.any(Object),
change: {
selectedOptions: [{ value: 'value1', label: 'label1' }],
},
})
)
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,10 @@ export class OnChangeGenerator implements SignalGenerator {
const parseChange = (target: HTMLElement): ChangedEvent | undefined => {
if (target instanceof HTMLSelectElement) {
return {
selectedOptions: Array.from(target.selectedOptions),
selectedOptions: Array.from(target.selectedOptions).map((option) => ({
value: option.value,
label: option.label,
})),
}
}
if (target instanceof HTMLTextAreaElement) {
Expand Down
Loading