Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

4.4 KB
Raw Blame
import { MakeLogicType, afterMount, kea, key, path, props, propsChanged, selectors } from 'kea'
import { loaders } from 'kea-loaders'

import api from 'lib/api'
import { objectsEqual } from 'lib/utils/objects'

import { Experiment } from '~/types'

import type { ExperimentIdType } from '../../types'
import { getSessionLinkabilityEventNames } from './utils'

export interface ViewRecordingsLinkabilityLogicProps {
    experiment: Experiment
}

/** Only an explicit `false` marks an event unlinkable; absent keys stay linkable (fail open). */
export function unlinkableEventNamesFromSeenTogether(
    seenTogetherMap: Record<string, boolean> | null | undefined
): Set<string> {
    return new Set(
        Object.entries(seenTogetherMap ?? {})
            .filter(([, seen]) => seen === false)
            .map(([eventName]) => eventName)
    )
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface viewRecordingsLinkabilityLogicValues {
    linkabilityLoaded: boolean
    seenTogetherMap: Record<string, boolean> | null
    seenTogetherMapLoading: boolean
    unlinkableEventNames: Set<string>
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface viewRecordingsLinkabilityLogicActions {
    loadSeenTogether: () => any
    loadSeenTogetherFailure: (
        error: string,
        errorObject?: any
    ) => {
        error: string
        errorObject?: any
    }
    loadSeenTogetherSuccess: (
        seenTogetherMap: Record<string, boolean>,
        payload?: any
    ) => {
        seenTogetherMap: Record<string, boolean>
        payload?: any
    }
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface viewRecordingsLinkabilityLogicMeta {
    key: ExperimentIdType
    __keaTypeGenInternalSelectorTypes: {
        linkabilityLoaded: (seenTogetherMap: Record<string, boolean> | null) => boolean
        unlinkableEventNames: (seenTogetherMap: Record<string, boolean> | null) => Set<string>
    }
}

export type viewRecordingsLinkabilityLogicType = MakeLogicType<
    viewRecordingsLinkabilityLogicValues,
    viewRecordingsLinkabilityLogicActions,
    ViewRecordingsLinkabilityLogicProps,
    viewRecordingsLinkabilityLogicMeta
>

/**
 * Checks, once per experiment page, which of the experiment's events have ever been seen with
 * `$session_id` — events captured server-side never carry one, so a recordings filter on them
 * can only match zero sessions. Keyed on the experiment id so every recordings surface (the
 * per-variant "View recordings" buttons, the recordings tab) shares a single lookup.
 */
export const viewRecordingsLinkabilityLogic = kea<viewRecordingsLinkabilityLogicType>([
    props({} as ViewRecordingsLinkabilityLogicProps),
    key((props) => props.experiment.id ?? 'new'),
    path((key) => ['scenes', 'experiments', 'viewRecordingsLinkabilityLogic', String(key)]),
    loaders(({ props }) => ({
        seenTogetherMap: [
            null as Record<string, boolean> | null,
            {
                loadSeenTogether: async (): Promise<Record<string, boolean>> => {
                    const eventNames = getSessionLinkabilityEventNames(props.experiment)
                    if (eventNames.length === 0) {
                        return {}
                    }
                    return await api.propertyDefinitions.seenTogether({
                        eventNames,
                        propertyDefinitionName: '$session_id',
                    })
                },
            },
        ],
    })),
    selectors({
        /** False while the check is in flight or if it failed — callers fail open to today's behavior. */
        linkabilityLoaded: [
            (s) => [s.seenTogetherMap],
            (seenTogetherMap: Record<string, boolean> | null): boolean => seenTogetherMap !== null,
        ],
        unlinkableEventNames: [
            (s) => [s.seenTogetherMap],
            (seenTogetherMap: Record<string, boolean> | null): Set<string> =>
                unlinkableEventNamesFromSeenTogether(seenTogetherMap),
        ],
    }),
    afterMount(({ actions }) => {
        actions.loadSeenTogether()
    }),
    propsChanged(({ actions, props }, oldProps) => {
        if (
            !objectsEqual(
                getSessionLinkabilityEventNames(props.experiment),
                getSessionLinkabilityEventNames(oldProps.experiment)
            )
        ) {
            actions.loadSeenTogether()
        }
    }),
])