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
7 changes: 6 additions & 1 deletion packages/web/src/app/AppProviders.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
import { PersistGate } from 'redux-persist/integration/react'
import { WagmiProvider } from 'wagmi'

import { REACT_QUERY_DEVTOOLS_KEY, useDevToggle } from 'hooks/useDevToggle'
import { useIsMobile } from 'hooks/useIsMobile'
import { env } from 'services/env'
import { queryClient } from 'services/query-client'
Expand All @@ -41,6 +42,10 @@ type AppProvidersProps = {

export const AppProviders = ({ children }: AppProvidersProps) => {
const isMobile = useIsMobile()
const [reactQueryDevtoolsEnabled] = useDevToggle(
REACT_QUERY_DEVTOOLS_KEY,
false
)

const [{ store, persistor }] = useState(() => {
const theme = getTheme()
Expand Down Expand Up @@ -95,7 +100,7 @@ export const AppProviders = ({ children }: AppProvidersProps) => {
</PersistGate>
</ReduxProvider>
</MediaProvider>
<ReactQueryDevtools />
{reactQueryDevtoolsEnabled ? <ReactQueryDevtools /> : null}
</QueryClientProvider>
</WagmiProvider>
)
Expand Down
58 changes: 58 additions & 0 deletions packages/web/src/hooks/useDevToggle.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import { useCallback, useEffect, useState } from 'react'

const CHANGE_EVENT = 'audius:dev-toggle-change'

const read = (key: string, defaultValue: boolean): boolean => {
if (typeof window === 'undefined') return defaultValue

try {
const raw = window.localStorage.getItem(key)
if (raw === null) return defaultValue
return raw === 'true'
} catch {
return defaultValue
}
}

export const useDevToggle = (
key: string,
defaultValue: boolean
): [boolean, (next: boolean) => void] => {
const [value, setValue] = useState(() => read(key, defaultValue))

useEffect(() => {
const sync = (event: Event) => {
if (event instanceof CustomEvent && event.detail?.key === key) {
setValue(read(key, defaultValue))
}

if (event instanceof StorageEvent && event.key === key) {
setValue(read(key, defaultValue))
}
}

window.addEventListener(CHANGE_EVENT, sync)
window.addEventListener('storage', sync)

return () => {
window.removeEventListener(CHANGE_EVENT, sync)
window.removeEventListener('storage', sync)
}
}, [key, defaultValue])

const set = useCallback(
(next: boolean) => {
try {
window.localStorage.setItem(key, String(next))
} catch {}

setValue(next)
window.dispatchEvent(new CustomEvent(CHANGE_EVENT, { detail: { key } }))
},
[key]
)

return [value, set]
}

export const REACT_QUERY_DEVTOOLS_KEY = 'audius-react-query-devtools-enabled'
18 changes: 18 additions & 0 deletions packages/web/src/pages/dev-tools/DevTools.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
IconShieldCheck,
IconDashboard,
IconFanClub,
IconRefresh,
IconUser,
Paper,
Text,
Expand All @@ -19,6 +20,7 @@ import { useNavigate } from 'react-router'

import { Header } from 'components/header/desktop/Header'
import { Page } from 'components/page/Page'
import { REACT_QUERY_DEVTOOLS_KEY, useDevToggle } from 'hooks/useDevToggle'
import { env } from 'services/env'

import { messages } from './messages'
Expand Down Expand Up @@ -102,6 +104,8 @@ export const DevTools = () => {
const dispatch = useDispatch()
const navigate = useNavigate()
const { onOpen: openCoinSuccessModal } = useCoinSuccessModal()
const [reactQueryDevtoolsEnabled, setReactQueryDevtoolsEnabled] =
useDevToggle(REACT_QUERY_DEVTOOLS_KEY, false)

const handleOpenFeatureFlags = () => {
dispatch(
Expand Down Expand Up @@ -217,6 +221,20 @@ export const DevTools = () => {
buttonText={messages.coinSuccessModalPreviewButton}
onButtonClick={handleOpenCoinSuccessModalPreview}
/>

<DevToolCard
icon={IconRefresh}
title={messages.reactQueryDevtoolsTitle}
description={messages.reactQueryDevtoolsDescription}
buttonText={
reactQueryDevtoolsEnabled
? messages.reactQueryDevtoolsDisable
: messages.reactQueryDevtoolsEnable
}
onButtonClick={() =>
setReactQueryDevtoolsEnabled(!reactQueryDevtoolsEnabled)
}
/>
</Flex>
</Box>
</Page>
Expand Down
7 changes: 6 additions & 1 deletion packages/web/src/pages/dev-tools/messages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,10 @@ export const messages = {
coinSuccessModalPreviewTitle: 'Coin success modal',
coinSuccessModalPreviewDescription:
'Open the post-launch fan club success dialog with sample coin data (UI preview only).',
coinSuccessModalPreviewButton: 'Open coin success modal'
coinSuccessModalPreviewButton: 'Open coin success modal',
reactQueryDevtoolsTitle: 'React Query Devtools',
reactQueryDevtoolsDescription:
'Show the floating React Query devtools button for inspecting queries, mutations, and cache state. Off by default.',
reactQueryDevtoolsEnable: 'Show Devtools Button',
reactQueryDevtoolsDisable: 'Hide Devtools Button'
}
Loading