: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.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import { expectLogic } from 'kea-test-utils'
import { dayjs } from 'lib/dayjs'
import { initKeaTests } from '~/test/init'
import { AnnotationScope, AnnotationType } from '~/types'
import * as generatedApi from '../generated/api'
import type { AnnotationApi } from '../generated/api.schemas'
import { annotationModalLogic } from './annotationModalLogic'
describe('annotationModalLogic', () => {
let updateSpy: jest.SpyInstance
beforeEach(() => {
initKeaTests()
updateSpy = jest.spyOn(generatedApi, 'annotationsPartialUpdate').mockResolvedValue({ id: 1 } as AnnotationApi)
})
afterEach(() => {
updateSpy.mockRestore()
})
it.each([
{
name: 'omits the stored insight when edited off an insight',
stored: { scope: AnnotationScope.Organization, dashboard_item: 99 },
insightId: null,
dashboardId: null,
newScope: null,
expected: { scope: AnnotationScope.Organization, dashboard_id: null },
absent: ['dashboard_item'],
},
{
name: 'moves the annotation to the insight it is edited from',
stored: { scope: AnnotationScope.Project, dashboard_item: 99 },
insightId: 7,
dashboardId: null,
newScope: AnnotationScope.Insight,
expected: { scope: AnnotationScope.Insight, dashboard_item: 7 },
absent: [],
},
{
name: 'takes the open dashboard when a row without one moves to dashboard scope',
stored: { scope: AnnotationScope.Project, dashboard_id: null },
insightId: 7,
dashboardId: 5,
newScope: AnnotationScope.Dashboard,
expected: { scope: AnnotationScope.Dashboard, dashboard_id: 5 },
absent: [],
},
{
name: 'keeps a project row off the dashboard it is edited from',
stored: { scope: AnnotationScope.Project, dashboard_id: null },
insightId: 7,
dashboardId: 5,
newScope: null,
expected: { scope: AnnotationScope.Project, dashboard_id: null },
absent: [],
},
])('$name', async ({ stored, insightId, dashboardId, newScope, expected, absent }) => {
const annotation: AnnotationType = {
id: 1,
content: 'Release',
date_marker: dayjs('2024-01-01T00:00:00Z'),
created_at: dayjs('2024-01-01T00:00:00Z'),
updated_at: '2024-01-01T00:00:00Z',
dashboard_item: null,
dashboard_id: null,
...stored,
}
const logic = annotationModalLogic()
logic.mount()
logic.actions.openModalToEditAnnotation(annotation, insightId, dashboardId)
if (newScope) {
logic.actions.setAnnotationModalValue('scope', newScope)
}
logic.actions.submitAnnotationModal()
await expectLogic(logic).toFinishAllListeners()
expect(updateSpy).toHaveBeenCalledTimes(1)
const body = updateSpy.mock.calls[0][2]
expect(body).toMatchObject(expected)
for (const key of absent) {
expect(body).not.toHaveProperty(key)
}
})
})