Skip to content

chore(deps): update dependency wait-for-expect to v4 (#2779) #2783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 15, 2025
Merged

chore(deps): update dependency wait-for-expect to v4 (#2779) #2783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/chilly-trains-fix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@scaleway/use-analytics": patch
---

Add timeout option also when shouldRenderOnlyWhenReady is not set
2 changes: 2 additions & 0 deletions packages/use-analytics/src/analytics/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import type { ConsentOptions, LoadOptions } from '@rudderstack/analytics-js'

export const defaultTimeout = 5000

export const defaultConsentOptions: ConsentOptions = {
trackConsent: false,
/**
Expand Down
10 changes: 4 additions & 6 deletions packages/use-analytics/src/analytics/useAnalytics.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import type { ReactNode } from 'react'
import { useDeepCompareEffectNoCheck } from 'use-deep-compare-effect'
import { destSDKBaseURL, pluginsSDKBaseURL } from '../constants'
import type { CategoryKind } from '../types'
import { defaultConsentOptions, defaultLoadOptions } from './constants'
import { defaultConsentOptions, defaultLoadOptions, defaultTimeout } from './constants'
import { normalizeIdsMigration } from './normalizeIdsMigration'

type Analytics = RudderAnalytics
Expand Down Expand Up @@ -50,7 +50,7 @@ export type AnalyticsProviderProps<T> = {
loadOptions?: LoadOptions

/**
* This option force provider to render children only when isAnalytics is ready
* This option force provider to render children only when isAnalytics is ready, you can also set a timeout to prevent blocking indefinitely and use isAnalyticsReady to show a loading screen.
*/
shouldRenderOnlyWhenReady?: boolean
/**
Expand Down Expand Up @@ -92,11 +92,9 @@ export function AnalyticsProvider<T extends Events>({
// This effect will unlock the case where we have a failure with the load of the analytics.load as rudderstack doesn't provider any solution for this case.
useEffect(() => {
let timer: ReturnType<typeof setTimeout> | undefined
if (!isAnalyticsReady && timeout) {
if (shouldRenderOnlyWhenReady) {
timer = setTimeout(() => setIsAnalyticsReady(true), timeout)
if (!isAnalyticsReady && (Number.isFinite(timeout) || shouldRenderOnlyWhenReady)) {
timer = setTimeout(() => setIsAnalyticsReady(true), timeout ?? defaultTimeout)
onError?.(new Error('Analytics Setup Timeout'))
}
}

return () => {
Expand Down
Loading