index.ts

import { Plugin } from '@posthog/plugin-scaffold'

const ONE_DAY = 60 * 60 * 24 // 24h in seconds

const defaultLocationSetProps = {
    $geoip_city_name: null,
    $geoip_city_confidence: null,
    $geoip_subdivision_2_name: null,
    $geoip_subdivision_2_code: null,
    $geoip_subdivision_1_name: null,
    $geoip_subdivision_1_code: null,
    $geoip_country_name: null,
    $geoip_country_code: null,
    $geoip_continent_name: null,
    $geoip_continent_code: null,
    $geoip_postal_code: null,
    $geoip_latitude: null,
    $geoip_longitude: null,
    $geoip_accuracy_radius: null,
    $geoip_time_zone: null,
}

const defaultLocationSetOnceProps = {
    $initial_geoip_city_name: null,
    $initial_geoip_city_confidence: null,
    $initial_geoip_subdivision_2_name: null,
    $initial_geoip_subdivision_2_code: null,
    $initial_geoip_subdivision_1_name: null,
    $initial_geoip_subdivision_1_code: null,
    $initial_geoip_country_name: null,
    $initial_geoip_country_code: null,
    $initial_geoip_continent_name: null,
    $initial_geoip_continent_code: null,
    $initial_geoip_postal_code: null,
    $initial_geoip_latitude: null,
    $initial_geoip_longitude: null,
    $initial_geoip_accuracy_radius: null,
    $initial_geoip_time_zone: null,
}

const plugin: Plugin = {
    processEvent: async (event, { geoip }) => {
        if (!geoip) {
            throw new Error('This PostHog version does not have GeoIP capabilities! Upgrade to PostHog 1.24.0 or later')
        }
        let ip = event.properties?.$ip || event.ip
        if (ip && !event.properties?.$geoip_disable) {
            ip = String(ip)
            if (ip === '127.0.0.1') {
                ip = '13.106.122.3' // Spoofing an Australian IP address for local development
            }
            const response = await geoip.locate(ip)
            if (response) {
                const location: Record<string, any> = {}
                if (response.city) {
                    location['city_name'] = response.city.names?.en
                    location['city_confidence'] = response.city.confidence ?? null
                }
                if (response.country) {
                    location['country_name'] = response.country.names?.en
                    location['country_code'] = response.country.isoCode
                }
                if (response.continent) {
                    location['continent_name'] = response.continent.names?.en
                    location['continent_code'] = response.continent.code
                }
                if (response.postal) {
                    location['postal_code'] = response.postal.code
                }
                if (response.location) {
                    location['latitude'] = response.location?.latitude
                    location['longitude'] = response.location?.longitude
                    location['accuracy_radius'] = response.location?.accuracyRadius
                    location['time_zone'] = response.location?.timeZone
                }
                if (response.subdivisions) {
                    for (const [index, subdivision] of response.subdivisions.entries()) {
                        location[`subdivision_${index + 1}_code`] = subdivision.isoCode
                        location[`subdivision_${index + 1}_name`] = subdivision.names?.en
                    }
                }

                if (!event.properties) {
                    event.properties = {}
                }

                if (!event.properties.$set) {
                    event.properties.$set = {}
                }
                if (!event.properties.$set_once) {
                    event.properties.$set_once = {}
                }
                event.properties.$set = { ...defaultLocationSetProps, ...(event.properties.$set ?? {}) }
                event.properties.$set_once = {
                    ...defaultLocationSetOnceProps,
                    ...(event.properties.$set_once ?? {}),
                }

                for (const [key, value] of Object.entries(location)) {
                    event.properties[`$geoip_${key}`] = value
                    event.properties.$set![`$geoip_${key}`] = value
                    event.properties.$set_once![`$initial_geoip_${key}`] = value
                }
            }
        }
        return event
    },
}

module.exports = plugin