Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

feat: improve nextjs proxying mode

Carl-Gerhard Lindesvärd6da8267509ca
diff --git a/apps/public/app/api/[...op]/route.ts b/apps/public/app/api/[...op]/route.ts
index 82945e540..8c9ad4a38 100644
--- a/apps/public/app/api/[...op]/route.ts
+++ b/apps/public/app/api/[...op]/route.ts
@@ -1,7 +1,5 @@
-import {
- createNextRouteHandler,
- createScriptHandler,
-} from '@openpanel/nextjs/server';
+import { createRouteHandler } from '@openpanel/nextjs/server';
-export const POST = createNextRouteHandler();
-export const GET = createScriptHandler();
+const routeHandler = createRouteHandler();
+export const GET = routeHandler;
+export const POST = routeHandler;
diff --git a/apps/public/app/test/page.tsx b/apps/public/app/test/page.tsx
new file mode 100644
index 000000000..36330dd55
--- /dev/null
+++ b/apps/public/app/test/page.tsx
@@ -0,0 +1,23 @@
+'use client';
+
+import { Button } from '@/components/ui/button';
+import { useOpenPanel } from '@openpanel/nextjs';
+
+export default function TestPage() {
+ const op = useOpenPanel();
+ return (
+ <div>
+ <h1>Test Page</h1>
+ <Button
+ onClick={async () => {
+ const deviceId = await op.fetchDeviceId();
+ alert(`Device ID: ${deviceId}`);
+ }}
+ >
+ Fetch device id
+ </Button>
+ <Button onClick={() => op.track('hello')}>Hello</Button>
+ <Button onClick={() => op.revenue(100)}>Revenue</Button>
+ </div>
+ );
+}
diff --git a/apps/public/content/docs/(tracking)/sdks/nextjs.mdx b/apps/public/content/docs/(tracking)/sdks/nextjs.mdx
index 1f0ad37f4..8afef4a51 100644
--- a/apps/public/content/docs/(tracking)/sdks/nextjs.mdx
+++ b/apps/public/content/docs/(tracking)/sdks/nextjs.mdx
@@ -273,13 +273,16 @@ export function GET() {
### Proxy events
-With `createNextRouteHandler` you can proxy your events through your server, this will ensure all events are tracked since there is a lot of adblockers that block requests to third party domains. You'll also need to either host our tracking script or you can use `createScriptHandler` function which proxies this as well.
+With `createRouteHandler` you can proxy your events through your server, this will ensure all events are tracked since there is a lot of adblockers that block requests to third party domains. The handler automatically routes requests based on the path, supporting both API endpoints (like `/track` and `/track/device-id`) and the tracking script (`/op1.js`).
```typescript title="/app/api/[...op]/route.ts"
-import { createNextRouteHandler, createScriptHandler } from '@openpanel/nextjs/server';
+import { createRouteHandler } from '@openpanel/nextjs/server';
-export const POST = createNextRouteHandler();
-export const GET = createScriptHandler()
+const routeHandler = createRouteHandler();
+
+// Export the same handler for all HTTP methods - it routes internally based on pathname
+export const GET = routeHandler;
+export const POST = routeHandler;
```
Remember to change the `apiUrl` and `cdnUrl` in the `OpenPanelComponent` to your own server.
diff --git a/apps/public/package.json b/apps/public/package.json
index 9eeb79b20..231f4690b 100644
--- a/apps/public/package.json
+++ b/apps/public/package.json
@@ -14,7 +14,7 @@
"@hyperdx/node-opentelemetry": "^0.8.1",
"@number-flow/react": "0.3.5",
"@openpanel/common": "workspace:*",
- "@openpanel/nextjs": "^1.0.17",
+ "@openpanel/nextjs": "^1.1.0",
"@openpanel/payments": "workspace:^",
"@openpanel/sdk-info": "workspace:^",
"@openstatus/react": "0.0.3",
diff --git a/packages/sdks/nextjs/createNextRouteHandler.ts b/packages/sdks/nextjs/createNextRouteHandler.ts
index 35dccdcc9..41e91ab30 100644
--- a/packages/sdks/nextjs/createNextRouteHandler.ts
+++ b/packages/sdks/nextjs/createNextRouteHandler.ts
@@ -3,80 +3,141 @@ import { createHash } from 'node:crypto';
// with esm and nextjs (when using pages dir)
import { NextResponse } from 'next/server.js';
-type CreateNextRouteHandlerOptions = {
+type RouteHandlerOptions = {
apiUrl?: string;
};
-export function createNextRouteHandler(
- options?: CreateNextRouteHandlerOptions,
-) {
- return async function POST(req: Request) {
- const apiUrl = options?.apiUrl ?? 'https://api.openpanel.dev';
- const headers = new Headers();
-
- const ip =
- req.headers.get('cf-connecting-ip') ??
- req.headers.get('x-forwarded-for')?.split(',')[0] ??
- req.headers.get('x-vercel-forwarded-for');
- headers.set('Content-Type', 'application/json');
- headers.set(
- 'openpanel-client-id',
- req.headers.get('openpanel-client-id') ?? '',
- );
- headers.set('origin', req.headers.get('origin') ?? '');
- headers.set('User-Agent', req.headers.get('user-agent') ?? '');
- if (ip) {
- headers.set('openpanel-client-ip', ip);
- }
+const DEFAULT_API_URL = 'https://api.openpanel.dev';
+const SCRIPT_URL = 'https://openpanel.dev';
+const SCRIPT_PATH = '/op1.js';
+
+function getClientHeaders(req: Request): Headers {
+ const headers = new Headers();
+ const ip =
+ req.headers.get('cf-connecting-ip') ??
+ req.headers.get('x-forwarded-for')?.split(',')[0] ??
+ req.headers.get('x-vercel-forwarded-for');
+
+ headers.set('Content-Type', 'application/json');
+ headers.set(
+ 'openpanel-client-id',
+ req.headers.get('openpanel-client-id') ?? '',
+ );
- try {
- const res = await fetch(`${apiUrl}/track`, {
- method: 'POST',
- headers,
- body: JSON.stringify(await req.json()),
- });
- return NextResponse.json(await res.text(), { status: res.status });
- } catch (e) {
- return NextResponse.json(e);
+ // Construct origin: browsers send Origin header for POST requests and cross-origin requests,
+ // but not for same-origin GET requests. Fallback to constructing from request URL.
+ const origin =
+ req.headers.get('origin') ??
+ (() => {
+ const url = new URL(req.url);
+ return `${url.protocol}//${url.host}`;
+ })();
+ headers.set('origin', origin);
+
+ headers.set('User-Agent', req.headers.get('user-agent') ?? '');
+ if (ip) {
+ headers.set('openpanel-client-ip', ip);
+ }
+
+ return headers;
+}
+
+async function handleApiRoute(
+ req: Request,
+ apiUrl: string,
+ apiPath: string,
+): Promise<NextResponse> {
+ const headers = getClientHeaders(req);
+
+ try {
+ const res = await fetch(`${apiUrl}${apiPath}`, {
+ method: req.method,
+ headers,
+ body:
+ req.method === 'POST' ? JSON.stringify(await req.json()) : undefined,
+ });
+
+ if (res.headers.get('content-type')?.includes('application/json')) {
+ return NextResponse.json(await res.json(), { status: res.status });
}
- };
+ return NextResponse.json(await res.text(), { status: res.status });
+ } catch (e) {
+ return NextResponse.json(
+ {
+ error: 'Failed to proxy request',
+ message: e instanceof Error ? e.message : String(e),
+ },
+ { status: 500 },
+ );
+ }
}
-export function createScriptHandler() {
- return async function GET(req: Request) {
+async function handleScriptProxyRoute(req: Request): Promise<NextResponse> {
+ const url = new URL(req.url);
+ const pathname = url.pathname;
+
+ if (!pathname.endsWith(SCRIPT_PATH)) {
+ return NextResponse.json({ error: 'Not found' }, { status: 404 });
+ }
+
+ let scriptUrl = `${SCRIPT_URL}${SCRIPT_PATH}`;
+ if (url.searchParams.size > 0) {
+ scriptUrl += `?${url.searchParams.toString()}`;
+ }
+
+ try {
+ const res = await fetch(scriptUrl, {
+ // @ts-ignore
+ next: { revalidate: 86400 },
+ });
+ const text = await res.text();
+ const etag = `"${createHash('md5')
+ .update(scriptUrl + text)
+ .digest('hex')}"`;
+
+ return new NextResponse(text, {
+ headers: {
+ 'Content-Type': 'text/javascript',
+ 'Cache-Control': 'public, max-age=86400, stale-while-revalidate=86400',
+ ETag: etag,
+ },
+ });
+ } catch (e) {
+ return NextResponse.json(
+ {
+ error: 'Failed to fetch script',
+ message: e instanceof Error ? e.message : String(e),
+ },
+ { status: 500 },
+ );
+ }
+}
+
+function createRouteHandler(options?: RouteHandlerOptions) {
+ const apiUrl = options?.apiUrl ?? DEFAULT_API_URL;
+
+ return async function handler(req: Request): Promise<NextResponse> {
const url = new URL(req.url);
- const query = url.searchParams.toString();
+ const pathname = url.pathname;
+ const method = req.method;
- if (!url.pathname.endsWith('op1.js')) {
- return NextResponse.json({ error: 'Not found' }, { status: 404 });
+ // Handle script proxy: GET /op1.js
+ if (method === 'GET' && pathname.endsWith(SCRIPT_PATH)) {
+ return handleScriptProxyRoute(req);
}
- const scriptUrl = 'https://openpanel.dev/op1.js';
- try {
- const res = await fetch(scriptUrl, {
- // @ts-ignore
- next: { revalidate: 86400 },
- });
- const text = await res.text();
- const etag = `"${createHash('md5')
- .update(text + query)
- .digest('hex')}"`;
- return new NextResponse(text, {
- headers: {
- 'Content-Type': 'text/javascript',
- 'Cache-Control':
- 'public, max-age=86400, stale-while-revalidate=86400',
- ETag: etag,
- },
- });
- } catch (e) {
- return NextResponse.json(
- {
- error: 'Failed to fetch script',
- message: e instanceof Error ? e.message : String(e),
- },
- { status: 500 },
- );
+ const apiPathMatch = pathname.indexOf('/track');
+ if (apiPathMatch === -1) {
+ return NextResponse.json({ error: 'Not found' }, { status: 404 });
}
+
+ const apiPath = pathname.substring(apiPathMatch);
+ return handleApiRoute(req, apiUrl, apiPath);
};
}
+
+export { createRouteHandler };
+
+// const routeHandler = createRouteHandler();
+// export const GET = routeHandler;
+// export const POST = routeHandler;
diff --git a/packages/sdks/nextjs/index.tsx b/packages/sdks/nextjs/index.tsx
index 123ac958c..56e22ccee 100644
--- a/packages/sdks/nextjs/index.tsx
+++ b/packages/sdks/nextjs/index.tsx
@@ -68,9 +68,17 @@ export function OpenPanelComponent({
value: globalProperties,
});
}
+
+ const appendVersion = (url: string) => {
+ if (url.endsWith('.js')) {
+ return `${url}?v=${process.env.NEXTJS_VERSION!}`;
+ }
+ return url;
+ };
+
return (
<>
- <Script src={cdnUrl ?? CDN_URL} async defer />
+ <Script src={appendVersion(cdnUrl || CDN_URL)} async defer />
<Script
strategy="beforeInteractive"
dangerouslySetInnerHTML={{
diff --git a/packages/sdks/nextjs/package.json b/packages/sdks/nextjs/package.json
index 6ced47b67..12c3df358 100644
--- a/packages/sdks/nextjs/package.json
+++ b/packages/sdks/nextjs/package.json
@@ -1,6 +1,6 @@
{
"name": "@openpanel/nextjs",
- "version": "1.0.20-local",
+ "version": "1.1.0-local",
"module": "index.ts",
"scripts": {
"build": "rm -rf dist && tsup",
diff --git a/packages/sdks/nextjs/server.ts b/packages/sdks/nextjs/server.ts
index b3751d344..5857a5575 100644
--- a/packages/sdks/nextjs/server.ts
+++ b/packages/sdks/nextjs/server.ts
@@ -1,4 +1 @@
-export {
- createNextRouteHandler,
- createScriptHandler,
-} from './createNextRouteHandler';
+export { createRouteHandler } from './createNextRouteHandler';
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 47f44aea1..30d76eee2 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -275,8 +275,8 @@ importers:
specifier: workspace:*
version: link:../../packages/common
'@openpanel/nextjs':
- specifier: ^1.0.17
+ specifier: ^1.1.0
'@openpanel/payments':
specifier: workspace:^
version: link:../../packages/payments
@@ -4796,8 +4796,8 @@ packages:
resolution: {integrity: sha512-T8TbSnGsxo6TDBJx/Sgv/BlVJL3tshxZP7Aq5R1mSnM5OcHY2dQaxLMu2+E8u3gN0MLOzdjurqN4ZRVuzQycOQ==}
engines: {node: '>=8.0'}
- '@openpanel/[email protected]':
- resolution: {integrity: sha512-vH1PHlO43WJq2wOpQ36kxvWqsht6S26HHC/NyjA9uPVGAptYlXqVJi4fx5MI79azTaGMZzuxmW2yXAJhy9gjhQ==}
+ '@openpanel/[email protected]':
+ resolution: {integrity: sha512-43UM4/Vau3SxwawsgA9NRKLSFNZOvSDnJA5VZS4fnXdzc6xZ64Id82q9onrNiUItMlaV9NqVJaKGPoYfbRP9lg==}
peerDependencies:
next: ^12.0.0 || ^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0
react: ^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0
@@ -4806,14 +4806,14 @@ packages:
'@openpanel/[email protected]':
resolution: {integrity: sha512-FNmmfjdXoC/VHEjA+WkrQ4lyM5lxEmV7xDd57uj4E+lIS0sU3DLG2mV/dpS8AscnZbUvuMn3kPhiLCqYzuv/gg==}
- '@openpanel/[email protected]':
- resolution: {integrity: sha512-9YQlrEnmqyr5u+y+MRE/pHYnrtV/oInPJZclVqVDiiQyEL4GmpaU/ZAbJPNVln7ZPw4i5Voj7vrlVY3rlbWfyw==}
+ '@openpanel/[email protected]':
+ resolution: {integrity: sha512-WvVWCBcJvJhM5MYKO5Hxjo4G/E0tnK5XK2UC+hKDHtoF+iKvtUWa5bz18pFAPQprq0u/Ev2YqirPsrMQJy5g2g==}
'@openpanel/[email protected]':
resolution: {integrity: sha512-cVZ7Kr9SicczJ/RDIfEtZs8+1iGDzwkabVA/j3NqSl8VSucsC8m1+LVbjmCDzCJNnK4yVn6tEcc9PJRi2rtllw==}
- '@openpanel/[email protected]':
- resolution: {integrity: sha512-wEmVXAk6K5hRO/2KJc7GSrt6V8YhzmzntyLkEPshysnFMsWLNFDYUdu11sNy+Wn0cEb4HKDv/Nn34wNLJX0ydw==}
+ '@openpanel/[email protected]':
+ resolution: {integrity: sha512-n/A9fKiHWcDTH2N6N8MM214ET7aoNJjgpLux0GRW+CD0KDEwI8UosQvvz3UOGHZ3jWqMMsUNdU2B7eYk2W87mg==}
'@openstatus/[email protected]':
resolution: {integrity: sha512-uDiegz7e3H67pG8lTT+op+6w5keTT7XpcENrREaqlWl5j53TYyO8nheOG1PeNw2/Qgd5KaGeRJJFn1crhTUSYw==}
@@ -19884,24 +19884,24 @@ snapshots:
'@oozcitak/[email protected]': {}
dependencies:
- '@openpanel/web': 1.0.4
+ '@openpanel/web': 1.0.5
react: 19.1.1
react-dom: 19.1.1([email protected])
'@openpanel/[email protected]': {}
- '@openpanel/[email protected]': {}
+ '@openpanel/[email protected]': {}
'@openpanel/[email protected]':
dependencies:
'@openpanel/sdk': 1.0.0
- '@openpanel/[email protected]':
+ '@openpanel/[email protected]':
dependencies:
- '@openpanel/sdk': 1.0.1
+ '@openpanel/sdk': 1.0.2
dependencies: