OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.
import { zodResolver } from '@hookform/resolvers/zod';
import { zCreateS3ExportIntegration } from '@openpanel/core/modules/integration/integration.constants';
import { useMutation } from '@tanstack/react-query';
import { mergeDeepRight, path } from 'ramda';
import { Controller, useForm, useWatch } from 'react-hook-form';
import { toast } from 'sonner';
import type { z } from 'zod';
import { InputWithLabel } from '@/components/forms/input-with-label';
import { Button } from '@/components/ui/button';
import {
Select,
SelectContent,
SelectItem,
SelectTrigger,
SelectValue,
} from '@/components/ui/select';
import { useAppParams } from '@/hooks/use-app-params';
import { useTRPC } from '@/integrations/trpc/react';
import type { RouterOutputs } from '@/trpc/client';
type IForm = z.infer<typeof zCreateS3ExportIntegration>;
const AWS_REGIONS = [
'auto',
'us-east-1',
'us-east-2',
'us-west-1',
'us-west-2',
'eu-west-1',
'eu-west-2',
'eu-west-3',
'eu-central-1',
'eu-north-1',
'ap-southeast-1',
'ap-southeast-2',
'ap-northeast-1',
'ap-northeast-2',
'ap-south-1',
'sa-east-1',
];
export function S3ExportIntegrationForm({
defaultValues,
onSuccess,
}: {
defaultValues?: RouterOutputs['integration']['get'];
onSuccess: () => void;
}) {
const { projectId } = useAppParams();
const form = useForm<IForm>({
defaultValues: mergeDeepRight(
{
id: defaultValues?.id,
projectId,
name: '',
config: {
type: 's3_export' as const,
bucket: '',
prefix: 'openpanel-exports',
region: 'us-east-1',
format: 'jsonl_gzip' as const,
authMode: 'iam_role' as const,
roleArn: '',
externalId: '',
encryption: 'SSE-S3' as const,
kmsKeyId: '',
},
},
defaultValues ?? {}
),
resolver: zodResolver(zCreateS3ExportIntegration),
});
const trpc = useTRPC();
const mutation = useMutation(
trpc.integration.createOrUpdateExport.mutationOptions({
onSuccess,
onError(error) {
toast.error(error.message || 'Failed to create integration');
},
})
);
const testMutation = useMutation(
trpc.integration.testExportConnection.mutationOptions({
onSuccess(data) {
if (data.success) {
toast.success('Connection successful! Bucket is accessible.');
} else {
toast.error(`Connection failed: ${data.error}`);
}
},
onError(error) {
toast.error(error.message || 'Failed to test connection');
},
})
);
const authMode = useWatch({ control: form.control, name: 'config.authMode' });
const encryption = useWatch({
control: form.control,
name: 'config.encryption',
});
const handleSubmit = (values: IForm) => {
mutation.mutate(values);
};
const handleError = () => {
toast.error('Please fix validation errors');
};
const handleTest = () => {
const values = form.getValues();
if (!(values.config.bucket && values.config.region)) {
return toast.error('Bucket and Region are required');
}
if (values.config.authMode === 'iam_role' && !values.config.roleArn) {
return toast.error('IAM Role ARN is required');
}
if (
values.config.authMode === 'access_key' &&
!(values.config.accessKeyId && values.config.secretAccessKey)
) {
return toast.error('Access Key ID and Secret Access Key are required');
}
testMutation.mutate(values);
};
return (
<form
className="col gap-4"
onSubmit={form.handleSubmit(handleSubmit, handleError)}
>
<InputWithLabel
label="Name"
placeholder="Eg. Production S3 Export"
{...form.register('name')}
error={form.formState.errors.name?.message}
/>
<div className="grid grid-cols-2 gap-4">
<InputWithLabel
label="S3 Bucket"
placeholder="my-analytics-bucket"
{...form.register('config.bucket')}
error={path(['config', 'bucket', 'message'], form.formState.errors)}
/>
<InputWithLabel
label="Prefix"
placeholder="openpanel-exports"
{...form.register('config.prefix')}
error={path(['config', 'prefix', 'message'], form.formState.errors)}
/>
</div>
<div className="grid grid-cols-2 gap-4">
<div className="col gap-1.5">
<label className="font-medium text-sm">Region</label>
<Controller
control={form.control}
name="config.region"
render={({ field }) => (
<Select onValueChange={field.onChange} value={field.value}>
<SelectTrigger>
<SelectValue placeholder="Select region" />
</SelectTrigger>
<SelectContent>
{AWS_REGIONS.map((region) => (
<SelectItem key={region} value={region}>
{region}
</SelectItem>
))}
</SelectContent>
</Select>
)}
/>
</div>
<div className="col gap-1.5">
<label className="font-medium text-sm">Format</label>
<Controller
control={form.control}
name="config.format"
render={({ field }) => (
<Select onValueChange={field.onChange} value={field.value}>
<SelectTrigger>
<SelectValue placeholder="Select format" />
</SelectTrigger>
<SelectContent>
<SelectItem value="jsonl_gzip">JSONL (gzip)</SelectItem>
<SelectItem disabled value="parquet">
Parquet (coming soon)
</SelectItem>
</SelectContent>
</Select>
)}
/>
</div>
</div>
<div className="col gap-1.5">
<label className="font-medium text-sm">Authentication Mode</label>
<Controller
control={form.control}
name="config.authMode"
render={({ field }) => (
<Select onValueChange={field.onChange} value={field.value}>
<SelectTrigger>
<SelectValue placeholder="Select authentication mode" />
</SelectTrigger>
<SelectContent>
<SelectItem value="iam_role">IAM Role (AWS)</SelectItem>
<SelectItem value="access_key">
Access Keys (R2, MinIO, Spaces)
</SelectItem>
</SelectContent>
</Select>
)}
/>
<p className="text-muted-foreground text-xs">
{authMode === 'iam_role'
? 'Recommended for AWS S3. Create an IAM role that grants OpenPanel access.'
: 'Use access keys for Cloudflare R2, MinIO, DigitalOcean Spaces, or other S3-compatible storage.'}
</p>
</div>
{authMode === 'iam_role' && (
<>
<InputWithLabel
label="IAM Role ARN"
placeholder="arn:aws:iam::123456789012:role/OpenPanelExportRole"
{...form.register('config.roleArn')}
error={path(
['config', 'roleArn', 'message'],
form.formState.errors
)}
/>
<InputWithLabel
label="External ID (optional)"
placeholder="Optional external ID for cross-account access"
{...form.register('config.externalId')}
error={path(
['config', 'externalId', 'message'],
form.formState.errors
)}
/>
</>
)}
{authMode === 'access_key' && (
<>
<InputWithLabel
label="Endpoint URL (optional)"
placeholder="https://your-account-id.r2.cloudflarestorage.com"
{...form.register('config.endpoint')}
error={path(
['config', 'endpoint', 'message'],
form.formState.errors
)}
/>
<p className="-mt-2 text-muted-foreground text-xs">
Required for R2, MinIO, etc. Leave empty for AWS S3.
</p>
<div className="grid grid-cols-2 gap-4">
<InputWithLabel
label="Access Key ID"
placeholder="AKIAIOSFODNN7EXAMPLE"
{...form.register('config.accessKeyId')}
error={path(
['config', 'accessKeyId', 'message'],
form.formState.errors
)}
/>
<InputWithLabel
label="Secret Access Key"
placeholder={
defaultValues?.id
? 'Leave blank to keep the current key'
: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'
}
type="password"
// Stored secrets are never sent back to the browser, so an edit
// starts blank and blank means "keep the stored key".
{...form.register('config.secretAccessKey')}
error={path(
['config', 'secretAccessKey', 'message'],
form.formState.errors
)}
/>
</div>
</>
)}
<div className="grid grid-cols-2 gap-4">
<div className="col gap-1.5">
<label className="font-medium text-sm">Encryption</label>
<Controller
control={form.control}
name="config.encryption"
render={({ field }) => (
<Select onValueChange={field.onChange} value={field.value}>
<SelectTrigger>
<SelectValue placeholder="Select encryption" />
</SelectTrigger>
<SelectContent>
<SelectItem value="SSE-S3">SSE-S3 (AES-256)</SelectItem>
<SelectItem value="SSE-KMS">SSE-KMS</SelectItem>
<SelectItem value="none">None</SelectItem>
</SelectContent>
</Select>
)}
/>
</div>
{encryption === 'SSE-KMS' && (
<InputWithLabel
label="KMS Key ID"
placeholder="arn:aws:kms:us-east-1:..."
{...form.register('config.kmsKeyId')}
error={path(
['config', 'kmsKeyId', 'message'],
form.formState.errors
)}
/>
)}
</div>
<div className="row gap-4">
<Button
disabled={testMutation.isPending}
onClick={handleTest}
type="button"
variant="outline"
>
{testMutation.isPending ? 'Testing...' : 'Test connection'}
</Button>
<Button className="flex-1" disabled={mutation.isPending} type="submit">
{mutation.isPending
? 'Saving...'
: defaultValues?.id
? 'Update'
: 'Create'}
</Button>
</div>
</form>
);
}