mirror of
https://github.com/hanzoai/insights.git
synced 2026-11-02 14:32:45 +00:00
The rule table mapped HOG_ -> FN_ ahead of any POSTHOG rule, so POSTHOG_FOO split into POST + HOG_ and came out POSTFN_FOO. Nothing sets that. The live pods set INSIGHTS_SKIP_MIGRATION_CHECKS, which bin/migrate-check reads on the container entrypoint, so the misspelling does not degrade a feature -- it runs migrate --check against a database whose history this tree does not share and the container never starts. Both replacements are measured against the shipped tree rather than chosen: every HOG_ name with a counterpart there is spelled INSIGHTS_ (HOG_QL -> INSIGHTS_QL, HOG_FUNCTION_TEMPLATES -> INSIGHTS_FUNCTION_TEMPLATES, 12 of 12 determinate cases), and FN_ appears in it nowhere. Upstream carries 95 HOG_ tokens and zero FN_ ones, so repairing FN_ back out is exactly the inverse of the bad rule and cannot collide with an upstream name. The rule is fixed for the next convergence, and the tree it already produced is repaired in the same commit -- the codemod is idempotent against its own output, so it cannot undo this itself.
196 lines
8.0 KiB
TypeScript
196 lines
8.0 KiB
TypeScript
import { z } from 'zod'
|
|
|
|
import { INSIGHT_ALERT_FIRING_EVENT_ID, INSIGHT_ALERT_FIRING_SUB_TEMPLATE_ID } from 'lib/constants'
|
|
import {
|
|
INSIGHTS_FUNCTION_SUB_TEMPLATES,
|
|
INSIGHTS_FUNCTION_SUB_TEMPLATE_COMMON_PROPERTIES,
|
|
} from 'scenes/insights-functions/sub-templates/sub-templates'
|
|
|
|
import { CyclotronJobFiltersType, InsightsFunctionType, PropertyFilterType, PropertyOperator } from '~/types'
|
|
|
|
export const ALERT_NOTIFICATION_TYPE_SLACK = 'slack' as const
|
|
export const ALERT_NOTIFICATION_TYPE_WEBHOOK = 'webhook' as const
|
|
export const ALERT_NOTIFICATION_TYPE_DISCORD = 'discord' as const
|
|
export const ALERT_NOTIFICATION_TYPE_MICROSOFT_TEAMS = 'microsoft_teams' as const
|
|
export type AlertNotificationType =
|
|
| typeof ALERT_NOTIFICATION_TYPE_SLACK
|
|
| typeof ALERT_NOTIFICATION_TYPE_WEBHOOK
|
|
| typeof ALERT_NOTIFICATION_TYPE_DISCORD
|
|
| typeof ALERT_NOTIFICATION_TYPE_MICROSOFT_TEAMS
|
|
|
|
const webhookUrlSchema = z.string().url()
|
|
|
|
export function getAlertNotificationAddDisabledReason(
|
|
selectedType: AlertNotificationType,
|
|
hasSlackIntegration: boolean,
|
|
slackChannelValue: string | null,
|
|
webhookUrl: string
|
|
): string | undefined {
|
|
if (selectedType === ALERT_NOTIFICATION_TYPE_SLACK) {
|
|
if (!hasSlackIntegration) {
|
|
return 'Connect Slack first'
|
|
}
|
|
if (!slackChannelValue) {
|
|
return 'Select a Slack channel'
|
|
}
|
|
return undefined
|
|
}
|
|
|
|
if (!webhookUrl) {
|
|
if (selectedType === ALERT_NOTIFICATION_TYPE_DISCORD) {
|
|
return 'Enter a Discord webhook URL'
|
|
}
|
|
if (selectedType === ALERT_NOTIFICATION_TYPE_MICROSOFT_TEAMS) {
|
|
return 'Enter a Microsoft Teams workflow URL'
|
|
}
|
|
return 'Enter a webhook URL'
|
|
}
|
|
|
|
if (!webhookUrlSchema.safeParse(webhookUrl).success) {
|
|
if (selectedType === ALERT_NOTIFICATION_TYPE_DISCORD) {
|
|
return 'Enter a valid Discord webhook URL'
|
|
}
|
|
if (selectedType === ALERT_NOTIFICATION_TYPE_MICROSOFT_TEAMS) {
|
|
return 'Enter a valid Microsoft Teams workflow URL'
|
|
}
|
|
return 'Enter a valid webhook URL'
|
|
}
|
|
|
|
return undefined
|
|
}
|
|
|
|
// Single source of truth for which destination InsightsFunction template each notification type uses.
|
|
// buildAlertDestination reads it when creating a destination; notificationTypeFromTemplateId inverts
|
|
// it to label an existing one. Keeping both directions off one map avoids the two drifting apart.
|
|
const TEMPLATE_ID_BY_NOTIFICATION_TYPE: Record<AlertNotificationType, string> = {
|
|
[ALERT_NOTIFICATION_TYPE_SLACK]: 'template-slack',
|
|
[ALERT_NOTIFICATION_TYPE_DISCORD]: 'template-discord',
|
|
[ALERT_NOTIFICATION_TYPE_MICROSOFT_TEAMS]: 'template-microsoft-teams',
|
|
[ALERT_NOTIFICATION_TYPE_WEBHOOK]: 'template-webhook',
|
|
}
|
|
|
|
// Maps a destination InsightsFunction's template_id back to the notification type, so analytics and
|
|
// UI code can label an existing destination without re-deriving it from inputs.
|
|
export const notificationTypeFromTemplateId = (templateId?: string | null): AlertNotificationType | null => {
|
|
const match = Object.entries(TEMPLATE_ID_BY_NOTIFICATION_TYPE).find(([, id]) => id === templateId)
|
|
return match ? (match[0] as AlertNotificationType) : null
|
|
}
|
|
|
|
export const buildAlertFilterConfig = (alertId: string): CyclotronJobFiltersType => ({
|
|
properties: [
|
|
{
|
|
key: 'alert_id',
|
|
value: alertId,
|
|
operator: PropertyOperator.Exact,
|
|
type: PropertyFilterType.Event,
|
|
},
|
|
],
|
|
events: [
|
|
{
|
|
id: INSIGHT_ALERT_FIRING_EVENT_ID,
|
|
type: 'events',
|
|
},
|
|
],
|
|
})
|
|
|
|
// Default inputs the alert wizard pre-fills for a destination, sourced from the shared sub-template
|
|
// (single source of truth with the full destination picker).
|
|
const subTemplateInputs = (templateId: string): NonNullable<InsightsFunctionType['inputs']> =>
|
|
INSIGHTS_FUNCTION_SUB_TEMPLATES[INSIGHT_ALERT_FIRING_SUB_TEMPLATE_ID].find((t) => t.template_id === templateId)
|
|
?.inputs ?? {}
|
|
|
|
export type PendingAlertNotification =
|
|
| {
|
|
type: typeof ALERT_NOTIFICATION_TYPE_SLACK
|
|
slackWorkspaceId: number
|
|
slackChannelId: string
|
|
slackChannelName?: string
|
|
}
|
|
| {
|
|
type: typeof ALERT_NOTIFICATION_TYPE_WEBHOOK
|
|
webhookUrl: string
|
|
}
|
|
| {
|
|
type: typeof ALERT_NOTIFICATION_TYPE_DISCORD
|
|
webhookUrl: string
|
|
}
|
|
| {
|
|
type: typeof ALERT_NOTIFICATION_TYPE_MICROSOFT_TEAMS
|
|
webhookUrl: string
|
|
}
|
|
|
|
export function buildInsightsFunctionPayload(
|
|
alertId: string,
|
|
alertName: string | undefined,
|
|
notification: PendingAlertNotification
|
|
): Partial<InsightsFunctionType> {
|
|
const commonProps = INSIGHTS_FUNCTION_SUB_TEMPLATE_COMMON_PROPERTIES[INSIGHT_ALERT_FIRING_SUB_TEMPLATE_ID]
|
|
return {
|
|
type: commonProps.type,
|
|
enabled: true,
|
|
masking: null,
|
|
filters: buildAlertFilterConfig(alertId),
|
|
...buildAlertDestination(alertName ?? 'Alert', notification),
|
|
}
|
|
}
|
|
|
|
// Per-destination name, template, and inputs. One exhaustive case per notification type — adding a
|
|
// destination is a single case here plus an entry in PendingAlertNotification and the dropdown options.
|
|
function buildAlertDestination(
|
|
alertName: string,
|
|
notification: PendingAlertNotification
|
|
): Pick<InsightsFunctionType, 'name' | 'template_id' | 'inputs'> {
|
|
switch (notification.type) {
|
|
case ALERT_NOTIFICATION_TYPE_SLACK:
|
|
return {
|
|
name: `${alertName}: Slack #${notification.slackChannelName ?? 'channel'}`,
|
|
template_id: TEMPLATE_ID_BY_NOTIFICATION_TYPE[ALERT_NOTIFICATION_TYPE_SLACK],
|
|
inputs: {
|
|
...subTemplateInputs(TEMPLATE_ID_BY_NOTIFICATION_TYPE[ALERT_NOTIFICATION_TYPE_SLACK]),
|
|
slack_workspace: { value: notification.slackWorkspaceId },
|
|
channel: { value: notification.slackChannelId },
|
|
},
|
|
}
|
|
case ALERT_NOTIFICATION_TYPE_DISCORD:
|
|
return {
|
|
name: `${alertName}: Discord`,
|
|
template_id: TEMPLATE_ID_BY_NOTIFICATION_TYPE[ALERT_NOTIFICATION_TYPE_DISCORD],
|
|
inputs: {
|
|
...subTemplateInputs(TEMPLATE_ID_BY_NOTIFICATION_TYPE[ALERT_NOTIFICATION_TYPE_DISCORD]),
|
|
webhookUrl: { value: notification.webhookUrl },
|
|
},
|
|
}
|
|
case ALERT_NOTIFICATION_TYPE_MICROSOFT_TEAMS:
|
|
return {
|
|
name: `${alertName}: Microsoft Teams`,
|
|
template_id: TEMPLATE_ID_BY_NOTIFICATION_TYPE[ALERT_NOTIFICATION_TYPE_MICROSOFT_TEAMS],
|
|
inputs: {
|
|
...subTemplateInputs(TEMPLATE_ID_BY_NOTIFICATION_TYPE[ALERT_NOTIFICATION_TYPE_MICROSOFT_TEAMS]),
|
|
webhookUrl: { value: notification.webhookUrl },
|
|
},
|
|
}
|
|
case ALERT_NOTIFICATION_TYPE_WEBHOOK:
|
|
return {
|
|
name: `${alertName}: Webhook ${notification.webhookUrl}`,
|
|
template_id: TEMPLATE_ID_BY_NOTIFICATION_TYPE[ALERT_NOTIFICATION_TYPE_WEBHOOK],
|
|
inputs: {
|
|
url: { value: notification.webhookUrl },
|
|
body: {
|
|
value: {
|
|
alert_name: '{event.properties.alert_name}',
|
|
insight_name: '{event.properties.insight_name}',
|
|
breaches: '{event.properties.breaches}',
|
|
insight_url: '{project.url}/insights/{event.properties.insight_id}',
|
|
alert_url:
|
|
'{project.url}/insights/{event.properties.insight_id}/alerts?alert_id={event.properties.alert_id}',
|
|
},
|
|
},
|
|
},
|
|
}
|
|
default:
|
|
// Compile error if a PendingAlertNotification variant is added without a case above.
|
|
notification satisfies never
|
|
throw new Error('Unhandled alert notification type')
|
|
}
|
|
}
|