feat(web-analytics): Add site_name in config and $site_name property

playground/nextjs/pages/_app.tsx

@@ -15,6 +15,7 @@ if (typeof window !== 'undefined') {
         },
         debug: true,
         __preview_send_client_session_params: true,
+        site_name: 'playground-nextjs',
     })
     ;(window as any).posthog = posthog
 }

src/__tests__/posthog-core.js

@@ -234,6 +234,26 @@ describe('posthog core', () => {
                 undefined
             )
         })
+
+        it('includes $site_name from config', () => {
+            given('config', () => ({
+                site_name: 'test site name',
+                property_blacklist: [],
+                _onCapture: jest.fn(),
+            }))
+            const event = given.subject()
+            expect(event.properties['$site_name']).toBe('test site name')
+        })
+
+        it('doesnt include $site_name if not set', () => {
+            given('config', () => ({
+                site_name: undefined,
+                property_blacklist: [],
+                _onCapture: jest.fn(),
+            }))
+            const event = given.subject()
+            expect(event.properties).not.toHaveProperty('$site_name')
+        })
     })
 
     describe('_afterDecideResponse', () => {

src/posthog-core.ts

@@ -988,6 +988,10 @@ export class PostHog {
             properties['$duration'] = parseFloat((duration_in_ms / 1000).toFixed(3))
         }
 
+        if (this.config.site_name) {
+            properties['$site_name'] = this.config.site_name
+        }
+
         // note: extend writes to the first object, so lets make sure we
         // don't write to the persistence properties object and info
         // properties object by passing in a new object

src/types.ts

@@ -124,6 +124,7 @@ export interface PostHogConfig {
         featureFlagPayloads?: Record<string, JsonType>
     }
     segment?: any
+    site_name?: string
     __preview_measure_pageview_stats?: boolean
     __preview_send_client_session_params?: boolean
 }