Skip to content
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.

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

feat: toolbar event debugger #26561

Merged
merged 10 commits into from
Dec 2, 2024
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
Binary file modified frontend/__snapshots__/scenes-other-toolbar--actions--dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified frontend/__snapshots__/scenes-other-toolbar--actions--light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified frontend/__snapshots__/scenes-other-toolbar--experiments--dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions frontend/src/lib/taxonomy.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@ export const CORE_FILTER_DEFINITIONS_BY_GROUP = {
description: 'User interactions that were automatically captured.',
examples: ['clicked button'],
},
$$heatmap: {
label: 'Heatmap',
description: 'Heatmap events carry heatmap data to the backend, they do not contribute to event counts.',
},
$copy_autocapture: {
label: 'Clipboard autocapture',
description: 'Selected text automatically captured when a user copies or cuts.',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export function SettingsBar({
className={clsx(
border === 'bottom' && 'border-b',
border === 'top' && 'border-t',
'flex flex-row w-full overflow-hidden font-light text-small bg-bg-3000',
'flex flex-row w-full overflow-hidden font-light text-xs bg-bg-3000 items-center',
className
)}
>
Expand Down
6 changes: 6 additions & 0 deletions frontend/src/toolbar/Toolbar.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,12 @@ export const Experiments = (): JSX.Element => {
return <BasicTemplate menu="experiments" />
}

export const ExperimentsDisabledInParent = (): JSX.Element => {
// fake that the host site posthog config disables web experiments
window.parent.posthog = { config: { disable_web_experiments: true } }
return <BasicTemplate menu="experiments" />
}

// Dark theme
export const DefaultDark = (): JSX.Element => {
return <BasicTemplate theme="dark" />
Expand Down
19 changes: 13 additions & 6 deletions frontend/src/toolbar/bar/ToolbarMenu.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,29 @@ import clsx from 'clsx'
export type ToolbarMenuProps = {
children: React.ReactNode
className?: string
noPadding?: boolean
}

export function ToolbarMenu({ children, className }: ToolbarMenuProps): JSX.Element {
return <div className={clsx('w-full h-full flex flex-col overflow-hidden', className)}>{children}</div>
}

ToolbarMenu.Header = function ToolbarMenuHeader({ children, className }: ToolbarMenuProps): JSX.Element {
return <div className={clsx('pt-1 px-1', className)}>{children}</div>
ToolbarMenu.Header = function ToolbarMenuHeader({ children, className, noPadding }: ToolbarMenuProps): JSX.Element {
return <div className={clsx(!noPadding && 'px-1 pt-1', className)}>{children}</div>
}

ToolbarMenu.Body = function ToolbarMenuBody({ children, className }: ToolbarMenuProps): JSX.Element {
ToolbarMenu.Body = function ToolbarMenuBody({ children, className, noPadding }: ToolbarMenuProps): JSX.Element {
return (
<div className={clsx('flex flex-col flex-1 h-full overflow-y-auto px-1 min-h-20', className)}>{children}</div>
<div className={clsx(!noPadding && 'px-1', 'flex flex-col flex-1 h-full overflow-y-auto min-h-20', className)}>
{children}
</div>
)
}

ToolbarMenu.Footer = function ToolbarMenufooter({ children, className }: ToolbarMenuProps): JSX.Element {
return <div className={clsx('flex flex-row items-center p-2 border-t gap-2', className)}>{children}</div>
ToolbarMenu.Footer = function ToolbarMenufooter({ children, className, noPadding }: ToolbarMenuProps): JSX.Element {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i only needed no padding in this component i think
but felt weird for it to not be an option throughout

return (
<div className={clsx(!noPadding && 'p-1', 'flex flex-row items-center border-t gap-2', className)}>
{children}
</div>
)
}
177 changes: 124 additions & 53 deletions frontend/src/toolbar/debug/EventDebugMenu.tsx
Original file line number Diff line number Diff line change
@@ -1,67 +1,133 @@
import { BaseIcon, IconCheck, IconEye, IconLogomark, IconSearch, IconVideoCamera } from '@posthog/icons'
import { useActions, useValues } from 'kea'
import { AnimatedCollapsible } from 'lib/components/AnimatedCollapsible'
import { TZLabel } from 'lib/components/TZLabel'
import { LemonCheckbox } from 'lib/lemon-ui/LemonCheckbox'
import { PropertyKeyInfo } from 'lib/components/PropertyKeyInfo'
import { TaxonomicFilterGroupType } from 'lib/components/TaxonomicFilter/types'
import { dayjs } from 'lib/dayjs'
import { IconUnverifiedEvent } from 'lib/lemon-ui/icons'
import { LemonInput } from 'lib/lemon-ui/LemonInput'
import { LemonSegmentedButton } from 'lib/lemon-ui/LemonSegmentedButton'
import { LemonMenuItem } from 'lib/lemon-ui/LemonMenu'
import { SettingsBar, SettingsMenu, SettingsToggle } from 'scenes/session-recordings/components/PanelSettings'
import { SimpleKeyValueList } from 'scenes/session-recordings/player/inspector/components/SimpleKeyValueList'

import { eventDebugMenuLogic } from '~/toolbar/debug/eventDebugMenuLogic'
import { EventType } from '~/types'

import { ToolbarMenu } from '../bar/ToolbarMenu'

function showEventMenuItem(
label: string,
count: number,
icon: JSX.Element,
isActive: boolean,
onClick: () => void
): LemonMenuItem {
return {
label: (
<div className="w-full flex flex-row justify-between items-center">
<div className="flex flex-row items-center gap-1">
{isActive ? <IconCheck /> : <BaseIcon />}
{icon}
{label}
</div>
<span
// without setting fontVariant to none a single digit number between brackets gets rendered as a ligature 🤷
// eslint-disable-next-line react/forbid-dom-props
style={{ fontVariant: 'none' }}
>
({count})
</span>
</div>
),
active: isActive,
onClick: onClick,
}
}

function EventTimestamp({ e }: { e: EventType }): JSX.Element {
const ts = dayjs(e.timestamp)

let formatString = 'HH:mm:ss'
// if we're watching events around midnight, show the day as well for yesterday's events
if (!ts.isSame(dayjs(), 'day')) {
formatString = 'ddd HH:mm:ss'
}

return (
<div>
<span>{ts.format(formatString)}</span>
<span className="text-xxs text-muted">{ts.format('.SSS')}</span>
</div>
)
}

export const EventDebugMenu = (): JSX.Element => {
const {
searchType,
searchVisible,
searchText,
filteredEvents,
isCollapsedEventRow,
activeFilteredEvents,
searchFilteredEventsCount,
expandedEvent,
showRecordingSnapshots,
snapshotCount,
eventCount,
filteredProperties,
selectedEventTypes,
} = useValues(eventDebugMenuLogic)
const { setSearchType, markExpanded, setShowRecordingSnapshots, setSearchText } = useActions(eventDebugMenuLogic)
const { markExpanded, setSelectedEventType, setSearchText, setSearchVisible } = useActions(eventDebugMenuLogic)

const showEventsMenuItems = [
showEventMenuItem(
'PostHog Events',
searchFilteredEventsCount['posthog'],
<IconLogomark />,
selectedEventTypes.includes('posthog'),
() => setSelectedEventType('posthog', !selectedEventTypes.includes('posthog'))
),
showEventMenuItem(
'Custom Events',
searchFilteredEventsCount['custom'],
<IconVideoCamera />,
selectedEventTypes.includes('custom'),
() => setSelectedEventType('custom', !selectedEventTypes.includes('custom'))
),
showEventMenuItem(
'Replay Events',
searchFilteredEventsCount['snapshot'],
<IconUnverifiedEvent />,
selectedEventTypes.includes('snapshot'),
() => setSelectedEventType('snapshot', !selectedEventTypes.includes('snapshot'))
),
]
return (
<ToolbarMenu>
<ToolbarMenu.Header>
<ToolbarMenu.Header noPadding>
<div className="flex flex-col pb-2 space-y-1">
<div className="flex flex-row justify-around items-center">
<span className="text-xs">Seen {eventCount} events.</span>
<LemonCheckbox
checked={showRecordingSnapshots}
onChange={(c) => setShowRecordingSnapshots(c)}
label={`Show ${snapshotCount} snapshot events`}
size="small"
/>
</div>
<div className="flex justify-center flex-col">
<div className="flex flex-row items-center justify-between space-x-2">
<span>search:</span>
<LemonSegmentedButton
size="small"
value={searchType}
options={[
{
value: 'events',
label: 'events',
},
{ value: 'properties', label: 'properties' },
]}
onChange={setSearchType}
<SettingsBar border="bottom" className="justify-end">
<div className="flex-1 text-sm">
View events from this page as they are sent to PostHog.
</div>
<SettingsToggle
label="Search"
icon={<IconSearch />}
active={searchVisible}
onClick={() => setSearchVisible(!searchVisible)}
/>

<LemonInput fullWidth={true} type="search" value={searchText} onChange={setSearchText} />
</div>
</SettingsBar>
{searchVisible && (
<LemonInput
size="xsmall"
fullWidth={true}
type="search"
value={searchText}
onChange={setSearchText}
/>
)}
</div>
</div>
</ToolbarMenu.Header>
<ToolbarMenu.Body>
<div className="flex flex-col space-y-1">
{filteredEvents.length ? (
filteredEvents.map((e) => {
{activeFilteredEvents.length ? (
activeFilteredEvents.map((e) => {
return (
<div
className="-mx-1 py-1 px-2 cursor-pointer"
Expand All @@ -70,23 +136,21 @@ export const EventDebugMenu = (): JSX.Element => {
expandedEvent === e.uuid ? markExpanded(null) : markExpanded(e.uuid || null)
}}
>
<div className="flex flex-row justify-between">
<div>{e.event}</div>
<div>
<TZLabel time={e.timestamp} />
</div>
<div className="flex flex-row justify-between hover:bg-bg-light hover:text-text-3000-light">
<EventTimestamp e={e} />
<PropertyKeyInfo
value={e.event}
type={TaxonomicFilterGroupType.Events}
disableIcon={true}
/>
</div>
<AnimatedCollapsible
collapsed={e.uuid === undefined ? true : isCollapsedEventRow(e.uuid)}
>
<div className="my-1 ml-1 pl-2 border-l-2">
<SimpleKeyValueList
item={filteredProperties(e.properties)}
emptyMessage={
searchText && searchType === 'properties'
? 'No matching properties'
: 'No properties'
}
item={e.properties}
emptyMessage={searchText ? 'No matching properties' : 'No properties'}
/>
</div>
</AnimatedCollapsible>
Expand All @@ -95,15 +159,22 @@ export const EventDebugMenu = (): JSX.Element => {
})
) : (
<div className="px-4 py-2">
{searchText && searchType === 'events'
? 'No events match your search.'
{searchText && !!activeFilteredEvents.length
? 'Nothing matches your search.'
: 'Interact with your page and then come back to the toolbar to see what events were generated.'}
</div>
)}
</div>
</ToolbarMenu.Body>
<ToolbarMenu.Footer>
<span className="text-xs">View events from this page as they are sent to PostHog.</span>
<ToolbarMenu.Footer noPadding>
<SettingsBar border="top" className="justify-end">
<SettingsMenu
items={showEventsMenuItems}
highlightWhenActive={false}
icon={<IconEye />}
label={`Showing ${activeFilteredEvents.length} events`}
/>
</SettingsBar>
</ToolbarMenu.Footer>
</ToolbarMenu>
)
Expand Down
Loading
Loading