feat: use /api/__plausible_event__ as proxy default path

Author: johannschopplich

README.md

@@ -83,7 +83,7 @@ export default defineNuxtConfig({
 ```
 
 > [!NOTE]
-> When enabled, all Plausible events will be sent to your server first, which then forwards them to Plausible's API. The default proxy endpoint is `/api/event`, but you can customize it using the `proxyBaseURL` option.
+> When enabled, all Plausible events will be sent to your server first, which then forwards them to Plausible's API. The default proxy endpoint is `/api/__plausible_event__`, but you can customize the path using the `proxyBaseURL` module option.
 
 ## Module Options
 
@@ -99,7 +99,7 @@ export default defineNuxtConfig({
 | `autoOutboundTracking` | `boolean`  | `false`                      | Track all outbound link clicks automatically. If enabled, a [MutationObserver](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver) automagically detects link nodes throughout the application and binds `click` events to them. |
 | `logIgnoredEvents`     | `boolean`  | `false`                      | Log events to the console if they are ignored.                                                                                                                                                                                                  |
 | `proxy`                | `boolean`  | `false`                      | Whether to proxy the event endpoint through the current origin.                                                                                                                                                                                 |
-| `proxyBaseURL`         | `string`   | `'/api/event'`               | The base URL to proxy the event endpoint through.                                                                                                                                                                                               |
+| `proxyBaseURL`         | `string`   | `'/api/__plausible_event__'` | The base URL to proxy the event endpoint through.                                                                                                                                                                                               |
 
 ## Composables
 

src/module.ts

@@ -100,9 +100,9 @@ export interface ModuleOptions {
   proxy?: boolean
 
   /**
-   * The base URL to proxy the event endpoint through.
+   * The base URL to proxy the Plausible event endpoint through.
    *
-   * @default '/api/event'
+   * @default '/api/__plausible_event__'
    */
   proxyBaseURL?: string
 }
@@ -128,7 +128,7 @@ export default defineNuxtModule<ModuleOptions>({
     autoOutboundTracking: false,
     logIgnoredEvents: false,
     proxy: false,
-    proxyBaseURL: '/api/event',
+    proxyBaseURL: '/api/__plausible_event__',
   },
   setup(options, nuxt) {
     const logger = useLogger('plausible')
@@ -160,7 +160,7 @@ export default defineNuxtModule<ModuleOptions>({
     nuxt.options.build.transpile.push(resolve('runtime'))
 
     if (nuxt.options.runtimeConfig.public.plausible.proxy) {
-      const proxyBaseURL = nuxt.options.runtimeConfig.public.plausible.proxyBaseURL
+      const { proxyBaseURL } = nuxt.options.runtimeConfig.public.plausible
 
       const hasUserProvidedProxyBaseURL
         = nuxt.options.serverHandlers.find(handler => handler.route?.startsWith(proxyBaseURL))
@@ -171,7 +171,7 @@ export default defineNuxtModule<ModuleOptions>({
 
       addServerHandler({
         route: proxyBaseURL,
-        handler: resolve('runtime/server/api/event.post'),
+        handler: resolve('runtime/server/event-handler'),
         method: 'post',
       })
     }

src/runtime/server/api/event.post.ts renamed to src/runtime/server/event-handler.ts

@@ -1,4 +1,4 @@
-import type { ModuleOptions } from '../../../module'
+import type { ModuleOptions } from '../../module'
 import { useRuntimeConfig } from '#imports'
 import { createError, defineEventHandler, getRequestHeader, getRequestIP, readBody } from 'h3'
 import { joinURL } from 'ufo'
@@ -18,17 +18,15 @@ export default defineEventHandler(async (event) => {
     const target = joinURL(options.apiHost, 'api/event')
     const body = await readBody(event)
 
-    const headers = new Headers({
-      'Content-Type': 'application/json',
-      ...Object.fromEntries([
-        ['User-Agent', getRequestHeader(event, 'user-agent')],
-        ['X-Forwarded-For', getRequestIP(event, { xForwardedFor: true })],
-      ].filter(([_, value]) => value != null)),
-    })
-
     const result = await globalThis.$fetch(target, {
       method: 'POST',
-      headers: headers,
+      headers: {
+        'Content-Type': 'application/json',
+        ...Object.fromEntries([
+          ['User-Agent', getRequestHeader(event, 'user-agent')],
+          ['X-Forwarded-For', getRequestIP(event, { xForwardedFor: true })],
+        ].filter(([_, value]) => value != null)),
+      },
       body,
       retry: 2,
       timeout: 5000,
@@ -43,7 +41,7 @@ export default defineEventHandler(async (event) => {
     if (error instanceof Error && error.name === 'FetchError') {
       throw createError({
         statusCode: 502,
-        message: 'Failed to reach Plausible analytics service',
+        message: 'Failed to reach Plausible Analytics service',
       })
     }