OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.
web & sdk: improved sdk (better failover and batching)
Carl-Gerhard Lindesvärd5b5ad23f66d5
diff --git a/.gitignore b/.gitignoreindex 193e7fdd6..8303cd42e 100644--- a/.gitignore+++ b/.gitignore@@ -1,6 +1,7 @@# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignorepackages/sdk/profileId.txtpackages/sdk/test.ts+dump.sql# Logsdiff --git a/apps/test/src/pages/_app.tsx b/apps/test/src/pages/_app.tsxindex 3a6c316e4..a27e88944 100644--- a/apps/test/src/pages/_app.tsx+++ b/apps/test/src/pages/_app.tsx@@ -3,10 +3,11 @@ import { mixan } from '@/analytics';import type { AppProps } from 'next/app';import { useRouter } from 'next/router';+mixan.init();+export default function MyApp({ Component, pageProps }: AppProps) {const router = useRouter();useEffect(() => {- mixan.init();return router.events.on('routeChangeComplete', () => {mixan.screenView();});diff --git a/apps/test/src/pages/test.tsx b/apps/test/src/pages/test.tsxindex 8d670b4e4..300908d55 100644--- a/apps/test/src/pages/test.tsx+++ b/apps/test/src/pages/test.tsx@@ -1,9 +1,53 @@+import { mixan } from '@/analytics';import Link from 'next/link';export default function Test() {return (<div><Link href="/">Home</Link>+ <button+ onClick={() => {+ mixan.setUser({+ first_name: 'John',+ });+ mixan.setUser({+ last_name: 'Doe',+ });+ mixan.setUser({+ email: '[email protected]',+ });+ mixan.setUser({+ id: '1234',+ });+ }}+ >+ Set user+ </button>+ <button+ onClick={() => {+ localStorage.clear();+ window.location.reload();+ }}+ >+ Clear storage and reload+ </button>+ <button+ onClick={() => {+ mixan.event('custom_click', {+ custom_string: 'test',+ custom_number: 1,+ });+ }}+ >+ Trigger event+ </button>+ <button+ onClick={() => {+ mixan.clear();+ }}+ >+ Logout+ </button></div>);}diff --git a/apps/web/prisma/migrations/20240110151531_add_cors_settings_on_client/migration.sql b/apps/web/prisma/migrations/20240110151531_add_cors_settings_on_client/migration.sqlnew file mode 100644index 000000000..cded98e86--- /dev/null+++ b/apps/web/prisma/migrations/20240110151531_add_cors_settings_on_client/migration.sql@@ -0,0 +1,3 @@+-- AlterTable+ALTER TABLE "clients" ADD COLUMN "cors" TEXT NOT NULL DEFAULT '*',+ALTER COLUMN "secret" DROP NOT NULL;diff --git a/apps/web/prisma/migrations/20240112083054_add_failed_events/migration.sql b/apps/web/prisma/migrations/20240112083054_add_failed_events/migration.sqlnew file mode 100644index 000000000..768fc013a--- /dev/null+++ b/apps/web/prisma/migrations/20240112083054_add_failed_events/migration.sql@@ -0,0 +1,9 @@+-- CreateTable+CREATE TABLE "event_failed" (+ "id" UUID NOT NULL DEFAULT gen_random_uuid(),+ "data" JSONB NOT NULL,+ "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,+ "updatedAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,++ CONSTRAINT "event_failed_pkey" PRIMARY KEY ("id")+);diff --git a/apps/web/prisma/schema.prisma b/apps/web/prisma/schema.prismaindex c96479f57..4d298835a 100644--- a/apps/web/prisma/schema.prisma+++ b/apps/web/prisma/schema.prisma@@ -90,14 +90,24 @@ model Profile {@@map("profiles")}+model EventFailed {+ id String @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid+ data Json+ createdAt DateTime @default(now())+ updatedAt DateTime @default(now()) @updatedAt++ @@map("event_failed")+}+model Client {id String @id @default(dbgenerated("gen_random_uuid()")) @db.Uuidname String- secret String+ secret String?project_id String @db.Uuidproject Project @relation(fields: [project_id], references: [id])organization_id String @db.Uuidorganization Organization @relation(fields: [organization_id], references: [id])+ cors String @default("*")createdAt DateTime @default(now())updatedAt DateTime @default(now()) @updatedAtdiff --git a/apps/web/src/components/Syntax.tsx b/apps/web/src/components/Syntax.tsxindex c353bddc9..347df66bc 100644--- a/apps/web/src/components/Syntax.tsx+++ b/apps/web/src/components/Syntax.tsx@@ -9,5 +9,9 @@ interface SyntaxProps {}export default function Syntax({ code }: SyntaxProps) {- return <SyntaxHighlighter style={docco}>{code}</SyntaxHighlighter>;+ return (+ <SyntaxHighlighter wrapLongLines style={docco}>+ {code}+ </SyntaxHighlighter>+ );}diff --git a/apps/web/src/components/clients/table.tsx b/apps/web/src/components/clients/table.tsxindex 440e8dbbd..b6b454534 100644--- a/apps/web/src/components/clients/table.tsx+++ b/apps/web/src/components/clients/table.tsx@@ -23,17 +23,26 @@ export const columns: ColumnDef<IClientWithProject>[] = [accessorKey: 'id',header: 'Client ID',},+ {+ accessorKey: 'cors',+ header: 'Cors',+ },{accessorKey: 'secret',header: 'Secret',- cell: () => <div className="italic text-muted-foreground">Hidden</div>,+ cell: (info) =>+ info.getValue() ? (+ <div className="italic text-muted-foreground">Hidden</div>+ ) : (+ 'None'+ ),},{accessorKey: 'createdAt',header: 'Created at',cell({ row }) {const date = row.original.createdAt;- return <div>{formatDate(date)}</div>;+ return formatDate(date);},},{diff --git a/apps/web/src/components/forms/InputWithLabel.tsx b/apps/web/src/components/forms/InputWithLabel.tsxindex e9f0c4611..47df69dfa 100644--- a/apps/web/src/components/forms/InputWithLabel.tsx+++ b/apps/web/src/components/forms/InputWithLabel.tsx@@ -9,9 +9,9 @@ type InputWithLabelProps = InputProps & {};export const InputWithLabel = forwardRef<HTMLInputElement, InputWithLabelProps>(- ({ label, ...props }, ref) => {+ ({ label, className, ...props }, ref) => {return (- <div>+ <div className={className}><Label htmlFor={label} className="block mb-2">{label}</Label>diff --git a/apps/web/src/modals/AddClient.tsx b/apps/web/src/modals/AddClient.tsxindex 2e4c292aa..9366b818c 100644--- a/apps/web/src/modals/AddClient.tsx+++ b/apps/web/src/modals/AddClient.tsx@@ -1,8 +1,10 @@import { ButtonContainer } from '@/components/ButtonContainer';import { InputWithLabel } from '@/components/forms/InputWithLabel';import { Button } from '@/components/ui/button';+import { Checkbox } from '@/components/ui/checkbox';import { Combobox } from '@/components/ui/combobox';import { Label } from '@/components/ui/label';+import { RadioGroup, RadioGroupItem } from '@/components/ui/radio-group';import { toast } from '@/components/ui/use-toast';import { useOrganizationParams } from '@/hooks/useOrganizationParams';import { useRefetchActive } from '@/hooks/useRefetchActive';@@ -11,7 +13,7 @@ import { clipboard } from '@/utils/clipboard';import { zodResolver } from '@hookform/resolvers/zod';import { Copy } from 'lucide-react';import dynamic from 'next/dynamic';-import { Controller, useForm } from 'react-hook-form';+import { Controller, useForm, useWatch } from 'react-hook-form';import { z } from 'zod';import { popModal } from '.';@@ -21,6 +23,8 @@ const Syntax = dynamic(import('@/components/Syntax'));const validator = z.object({name: z.string().min(1, 'Required'),+ cors: z.string().min(1, 'Required'),+ withCors: z.boolean(),projectId: z.string().min(1, 'Required'),});@@ -46,12 +50,29 @@ export default function CreateProject() {resolver: zodResolver(validator),defaultValues: {name: '',+ cors: '*',projectId: '',+ withCors: true,},});+ const withCors = useWatch({+ control,+ name: 'withCors',+ });+if (mutation.isSuccess && mutation.data) {- const { clientId, clientSecret } = mutation.data;+ const { clientId, clientSecret, cors } = mutation.data;+ const snippet = clientSecret+ ? `const mixan = new Mixan({+ clientId: "${clientId}",+ // Avoid using this on web, rely on cors settings instead+ // Mostly for react-native and node/backend+ clientSecret: "${clientSecret}",+})`+ : `const mixan = new Mixan({+ clientId: "${clientId}",+})`;return (<ModalContent><ModalHeader title="Client created 🚀" />@@ -60,32 +81,36 @@ export default function CreateProject() {so keep it safe 🫣</p>- <button className="mt-4 text-left" onClick={() => clipboard(clientId)}>- <Label>Client ID</Label>+ <button className="mt-4 text-left" onClick={() => clipboard(cors)}>+ <Label>Cors settings</Label><div className="flex items-center justify-between rounded bg-gray-100 p-2 px-3">- {clientId}+ {cors}<Copy size={16} /></div></button>- <button- className="mt-4 text-left"- onClick={() => clipboard(clientSecret)}- >- <Label>Client Secret</Label>+ <button className="mt-4 text-left" onClick={() => clipboard(clientId)}>+ <Label>Client ID</Label><div className="flex items-center justify-between rounded bg-gray-100 p-2 px-3">- {clientSecret}+ {clientId}<Copy size={16} /></div></button>+ {clientSecret && (+ <button+ className="mt-4 text-left"+ onClick={() => clipboard(clientSecret)}+ >+ <Label>Client Secret</Label>+ <div className="flex items-center justify-between rounded bg-gray-100 p-2 px-3">+ {clientSecret}+ <Copy size={16} />+ </div>+ </button>+ )}<div className="mt-4"><Label>Code snippet</Label>- <div className="overflow-x-auto [&_pre]:!rounded [&_pre]:!bg-gray-100 [&_pre]:text-sm">- <Syntax- code={`const mixan = new Mixan({- clientId: "${clientId}",- clientSecret: "${clientSecret}",-})`}- />+ <div className="[&_pre]:!rounded [&_pre]:!bg-gray-100 [&_pre]:text-sm">+ <Syntax code={snippet} /></div></div>@@ -114,6 +139,36 @@ export default function CreateProject() {{...register('name')}className="mb-4"/>++ <Controller+ name="withCors"+ control={control}+ render={({ field }) => (+ <label className="flex items-center gap-2 text-sm font-medium leading-none mb-4">+ <Checkbox+ ref={field.ref}+ onBlur={field.onBlur}+ defaultChecked={field.value}+ onCheckedChange={(checked) => {+ field.onChange(checked);+ }}+ />+ Auth with cors settings+ </label>+ )}+ />+ {withCors && (+ <>+ <InputWithLabel+ label="Cors"+ placeholder="Cors"+ {...register('cors')}+ />+ <div className="text-xs text-muted-foreground mb-4 mt-1">+ Restrict access by domain names (include https://)+ </div>+ </>+ )}<Controllercontrol={control}name="projectId"diff --git a/apps/web/src/modals/EditClient.tsx b/apps/web/src/modals/EditClient.tsxindex 7ff271ca2..8a081ed43 100644--- a/apps/web/src/modals/EditClient.tsx+++ b/apps/web/src/modals/EditClient.tsx@@ -19,6 +19,7 @@ interface EditClientProps {const validator = z.object({id: z.string().min(1),name: z.string().min(1),+ cors: z.string().min(1),});type IForm = z.infer<typeof validator>;@@ -43,6 +44,7 @@ export default function EditClient({ id }: EditClientProps) {defaultValues: {id: '',name: '',+ cors: '',},});@@ -60,7 +62,18 @@ export default function EditClient({ id }: EditClientProps) {mutation.mutate(values);})}>- <InputWithLabel label="Name" placeholder="Name" {...register('name')} />+ <div className="flex flex-col gap-4">+ <InputWithLabel+ label="Name"+ placeholder="Name"+ {...register('name')}+ />+ <InputWithLabel+ label="Cors"+ placeholder="Cors"+ {...register('cors')}+ />+ </div><ButtonContainer><Button type="button" variant="outline" onClick={() => popModal()}>Canceldiff --git a/apps/web/src/pages/api/sdk/batch.ts b/apps/web/src/pages/api/sdk/batch.tsnew file mode 100644index 000000000..38d5cd702--- /dev/null+++ b/apps/web/src/pages/api/sdk/batch.ts@@ -0,0 +1,238 @@+import { validateSdkRequest } from '@/server/auth';+import { db } from '@/server/db';+import { createError, handleError } from '@/server/exceptions';+import { tickProfileProperty } from '@/server/services/profile.service';+import { Prisma } from '@prisma/client';+import type { NextApiRequest, NextApiResponse } from 'next';+import { mergeDeepRight } from 'ramda';++import type { BatchPayload } from '@mixan/types';++interface Request extends NextApiRequest {+ body: BatchPayload[];+}++export const config = {+ api: {+ responseLimit: false,+ },+};++export default async function handler(req: Request, res: NextApiResponse) {+ if (req.method == 'OPTIONS') {+ await validateSdkRequest(req, res);+ return res.status(200).json({});+ }++ if (req.method !== 'POST') {+ return handleError(res, createError(405, 'Method not allowed'));+ }++ const time = Date.now();++ try {+ // Check client id & secret+ const projectId = await validateSdkRequest(req, res);++ const profileIds = new Set<string>(+ req.body+ .map((item) => item.payload.profileId)+ .filter((id): id is string => typeof id === 'string' && id.length > 0)+ );++ if (profileIds.size === 0) {+ return res.status(400).json({ status: 'error' });+ }++ const profiles = await db.profile.findMany({+ where: {+ id: {+ in: Array.from(profileIds),+ },+ },+ });++ // eslint-disable-next-line no-inner-declarations+ async function getProfile(profileId: string) {+ const profile = profiles.find((profile) => profile.id === profileId);+ if (profile) {+ return profile;+ }++ const created = await db.profile.create({+ data: {+ id: profileId,+ properties: {},+ project_id: projectId,+ },+ });++ profiles.push(created);++ return created;+ }++ const mergedBody: BatchPayload[] = req.body.reduce((acc, item) => {+ const canMerge =+ item.type === 'update_profile' || item.type === 'update_session';++ if (!canMerge) {+ return [...acc, item];+ }++ const match = acc.findIndex(+ (i) =>+ i.type === item.type && i.payload.profileId === item.payload.profileId+ );++ if (acc[match]) {+ acc[match]!.payload = mergeDeepRight(acc[match]!.payload, item.payload);+ } else {+ acc.push(item);+ }++ return acc;+ }, [] as BatchPayload[]);++ const failedEvents: BatchPayload[] = [];++ for (const item of mergedBody) {+ try {+ const { type, payload } = item;+ const profile = await getProfile(payload.profileId);+ switch (type) {+ case 'create_profile': {+ profile.properties = {+ ...(typeof profile.properties === 'object'+ ? profile.properties ?? {}+ : {}),+ ...(payload.properties ?? {}),+ };+ await db.profile.update({+ where: {+ id: payload.profileId,+ },+ data: {+ properties: profile.properties,+ },+ });+ break;+ }+ case 'update_profile': {+ profile.properties = {+ ...(typeof profile.properties === 'object'+ ? profile.properties ?? {}+ : {}),+ ...(payload.properties ?? {}),+ };+ await db.profile.update({+ where: {+ id: payload.profileId,+ },+ data: {+ external_id: payload.id,+ email: payload.email,+ first_name: payload.first_name,+ last_name: payload.last_name,+ avatar: payload.avatar,+ properties: profile.properties,+ },+ });+ break;+ }+ case 'set_profile_property': {+ if (+ typeof (profile.properties as Record<string, unknown>)[+ payload.name+ ] === 'undefined'+ ) {+ (profile.properties as Record<string, unknown>)[payload.name] =+ payload.value;++ await db.profile.update({+ where: {+ id: payload.profileId,+ },+ data: {+ // @ts-expect-error+ properties: profile.properties,+ },+ });+ }+ break;+ }+ case 'increment': {+ await tickProfileProperty({+ profileId: payload.profileId,+ name: payload.name,+ tick: payload.value,+ });+ break;+ }+ case 'decrement': {+ await tickProfileProperty({+ profileId: payload.profileId,+ name: payload.name,+ tick: -Math.abs(payload.value),+ });+ break;+ }+ case 'event': {+ await db.event.create({+ data: {+ name: payload.name,+ properties: payload.properties,+ createdAt: payload.time,+ project_id: projectId,+ profile_id: payload.profileId,+ },+ });+ break;+ }+ case 'update_session': {+ const session = await db.event.findFirst({+ where: {+ profile_id: payload.profileId,+ project_id: projectId,+ name: 'session_start',+ },+ orderBy: {+ createdAt: 'desc',+ },+ });+ if (session) {+ await db.$executeRawUnsafe(+ `UPDATE events SET properties = '${JSON.stringify(+ payload.properties+ )}' || properties WHERE "createdAt" >= '${session.createdAt.toISOString()}' AND profile_id = '${+ payload.profileId+ }'`+ );+ }+ break;+ }+ }+ } catch (error) {+ console.log(`Failed to create "${item.type}"`);+ console.log(' > Payload:', item.payload);+ console.log(' > Error:', error);+ failedEvents.push(item);+ }+ } // end for++ await db.eventFailed.createMany({+ data: failedEvents.map((item) => ({+ data: item as Record<string, any>,+ })),+ });++ console.log('Batch took', Date.now() - time, 'ms', {+ events: req.body.length,+ combined: mergedBody.length,+ });++ res.status(200).json({ status: 'ok' });+ } catch (error) {+ handleError(res, error);+ }+}diff --git a/apps/web/src/pages/api/sdk/events.ts b/apps/web/src/pages/api/sdk/events.tsindex 7645130cf..cff11717c 100644--- a/apps/web/src/pages/api/sdk/events.ts+++ b/apps/web/src/pages/api/sdk/events.ts@@ -11,7 +11,8 @@ interface Request extends NextApiRequest {export default async function handler(req: Request, res: NextApiResponse) {if (req.method == 'OPTIONS') {- return res.status(202).json({});+ await validateSdkRequest(req, res);+ return res.status(200).json({});}if (req.method !== 'POST') {@@ -20,7 +21,7 @@ export default async function handler(req: Request, res: NextApiResponse) {try {// Check client id & secret- const projectId = await validateSdkRequest(req);+ const projectId = await validateSdkRequest(req, res);await db.event.createMany({data: req.body.map((event) => ({diff --git a/apps/web/src/pages/api/sdk/profiles/[profileId]/decrement.ts b/apps/web/src/pages/api/sdk/profiles/[profileId]/decrement.tsindex ae5537006..ba810174c 100644--- a/apps/web/src/pages/api/sdk/profiles/[profileId]/decrement.ts+++ b/apps/web/src/pages/api/sdk/profiles/[profileId]/decrement.ts@@ -11,7 +11,8 @@ interface Request extends NextApiRequest {export default async function handler(req: Request, res: NextApiResponse) {if (req.method == 'OPTIONS') {- return res.status(202).json({});+ await validateSdkRequest(req, res);+ return res.status(200).json({});}if (req.method !== 'PUT') {@@ -20,7 +21,7 @@ export default async function handler(req: Request, res: NextApiResponse) {try {// Check client id & secret- await validateSdkRequest(req);+ await validateSdkRequest(req, res);const profileId = req.query.profileId as string;diff --git a/apps/web/src/pages/api/sdk/profiles/[profileId]/increment.ts b/apps/web/src/pages/api/sdk/profiles/[profileId]/increment.tsindex c45a48fb0..12caca213 100644--- a/apps/web/src/pages/api/sdk/profiles/[profileId]/increment.ts+++ b/apps/web/src/pages/api/sdk/profiles/[profileId]/increment.ts@@ -11,7 +11,8 @@ interface Request extends NextApiRequest {export default async function handler(req: Request, res: NextApiResponse) {if (req.method == 'OPTIONS') {- return res.status(202).json({});+ await validateSdkRequest(req, res);+ return res.status(200).json({});}if (req.method !== 'PUT') {@@ -20,7 +21,7 @@ export default async function handler(req: Request, res: NextApiResponse) {try {// Check client id & secret- await validateSdkRequest(req);+ await validateSdkRequest(req, res);const profileId = req.query.profileId as string;diff --git a/apps/web/src/pages/api/sdk/profiles/[profileId]/index.ts b/apps/web/src/pages/api/sdk/profiles/[profileId]/index.tsindex 14dc80975..5500b8d4e 100644--- a/apps/web/src/pages/api/sdk/profiles/[profileId]/index.ts+++ b/apps/web/src/pages/api/sdk/profiles/[profileId]/index.ts@@ -12,7 +12,8 @@ interface Request extends NextApiRequest {export default async function handler(req: Request, res: NextApiResponse) {if (req.method == 'OPTIONS') {- return res.status(202).json({});+ await validateSdkRequest(req, res);+ return res.status(200).json({});}if (req.method !== 'PUT' && req.method !== 'POST') {@@ -21,7 +22,7 @@ export default async function handler(req: Request, res: NextApiResponse) {try {// Check client id & secret- await validateSdkRequest(req);+ await validateSdkRequest(req, res);const profileId = req.query.profileId as string;const profile = await getProfile(profileId);diff --git a/apps/web/src/pages/api/sdk/profiles/index.ts b/apps/web/src/pages/api/sdk/profiles/index.tsindex 7afcdbb57..cd6a37236 100644--- a/apps/web/src/pages/api/sdk/profiles/index.ts+++ b/apps/web/src/pages/api/sdk/profiles/index.ts@@ -4,16 +4,20 @@ import { createError, handleError } from '@/server/exceptions';import type { NextApiRequest, NextApiResponse } from 'next';import randomAnimalName from 'random-animal-name';+import type {+ CreateProfilePayload,+ CreateProfileResponse,+ ProfilePayload,+} from '@mixan/types';+interface Request extends NextApiRequest {- body: {- id?: string;- properties?: Record<string, any>;- };+ body: ProfilePayload | CreateProfilePayload;}export default async function handler(req: Request, res: NextApiResponse) {if (req.method == 'OPTIONS') {- return res.status(202).json({});+ await validateSdkRequest(req, res);+ return res.status(200).json({});}if (req.method !== 'POST') {@@ -22,12 +26,15 @@ export default async function handler(req: Request, res: NextApiResponse) {try {// Check client id & secret- const projectId = await validateSdkRequest(req);+ const projectId = await validateSdkRequest(req, res);++ // Providing an `ID` is deprecated, should be removed in the future+ const profileId = 'id' in req.body ? req.body.id : undefined;+ const { properties } = req.body ?? {};- const { id, properties } = req.body ?? {};const profile = await db.profile.create({data: {- id,+ id: profileId,external_id: null,email: null,first_name: randomAnimalName(),@@ -40,7 +47,8 @@ export default async function handler(req: Request, res: NextApiResponse) {},});- res.status(200).json({ id: profile.id });+ const response: CreateProfileResponse = { id: profile.id };+ res.status(200).json(response);} catch (error) {handleError(res, error);}diff --git a/apps/web/src/server/api/routers/client.ts b/apps/web/src/server/api/routers/client.tsindex 75455d792..3b51d7ef7 100644--- a/apps/web/src/server/api/routers/client.ts+++ b/apps/web/src/server/api/routers/client.ts@@ -59,6 +59,7 @@ export const clientRouter = createTRPCRouter({name: z.string(),projectId: z.string(),organizationSlug: z.string(),+ withCors: z.boolean().default(true),})).mutation(async ({ input }) => {@@ -69,13 +70,14 @@ export const clientRouter = createTRPCRouter({organization_id: organization.id,project_id: input.projectId,name: input.name,- secret: await hashPassword(secret),+ secret: input.withCors ? null : await hashPassword(secret),},});return {- clientSecret: secret,+ clientSecret: input.withCors ? null : secret,clientId: client.id,+ cors: client.cors,};}),remove: protectedProcedurediff --git a/apps/web/src/server/auth.ts b/apps/web/src/server/auth.tsindex 1b8267624..6606b3261 100644--- a/apps/web/src/server/auth.ts+++ b/apps/web/src/server/auth.ts@@ -1,6 +1,10 @@import { db } from '@/server/db';import { verifyPassword } from '@/server/services/hash.service';-import type { GetServerSidePropsContext, NextApiRequest } from 'next';+import type {+ GetServerSidePropsContext,+ NextApiRequest,+ NextApiResponse,+} from 'next';import { getServerSession } from 'next-auth';import type { DefaultSession, NextAuthOptions } from 'next-auth';import Credentials from 'next-auth/providers/credentials';@@ -98,7 +102,10 @@ export const getServerAuthSession = (ctx: {return getServerSession(ctx.req, ctx.res, authOptions);};-export async function validateSdkRequest(req: NextApiRequest): Promise<string> {+export async function validateSdkRequest(+ req: NextApiRequest,+ res: NextApiResponse+): Promise<string> {const clientId = req?.headers['mixan-client-id'] as string | undefined;const clientSecret = req.headers['mixan-client-secret'] as string | undefined;@@ -106,10 +113,6 @@ export async function validateSdkRequest(req: NextApiRequest): Promise<string> {throw createError(401, 'Misisng client id');}- if (!clientSecret) {- throw createError(401, 'Misisng client secret');- }-const client = await db.client.findUnique({where: {id: clientId,@@ -120,8 +123,12 @@ export async function validateSdkRequest(req: NextApiRequest): Promise<string> {throw createError(401, 'Invalid client id');}- if (!(await verifyPassword(clientSecret, client.secret))) {- throw createError(401, 'Invalid client secret');+ if (client.secret) {+ if (!(await verifyPassword(clientSecret || '', client.secret))) {+ throw createError(401, 'Invalid client secret');+ }+ } else if (client.cors !== '*') {+ res.setHeader('Access-Control-Allow-Origin', client.cors);}return client.project_id;diff --git a/packages/sdk-native/index.ts b/packages/sdk-native/index.tsindex e322aab1e..75ee72522 100644--- a/packages/sdk-native/index.ts+++ b/packages/sdk-native/index.ts@@ -6,15 +6,8 @@ export class MixanNative extends Mixan {super(options);}- async properties() {- return {- ip: await super.ip(),- };- }-- async init(properties: Record<string, unknown>) {+ init(properties?: Record<string, unknown>) {super.init({- ...(await this.properties()),...(properties ?? {}),});}diff --git a/packages/sdk-web/index.ts b/packages/sdk-web/index.tsindex 6fb9fd42d..29aa00200 100644--- a/packages/sdk-web/index.ts+++ b/packages/sdk-web/index.ts@@ -1,45 +1,56 @@import type { NewMixanOptions } from '@mixan/sdk';import { Mixan } from '@mixan/sdk';+import type { PartialBy } from '@mixan/types';import { parseQuery } from './src/parseQuery';import { getDevice, getOS, getTimezone } from './src/utils';-type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;-type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;-export class MixanWeb extends Mixan {constructor(options: PartialBy<NewMixanOptions, 'setItem' | 'removeItem' | 'getItem'>) {+ const hasStorage = typeof localStorage === 'undefined';super({- batchInterval: options.batchInterval ?? 1000,- setItem:- typeof localStorage === 'undefined'- ? () => {}- : localStorage.setItem.bind(localStorage),- removeItem:- typeof localStorage === 'undefined'- ? () => {}- : localStorage.removeItem.bind(localStorage),- getItem:- typeof localStorage === 'undefined'- ? () => null- : localStorage.getItem.bind(localStorage),+ batchInterval: options.batchInterval ?? 2000,+ setItem: hasStorage ? () => {} : localStorage.setItem.bind(localStorage),+ removeItem: hasStorage+ ? () => {}+ : localStorage.removeItem.bind(localStorage),+ getItem: hasStorage+ ? () => null+ : localStorage.getItem.bind(localStorage),...options,});}- isServer() {+ private isServer() {return typeof document === 'undefined';}- async properties() {+ private parseUrl(url?: string) {+ if (!url || url === '') {+ return {+ direct: true,+ };+ }++ const ref = new URL(url);+ return {+ host: ref.host,+ hostname: ref.hostname,+ url: ref.href,+ path: ref.pathname,+ query: parseQuery(ref.search),+ hash: ref.hash,+ };+ }++ private properties() {return {- ip: await super.ip(),os: getOS(),device: getDevice(),ua: navigator.userAgent,- referrer: document.referrer,+ referrer: this.parseUrl(document.referrer),language: navigator.language,timezone: getTimezone(),screen: {@@ -47,22 +58,28 @@ export class MixanWeb extends Mixan {height: window.screen.height,pixelRatio: window.devicePixelRatio,},+ title: document.title,+ ...this.parseUrl(window.location.href),};}- async init(properties?: Record<string, unknown>) {+ public init(properties?: Record<string, unknown>) {if (this.isServer()) {return;}super.init({- ...(await this.properties()),+ ...this.properties(),...(properties ?? {}),});this.screenView();++ window.addEventListener('beforeunload', () => {+ this.flush();+ });}- trackOutgoingLinks() {+ public trackOutgoingLinks() {if (this.isServer()) {return;}@@ -82,16 +99,15 @@ export class MixanWeb extends Mixan {});}- screenView(properties?: Record<string, unknown>): void {+ public screenView(properties?: Record<string, unknown>): void {if (this.isServer()) {return;}super.event('screen_view', {...properties,- route: window.location.pathname,- url: window.location.href,- query: parseQuery(window.location.search ?? ''),+ ...this.parseUrl(window.location.href),+ title: document.title,});}}diff --git a/packages/sdk/index.ts b/packages/sdk/index.tsindex 4c42831ec..46898e70b 100644--- a/packages/sdk/index.ts+++ b/packages/sdk/index.ts@@ -1,37 +1,60 @@import type {- EventPayload,+ BatchPayload,+ BatchUpdateProfilePayload,+ BatchUpdateSessionPayload,MixanErrorResponse,- ProfilePayload,} from '@mixan/types';+type MixanLogger = (...args: unknown[]) => void;+export interface NewMixanOptions {url: string;clientId: string;- clientSecret: string;+ clientSecret?: string;batchInterval?: number;maxBatchSize?: number;sessionTimeout?: number;session?: boolean;verbose?: boolean;- profile?: boolean;trackIp?: boolean;+ ipUrl?: string;setItem: (key: string, profileId: string) => void;getItem: (key: string) => string | null;removeItem: (key: string) => void;}+export type MixanOptions = Required<NewMixanOptions>;+export interface MixanState {+ profileId: string;+ lastEventAt: number;+ properties: Record<string, unknown>;+}++function createLogger(verbose: boolean): MixanLogger {+ return verbose ? (...args) => console.log('[Mixan]', ...args) : () => {};+}++function uuid() {+ return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {+ const r = (Math.random() * 16) | 0;+ const v = c === 'x' ? r : (r & 0x3) | 0x8;+ return v.toString(16);+ });+}+class Fetcher {private url: string;private clientId: string;private clientSecret: string;- private logger: (...args: any[]) => void;- constructor(options: MixanOptions) {+ constructor(+ options: MixanOptions,+ private logger: MixanLogger+ ) {this.url = options.url;this.clientId = options.clientId;this.clientSecret = options.clientSecret;- this.logger = options.verbose ? console.log : () => {};}post<PostData, PostResponse>(@@ -40,91 +63,96 @@ class Fetcher {options?: RequestInit): Promise<PostResponse | null> {const url = `${this.url}${path}`;- this.logger(`Mixan request: ${url}`, JSON.stringify(data, null, 2));+ let timer: ReturnType<typeof setTimeout>;- return fetch(url, {- headers: {- ['mixan-client-id']: this.clientId,- ['mixan-client-secret']: this.clientSecret,- 'Content-Type': 'application/json',- },- method: 'POST',- body: JSON.stringify(data ?? {}),- keepalive: true,- ...(options ?? {}),- })- .then(async (res) => {- const response = (await res.json()) as- | MixanErrorResponse- | PostResponse;-- if (!response) {- return null;- }+ return new Promise((resolve) => {+ const wrappedFetch = (attempt: number) => {+ clearTimeout(timer);++ this.logger(+ `Request attempt ${attempt + 1}: ${url}`,+ JSON.stringify(data, null, 2)+ );- if (- typeof response === 'object' &&- 'status' in response &&- response.status === 'error'- ) {- this.logger(- `Mixan request failed: [${options?.method ?? 'POST'}] ${url}`,- JSON.stringify(response, null, 2)- );- return null;+ fetch(url, {+ headers: {+ ['mixan-client-id']: this.clientId,+ ['mixan-client-secret']: this.clientSecret,+ 'Content-Type': 'application/json',+ },+ method: 'POST',+ body: JSON.stringify(data ?? {}),+ keepalive: true,+ ...(options ?? {}),+ })+ .then(async (res) => {+ if (res.status !== 200) {+ return retry(attempt, resolve);+ }++ const response = (await res.json()) as+ | MixanErrorResponse+ | PostResponse;++ if (!response) {+ return resolve(null);+ }++ resolve(response as PostResponse);+ })+ .catch(() => {+ return retry(attempt, resolve);+ });+ };++ function retry(+ attempt: number,+ resolve: (value: PostResponse | null) => void+ ) {+ if (attempt > 3) {+ return resolve(null);}- return response as PostResponse;- })- .catch(() => {- this.logger(- `Mixan request failed: [${options?.method ?? 'POST'}] ${url}`+ timer = setTimeout(+ () => {+ wrappedFetch(attempt + 1);+ },+ Math.pow(2, attempt) * 500);- return null;- });+ }++ wrappedFetch(0);+ });}}-class Batcher<T> {- queue: T[] = [];+class Batcher {+ queue: BatchPayload[] = [];timer?: ReturnType<typeof setTimeout>;- callback: (queue: T[]) => void;- maxBatchSize: number;- batchInterval: number;-- constructor(options: MixanOptions, callback: (queue: T[]) => void) {- this.callback = callback;- this.maxBatchSize = options.maxBatchSize;- this.batchInterval = options.batchInterval;- }- add(payload: T) {- this.queue.push(payload);- this.flush();- }+ constructor(+ private options: MixanOptions,+ private callback: (payload: BatchPayload[]) => void,+ private logger: MixanLogger+ ) {}- flush() {+ add(action: BatchPayload) {if (this.timer) {clearTimeout(this.timer);}- if (this.queue.length === 0) {- return;- }+ this.logger(`Add to queue ${action.type}`);+ this.queue.push(action);- if (this.queue.length >= this.maxBatchSize) {+ if (this.queue.length >= this.options.maxBatchSize) {this.send();- return;+ } else {+ this.timer = setTimeout(this.send.bind(this), this.options.batchInterval);}-- this.timer = setTimeout(this.send.bind(this), this.batchInterval);}send() {- if (this.timer) {- clearTimeout(this.timer);- }-+ this.logger('Send queue', this.queue.length > 0);if (this.queue.length > 0) {this.callback(this.queue);this.queue = [];@@ -133,17 +161,18 @@ class Batcher<T> {}export class Mixan {- private fetch: Fetcher;- private eventBatcher: Batcher<EventPayload>;- private profileId?: string;private options: MixanOptions;+ private fetch: Fetcher;+ private batcher: Batcher;private logger: (...args: any[]) => void;- private globalProperties: Record<string, unknown> = {};- private lastEventAt: string;- private promiseIp: Promise<string | null>;+ private state: MixanState = {+ profileId: '',+ lastEventAt: 0,+ properties: {},+ };constructor(options: NewMixanOptions) {- this.logger = options.verbose ? console.log : () => {};+ this.logger = createLogger(options.verbose ?? false);this.options = {sessionTimeout: 1000 * 60 * 30,session: true,@@ -151,210 +180,234 @@ export class Mixan {batchInterval: 10000,maxBatchSize: 10,trackIp: false,- profile: true,+ clientSecret: '',+ ipUrl: 'https://api.ipify.org',...options,};-- this.lastEventAt =- this.options.getItem('@mixan:lastEventAt') ?? '1970-01-01';- this.fetch = new Fetcher(this.options);- this.eventBatcher = new Batcher(this.options, (queue) => {- this.fetch.post(- '/events',- queue.map((item) => ({- ...item,- properties: {- ...this.globalProperties,- ...item.properties,- },- profileId: item.profileId ?? this.profileId ?? null,- }))- );- });-- this.promiseIp = this.options.trackIp- ? fetch('https://api.ipify.org')- .then((res) => res.text())- .catch(() => null)- : Promise.resolve(null);+ this.fetch = new Fetcher(this.options, this.logger);+ this.batcher = new Batcher(+ this.options,+ (queue) => {+ this.fetch.post('/batch', queue);+ },+ this.logger+ );}- async ip() {- return this.promiseIp;- }+ // Public- timestamp(modify = 0) {- return new Date(Date.now() + modify).toISOString();+ public init(properties?: Record<string, unknown>) {+ this.logger('Init');+ this.state.properties = properties ?? {};+ this.createProfile();+ this.createSession();+ this.ipLookup();}- init(properties?: Record<string, unknown>) {- if (properties) {- this.setGlobalProperties(properties);- }- this.logger('Mixan: Init');- this.setAnonymousUser();+ public setUser(payload: Omit<BatchUpdateProfilePayload, 'profileId'>) {+ this.createSession();++ this.batcher.add({+ type: 'update_profile',+ payload: {+ ...payload,+ properties: payload.properties ?? {},+ profileId: this.state.profileId,+ },+ });}- event(name: string, properties: Record<string, unknown> = {}) {- const now = new Date();- const isSessionStart =- this.options.session &&- now.getTime() - new Date(this.lastEventAt).getTime() >- this.options.sessionTimeout;+ public setSession(properties: BatchUpdateSessionPayload['properties']) {+ this.createSession();- if (isSessionStart) {- this.logger('Mixan: Session start');- this.eventBatcher.add({- name: 'session_start',- time: this.timestamp(-10),- properties: {},- profileId: this.profileId ?? null,- });- }-- this.logger('Mixan: Queue event', name);- this.eventBatcher.add({- name,- properties,- time: this.timestamp(),- profileId: this.profileId ?? null,+ this.batcher.add({+ type: 'update_session',+ payload: {+ properties,+ profileId: this.state.profileId,+ },});- this.lastEventAt = this.timestamp();- this.options.setItem('@mixan:lastEventAt', this.lastEventAt);}- private async setAnonymousUser(retryCount = 0) {- if (!this.options.profile) {- return;- }- const profileId = this.options.getItem('@mixan:profileId');- if (profileId) {- this.profileId = profileId;- await this.setUser({- properties: this.globalProperties,- });- this.logger('Mixan: Use existing profile', this.profileId);- } else {- const res = await this.fetch.post<ProfilePayload, { id: string }>(- '/profiles',- {- properties: this.globalProperties,- }- );+ public increment(name: string, value: number) {+ this.createSession();- if (res) {- this.profileId = res.id;- this.options.setItem('@mixan:profileId', res.id);- this.logger('Mixan: Create new profile', this.profileId);- } else if (retryCount < 2) {- setTimeout(() => {- this.setAnonymousUser(retryCount + 1);- }, 500);- } else {- this.logger('Mixan: Failed to create new profile');- }- }+ this.batcher.add({+ type: 'increment',+ payload: {+ name,+ value,+ profileId: this.state.profileId,+ },+ });}- async setUser(profile: ProfilePayload) {- if (!this.options.profile) {- return;- }- if (!this.profileId) {- return this.logger('Mixan: Set user failed, no profileId');- }- this.logger('Mixan: Set user', profile);- await this.fetch.post(`/profiles/${this.profileId}`, profile, {- method: 'PUT',+ public decrement(name: string, value: number) {+ this.createSession();++ this.batcher.add({+ type: 'decrement',+ payload: {+ name,+ value,+ profileId: this.state.profileId,+ },});}- async setUserProperty(- name: string,- value: string | number | boolean | Record<string, unknown> | unknown[]- ) {- if (!this.options.profile) {- return;- }- if (!this.profileId) {- return this.logger('Mixan: Set user property, no profileId');- }- this.logger('Mixan: Set user property', name, value);- await this.fetch.post(`/profiles/${this.profileId}`, {- properties: {- [name]: value,+ public event(name: string, properties?: Record<string, unknown>) {+ this.createSession();++ this.batcher.add({+ type: 'event',+ payload: {+ name,+ properties: {+ ...this.state.properties,+ ...(properties ?? {}),+ },+ time: this.timestamp(),+ profileId: this.state.profileId,},});}- setGlobalProperties(properties: Record<string, unknown>) {+ public setGlobalProperties(properties: Record<string, unknown>) {if (typeof properties !== 'object') {return this.logger(- 'Mixan: Set global properties failed, properties must be an object'+ 'Set global properties failed, properties must be an object');}- this.logger('Mixan: Set global properties', properties);- this.globalProperties = {- ...this.globalProperties,++ this.logger('Set global properties', properties);+ this.state.properties = {+ ...this.state.properties,...properties,};}- async increment(name: string, value = 1) {- if (!this.options.profile) {- return;- }- if (!this.profileId) {- this.logger('Mixan: Increment failed, no profileId');- return;- }+ public flush() {+ this.batcher.send();+ }++ public clear() {+ this.logger('Clear / Logout');+ this.flush();+ this.options.removeItem('@mixan:ip');+ this.options.removeItem('@mixan:profileId');+ this.options.removeItem('@mixan:lastEventAt');+ this.state.profileId = '';+ this.state.lastEventAt = 0;+ this.createProfile();+ }- this.logger('Mixan: Increment user property', name, value);- await this.fetch.post(- `/profiles/${this.profileId}/increment`,- {+ public setUserProperty(name: string, value: unknown, update = true) {+ this.batcher.add({+ type: 'set_profile_property',+ payload: {name,value,+ update,+ profileId: this.state.profileId,},- {- method: 'PUT',- }- );+ });}- async decrement(name: string, value = 1) {- if (!this.options.profile) {- return;+ // Private++ private timestamp(modify = 0) {+ this.setLastEventAt();+ return new Date(Date.now() + modify).toISOString();+ }++ private createProfile() {+ const profileId = this.options.getItem('@mixan:profileId');++ if (profileId) {+ this.logger('Reusing existing profile');+ this.state.profileId = profileId;+ } else {+ this.logger('Creating profile');+ this.state.profileId = uuid();+ this.options.setItem('@mixan:profileId', this.state.profileId);+ this.batcher.add({+ type: 'create_profile',+ payload: {+ profileId: this.state.profileId,+ properties: this.state.properties,+ },+ });+ }+ }++ private checkSession() {+ if (!this.options.session) {+ return false;}- if (!this.profileId) {- this.logger('Mixan: Decrement failed, no profileId');++ if (this.state.lastEventAt === 0) {+ const str = this.options.getItem('@mixan:lastEventAt') ?? '0';+ const value = parseInt(str, 10);+ this.state.lastEventAt = isNaN(value) ? 0 : value;+ }++ return Date.now() - this.state.lastEventAt > this.options.sessionTimeout;+ }++ private createSession() {+ if (!this.checkSession()) {return;}- this.logger('Mixan: Decrement user property', name, value);- await this.fetch.post(- `/profiles/${this.profileId}/decrement`,- {- name,- value,+ const time = this.timestamp(-10);++ this.batcher.add({+ type: 'event',+ payload: {+ name: 'session_start',+ properties: this.state.properties,+ profileId: this.state.profileId,+ time,},- {- method: 'PUT',- }- );+ });}- flush() {- this.logger('Mixan: Flushing events queue');- this.eventBatcher.send();+ private setLastEventAt() {+ this.state.lastEventAt = Date.now();+ this.options.setItem(+ '@mixan:lastEventAt',+ this.state.lastEventAt.toString()+ );}- clear() {- this.logger('Mixan: Clear, send remaining events and remove profileId');- this.eventBatcher.send();- this.options.removeItem('@mixan:profileId');- this.options.removeItem('@mixan:lastEventAt');- this.profileId = undefined;- this.setAnonymousUser();+ private async ipLookup() {+ if (!this.options.trackIp) {+ return null;+ }++ let ip: string | null;++ const cachedIp = this.options.getItem('@mixan:ip');+ if (cachedIp) {+ ip = cachedIp;+ } else {+ const controller = new AbortController();+ const timeout = setTimeout(() => controller.abort(), 1000);+ ip = await fetch(this.options.ipUrl, {+ signal: controller.signal,+ })+ .then((res) => res.text())+ .catch(() => null)+ .finally(() => clearTimeout(timeout));+ }++ if (ip) {+ this.options.setItem('@mixan:ip', ip);+ this.setGlobalProperties({ ip });+ if (!cachedIp) {+ this.setUserProperty('ip', ip, false);+ this.setSession({ ip });+ }+ }}}diff --git a/packages/sdk/index_old.ts b/packages/sdk/index_old.tsnew file mode 100644index 000000000..4c42831ec--- /dev/null+++ b/packages/sdk/index_old.ts@@ -0,0 +1,360 @@+import type {+ EventPayload,+ MixanErrorResponse,+ ProfilePayload,+} from '@mixan/types';++export interface NewMixanOptions {+ url: string;+ clientId: string;+ clientSecret: string;+ batchInterval?: number;+ maxBatchSize?: number;+ sessionTimeout?: number;+ session?: boolean;+ verbose?: boolean;+ profile?: boolean;+ trackIp?: boolean;+ setItem: (key: string, profileId: string) => void;+ getItem: (key: string) => string | null;+ removeItem: (key: string) => void;+}+export type MixanOptions = Required<NewMixanOptions>;++class Fetcher {+ private url: string;+ private clientId: string;+ private clientSecret: string;+ private logger: (...args: any[]) => void;++ constructor(options: MixanOptions) {+ this.url = options.url;+ this.clientId = options.clientId;+ this.clientSecret = options.clientSecret;+ this.logger = options.verbose ? console.log : () => {};+ }++ post<PostData, PostResponse>(+ path: string,+ data?: PostData,+ options?: RequestInit+ ): Promise<PostResponse | null> {+ const url = `${this.url}${path}`;+ this.logger(`Mixan request: ${url}`, JSON.stringify(data, null, 2));++ return fetch(url, {+ headers: {+ ['mixan-client-id']: this.clientId,+ ['mixan-client-secret']: this.clientSecret,+ 'Content-Type': 'application/json',+ },+ method: 'POST',+ body: JSON.stringify(data ?? {}),+ keepalive: true,+ ...(options ?? {}),+ })+ .then(async (res) => {+ const response = (await res.json()) as+ | MixanErrorResponse+ | PostResponse;++ if (!response) {+ return null;+ }++ if (+ typeof response === 'object' &&+ 'status' in response &&+ response.status === 'error'+ ) {+ this.logger(+ `Mixan request failed: [${options?.method ?? 'POST'}] ${url}`,+ JSON.stringify(response, null, 2)+ );+ return null;+ }++ return response as PostResponse;+ })+ .catch(() => {+ this.logger(+ `Mixan request failed: [${options?.method ?? 'POST'}] ${url}`+ );+ return null;+ });+ }+}++class Batcher<T> {+ queue: T[] = [];+ timer?: ReturnType<typeof setTimeout>;+ callback: (queue: T[]) => void;+ maxBatchSize: number;+ batchInterval: number;++ constructor(options: MixanOptions, callback: (queue: T[]) => void) {+ this.callback = callback;+ this.maxBatchSize = options.maxBatchSize;+ this.batchInterval = options.batchInterval;+ }++ add(payload: T) {+ this.queue.push(payload);+ this.flush();+ }++ flush() {+ if (this.timer) {+ clearTimeout(this.timer);+ }++ if (this.queue.length === 0) {+ return;+ }++ if (this.queue.length >= this.maxBatchSize) {+ this.send();+ return;+ }++ this.timer = setTimeout(this.send.bind(this), this.batchInterval);+ }++ send() {+ if (this.timer) {+ clearTimeout(this.timer);+ }++ if (this.queue.length > 0) {+ this.callback(this.queue);+ this.queue = [];+ }+ }+}++export class Mixan {+ private fetch: Fetcher;+ private eventBatcher: Batcher<EventPayload>;+ private profileId?: string;+ private options: MixanOptions;+ private logger: (...args: any[]) => void;+ private globalProperties: Record<string, unknown> = {};+ private lastEventAt: string;+ private promiseIp: Promise<string | null>;++ constructor(options: NewMixanOptions) {+ this.logger = options.verbose ? console.log : () => {};+ this.options = {+ sessionTimeout: 1000 * 60 * 30,+ session: true,+ verbose: false,+ batchInterval: 10000,+ maxBatchSize: 10,+ trackIp: false,+ profile: true,+ ...options,+ };++ this.lastEventAt =+ this.options.getItem('@mixan:lastEventAt') ?? '1970-01-01';+ this.fetch = new Fetcher(this.options);+ this.eventBatcher = new Batcher(this.options, (queue) => {+ this.fetch.post(+ '/events',+ queue.map((item) => ({+ ...item,+ properties: {+ ...this.globalProperties,+ ...item.properties,+ },+ profileId: item.profileId ?? this.profileId ?? null,+ }))+ );+ });++ this.promiseIp = this.options.trackIp+ ? fetch('https://api.ipify.org')+ .then((res) => res.text())+ .catch(() => null)+ : Promise.resolve(null);+ }++ async ip() {+ return this.promiseIp;+ }++ timestamp(modify = 0) {+ return new Date(Date.now() + modify).toISOString();+ }++ init(properties?: Record<string, unknown>) {+ if (properties) {+ this.setGlobalProperties(properties);+ }+ this.logger('Mixan: Init');+ this.setAnonymousUser();+ }++ event(name: string, properties: Record<string, unknown> = {}) {+ const now = new Date();+ const isSessionStart =+ this.options.session &&+ now.getTime() - new Date(this.lastEventAt).getTime() >+ this.options.sessionTimeout;++ if (isSessionStart) {+ this.logger('Mixan: Session start');+ this.eventBatcher.add({+ name: 'session_start',+ time: this.timestamp(-10),+ properties: {},+ profileId: this.profileId ?? null,+ });+ }++ this.logger('Mixan: Queue event', name);+ this.eventBatcher.add({+ name,+ properties,+ time: this.timestamp(),+ profileId: this.profileId ?? null,+ });+ this.lastEventAt = this.timestamp();+ this.options.setItem('@mixan:lastEventAt', this.lastEventAt);+ }++ private async setAnonymousUser(retryCount = 0) {+ if (!this.options.profile) {+ return;+ }+ const profileId = this.options.getItem('@mixan:profileId');+ if (profileId) {+ this.profileId = profileId;+ await this.setUser({+ properties: this.globalProperties,+ });+ this.logger('Mixan: Use existing profile', this.profileId);+ } else {+ const res = await this.fetch.post<ProfilePayload, { id: string }>(+ '/profiles',+ {+ properties: this.globalProperties,+ }+ );++ if (res) {+ this.profileId = res.id;+ this.options.setItem('@mixan:profileId', res.id);+ this.logger('Mixan: Create new profile', this.profileId);+ } else if (retryCount < 2) {+ setTimeout(() => {+ this.setAnonymousUser(retryCount + 1);+ }, 500);+ } else {+ this.logger('Mixan: Failed to create new profile');+ }+ }+ }++ async setUser(profile: ProfilePayload) {+ if (!this.options.profile) {+ return;+ }+ if (!this.profileId) {+ return this.logger('Mixan: Set user failed, no profileId');+ }+ this.logger('Mixan: Set user', profile);+ await this.fetch.post(`/profiles/${this.profileId}`, profile, {+ method: 'PUT',+ });+ }++ async setUserProperty(+ name: string,+ value: string | number | boolean | Record<string, unknown> | unknown[]+ ) {+ if (!this.options.profile) {+ return;+ }+ if (!this.profileId) {+ return this.logger('Mixan: Set user property, no profileId');+ }+ this.logger('Mixan: Set user property', name, value);+ await this.fetch.post(`/profiles/${this.profileId}`, {+ properties: {+ [name]: value,+ },+ });+ }++ setGlobalProperties(properties: Record<string, unknown>) {+ if (typeof properties !== 'object') {+ return this.logger(+ 'Mixan: Set global properties failed, properties must be an object'+ );+ }+ this.logger('Mixan: Set global properties', properties);+ this.globalProperties = {+ ...this.globalProperties,+ ...properties,+ };+ }++ async increment(name: string, value = 1) {+ if (!this.options.profile) {+ return;+ }+ if (!this.profileId) {+ this.logger('Mixan: Increment failed, no profileId');+ return;+ }++ this.logger('Mixan: Increment user property', name, value);+ await this.fetch.post(+ `/profiles/${this.profileId}/increment`,+ {+ name,+ value,+ },+ {+ method: 'PUT',+ }+ );+ }++ async decrement(name: string, value = 1) {+ if (!this.options.profile) {+ return;+ }+ if (!this.profileId) {+ this.logger('Mixan: Decrement failed, no profileId');+ return;+ }++ this.logger('Mixan: Decrement user property', name, value);+ await this.fetch.post(+ `/profiles/${this.profileId}/decrement`,+ {+ name,+ value,+ },+ {+ method: 'PUT',+ }+ );+ }++ flush() {+ this.logger('Mixan: Flushing events queue');+ this.eventBatcher.send();+ }++ clear() {+ this.logger('Mixan: Clear, send remaining events and remove profileId');+ this.eventBatcher.send();+ this.options.removeItem('@mixan:profileId');+ this.options.removeItem('@mixan:lastEventAt');+ this.profileId = undefined;+ this.setAnonymousUser();+ }+}diff --git a/packages/types/index.ts b/packages/types/index.tsindex 32c489346..23d172619 100644--- a/packages/types/index.ts+++ b/packages/types/index.ts@@ -1,5 +1,9 @@+export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;+export type MixanJson = Record<string, any>;+// Deprecatedexport interface EventPayload {name: string;time: string;@@ -7,6 +11,7 @@ export interface EventPayload {properties: MixanJson;}+// Deprecatedexport interface ProfilePayload {first_name?: string;last_name?: string;@@ -16,45 +21,97 @@ export interface ProfilePayload {properties?: MixanJson;}-export interface ProfileIncrementPayload {+export type BatchPayload =+ | {+ type: 'increment';+ payload: BatchProfileIncrementPayload;+ }+ | {+ type: 'decrement';+ payload: BatchProfileDecrementPayload;+ }+ | {+ type: 'event';+ payload: BatchEventPayload;+ }+ | {+ type: 'create_profile';+ payload: BatchCreateProfilePayload;+ }+ | {+ type: 'update_profile';+ payload: BatchUpdateProfilePayload;+ }+ | {+ type: 'update_session';+ payload: BatchUpdateSessionPayload;+ }+ | {+ type: 'set_profile_property';+ payload: BatchSetProfilePropertyPayload;+ };++export interface BatchSetProfilePropertyPayload {+ profileId: string;name: string;- value: number;+ value: any;+ update: boolean;+}++export interface CreateProfileResponse {id: string;}-export interface ProfileDecrementPayload {+export interface BatchCreateProfilePayload {+ profileId: string;+ properties?: MixanJson;+}++export interface BatchUpdateSessionPayload {+ profileId: string;+ properties?: MixanJson;+}++export interface BatchEventPayload {name: string;- value: number;- id: string;+ time: string;+ profileId: string;+ properties: MixanJson;}-// Batching-export interface BatchEvent {- type: 'event';- payload: EventPayload;+export interface BatchUpdateProfilePayload {+ first_name?: string;+ last_name?: string;+ email?: string;+ avatar?: string;+ id?: string;+ properties?: MixanJson;+ profileId: string;}-export interface BatchProfile {- type: 'profile';- payload: ProfilePayload;+export interface ProfileIncrementPayload {+ name: string;+ value: number;+ profileId: string;}-export interface BatchProfileIncrement {- type: 'profile_increment';- payload: ProfileIncrementPayload;+export interface ProfileDecrementPayload {+ name: string;+ value: number;+ profileId: string;}-export interface BatchProfileDecrement {- type: 'profile_decrement';- payload: ProfileDecrementPayload;+export interface BatchProfileIncrementPayload {+ name: string;+ value: number;+ profileId: string;}-export type BatchItem =- | BatchEvent- | BatchProfile- | BatchProfileIncrement- | BatchProfileDecrement;-export type BatchPayload = BatchItem[];+export interface BatchProfileDecrementPayload {+ name: string;+ value: number;+ profileId: string;+}export interface MixanIssue {field: string;diff --git a/tooling/publish/publish.ts b/tooling/publish/publish.tsindex 754a8203c..1540cced1 100644--- a/tooling/publish/publish.ts+++ b/tooling/publish/publish.ts@@ -1,3 +1,4 @@+/* eslint-disable @typescript-eslint/no-var-requires */import { execSync } from 'node:child_process';import fs from 'node:fs';import path from 'node:path';diff --git a/tooling/typescript/tsup.config.json b/tooling/typescript/tsup.config.jsonindex 96fbf9a36..f05ad7a12 100644--- a/tooling/typescript/tsup.config.json+++ b/tooling/typescript/tsup.config.json@@ -4,5 +4,6 @@"dts": true,"splitting": false,"sourcemap": true,- "clean": true+ "clean": true,+ "minify": true}