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.

15.8 KB
Raw Blame
import { MakeLogicType, actions, afterMount, kea, key, listeners, path, props, reducers, selectors } from 'kea'
import { loaders } from 'kea-loaders'

import { captureAccessControlEvent } from 'lib/utils/accessControlUtils'
import { rolesLogic } from 'scenes/settings/organization/Permissions/Roles/rolesLogic'

import { membersLogic } from '~/models/membersLogic'

import {
    propertyAccessControlsCreate,
    propertyAccessControlsDestroy,
    propertyAccessControlsRetrieve,
} from 'products/access_control/frontend/generated/api'
import type {
    AccessLevelEnumApi,
    PropertyAccessControlStateApi,
} from 'products/access_control/frontend/generated/api.schemas'

export interface PropertyAccessControlLogicProps {
    propertyDefinitionId: string
    teamId: number
}

// Local state shape: tracks the user's pending edits
export interface LocalAccessControlState {
    defaultLevel: AccessLevelEnumApi
    // Maps member/role ID to their override level, or null meaning "remove override"
    memberOverrides: Record<string, AccessLevelEnumApi | null>
    roleOverrides: Record<string, AccessLevelEnumApi | null>
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface propertyAccessControlLogicValues {
    activeTab: string
    allMembers: {
        email: string
        first_name: string
        id: string
        last_name: string
    }[]
    allRoles: {
        id: string
        members: any[]
        name: string
    }[]
    defaultLevel: AccessLevelEnumApi
    hasChanges: boolean
    localState: LocalAccessControlState | null
    memberOverrides: Record<string, AccessLevelEnumApi | null>
    remoteState: PropertyAccessControlStateApi | null
    remoteStateLoading: boolean
    roleOverrides: Record<string, AccessLevelEnumApi | null>
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface propertyAccessControlLogicActions {
    loadRemoteState: () => any
    loadRemoteStateFailure: (
        error: string,
        errorObject?: any
    ) => {
        error: string
        errorObject?: any
    }
    loadRemoteStateSuccess: (
        remoteState: PropertyAccessControlStateApi,
        payload?: any
    ) => {
        remoteState: PropertyAccessControlStateApi
        payload?: any
    }
    resetLocalState: () => {
        value: true
    }
    saveAccessControls: () => {
        value: true
    }
    setActiveTab: (tab: string) => {
        tab: string
    }
    setLocalDefaultLevel: (level: AccessLevelEnumApi) => {
        level: AccessLevelEnumApi
    }
    setLocalMemberOverride: (
        memberId: string,
        level: AccessLevelEnumApi | null
    ) => {
        level: AccessLevelEnumApi | null
        memberId: string
    }
    setLocalRoleOverride: (
        roleId: string,
        level: AccessLevelEnumApi | null
    ) => {
        level: AccessLevelEnumApi | null
        roleId: string
    }
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface propertyAccessControlLogicMeta {
    key: string
    __keaTypeGenInternalSelectorTypes: {
        defaultLevel: (localState: LocalAccessControlState | null) => AccessLevelEnumApi
        memberOverrides: (localState: LocalAccessControlState | null) => Record<string, AccessLevelEnumApi | null>
        roleOverrides: (localState: LocalAccessControlState | null) => Record<string, AccessLevelEnumApi | null>
        allMembers: (members: import('../../../types').OrganizationMemberType[] | null) => {
            email: string
            first_name: string
            id: string
            last_name: string
        }[]
        allRoles: (roles: import('../../../types').RoleType[]) => {
            id: string
            members: any[]
            name: string
        }[]
        hasChanges: (
            localState: LocalAccessControlState | null,
            remoteState: PropertyAccessControlStateApi | null
        ) => boolean
    }
}

export type propertyAccessControlLogicType = MakeLogicType<
    propertyAccessControlLogicValues,
    propertyAccessControlLogicActions,
    PropertyAccessControlLogicProps,
    propertyAccessControlLogicMeta
>

export const propertyAccessControlLogic = kea<propertyAccessControlLogicType>([
    path(['scenes', 'data-management', 'definition', 'propertyAccessControlLogic']),
    props({} as PropertyAccessControlLogicProps),
    key((props) => props.propertyDefinitionId),

    actions({
        setLocalDefaultLevel: (level: AccessLevelEnumApi) => ({ level }),
        setLocalMemberOverride: (memberId: string, level: AccessLevelEnumApi | null) => ({ memberId, level }),
        setLocalRoleOverride: (roleId: string, level: AccessLevelEnumApi | null) => ({ roleId, level }),
        resetLocalState: true,
        saveAccessControls: true,
        setActiveTab: (tab: string) => ({ tab }),
    }),

    loaders(({ props }) => ({
        remoteState: [
            null as PropertyAccessControlStateApi | null,
            {
                loadRemoteState: async () => {
                    return await propertyAccessControlsRetrieve(String(props.teamId), {
                        property_definition_id: props.propertyDefinitionId,
                    })
                },
            },
        ],
    })),

    reducers({
        localState: [
            null as LocalAccessControlState | null,
            {
                loadRemoteStateSuccess: (_, { remoteState }) => {
                    if (!remoteState) {
                        return null
                    }
                    const memberOverrides: Record<string, AccessLevelEnumApi | null> = {}
                    const roleOverrides: Record<string, AccessLevelEnumApi | null> = {}
                    for (const rule of remoteState.access_controls) {
                        if (rule.organization_member) {
                            memberOverrides[rule.organization_member] = rule.access_level
                        } else if (rule.role) {
                            roleOverrides[rule.role] = rule.access_level
                        }
                    }
                    return {
                        defaultLevel: remoteState.default_access_level as AccessLevelEnumApi,
                        memberOverrides,
                        roleOverrides,
                    }
                },
                setLocalDefaultLevel: (state, { level }) => (state ? { ...state, defaultLevel: level } : state),
                setLocalMemberOverride: (state, { memberId, level }) =>
                    state ? { ...state, memberOverrides: { ...state.memberOverrides, [memberId]: level } } : state,
                setLocalRoleOverride: (state, { roleId, level }) =>
                    state ? { ...state, roleOverrides: { ...state.roleOverrides, [roleId]: level } } : state,
                resetLocalState: () => null,
            },
        ],
        activeTab: [
            'members' as string,
            {
                setActiveTab: (_, { tab }) => tab,
            },
        ],
    }),

    selectors({
        defaultLevel: [
            (s) => [s.localState],
            (localState: LocalAccessControlState | null): AccessLevelEnumApi =>
                localState?.defaultLevel ?? 'read_write',
        ],
        memberOverrides: [
            (s) => [s.localState],
            (localState: LocalAccessControlState | null): Record<string, AccessLevelEnumApi | null> =>
                localState?.memberOverrides ?? {},
        ],
        roleOverrides: [
            (s) => [s.localState],
            (localState: LocalAccessControlState | null): Record<string, AccessLevelEnumApi | null> =>
                localState?.roleOverrides ?? {},
        ],
        allMembers: [
            () => [membersLogic.selectors.members],
            (
                members: import('../../../types').OrganizationMemberType[] | null
            ): { id: string; first_name: string; last_name: string; email: string }[] =>
                (members ?? []).map((member: any) => ({
                    id: member.id,
                    first_name: member.user?.first_name ?? '',
                    last_name: member.user?.last_name ?? '',
                    email: member.user?.email ?? '',
                })),
        ],
        allRoles: [
            () => [rolesLogic.selectors.roles],
            (roles: import('../../../types').RoleType[]): { id: string; name: string; members: any[] }[] =>
                (roles ?? []).map((role: any) => ({
                    id: role.id,
                    name: role.name,
                    members: (role.members ?? []).map((m: any) => ({
                        id: m.id,
                        first_name: m.user?.first_name ?? '',
                        last_name: m.user?.last_name ?? '',
                        email: m.user?.email ?? '',
                    })),
                })),
        ],
        hasChanges: [
            (s) => [s.localState, s.remoteState],
            (
                localState: LocalAccessControlState | null,
                remoteState: PropertyAccessControlStateApi | null
            ): boolean => {
                if (!localState || !remoteState) {
                    return false
                }
                // Check default level
                if (localState.defaultLevel !== remoteState.default_access_level) {
                    return true
                }
                // Build remote overrides for comparison
                const remoteMemberOverrides: Record<string, string> = {}
                const remoteRoleOverrides: Record<string, string> = {}
                for (const rule of remoteState.access_controls) {
                    if (rule.organization_member) {
                        remoteMemberOverrides[rule.organization_member] = rule.access_level
                    } else if (rule.role) {
                        remoteRoleOverrides[rule.role] = rule.access_level
                    }
                }
                // Check member overrides
                const allMemberIds = new Set([
                    ...Object.keys(localState.memberOverrides),
                    ...Object.keys(remoteMemberOverrides),
                ])
                for (const id of allMemberIds) {
                    const local = localState.memberOverrides[id] ?? undefined
                    const remote = remoteMemberOverrides[id] ?? undefined
                    if (local !== remote) {
                        return true
                    }
                }
                // Check role overrides
                const allRoleIds = new Set([
                    ...Object.keys(localState.roleOverrides),
                    ...Object.keys(remoteRoleOverrides),
                ])
                for (const id of allRoleIds) {
                    const local = localState.roleOverrides[id] ?? undefined
                    const remote = remoteRoleOverrides[id] ?? undefined
                    if (local !== remote) {
                        return true
                    }
                }
                return false
            },
        ],
    }),

    listeners(({ values, actions, props }) => ({
        setLocalDefaultLevel: ({ level }) => {
            captureAccessControlEvent('access_control_property_default_level_changed', {
                property_definition_id: props.propertyDefinitionId,
                access_level: level,
            })
        },
        setLocalMemberOverride: ({ level }) => {
            captureAccessControlEvent('access_control_property_override_changed', {
                property_definition_id: props.propertyDefinitionId,
                subject: 'member',
                action: level === null ? 'removed' : 'changed',
                access_level: level,
            })
        },
        setLocalRoleOverride: ({ level }) => {
            captureAccessControlEvent('access_control_property_override_changed', {
                property_definition_id: props.propertyDefinitionId,
                subject: 'role',
                action: level === null ? 'removed' : 'changed',
                access_level: level,
            })
        },
        saveAccessControls: async () => {
            if (!values.localState || !values.remoteState) {
                return
            }
            const teamId = String(props.teamId)

            // Save default level if changed
            if (values.localState.defaultLevel !== values.remoteState.default_access_level) {
                await propertyAccessControlsCreate(teamId, {
                    property_definition_id: props.propertyDefinitionId,
                    access_level: values.localState.defaultLevel,
                })
            }

            // Build remote override maps for diffing
            const remoteMemberOverrides: Record<string, string> = {}
            const remoteRoleOverrides: Record<string, string> = {}
            for (const rule of values.remoteState.access_controls) {
                if (rule.organization_member) {
                    remoteMemberOverrides[rule.organization_member] = rule.access_level
                } else if (rule.role) {
                    remoteRoleOverrides[rule.role] = rule.access_level
                }
            }

            // Save member override changes
            for (const [memberId, level] of Object.entries(values.localState.memberOverrides)) {
                const remoteLevel = remoteMemberOverrides[memberId] ?? undefined
                if (level !== null && level !== remoteLevel) {
                    await propertyAccessControlsCreate(teamId, {
                        property_definition_id: props.propertyDefinitionId,
                        access_level: level,
                        organization_member: memberId,
                    })
                }
            }
            // Handle removed member overrides (was in remote but set to null locally)
            for (const memberId of Object.keys(remoteMemberOverrides)) {
                if (values.localState.memberOverrides[memberId] === null) {
                    await propertyAccessControlsDestroy(teamId, {
                        property_definition_id: props.propertyDefinitionId,
                        organization_member: memberId,
                    })
                }
            }

            // Save role override changes
            for (const [roleId, level] of Object.entries(values.localState.roleOverrides)) {
                const remoteLevel = remoteRoleOverrides[roleId] ?? undefined
                if (level !== null && level !== remoteLevel) {
                    await propertyAccessControlsCreate(teamId, {
                        property_definition_id: props.propertyDefinitionId,
                        access_level: level,
                        role: roleId,
                    })
                }
            }
            // Handle removed role overrides
            for (const roleId of Object.keys(remoteRoleOverrides)) {
                if (values.localState.roleOverrides[roleId] === null) {
                    await propertyAccessControlsDestroy(teamId, {
                        property_definition_id: props.propertyDefinitionId,
                        role: roleId,
                    })
                }
            }

            captureAccessControlEvent('access_control_property_settings_saved', {
                property_definition_id: props.propertyDefinitionId,
                default_access_level: values.localState.defaultLevel,
                default_changed: values.localState.defaultLevel !== values.remoteState.default_access_level,
                member_overrides: Object.values(values.localState.memberOverrides).filter((l) => l !== null).length,
                role_overrides: Object.values(values.localState.roleOverrides).filter((l) => l !== null).length,
            })

            // Reload remote state to sync
            actions.loadRemoteState()
        },
    })),

    afterMount(({ actions }) => {
        actions.loadRemoteState()
        membersLogic.actions.ensureAllMembersLoaded()
        rolesLogic.actions.loadRoles()
    }),
])