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.

9.2 KB
Raw Blame
import { MakeLogicType, actions, afterMount, connect, kea, listeners, path, reducers, selectors } from 'kea'
import { loaders } from 'kea-loaders'

import { lemonToast } from 'lib/lemon-ui/LemonToast/LemonToast'
import { projectLogic } from 'scenes/projectLogic'

import { sandboxCreate, sandboxDestroy, sandboxList, sandboxPartialUpdate } from 'products/tasks/frontend/generated/api'
import {
    type SandboxEnvironmentDTOApi,
    SandboxEnvironmentNetworkAccessLevelEnumApi,
} from 'products/tasks/frontend/generated/api.schemas'

export interface CloudEnvironmentDraft {
    id: string | null
    name: string
    network_access_level: SandboxEnvironmentNetworkAccessLevelEnumApi
    allowed_domains: string[]
    include_default_domains: boolean
    repositories: string[]
    private: boolean
    custom_image_id: string | null
}

const NEW_ENVIRONMENT: CloudEnvironmentDraft = {
    id: null,
    name: '',
    network_access_level: SandboxEnvironmentNetworkAccessLevelEnumApi.Trusted,
    allowed_domains: [],
    include_default_domains: true,
    repositories: [],
    private: true,
    custom_image_id: null,
}

export async function listAllPages<T>(
    fetchPage: (params: { limit: number; offset: number }) => Promise<{ count: number; results: T[] }>
): Promise<T[]> {
    const items: T[] = []
    let count = Infinity
    while (items.length < count) {
        const page = await fetchPage({ limit: 100, offset: items.length })
        items.push(...page.results)
        count = page.results.length > 0 ? page.count : items.length
    }
    return items
}

function isNetworkAccessLevel(value: string): value is SandboxEnvironmentNetworkAccessLevelEnumApi {
    return (Object.values(SandboxEnvironmentNetworkAccessLevelEnumApi) as string[]).includes(value)
}

export function draftFromEnvironment(environment: SandboxEnvironmentDTOApi): CloudEnvironmentDraft {
    return {
        id: environment.id,
        name: environment.name,
        network_access_level: isNetworkAccessLevel(environment.network_access_level)
            ? environment.network_access_level
            : SandboxEnvironmentNetworkAccessLevelEnumApi.Full,
        allowed_domains: environment.allowed_domains ?? [],
        include_default_domains: environment.include_default_domains,
        repositories: environment.repositories ?? [],
        private: environment.private,
        custom_image_id: environment.custom_image_id ?? null,
    }
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface cloudEnvironmentsLogicValues {
    currentProjectId: number | null // projectLogic
    draft: CloudEnvironmentDraft | null
    draftError: string | null
    draftSaving: boolean
    environments: SandboxEnvironmentDTOApi[] | null
    environmentsFailed: boolean
    environmentsLoading: boolean
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface cloudEnvironmentsLogicActions {
    closeDraft: () => {
        value: true
    }
    deleteEnvironment: (environment: SandboxEnvironmentDTOApi) => {
        environment: SandboxEnvironmentDTOApi
    }
    editEnvironment: (environment: SandboxEnvironmentDTOApi) => {
        environment: SandboxEnvironmentDTOApi
    }
    environmentCreated: (environment: SandboxEnvironmentDTOApi) => {
        environment: SandboxEnvironmentDTOApi
    }
    loadEnvironments: () => any
    loadEnvironmentsFailure: (
        error: string,
        errorObject?: any
    ) => {
        error: string
        errorObject?: any
    }
    loadEnvironmentsSuccess: (
        environments: SandboxEnvironmentDTOApi[] | null,
        payload?: any
    ) => {
        environments: SandboxEnvironmentDTOApi[] | null
        payload?: any
    }
    saveDraft: () => {
        value: true
    }
    saveDraftDone: () => {
        value: true
    }
    startNewEnvironment: () => {
        value: true
    }
    updateDraft: (changes: Partial<CloudEnvironmentDraft>) => {
        changes: Partial<CloudEnvironmentDraft>
    }
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface cloudEnvironmentsLogicMeta {
    __keaTypeGenInternalSelectorTypes: {
        draftError: (draft: CloudEnvironmentDraft | null) => string | null
    }
}

export type cloudEnvironmentsLogicType = MakeLogicType<
    cloudEnvironmentsLogicValues,
    cloudEnvironmentsLogicActions,
    Record<string, any>,
    cloudEnvironmentsLogicMeta
>

export const cloudEnvironmentsLogic = kea<cloudEnvironmentsLogicType>([
    path(['scenes', 'settings', 'environment', 'cloudEnvironmentsLogic']),
    connect(() => ({
        values: [projectLogic, ['currentProjectId']],
    })),
    actions({
        startNewEnvironment: true,
        editEnvironment: (environment: SandboxEnvironmentDTOApi) => ({ environment }),
        updateDraft: (changes: Partial<CloudEnvironmentDraft>) => ({ changes }),
        closeDraft: true,
        saveDraft: true,
        saveDraftDone: true,
        environmentCreated: (environment: SandboxEnvironmentDTOApi) => ({ environment }),
        deleteEnvironment: (environment: SandboxEnvironmentDTOApi) => ({ environment }),
    }),
    loaders(({ values }) => ({
        environments: [
            null as SandboxEnvironmentDTOApi[] | null,
            {
                loadEnvironments: async (): Promise<SandboxEnvironmentDTOApi[] | null> => {
                    if (values.currentProjectId == null) {
                        return null
                    }
                    const projectId = String(values.currentProjectId)
                    return await listAllPages((params) => sandboxList(projectId, params))
                },
            },
        ],
    })),
    reducers({
        environments: {
            environmentCreated: (state, { environment }) => [
                ...(state ?? []).filter((existing) => existing.id !== environment.id),
                environment,
            ],
        },
        draft: [
            null as CloudEnvironmentDraft | null,
            {
                startNewEnvironment: () => NEW_ENVIRONMENT,
                editEnvironment: (_, { environment }) => draftFromEnvironment(environment),
                updateDraft: (draft, { changes }) => (draft ? { ...draft, ...changes } : draft),
                closeDraft: () => null,
            },
        ],
        draftSaving: [
            false,
            {
                saveDraft: () => true,
                saveDraftDone: () => false,
                closeDraft: () => false,
            },
        ],
        environmentsFailed: [
            false,
            {
                loadEnvironments: () => false,
                loadEnvironmentsSuccess: () => false,
                loadEnvironmentsFailure: () => true,
            },
        ],
    }),
    selectors({
        draftError: [
            (s) => [s.draft],
            (draft: CloudEnvironmentDraft | null): string | null => {
                if (!draft) {
                    return null
                }
                if (!draft.name.trim()) {
                    return 'Enter a name'
                }
                if (
                    draft.network_access_level === SandboxEnvironmentNetworkAccessLevelEnumApi.Custom &&
                    draft.allowed_domains.length === 0 &&
                    !draft.include_default_domains
                ) {
                    return 'Add at least one allowed domain'
                }
                return null
            },
        ],
    }),
    listeners(({ actions, values }) => ({
        saveDraft: async () => {
            const { draft, currentProjectId } = values
            if (!draft || currentProjectId == null || values.draftError) {
                actions.saveDraftDone()
                return
            }
            const body = {
                name: draft.name.trim(),
                network_access_level: draft.network_access_level,
                allowed_domains: draft.allowed_domains,
                include_default_domains: draft.include_default_domains,
                repositories: draft.repositories,
                private: draft.private,
                custom_image_id: draft.custom_image_id,
            }
            try {
                if (draft.id) {
                    await sandboxPartialUpdate(String(currentProjectId), draft.id, body)
                } else {
                    actions.environmentCreated(await sandboxCreate(String(currentProjectId), body))
                }
                lemonToast.success(draft.id ? 'Environment saved' : 'Environment created')
                actions.closeDraft()
                actions.loadEnvironments()
            } catch (error: any) {
                lemonToast.error(error?.detail ?? 'The environment did not save. Try again.')
                actions.saveDraftDone()
            }
        },
        deleteEnvironment: async ({ environment }) => {
            if (values.currentProjectId == null) {
                return
            }
            try {
                await sandboxDestroy(String(values.currentProjectId), environment.id)
                lemonToast.success('Environment deleted')
                actions.loadEnvironments()
            } catch {
                lemonToast.error('The environment was not deleted. Try again.')
            }
        },
    })),
    afterMount(({ actions }) => {
        actions.loadEnvironments()
    }),
])