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/swift-cooks-reply.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@scaleway/use-segment': patch
---

fix(useSegment): add test and missing dep on useEffect
54 changes: 53 additions & 1 deletion packages/use-segment/src/__tests__/SegmentProvider.test.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { describe, expect, it, jest } from '@jest/globals'
import { afterAll, describe, expect, it, jest } from '@jest/globals'
import type { Context } from '@segment/analytics-next'
import { AnalyticsBrowser } from '@segment/analytics-next'
import { render, screen, waitFor } from '@testing-library/react'
Expand All @@ -8,6 +8,14 @@ import type { Analytics } from '../index'
const TestChildren = () => <div data-testid="test">children</div>

describe('SegmentProvider', () => {
beforeEach(() => {
jest.clearAllMocks()
})

afterAll(() => {
jest.restoreAllMocks()
})

it('Provider should render children when shouldRenderOnlyWhenReady is false', async () => {
const mock = jest
.spyOn(AnalyticsBrowser, 'load')
Expand Down Expand Up @@ -110,4 +118,48 @@ describe('SegmentProvider', () => {

expect(screen.queryByTestId('test')).toBeTruthy()
})

it('Provider should not render children when options are not loaded at first render, but load after options changed even without settings', async () => {
const mock = jest
.spyOn(AnalyticsBrowser, 'load')
.mockResolvedValue([{} as Analytics, {} as Context])

const { rerender } = render(
<SegmentProvider
initOptions={{}}
areOptionsLoaded={false}
shouldRenderOnlyWhenReady
events={{
event: () => () => Promise.resolve(),
}}
>
<TestChildren />
</SegmentProvider>,
)

await waitFor(() => {
expect(mock).toHaveBeenCalledTimes(0)
})

expect(screen.queryByTestId('test')).toBe(null)

rerender(
<SegmentProvider
initOptions={{}}
areOptionsLoaded
shouldRenderOnlyWhenReady
events={{
event: () => () => Promise.resolve(),
}}
>
<TestChildren />
</SegmentProvider>,
)

await waitFor(() => {
expect(mock).toHaveBeenCalledTimes(0)
})

expect(screen.queryByTestId('test')).toBeTruthy()
})
})
4 changes: 4 additions & 0 deletions packages/use-segment/src/__tests__/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ const wrapper =

describe('segment hook', () => {
beforeEach(() => {
jest.clearAllMocks()
})

afterAll(() => {
jest.restoreAllMocks()
})

Expand Down