Merge pull request #4162 from umami-software/dev

v3.1.0

Author: mikecao

.github/ISSUE_TEMPLATE/1.bug_report.yml

@@ -24,13 +24,13 @@ body:
       render: shell
   - type: input
     attributes:
-      label: Which Umami version are you using? (if relevant)
+      label: Which Umami version are you using?
       description: 'For example: 2.18.0, 2.15.1, 1.39.0, etc'
   - type: input
     attributes:
-      label: Which browser are you using? (if relevant)
-      description: 'For example: Chrome, Edge, Firefox, etc'
+      label: How are you deploying your application?
+      description: 'For example: Vercel, Railway, Docker, etc'
   - type: input
     attributes:
-      label: How are you deploying your application? (if relevant)
-      description: 'For example: Vercel, Railway, Docker, etc'
+      label: Which browser are you using?
+      description: 'For example: Chrome, Edge, Firefox, etc'

.github/workflows/cd.yml

@@ -124,4 +124,4 @@ jobs:
           push: true
           tags: ${{ steps.compute.outputs.docker_tags }}
           cache-from: type=gha
-          cache-to: type=gha,mode=max
+          cache-to: type=gha,mode=max

.github/workflows/ci.yml

@@ -17,10 +17,10 @@ jobs:
         with:
           version: 10
           run_install: false
-      - name: Use Node.js 18.18
+      - name: Use Node.js 22
         uses: actions/setup-node@v4
         with:
-          node-version: 18.18
+          node-version: 22
           cache: "pnpm"
       - run: npm install --global pnpm
       - run: pnpm install

.gitignore

@@ -11,16 +11,19 @@ package-lock.json
 /coverage
 
 # next.js
+next-env.d.ts
 /.next
 /out
 
 # production
 /build
 /public/script.js
+/public/recorder.js
 /geo
 /dist
 /generated
 /src/generated
+pm2.yml
 
 # misc
 .DS_Store
@@ -30,6 +33,11 @@ package-lock.json
 *.log
 .vscode
 .tool-versions
+.claude
+.agents
+tmpclaude*
+CLAUDE.md
+nul
 
 # debug
 npm-debug.log*
@@ -42,4 +50,3 @@ yarn-error.log*
 *.env.*
 
 *.dev.yml
-

.husky/pre-commit

@@ -14,7 +14,7 @@ FROM node:${NODE_IMAGE_VERSION} AS builder
 WORKDIR /app
 COPY --from=deps /app/node_modules ./node_modules
 COPY . .
-COPY docker/middleware.ts ./src
+COPY docker/proxy.ts ./src
 
 ARG BASE_PATH
 
@@ -28,7 +28,7 @@ RUN npm run build-docker
 FROM node:${NODE_IMAGE_VERSION} AS runner
 WORKDIR /app
 
-ARG PRISMA_VERSION="6.19.0"
+ARG PRISMA_VERSION="7.3.0"
 ARG NODE_OPTIONS
 
 ENV NODE_ENV=production
@@ -44,10 +44,12 @@ RUN set -x \
 # Script dependencies
 RUN pnpm --allow-build='@prisma/engines' add npm-run-all dotenv chalk semver \
     prisma@${PRISMA_VERSION} \
+    @prisma/client@${PRISMA_VERSION} \
     @prisma/adapter-pg@${PRISMA_VERSION}
 
 COPY --from=builder --chown=nextjs:nodejs /app/public ./public
 COPY --from=builder /app/prisma ./prisma
+COPY --from=builder /app/prisma.config.ts ./prisma.config.ts
 COPY --from=builder /app/scripts ./scripts
 COPY --from=builder /app/generated ./generated
 
@@ -63,4 +65,4 @@ EXPOSE 3000
 ENV HOSTNAME=0.0.0.0
 ENV PORT=3000
 
-CMD ["pnpm", "start-docker"]
+CMD ["pnpm", "start-docker"]

.stylelintrc.json

@@ -0,0 +1,105 @@
+-- Add performance columns to website_event
+ALTER TABLE umami.website_event ADD COLUMN lcp Nullable(Decimal(10, 1)) AFTER twclid;
+ALTER TABLE umami.website_event ADD COLUMN inp Nullable(Decimal(10, 1)) AFTER lcp;
+ALTER TABLE umami.website_event ADD COLUMN cls Nullable(Decimal(10, 4)) AFTER inp;
+ALTER TABLE umami.website_event ADD COLUMN fcp Nullable(Decimal(10, 1)) AFTER cls;
+ALTER TABLE umami.website_event ADD COLUMN ttfb Nullable(Decimal(10, 1)) AFTER fcp;
+
+-- Update materialized view to exclude performance events from view counts
+DROP TABLE umami.website_event_stats_hourly_mv;
+
+CREATE MATERIALIZED VIEW umami.website_event_stats_hourly_mv
+TO umami.website_event_stats_hourly
+AS
+SELECT
+    website_id,
+    session_id,
+    visit_id,
+    hostnames as hostname,
+    browser,
+    os,
+    device,
+    screen,
+    language,
+    country,
+    region,
+    city,
+    entry_url,
+    exit_url,
+    url_paths as url_path,
+    url_query,
+    utm_source,
+    utm_medium,
+    utm_campaign,
+    utm_content,
+    utm_term,
+    referrer_domain,
+    page_title,
+    gclid,
+    fbclid,
+    msclkid,
+    ttclid,
+    li_fat_id,
+    twclid,
+    event_type,
+    event_name,
+    views,
+    min_time,
+    max_time,
+    tag,
+    distinct_id,
+    timestamp as created_at
+FROM (SELECT
+    website_id,
+    session_id,
+    visit_id,
+    arrayFilter(x -> x != '', groupArray(hostname)) hostnames,
+    browser,
+    os,
+    device,
+    screen,
+    language,
+    country,
+    region,
+    city,
+    argMinState(url_path, created_at) entry_url,
+    argMaxState(url_path, created_at) exit_url,
+    arrayFilter(x -> x != '', groupArray(url_path)) as url_paths,
+    arrayFilter(x -> x != '', groupArray(url_query)) url_query,
+    arrayFilter(x -> x != '', groupArray(utm_source)) utm_source,
+    arrayFilter(x -> x != '', groupArray(utm_medium)) utm_medium,
+    arrayFilter(x -> x != '', groupArray(utm_campaign)) utm_campaign,
+    arrayFilter(x -> x != '', groupArray(utm_content)) utm_content,
+    arrayFilter(x -> x != '', groupArray(utm_term)) utm_term,
+    arrayFilter(x -> x != '' and x != hostname, groupArray(referrer_domain)) referrer_domain,
+    arrayFilter(x -> x != '', groupArray(page_title)) page_title,
+    arrayFilter(x -> x != '', groupArray(gclid)) gclid,
+    arrayFilter(x -> x != '', groupArray(fbclid)) fbclid,
+    arrayFilter(x -> x != '', groupArray(msclkid)) msclkid,
+    arrayFilter(x -> x != '', groupArray(ttclid)) ttclid,
+    arrayFilter(x -> x != '', groupArray(li_fat_id)) li_fat_id,
+    arrayFilter(x -> x != '', groupArray(twclid)) twclid,
+    event_type,
+    if(event_type = 2, groupArray(event_name), []) event_name,
+    sumIf(1, event_type NOT IN (2, 5)) views,
+    min(created_at) min_time,
+    max(created_at) max_time,
+    arrayFilter(x -> x != '', groupArray(tag)) tag,
+    distinct_id,
+    toStartOfHour(created_at) timestamp
+FROM umami.website_event
+GROUP BY website_id,
+    session_id,
+    visit_id,
+    hostname,
+    browser,
+    os,
+    device,
+    screen,
+    language,
+    country,
+    region,
+    city,
+    event_type,
+    distinct_id,
+    timestamp);

Dockerfile

@@ -0,0 +1,18 @@
+-- Create session_replay
+CREATE TABLE umami.session_replay
+(
+    replay_id UUID,
+    website_id UUID,
+    session_id UUID,
+    visit_id UUID,
+    chunk_index UInt32,
+    events String CODEC(ZSTD(3)),
+    event_count UInt32,
+    started_at DateTime64(6),
+    ended_at DateTime64(6),
+    created_at DateTime64(6) DEFAULT now64(6)
+)
+ENGINE = MergeTree()
+PARTITION BY toYYYYMM(created_at)
+ORDER BY (replay_id, website_id, session_id, visit_id, chunk_index)
+SETTINGS index_granularity = 8192;

db/clickhouse/migrations/09_add_performance.sql

@@ -34,6 +34,12 @@ CREATE TABLE umami.website_event
     ttclid String,
     li_fat_id String,
     twclid String,
+    --performance
+    lcp Nullable(Decimal(10, 1)),
+    inp Nullable(Decimal(10, 1)),
+    cls Nullable(Decimal(10, 4)),
+    fcp Nullable(Decimal(10, 1)),
+    ttfb Nullable(Decimal(10, 1)),
     --events
     event_type UInt32,
     event_name String,
@@ -209,7 +215,7 @@ FROM (SELECT
     arrayFilter(x -> x != '', groupArray(twclid)) twclid,
     event_type,
     if(event_type = 2, groupArray(event_name), []) event_name,
-    sumIf(1, event_type != 2) views,
+    sumIf(1, event_type NOT IN (2, 5)) views,
     min(created_at) min_time,
     max(created_at) max_time,
     arrayFilter(x -> x != '', groupArray(tag)) tag,
@@ -281,3 +287,22 @@ JOIN (SELECT event_id, string_value as currency
         WHERE positionCaseInsensitive(data_key, 'currency') > 0) c
       ON c.event_id = ed.event_id
 WHERE positionCaseInsensitive(data_key, 'revenue') > 0;
+
+-- Create session_replay
+CREATE TABLE umami.session_replay
+(
+    replay_id UUID,
+    website_id UUID,
+    session_id UUID,
+    visit_id UUID,
+    chunk_index UInt32,
+    events String CODEC(ZSTD(3)),
+    event_count UInt32,
+    started_at DateTime64(6),
+    ended_at DateTime64(6),
+    created_at DateTime64(6) DEFAULT now64(6)
+)
+ENGINE = MergeTree()
+PARTITION BY toYYYYMM(created_at)
+ORDER BY (replay_id, website_id, session_id, visit_id, chunk_index)
+SETTINGS index_granularity = 8192;