: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 { MOCK_TEAM_ID } from 'lib/api.mock'
import { router } from 'kea-router'
import { expectLogic } from 'kea-test-utils'
import posthog from 'posthog-js'
import { useMocks } from '~/mocks/jest'
import { initKeaTests } from '~/test/init'
import {
RecurrenceIntervalEnumApi,
SubscriptionResourceTypeEnumApi,
SubscriptionsDeliveriesListStatus,
SubscriptionTargetEnumApi,
} from 'products/subscriptions/frontend/generated/api.schemas'
import type { SubscriptionApi } from 'products/subscriptions/frontend/generated/api.schemas'
import { NEGATIVE_FEEDBACK_SURVEY_ID, subscriptionSceneLogic } from './subscriptionSceneLogic'
const MOCK_USER = {
id: 1,
uuid: '01863799-062b-0000-8a61-b2842d5f8642',
email: '[email protected]',
first_name: 'Test',
last_name: 'User',
hedgehog_config: null,
} as const
const MOCK_SUBSCRIPTION: SubscriptionApi = {
id: 1,
resource_type: SubscriptionResourceTypeEnumApi.Insight,
insight: 101,
dashboard: null,
insight_short_id: 'abc123',
resource_name: 'North star metric',
contexts: [],
title: 'Weekly rollup',
dashboard_export_insights: [],
target_type: SubscriptionTargetEnumApi.Email,
target_value: '[email protected]',
frequency: RecurrenceIntervalEnumApi.Weekly,
interval: 1,
start_date: '2022-01-01T00:00:00Z',
created_at: '2023-04-27T10:04:37.977401Z',
created_by: MOCK_USER,
summary: 'sent every week',
next_delivery_date: '2026-04-07T17:00:00Z',
deleted: false,
ai_query_plan_status: null,
}
const MOCK_AI_SUBSCRIPTION: SubscriptionApi = {
id: 2,
resource_type: SubscriptionResourceTypeEnumApi.AiPrompt,
insight: null,
dashboard: null,
insight_short_id: null,
resource_name: null,
contexts: [],
prompt: 'Summarize weekly signups and flag any anomalies',
title: 'Weekly AI digest',
dashboard_export_insights: [],
target_type: SubscriptionTargetEnumApi.Email,
target_value: '[email protected]',
frequency: RecurrenceIntervalEnumApi.Weekly,
interval: 1,
start_date: '2022-01-01T00:00:00Z',
created_at: '2023-04-27T10:04:37.977401Z',
created_by: MOCK_USER,
summary: 'sent every week',
next_delivery_date: '2026-04-07T17:00:00Z',
deleted: false,
ai_query_plan_status: null,
}
describe('subscriptionSceneLogic', () => {
let deliveriesRequestUrls: string[]
beforeEach(() => {
deliveriesRequestUrls = []
// deliveryFeedback persists to localStorage; clear it so recorded feedback can't leak between tests.
localStorage.clear()
})
it('includes status in deliveries list request when status filter is set', async () => {
useMocks({
get: {
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/1/`]: [200, MOCK_SUBSCRIPTION],
[`/api/environments/${MOCK_TEAM_ID}/subscriptions/1/deliveries/`]: ({ request }) => {
deliveriesRequestUrls.push(request.url)
return [200, { results: [], next: null, previous: null }]
},
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/1/deliveries/`]: ({ request }) => {
deliveriesRequestUrls.push(request.url)
return [200, { results: [], next: null, previous: null }]
},
},
})
initKeaTests()
const logic = subscriptionSceneLogic({ id: '1' })
logic.mount()
await expectLogic(logic).toFinishAllListeners()
expect(deliveriesRequestUrls).toHaveLength(1)
expect(deliveriesRequestUrls[0]).not.toContain('status=')
await expectLogic(logic, () => {
logic.actions.setDeliveryStatusFilter(SubscriptionsDeliveriesListStatus.Failed)
}).toFinishAllListeners()
expect(deliveriesRequestUrls).toHaveLength(2)
expect(deliveriesRequestUrls[1]).toContain('status=failed')
logic.unmount()
})
it('loads delivery history once the subscription has loaded', async () => {
useMocks({
get: {
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/1/`]: [200, MOCK_SUBSCRIPTION],
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/1/deliveries/`]: () => {
deliveriesRequestUrls.push('deliveries')
return [200, { results: [], next: null, previous: null }]
},
},
})
initKeaTests()
const logic = subscriptionSceneLogic({ id: '1' })
logic.mount()
await expectLogic(logic).toFinishAllListeners()
expect(deliveriesRequestUrls).toHaveLength(1)
logic.unmount()
})
it.each([
[403, true],
[404, false],
])('marks only a %s subscription load failure as access denied', async (status, subscriptionAccessDenied) => {
useMocks({
get: {
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/1/`]: () => [status, { detail: 'Request failed' }],
},
})
initKeaTests()
const logic = subscriptionSceneLogic({ id: '1' })
logic.mount()
await expectLogic(logic)
.toDispatchActions(['loadSubscriptionFailure'])
.toMatchValues({ subscriptionAccessDenied })
logic.unmount()
})
// The failure path matters too: the header button's double-submit guard would stick
// if deliveringSubscriptionId reset only on success.
it.each([
{ name: 'success', status: 202, terminalAction: 'deliverSubscriptionSuccess' },
{ name: 'failure', status: 500, terminalAction: 'deliverSubscriptionFailure' },
])('test delivery ($name) flips deliveringSubscriptionId then resets it', async ({ status, terminalAction }) => {
let testDeliveryCalls = 0
useMocks({
get: {
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/1/`]: [200, MOCK_SUBSCRIPTION],
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/1/deliveries/`]: [
200,
{ results: [], next: null, previous: null },
],
},
post: {
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/1/test-delivery/`]: () => {
testDeliveryCalls += 1
return [status, {}]
},
},
})
initKeaTests()
const logic = subscriptionSceneLogic({ id: '1' })
logic.mount()
await expectLogic(logic).toFinishAllListeners()
await expectLogic(logic, () => {
logic.actions.deliverSubscription(1)
}).toMatchValues({ deliveringSubscriptionId: 1 })
await expectLogic(logic).toDispatchActions([terminalAction]).toMatchValues({
deliveringSubscriptionId: null,
})
expect(testDeliveryCalls).toEqual(1)
logic.unmount()
})
it('loads an AI prompt subscription and its deliveries', async () => {
useMocks({
get: {
// Function form, not the `[200, body]` shorthand: useMocks serializes a bare array as
// the whole response body, so only a function-returned tuple delivers the object itself.
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/2/`]: () => [200, MOCK_AI_SUBSCRIPTION],
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/2/deliveries/`]: () => {
deliveriesRequestUrls.push('deliveries')
return [200, { results: [], next: null, previous: null }]
},
},
})
initKeaTests()
const logic = subscriptionSceneLogic({ id: '2' })
logic.mount()
await expectLogic(logic).toFinishAllListeners()
expect(logic.values.subscription?.resource_type).toEqual(SubscriptionResourceTypeEnumApi.AiPrompt)
expect(logic.values.subscription?.prompt).toBeTruthy()
expect(deliveriesRequestUrls).toHaveLength(1)
logic.unmount()
})
it.each([
['positive' as const, 'email'],
['negative' as const, 'slack'],
])('captures ai_report_feedback (%s, %s) from URL params and strips them', async (feedback, source) => {
useMocks({
get: {
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/2/`]: () => [200, MOCK_AI_SUBSCRIPTION],
},
})
initKeaTests()
const captureSpy = jest.spyOn(posthog, 'capture')
const displaySurveySpy = jest.spyOn(posthog, 'displaySurvey')
const logic = subscriptionSceneLogic({ id: '2' })
logic.mount()
await expectLogic(logic, () => {
router.actions.push('/subscriptions/2', {
feedback_delivery: 'd-123',
feedback,
feedback_source: source,
})
}).toFinishAllListeners()
expect(captureSpy).toHaveBeenCalledWith('ai_report_feedback', {
subscription_id: 2,
delivery_id: 'd-123',
feedback,
source,
previous_feedback: null,
})
// The "what was wrong?" survey opens only on a downvote, and this Slack/email flow must
// show it before the redirect strips the feedback params.
const expectedSurveyCalls = feedback === 'negative' ? [[NEGATIVE_FEEDBACK_SURVEY_ID]] : []
expect(displaySurveySpy.mock.calls).toEqual(expectedSurveyCalls)
// A feedback landing is also a click-through on the delivered report.
expect(captureSpy).toHaveBeenCalledWith('ai_report_clicked', {
subscription_id: 2,
delivery_id: 'd-123',
link: 'feedback',
source,
})
// The replace must remove the params so a refresh doesn't double-capture.
expect(router.values.searchParams).toEqual({})
expect(captureSpy.mock.calls.filter(([event]) => event === 'ai_report_feedback')).toHaveLength(1)
logic.unmount()
captureSpy.mockRestore()
displaySurveySpy.mockRestore()
})
it('captures ai_report_clicked from the report CTA delivery param and strips it', async () => {
useMocks({
get: {
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/2/`]: () => [200, MOCK_AI_SUBSCRIPTION],
},
})
initKeaTests()
const captureSpy = jest.spyOn(posthog, 'capture')
const logic = subscriptionSceneLogic({ id: '2' })
logic.mount()
await expectLogic(logic, () => {
router.actions.push('/subscriptions/2', { delivery: 'd-123', utm_medium: 'email' })
}).toFinishAllListeners()
expect(captureSpy).toHaveBeenCalledWith('ai_report_clicked', {
subscription_id: 2,
delivery_id: 'd-123',
link: 'manage',
source: 'email',
})
expect(captureSpy.mock.calls.filter(([event]) => event === 'ai_report_feedback')).toHaveLength(0)
// Only the delivery param is consumed — utm params stay for posthog-js.
expect(router.values.searchParams).toEqual({ utm_medium: 'email' })
logic.unmount()
captureSpy.mockRestore()
})
it('does not re-capture from a feedback link for an already-recorded delivery', async () => {
useMocks({
get: {
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/2/`]: () => [200, MOCK_AI_SUBSCRIPTION],
},
})
initKeaTests()
const captureSpy = jest.spyOn(posthog, 'capture')
const displaySurveySpy = jest.spyOn(posthog, 'displaySurvey')
const logic = subscriptionSceneLogic({ id: '2' })
logic.mount()
await expectLogic(logic, () => {
logic.actions.submitDeliveryFeedback('d-123', 'positive', 'in_app')
}).toFinishAllListeners()
captureSpy.mockClear()
await expectLogic(logic, () => {
router.actions.push('/subscriptions/2', {
feedback_delivery: 'd-123',
feedback: 'negative',
feedback_source: 'email',
})
}).toFinishAllListeners()
expect(captureSpy.mock.calls.filter(([event]) => event === 'ai_report_feedback')).toHaveLength(0)
// The already-recorded delivery is skipped, so the survey isn't reshown on a re-click either.
expect(displaySurveySpy).not.toHaveBeenCalled()
// Params are still stripped, and the originally recorded feedback wins.
expect(router.values.searchParams).toEqual({})
expect(logic.values.deliveryFeedback).toEqual({ 'd-123': 'positive' })
logic.unmount()
captureSpy.mockRestore()
displaySurveySpy.mockRestore()
})
it('persists recorded feedback across remounts', async () => {
useMocks({
get: {
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/2/`]: () => [200, MOCK_AI_SUBSCRIPTION],
},
})
initKeaTests()
let logic = subscriptionSceneLogic({ id: '2' })
logic.mount()
await expectLogic(logic, () => {
logic.actions.submitDeliveryFeedback('d-9', 'positive', 'in_app')
}).toFinishAllListeners()
logic.unmount()
logic = subscriptionSceneLogic({ id: '2' })
logic.mount()
expect(logic.values.deliveryFeedback).toEqual({ 'd-9': 'positive' })
// The thanks flash is transient — after a remount the row goes straight to the recorded option.
expect(logic.values.recentlyThankedDeliveries).toEqual({})
logic.unmount()
})
it('captures in-app thumbs feedback and records it per delivery', async () => {
useMocks({
get: {
[`/api/projects/${MOCK_TEAM_ID}/subscriptions/2/`]: () => [200, MOCK_AI_SUBSCRIPTION],
},
})
initKeaTests()
const captureSpy = jest.spyOn(posthog, 'capture')
const displaySurveySpy = jest.spyOn(posthog, 'displaySurvey')
const logic = subscriptionSceneLogic({ id: '2' })
logic.mount()
await expectLogic(logic, () => {
logic.actions.submitDeliveryFeedback('d-9', 'negative', 'in_app')
}).toFinishAllListeners()
expect(captureSpy).toHaveBeenCalledWith('ai_report_feedback', {
subscription_id: 2,
delivery_id: 'd-9',
feedback: 'negative',
source: 'in_app',
previous_feedback: null,
})
// Downvoting from the in-app thumbs opens the follow-up survey too.
expect(displaySurveySpy).toHaveBeenCalledWith(NEGATIVE_FEEDBACK_SURVEY_ID)
expect(logic.values.deliveryFeedback).toEqual({ 'd-9': 'negative' })
// Thanks flashes first, then expiry settles the row into the recorded option.
expect(logic.values.recentlyThankedDeliveries).toEqual({ 'd-9': true })
await expectLogic(logic, () => {
logic.actions.expireDeliveryThanks('d-9')
}).toFinishAllListeners()
expect(logic.values.recentlyThankedDeliveries).toEqual({})
expect(logic.values.deliveryFeedback).toEqual({ 'd-9': 'negative' })
// Switching the vote captures again with the previous value, and the latest one wins.
await expectLogic(logic, () => {
logic.actions.submitDeliveryFeedback('d-9', 'positive', 'in_app')
}).toFinishAllListeners()
expect(captureSpy).toHaveBeenCalledWith('ai_report_feedback', {
subscription_id: 2,
delivery_id: 'd-9',
feedback: 'positive',
source: 'in_app',
previous_feedback: 'negative',
})
expect(logic.values.deliveryFeedback).toEqual({ 'd-9': 'positive' })
// Switching to a positive vote must not reopen the survey.
expect(displaySurveySpy).toHaveBeenCalledTimes(1)
logic.unmount()
captureSpy.mockRestore()
displaySurveySpy.mockRestore()
})
})