Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions frontend/src/scenes/settings/SettingsMap.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ import { OrganizationDesktopBetaTerms } from './organization/OrgDesktopBetaTerms
import { OrganizationDisplayName } from './organization/OrgDisplayName'
import { OrgIPAnonymizationDefault } from './organization/OrgIPAnonymizationDefault'
import { OrganizationVariables } from './organization/OrgVariables'
import { OrganizationSSF } from './organization/ssf/OrganizationSSF'
import { EnforceVerifiedDomains } from './organization/VerifiedDomains/EnforceVerifiedDomains'
import { VerifiedDomains } from './organization/VerifiedDomains/VerifiedDomains'
import { ProjectDangerZone } from './project/ProjectDangerZone'
Expand Down Expand Up @@ -2353,6 +2354,20 @@ export const SETTINGS_MAP: SettingSection[] = [
},
],
},
{
level: 'organization',
id: 'organization-ssf',
title: 'Shared Signals Framework (SSF)',
settings: [
{
id: 'ssf-configuration',
title: 'Configuration',
description: 'Configure organization-wide security event sharing with trusted services.',
component: <OrganizationSSF />,
keywords: ['ssf', 'shared signals', 'security events', 'caep', 'identity provider'],
},
],
},
{
level: 'organization',
id: 'organization-billing',
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
import { MOCK_DEFAULT_ORGANIZATION, MOCK_DEFAULT_USER } from 'lib/api.mock'

import type { Meta, StoryObj } from '@storybook/react'
import { router } from 'kea-router'

import { OrganizationMembershipLevel } from 'lib/constants'
import { App } from 'scenes/App'
import { urls } from 'scenes/urls'

import { SSFStreamStatusEnumApi } from '~/generated/core/api.schemas'
import { mswDecorator } from '~/mocks/browser'
import { billingJson } from '~/mocks/fixtures/_billing'
import { AvailableFeature } from '~/types'

import { OrganizationSSF } from './OrganizationSSF'
import {
SSF_INCOMING_CONNECTION,
SSF_INCOMING_STREAM,
SSF_OUTGOING_CONNECTION,
SSF_OUTGOING_STREAM,
SSF_SETTINGS,
} from './ssfSettingsFixtures'

const user = {
...MOCK_DEFAULT_USER,
organization: {
...MOCK_DEFAULT_ORGANIZATION,
membership_level: OrganizationMembershipLevel.Admin,
available_product_features: [{ key: AvailableFeature.SSF, name: 'Shared Signals Framework' }],
},
}

const configured = {
get: {
'/api/organizations/:id/ssf': SSF_SETTINGS,
'/api/organizations/:id/ssf/connections': [SSF_INCOMING_CONNECTION, SSF_OUTGOING_CONNECTION],
'/api/organizations/:id/ssf/streams': [
{ ...SSF_INCOMING_STREAM, last_verified_at: '2026-10-23T11:55:00Z' },
{
...SSF_INCOMING_STREAM,
id: '01980000-0000-4000-8000-000000000013',
description: 'Device security events',
remote_stream_id: 'upstream-stream-two',
endpoint_url:
'https://posthog.example.com/ssf/example-organization/events/01980000-0000-4000-8000-000000000013',
},
SSF_OUTGOING_STREAM,
],
},
}

const meta: Meta<typeof OrganizationSSF> = {
title: 'Scenes-App/Settings/Shared signals',
component: OrganizationSSF,
parameters: { mockDate: '2026-10-23T12:00:00Z' },
decorators: [
mswDecorator({
get: {
'/api/users/@me': user,
'/api/organizations/@current': user.organization,
'/api/organizations/:id/ssf': { ...SSF_SETTINGS, enabled: false },
'/api/organizations/:id/ssf/connections': [],
'/api/organizations/:id/ssf/streams': [],
},
patch: {
'/api/organizations/:id/ssf/configuration': async ({ request }) => [
200,
{ ...SSF_SETTINGS, ...((await request.json()) as object) },
],
'/api/organizations/:id/ssf/streams/:stream': async ({ request }) => [
200,
{ ...SSF_INCOMING_STREAM, ...((await request.json()) as object) },
],
'/api/organizations/:id/ssf/connections/:connection': async ({ request }) => [
200,
{ ...SSF_INCOMING_CONNECTION, ...((await request.json()) as object) },
],
},
post: {
'/api/organizations/:id/ssf/connections': [201, SSF_INCOMING_CONNECTION],
'/api/organizations/:id/ssf/connections/:connection/rotate_token': {
token: 'phssf_example_not_a_real_credential',
},
'/api/organizations/:id/ssf/connections/:connection/refresh': SSF_INCOMING_CONNECTION,
'/api/organizations/:id/ssf/streams': [201, SSF_INCOMING_STREAM],
'/api/organizations/:id/ssf/streams/:stream/verify': {
...SSF_INCOMING_STREAM,
verification_pending: true,
},
'/api/organizations/:id/ssf/streams/:stream/provision': SSF_INCOMING_STREAM,
'/api/organizations/:id/ssf/streams/:stream/status': SSF_INCOMING_STREAM,
'/api/organizations/:id/ssf/rotate_key': SSF_SETTINGS,
},
}),
],
render: () => (
<div className="p-4 max-w-240">
<OrganizationSSF />
</div>
),
}
export default meta

type Story = StoryObj<typeof OrganizationSSF>

export const Unconfigured: Story = {}

export const Configured: Story = { decorators: [mswDecorator(configured)] }

export const StandalonePage: Story = {
decorators: [mswDecorator(configured)],
parameters: { layout: 'fullscreen' },
render: () => {
router.actions.push(urls.settings('organization-ssf'))
return <App />
},
}

export const NeedsUpgrade: Story = {
decorators: [
mswDecorator({
get: {
'/api/users/@me': { ...user, organization: { ...user.organization, available_product_features: [] } },
'/api/organizations/@current': { ...user.organization, available_product_features: [] },
'/api/billing': {
...billingJson,
products: billingJson.products.map((product, index) =>
index === 0
? {
...product,
features: [
...product.features,
{ key: AvailableFeature.SSF, name: 'Shared Signals Framework (SSF)' },
],
}
: product
),
},
},
}),
],
}

export const ReadOnly: Story = {
decorators: [
mswDecorator({
get: {
...configured.get,
'/api/users/@me': {
...user,
organization: { ...user.organization, membership_level: OrganizationMembershipLevel.Member },
},
'/api/organizations/@current': {
...user.organization,
membership_level: OrganizationMembershipLevel.Member,
},
},
}),
],
}

export const Narrow: Story = {
decorators: [mswDecorator(configured)],
render: () => (
<div className="p-4 w-130">
<OrganizationSSF />
</div>
),
}

export const FailedSetup: Story = {
decorators: [
mswDecorator({
get: {
...configured.get,
'/api/organizations/:id/ssf/streams': [
{
...SSF_INCOMING_STREAM,
status: SSFStreamStatusEnumApi.Failed,
last_error: 'The transmitter returned HTTP 401. Check its URL and API credentials.',
},
],
},
}),
],
}

export const LoadFailure: Story = {
decorators: [
mswDecorator({
get: { '/api/organizations/:id/ssf': () => [500, { detail: 'Could not load configuration.' }] },
}),
],
}
110 changes: 110 additions & 0 deletions frontend/src/scenes/settings/organization/ssf/OrganizationSSF.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
import { MOCK_DEFAULT_ORGANIZATION, MOCK_DEFAULT_PROJECT, MOCK_DEFAULT_TEAM } from 'lib/api.mock'

import '@testing-library/jest-dom'

import { fireEvent, render, screen, waitFor } from '@testing-library/react'
import { expectLogic } from 'kea-test-utils'

import { billingLogic } from 'scenes/billing/billingLogic'

import type { PatchedSSFConfigurationApi } from '~/generated/core/api.schemas'
import { billingJson } from '~/mocks/fixtures/_billing'
import { useMocks } from '~/mocks/jest'
import { initKeaTests } from '~/test/init'
import { AvailableFeature } from '~/types'

import { OrganizationSSF } from './OrganizationSSF'
import { SSF_SETTINGS } from './ssfSettingsFixtures'

const ssfFeature = { key: AvailableFeature.SSF, name: 'Shared Signals Framework (SSF)' }

describe('OrganizationSSF', () => {
it.each([
{ entitled: false, catalogIncludesSSF: true, expectedText: ssfFeature.name },
{ entitled: false, catalogIncludesSSF: false, expectedText: /Your plan does not include SSF/ },
{ entitled: true, catalogIncludesSSF: true, expectedText: 'Enable SSF' },
])(
'gates configuration with entitlement=$entitled and billing metadata=$catalogIncludesSSF',
async ({ entitled, catalogIncludesSSF, expectedText }) => {
let configurationRequests = 0
let configuration = SSF_SETTINGS
const updates: unknown[] = []
let finishSave!: () => void
const pendingSave = new Promise<void>((resolve) => {
finishSave = resolve
})
useMocks({
get: {
'/api/billing': {
...billingJson,
products: billingJson.products.map((product, index) =>
catalogIncludesSSF && index === 0
? { ...product, features: [...product.features, ssfFeature] }
: product
),
},
'/api/organizations/:organization/ssf': () => {
configurationRequests++
return [200, configuration]
},
'/api/organizations/:organization/ssf/connections': () => {
configurationRequests++
return [200, []]
},
'/api/organizations/:organization/ssf/streams': () => {
configurationRequests++
return [200, []]
},
},
patch: {
'/api/organizations/:organization/ssf/configuration': async ({ request }) => {
const update = (await request.json()) as PatchedSSFConfigurationApi
updates.push(update)
await pendingSave
configuration = { ...configuration, ...update }
return [200, configuration]
},
},
})
initKeaTests(true, MOCK_DEFAULT_TEAM, MOCK_DEFAULT_PROJECT, {
...MOCK_DEFAULT_ORGANIZATION,
available_product_features: entitled ? [ssfFeature] : [],
})
billingLogic.mount()
await expectLogic(billingLogic, () => billingLogic.actions.loadBilling()).toFinishAllListeners()

render(<OrganizationSSF />)
expect(await screen.findByText(expectedText)).toBeInTheDocument()
expect(configurationRequests).toBe(entitled ? 3 : 0)
if (!entitled) {
expect(screen.queryByText('Connections')).not.toBeInTheDocument()
expect(screen.queryByText('Save')).not.toBeInTheDocument()
} else {
const toggle = (): HTMLElement => screen.getByLabelText('Enable SSF')
fireEvent.click(toggle())
await waitFor(() => expect(updates).toEqual([{ enabled: false }]))
expect(toggle()).toBeDisabled()
expect(toggle()).toHaveAttribute('aria-checked', 'true')
fireEvent.click(toggle())
expect(updates).toHaveLength(1)
finishSave()
await waitFor(() => expect(screen.queryByText('Connections')).not.toBeInTheDocument())
for (const label of [
'Additional outgoing event types',
'Save',
'Streams',
'Transmitter discovery',
'Rotate signing key',
]) {
expect(screen.queryByText(label)).not.toBeInTheDocument()
}
expect(toggle()).toHaveAttribute('aria-checked', 'false')
expect(toggle()).not.toBeDisabled()
fireEvent.click(toggle())
expect(await screen.findByText('Connections')).toBeInTheDocument()
expect(screen.getByText('Additional outgoing event types')).toBeInTheDocument()
expect(updates).toEqual([{ enabled: false }, { enabled: true }])
}
}
)
})
31 changes: 31 additions & 0 deletions frontend/src/scenes/settings/organization/ssf/OrganizationSSF.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { useValues } from 'kea'

import { LemonBanner, Link } from '@posthog/lemon-ui'

import { PayGateMini } from 'lib/components/PayGateMini/PayGateMini'
import { organizationLogic } from 'scenes/organizationLogic'
import { urls } from 'scenes/urls'
import { userLogic } from 'scenes/userLogic'

import { AvailableFeature } from '~/types'

import { SSFConfiguration } from './SSFConfiguration'

export function OrganizationSSF(): JSX.Element {
const { currentOrganization } = useValues(organizationLogic)
const { hasAvailableFeature } = useValues(userLogic)

return (
<PayGateMini feature={AvailableFeature.SSF} featureDetail="organization-ssf">
{!hasAvailableFeature(AvailableFeature.SSF) ? (
<LemonBanner type="info">
Your plan does not include SSF.{' '}
<Link to={urls.organizationBilling()}>Review your billing plan</Link> to enable security event
sharing.
</LemonBanner>
) : currentOrganization ? (
<SSFConfiguration organizationId={currentOrganization.id} />
) : null}
</PayGateMini>
)
}
Loading
Loading