: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 { useActions, useValues } from 'kea'
import { Form } from 'kea-forms'
import { router } from 'kea-router'
import posthog from 'posthog-js'
import { ReactNode, useEffect, useState } from 'react'
import { IconCollapse, IconDay, IconExpand, IconInfo, IconLaptop, IconLock, IconNight } from '@posthog/icons'
import {
LemonBanner,
LemonButton,
LemonDivider,
LemonModal,
LemonSegmentedButton,
LemonSkeleton,
LemonSwitch,
Link,
} from '@posthog/lemon-ui'
import { CodeSnippet, Language } from 'lib/components/CodeSnippet'
import { TEMPLATE_LINK_HEADING, TEMPLATE_LINK_PII_WARNING } from 'lib/components/Sharing/templateLinkMessages'
import { TemplateLinkSection } from 'lib/components/Sharing/TemplateLinkSection'
import { TitleWithIcon } from 'lib/components/TitleWithIcon'
import { FEATURE_FLAGS } from 'lib/constants'
import { IconLink } from 'lib/lemon-ui/icons'
import { LemonDialog } from 'lib/lemon-ui/LemonDialog'
import { LemonField } from 'lib/lemon-ui/LemonField'
import { Spinner } from 'lib/lemon-ui/Spinner/Spinner'
import { Tooltip } from 'lib/lemon-ui/Tooltip'
import { featureFlagLogic } from 'lib/logic/featureFlagLogic'
import { preflightLogic } from 'lib/logic/preflightLogic'
import { getAccessControlDisabledReason, pluralizeResource } from 'lib/utils/accessControlUtils'
import { copyToClipboard } from 'lib/utils/copyToClipboard'
import { insightVizDataLogic } from 'scenes/insights/insightVizDataLogic'
import { projectLogic } from 'scenes/projectLogic'
import { urls } from 'scenes/urls'
import { AccessControlPopoutCTA } from '~/layout/navigation-3000/sidepanel/panels/access_control/AccessControlPopoutCTA'
import { nodeKindToInsightType } from '~/queries/nodes/InsightQuery/defaults'
import { isDataTableNode, isDataVisualizationNode, isInsightVizNode } from '~/queries/schema/node-guards'
import { AnyResponseType, Node } from '~/queries/schema/schema-general'
import { NodeKind } from '~/queries/schema/schema-general'
import { AccessControlLevel, AccessControlResourceType, AvailableFeature, InsightShortId, InsightModel } from '~/types'
import { InsightType } from '~/types'
import { upgradeModalLogic } from '../UpgradeModal/upgradeModalLogic'
import { SharePasswordsTable } from './SharePasswordsTable'
import { sharingLogic } from './sharingLogic'
function getResourceType(
dashboardId?: number,
insightShortId?: InsightShortId,
recordingId?: string,
notebookShortId?: string
): AccessControlResourceType {
if (dashboardId) {
return AccessControlResourceType.Dashboard
}
if (insightShortId) {
return AccessControlResourceType.Insight
}
if (recordingId) {
return AccessControlResourceType.SessionRecording
}
if (notebookShortId) {
return AccessControlResourceType.Notebook
}
return AccessControlResourceType.Project
}
export const SHARING_MODAL_WIDTH = 640
export interface SharingModalBaseProps {
dashboardId?: number
insightShortId?: InsightShortId
insight?: Partial<InsightModel>
cachedResults?: AnyResponseType
recordingId?: string
notebookShortId?: string
title?: string
previewIframe?: boolean
additionalParams?: Record<string, any>
/**
* When generating a link to a recording, this form can be used to allow the user to specify a timestamp
*/
recordingLinkTimeForm?: ReactNode
userAccessLevel?: AccessControlLevel
onSharingEnabledChange?: (enabled: boolean) => void
}
export interface SharingModalProps extends SharingModalBaseProps {
isOpen: boolean
closeModal: () => void
inline?: boolean
'data-attr'?: string
}
export function SharingModalContent({
dashboardId,
insightShortId,
insight,
cachedResults,
recordingId,
notebookShortId,
additionalParams,
previewIframe = false,
recordingLinkTimeForm = undefined,
userAccessLevel,
onSharingEnabledChange,
}: SharingModalBaseProps): JSX.Element {
const logicProps = {
dashboardId,
insightShortId,
recordingId,
notebookShortId,
additionalParams,
onSharingEnabledChange,
}
const {
whitelabelAvailable,
accessControlAvailable,
canManagePublicSharing,
sharingConfiguration,
sharingConfigurationLoading,
showPreview,
embedCode,
iframeProperties,
shareLink,
sharingAllowed,
} = useValues(sharingLogic(logicProps))
const { setIsEnabled, setPasswordRequired, togglePreview, setSharingSettingsValue } = useActions(
sharingLogic(logicProps)
)
const { guardAvailableFeature } = useValues(upgradeModalLogic)
const { preflight } = useValues(preflightLogic)
const siteUrl = preflight?.site_url || window.location.origin
const { featureFlags } = useValues(featureFlagLogic)
const passwordProtectedSharesEnabled = !!featureFlags[FEATURE_FLAGS.PASSWORD_PROTECTED_SHARES]
const { currentProjectId } = useValues(projectLogic)
const { push } = useActions(router)
const [iframeLoaded, setIframeLoaded] = useState(false)
const renderQueryUrl = insight?.query ? new URL('render_query', siteUrl).toString() : null
const renderQuerySnippet = renderQueryUrl
? createRenderQuerySnippet({
renderQueryUrl,
iframeId: getRenderQueryIframeId(insightShortId),
cachedResults,
query: insight?.query,
})
: null
const apiQueryUrl =
insight?.query && currentProjectId
? new URL(`api/projects/${currentProjectId}/query/`, siteUrl).toString()
: null
const apiQuerySnippet = apiQueryUrl
? createApiQuerySnippet({
apiQueryUrl,
query: insight?.query
? isInsightVizNode(insight.query) ||
isDataVisualizationNode(insight.query) ||
isDataTableNode(insight.query)
? insight.query.source
: insight.query
: null,
})
: null
const resource = dashboardId
? 'dashboard'
: insightShortId
? 'insight'
: recordingId
? 'recording'
: notebookShortId
? 'notebook'
: 'this'
// Sharing requires editor access to the underlying resource being shared (enforced via
// `userAccessLevel`, the object's own access level) AND editor access to the independent
// `sharing_configuration` resource, which lets an org restrict who may manage public sharing
// at all, regardless of how much access they have to the resource itself.
const underlyingResourceDisabledReason = userAccessLevel
? getAccessControlDisabledReason(
getResourceType(dashboardId, insightShortId, recordingId, notebookShortId),
AccessControlLevel.Editor,
userAccessLevel
)
: null
const sharingConfigDisabledReason = sharingConfiguration?.user_access_level
? getAccessControlDisabledReason(
AccessControlResourceType.SharingConfiguration,
AccessControlLevel.Editor,
sharingConfiguration.user_access_level
)
: null
const sharingManageDisabledReason = underlyingResourceDisabledReason ?? sharingConfigDisabledReason
const hasEditAccess = !sharingManageDisabledReason
useEffect(() => {
setIframeLoaded(false)
}, [iframeProperties.src, iframeProperties.key, sharingConfiguration?.enabled, showPreview])
return (
<div className="deprecated-space-y-4">
{dashboardId ? (
<>
<AccessControlPopoutCTA
resourceType={AccessControlResourceType.Dashboard}
callback={() => {
push(urls.dashboard(dashboardId))
}}
/>
<LemonDivider />
</>
) : undefined}
{insightShortId ? (
<>
<AccessControlPopoutCTA
resourceType={AccessControlResourceType.Insight}
callback={() => {
push(urls.insightView(insightShortId))
}}
/>
<LemonDivider />
</>
) : undefined}
<div className="flex flex-col gap-4">
{!sharingConfiguration && sharingConfigurationLoading ? (
<LemonSkeleton.Row repeat={3} />
) : !sharingConfiguration ? (
<p>Something went wrong...</p>
) : (
<div>
<h4 className="mb-3 text-xs font-semibold uppercase tracking-wide text-secondary">
Public sharing
</h4>
{sharingAllowed &&
accessControlAvailable &&
sharingConfiguration.has_relevant_access_controls && (
<LemonBanner type="warning" className="mb-3">
<p className="mb-0">
{`Anyone with the public link can view this ${resource} and its data, including people outside your organization. Access controls do not apply when viewing public ${pluralizeResource(getResourceType(dashboardId, insightShortId, recordingId, notebookShortId))}.`}
</p>
{canManagePublicSharing && (
<p className="mt-2 mb-0">
<Link
to={urls.settings('organization-security')}
data-attr="sharing-public-sharing-settings"
>
Disable public sharing for your organization
</Link>
</p>
)}
</LemonBanner>
)}
<LemonSwitch
id="sharing-switch"
label={`Share ${resource} publicly`}
checked={sharingAllowed && sharingConfiguration.enabled}
data-attr="sharing-switch"
onChange={(active) => setIsEnabled(active)}
bordered
fullWidth
loading={sharingConfigurationLoading}
disabledReason={
!sharingAllowed
? 'Public sharing is disabled for this organization.'
: sharingManageDisabledReason
}
/>
{sharingAllowed && sharingConfiguration.enabled && sharingConfiguration.access_token ? (
<div className="mt-2 flex flex-col gap-2">
{passwordProtectedSharesEnabled && (
<div className="LemonSwitch LemonSwitch--medium LemonSwitch--bordered LemonSwitch--full-width flex-col py-1.5">
<LemonSwitch
className="px-0"
fullWidth
label={
<div className="flex items-center">
Password protect
{!accessControlAvailable && (
<Tooltip title="This is a premium feature, click to learn more.">
<IconLock className="ml-1.5 text-muted text-lg" />
</Tooltip>
)}
</div>
}
onChange={(passwordRequired: boolean) => {
if (passwordRequired) {
guardAvailableFeature(AvailableFeature.ACCESS_CONTROL, () =>
setPasswordRequired(passwordRequired)
)
} else {
setPasswordRequired(passwordRequired)
}
}}
checked={sharingConfiguration.password_required}
disabledReason={sharingManageDisabledReason}
/>
{sharingConfiguration.password_required && (
<div className="mt-1 w-full">
<SharePasswordsTable
dashboardId={dashboardId}
insightId={insight?.id}
recordingId={recordingId}
notebookShortId={notebookShortId}
disabledReason={sharingManageDisabledReason}
/>
</div>
)}
</div>
)}
<LemonButton
data-attr="sharing-link-button"
type="primary"
onClick={() => {
// TRICKY: there's a chance this was sending useless errors to error tracking
// even when it succeeded, so we're explicitly ignoring the promise success
// and naming the error when reported to error tracking - @pauldambra
copyToClipboard(shareLink, shareLink).catch((e) =>
posthog.captureException(
new Error('unexpected sharing modal clipboard error: ' + e.message)
)
)
}}
icon={<IconLink />}
className="ml-auto"
>
Copy public link
</LemonButton>
{recordingLinkTimeForm}
</div>
) : null}
</div>
)}
{sharingAllowed &&
sharingConfiguration?.enabled &&
sharingConfiguration.access_token &&
hasEditAccess ? (
<>
<LemonDivider />
<div>
<div>
<h4 className="mb-2 text-xs font-semibold uppercase tracking-wide text-secondary">
Shared {resource} appearance
</h4>
<p className="mb-0 text-sm text-secondary">
Choose how the shared {resource} appears to viewers.
</p>
</div>
<Form
logic={sharingLogic}
props={logicProps}
formKey="sharingSettings"
className="mt-4 deprecated-space-y-2"
>
<div className="grid grid-cols-1 md:grid-cols-2 gap-2">
{insight && (
<LemonField name="noHeader">
{({ value, onChange }) => (
<LemonSwitch
fullWidth
bordered
label={<div>Show title and description</div>}
onChange={() => onChange(!value)}
checked={!value}
/>
)}
</LemonField>
)}
<LemonField name="whitelabel">
{({ value }) => (
<LemonSwitch
fullWidth
bordered
label={
<div className="flex items-center">
<span>Show branding</span>
{!whitelabelAvailable && (
<Tooltip title="This is a premium feature, click to learn more.">
<IconLock className="ml-1.5 text-secondary text-lg" />
</Tooltip>
)}
</div>
}
onChange={(showBranding: boolean) => {
const newWhitelabelValue = !showBranding
if (newWhitelabelValue) {
guardAvailableFeature(AvailableFeature.WHITE_LABELLING, () =>
setSharingSettingsValue('whitelabel', newWhitelabelValue)
)
} else {
setSharingSettingsValue('whitelabel', newWhitelabelValue)
}
}}
checked={!value}
/>
)}
</LemonField>
{isInsightVizNode(insight?.query) &&
insightShortId && (
// These options are only valid for `InsightVizNode`s, and they rely on `insightVizDataLogic`
<>
<LegendCheckbox insightShortId={insightShortId} />
<DetailedResultsCheckbox insightShortId={insightShortId} />
</>
)}
{recordingId && (
<LemonField name="showInspector">
{({ value, onChange }) => (
<LemonSwitch
fullWidth
bordered
label={<div>Show inspector panel</div>}
onChange={onChange}
checked={value}
/>
)}
</LemonField>
)}
{dashboardId && (
<LemonField name="theme" className="col-span-2">
{({ value, onChange }) => (
<fieldset>
<legend className="mb-2 text-sm font-semibold">Color theme</legend>
<LemonSegmentedButton
value={value ?? 'system'}
onChange={onChange}
fullWidth
options={[
{
value: 'system',
label: 'System',
icon: <IconLaptop />,
tooltip: 'Match the viewer’s system setting',
'data-attr': 'sharing-theme-system',
},
{
value: 'light',
label: 'Light',
icon: <IconDay />,
'data-attr': 'sharing-theme-light',
},
{
value: 'dark',
label: 'Dark',
icon: <IconNight />,
'data-attr': 'sharing-theme-dark',
},
]}
/>
</fieldset>
)}
</LemonField>
)}
</div>
{previewIframe && (
<div className="rounded border">
<LemonButton
fullWidth
sideIcon={showPreview ? <IconCollapse /> : <IconExpand />}
onClick={togglePreview}
>
Preview
{showPreview && !iframeLoaded ? <Spinner className="ml-2" /> : null}
</LemonButton>
{showPreview && (
<div className="SharingPreview border-t">
<iframe
className="block"
{...iframeProperties}
title="Shared insight preview"
onLoad={() => setIframeLoaded(true)}
sandbox="allow-scripts allow-same-origin allow-popups"
/>
</div>
)}
</div>
)}
</Form>
</div>
</>
) : null}
{sharingAllowed && sharingConfiguration?.enabled && sharingConfiguration.access_token && embedCode ? (
<>
<LemonDivider />
<div>
<TitleWithIcon
icon={
<Tooltip
title={`Use the HTML snippet below to embed the ${resource} on your website`}
>
<IconInfo />
</Tooltip>
}
>
<h4 className="mb-3 text-xs font-semibold uppercase tracking-wide text-secondary">
Embed {resource}
</h4>
</TitleWithIcon>
<CodeSnippet language={Language.HTML}>{embedCode}</CodeSnippet>
</div>
</>
) : null}
</div>
{insight?.query && (
<>
<LemonDivider />
<TemplateLinkSection
collapsible
defaultExpanded={false}
templateLink={getInsightDefinitionUrl({ query: insight.query }, siteUrl)}
heading={TEMPLATE_LINK_HEADING}
piiWarning={TEMPLATE_LINK_PII_WARNING}
copyButtonLabel="Copy link"
/>
{renderQuerySnippet && (
<>
<TemplateLinkSection
collapsible
defaultExpanded={false}
templateLink={renderQuerySnippet}
heading="Static iframe embed with pre-computed data"
piiWarning="Add this iframe to any site to embed a static PostHog chart. It will look identical to the chart you see here, but nothing will be editable. If any data is sensitive, consider that before sharing."
/>
{apiQuerySnippet && (
<TemplateLinkSection
templateLink={apiQuerySnippet}
heading="Fetch latest results for this insight"
piiWarning='Use this snippet to retrieve the freshest results for the insight. Replace the "cachedResults" section in the iframe's payload with the results of this call to update it.'
collapsible
defaultExpanded={false}
/>
)}
</>
)}
</>
)}
</div>
)
}
function getRenderQueryIframeId(insightShortId?: InsightShortId): string {
const suffix = (insightShortId || 'insight').replace(/[^a-zA-Z0-9_-]/g, '')
return `posthog-render-query-${suffix || 'embed'}`
}
function createRenderQuerySnippet({
renderQueryUrl,
iframeId,
cachedResults,
query,
}: {
renderQueryUrl: string
iframeId: string
cachedResults: AnyResponseType | Partial<InsightModel> | null | undefined
query: Node | null | undefined
}): string {
const preparedResults = prepareCachedResultsForSnippet(cachedResults)
const serializedResults = indentMultiline(JSON.stringify(preparedResults, null, 2), 8)
const serializedQuery = indentMultiline(JSON.stringify(query ?? null, null, 2), 8)
const escapedResults = escapeScriptJson(serializedResults)
const escapedQuery = escapeScriptJson(serializedQuery)
return `<iframe id="${iframeId}" title="PostHog embedded query" src="${renderQueryUrl}" style="width: 100%; height: 600px; border: 0;" loading="lazy"></iframe>
<script>
(function () {
const iframe = document.getElementById('${iframeId}')
if (!iframe) {
return
}
const payload = {
query: ${escapedQuery},
cachedResults: ${escapedResults},
}
const targetOrigin = new URL(${JSON.stringify(renderQueryUrl)}).origin
function send() {
if (!iframe.contentWindow) {
return
}
iframe.contentWindow.postMessage(payload, targetOrigin)
}
iframe.addEventListener('load', send)
send()
})()
</script>`
}
function createApiQuerySnippet({
apiQueryUrl,
query,
}: {
apiQueryUrl: string
query: Node | null | undefined
}): string {
const serializedQuery = indentMultiline(JSON.stringify(query ?? null, null, 2), 8)
const escapedQuery = escapeScriptJson(serializedQuery)
return `fetch(${JSON.stringify(apiQueryUrl)}, {
method: 'POST',
headers: {
Authorization: 'Bearer <PERSONAL_API_KEY>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
query: ${escapedQuery},
}),
})
.then((response) => response.json())
.then((data) => {
console.log('Latest results', data)
})`
}
function escapeScriptJson(value: string): string {
return value.replace(/</g, '\\u003C').replace(/>/g, '\\u003E').replace(/&/g, '\\u0026')
}
function indentMultiline(value: string, indent: number): string {
const indentation = ' '.repeat(indent)
return value
.split('\n')
.map((line, index) => (index === 0 ? line : `${indentation}${line}`))
.join('\n')
}
function prepareCachedResultsForSnippet(
cachedResults: AnyResponseType | Partial<InsightModel> | null | undefined
): AnyResponseType | Partial<InsightModel> | null {
if (!cachedResults) {
return null
}
if (Array.isArray(cachedResults)) {
return cachedResults
}
if (typeof cachedResults !== 'object') {
return cachedResults
}
const source = cachedResults as Record<string, any>
const allowedKeys = [
'cache_key',
'error',
'results',
'last_refresh',
'next_allowed_client_refresh',
'timezone',
'query_metadata',
]
const trimmed: Record<string, any> = {}
for (const key of allowedKeys) {
if (Object.prototype.hasOwnProperty.call(source, key)) {
const value = source[key]
if (value !== undefined) {
trimmed[key] = value
}
}
}
if (trimmed.results === undefined && Object.prototype.hasOwnProperty.call(source, 'result')) {
const value = source.result
if (value !== undefined) {
trimmed.results = value
}
}
return Object.keys(trimmed).length > 0 ? trimmed : null
}
function DetailedResultsCheckbox({ insightShortId }: { insightShortId: InsightShortId }): JSX.Element | null {
const { hasDetailedResultsTable } = useValues(insightVizDataLogic({ dashboardItemId: insightShortId }))
if (!hasDetailedResultsTable) {
return null // No detailed results toggle
}
return (
<LemonField name="detailed">
{({ value, onChange }) => (
<LemonSwitch
fullWidth
bordered
label="Show detailed results"
onChange={() => onChange(!value)}
checked={value}
/>
)}
</LemonField>
)
}
function LegendCheckbox({ insightShortId }: { insightShortId: InsightShortId }): JSX.Element | null {
const { hasLegend } = useValues(insightVizDataLogic({ dashboardItemId: insightShortId }))
if (!hasLegend) {
return null // No legend to toggle
}
return (
<LemonField name="legend">
{({ value, onChange }) => (
<LemonSwitch fullWidth bordered label="Show legend" onChange={() => onChange(!value)} checked={value} />
)}
</LemonField>
)
}
export function SharingModal({
closeModal,
isOpen,
inline,
title,
'data-attr': dataAttr,
...props
}: SharingModalProps): JSX.Element {
return (
<LemonModal
onClose={closeModal}
isOpen={isOpen}
width={SHARING_MODAL_WIDTH}
title={title ?? 'Sharing'}
data-attr={dataAttr}
footer={
<LemonButton type="secondary" onClick={closeModal}>
Done
</LemonButton>
}
inline={inline}
>
<SharingModalContent {...props} />
</LemonModal>
)
}
SharingModal.open = (props: SharingModalBaseProps) => {
LemonDialog.open({
title: props.title ?? 'Sharing',
content: (
<>
<SharingModalContent {...props} />
</>
),
width: SHARING_MODAL_WIDTH,
primaryButton: {
children: 'Close',
type: 'secondary',
},
})
}
/**
* Build a canonical definition-based insight link ("template link").
* The link always points to `/insights/new` on the provided baseUrl and includes:
* #insight=<InsightType>&q=<URL-encoded JSON definition>
*
* It works for both saved insights (where `query` is persisted on the model)
* and unsaved/draft insights (pass the raw query object).
*/
export function getInsightDefinitionUrl(
insight: Pick<InsightModel, 'query'> | { query: Node<Record<string, any>> },
baseUrl: string
): string {
if (!insight?.query) {
throw new Error('getInsightDefinitionUrl: insight.query is required')
}
// Derive InsightType from the query where possible so the #insight=<TYPE> hash param is present
let insightType: InsightType | undefined
type InsightVizNode = { kind: NodeKind.InsightVizNode; source?: { kind?: string } }
const kind = (
insight.query.kind === NodeKind.InsightVizNode
? (insight.query as InsightVizNode).source?.kind
: insight.query.kind
) as keyof typeof nodeKindToInsightType | undefined
if (kind && kind in nodeKindToInsightType) {
insightType = nodeKindToInsightType[kind as keyof typeof nodeKindToInsightType]
}
const relativeUrl = urls.insightNew({ query: insight.query, type: insightType })
// Ensure the link is project-agnostic (`/project/<id>` may get injected elsewhere)
const cleanedPath = relativeUrl.replace(/^\/project\/[^/]+/, '')
return `${baseUrl}${cleanedPath}`
}