Files
simstudioai--sim/apps/sim/lib/posthog/server.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

91 lines
2.7 KiB
TypeScript

import { createLogger, getRequestContext } from '@sim/logger'
import type { PostHog } from 'posthog-node'
import type { PostHogEventMap, PostHogEventName } from '@/lib/posthog/events'
const logger = createLogger('PostHogServer')
let _client: PostHog | null = null
let _disabled = false
export function getPostHogClient(): PostHog | null {
return getClient()
}
function getClient(): PostHog | null {
if (_disabled) return null
if (_client) return _client
const key = process.env.NEXT_PUBLIC_POSTHOG_KEY
const enabled = process.env.NEXT_PUBLIC_POSTHOG_ENABLED
if (!key || !enabled || enabled === 'false' || enabled === '0') {
_disabled = true
return null
}
// eslint-disable-next-line @typescript-eslint/no-require-imports
const { PostHog } = require('posthog-node') as typeof import('posthog-node')
_client = new PostHog(key, {
host: 'https://us.i.posthog.com',
flushAt: 20,
flushInterval: 10_000,
})
return _client
}
type PersonProperties = Record<string, string | number | boolean>
interface CaptureOptions {
/**
* Associate this event with workspace-level group analytics.
* Pass `{ workspace: workspaceId }`.
*/
groups?: Record<string, string>
/**
* Person properties to update on every capture (`$set`).
* Use for mutable state like `plan`, `total_workflows`.
*/
set?: PersonProperties
/**
* Person properties to set only once (`$set_once`).
* Use for immutable milestones like `first_execution_at`.
*/
setOnce?: PersonProperties
}
/**
* Capture a server-side PostHog event. Fire-and-forget — never throws.
*
* @param distinctId - The user (or workspace/org) ID to associate the event with.
* @param event - Typed event name from {@link PostHogEventMap}.
* @param properties - Strongly-typed property bag for this event.
* @param options - Optional groups, $set, and $set_once person properties.
*/
export function captureServerEvent<E extends PostHogEventName>(
distinctId: string,
event: E,
properties: PostHogEventMap[E],
options?: CaptureOptions
): void {
try {
const client = getClient()
if (!client) return
const contextRequestId = getRequestContext()?.requestId
const props = properties as Record<string, unknown>
client.capture({
distinctId,
event,
properties: {
...properties,
...(contextRequestId && !('request_id' in props) ? { request_id: contextRequestId } : {}),
...(options?.groups ? { $groups: options.groups } : {}),
...(options?.set ? { $set: options.set } : {}),
...(options?.setOnce ? { $set_once: options.setOnce } : {}),
},
})
} catch (error) {
logger.warn('Failed to capture PostHog server event', { event, error })
}
}