High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.
JavaScript campaigncampaign-managementemail-marketingemail-subscriptionlistmonkmailing-listnewsletternewsletter-managementnewsletter-softwareself-hostedsms-gatewaysmtptransactional-emails
Refactor subscriber 'Activity' page to be primary info page exactly like the new lists info page.
Kailash Nadhc4f84be3b321
diff --git a/cmd/handlers.go b/cmd/handlers.goindex 520c8209..52b07ebd 100644--- a/cmd/handlers.go+++ b/cmd/handlers.go@@ -104,11 +104,10 @@ func initHTTPHandlers(e *echo.Echo, a *App) {g.GET(path.Join(uriAdmin, "/subscribers/lists/:id"), pm(hasID(a.ViewSubscribers), "subscribers:get_all", "subscribers:get"))g.POST(path.Join(uriAdmin, "/subscribers/lists/:id"), pm(hasID(a.ViewSubscribers), "subscribers:get_all", "subscribers:get"))g.GET(path.Join(uriAdmin, "/subscribers/new"), pm(a.ViewNewSubscriber, "subscribers:manage"))- g.GET(path.Join(uriAdmin, "/subscribers/:id"), pm(hasID(a.ViewSubscriber), "subscribers:get_all", "subscribers:get"))+ g.GET(path.Join(uriAdmin, "/subscribers/:id/edit"), pm(hasID(a.ViewSubscriber), "subscribers:get_all", "subscribers:get"))+ g.GET(path.Join(uriAdmin, "/subscribers/:id"), pm(hasID(a.ViewSubscriberInfo), "subscribers:get_all", "subscribers:get"))g.GET(path.Join(uriAdmin, "/subscribers/:id/lists"), pm(hasID(a.ViewSubscriber), "subscribers:get_all", "subscribers:get"))- // This view renders both the subscriber profile and bounce records.g.GET(path.Join(uriAdmin, "/subscribers/:id/bounces"), pm(pm(hasID(a.ViewSubscriberBounces), "bounces:get"), "subscribers:get_all", "subscribers:get"))- g.GET(path.Join(uriAdmin, "/subscribers/:id/activity"), pm(hasID(a.ViewSubscriberActivity), "subscribers:get_all", "subscribers:get"))// Users and roles. Static segments are registered before the :id param routes.g.GET(path.Join(uriAdmin, "/users"), pm(a.ViewUsers, "users:get"))diff --git a/cmd/subscribers.go b/cmd/subscribers.goindex 57af7b30..78c2ee0e 100644--- a/cmd/subscribers.go+++ b/cmd/subscribers.go@@ -11,6 +11,7 @@ import ("strings""time"+ "github.com/jmoiron/sqlx/types""github.com/knadh/listmonk/internal/auth""github.com/knadh/listmonk/internal/i18n""github.com/knadh/listmonk/internal/notifs"@@ -92,6 +93,7 @@ type subscriberView struct {CampaignViews []subCampaignViewLinkClicks []subLinkClickTotalViews int+ Charts types.JSONTextTotalClicks int}@@ -182,7 +184,7 @@ func (a *App) ViewSubscriber(c echo.Context) error {return err}- tab := "profile"+ tab := "edit"if strings.HasSuffix(c.Path(), "/lists") {tab = "lists"}@@ -219,8 +221,8 @@ func (a *App) ViewSubscriberBounces(c echo.Context) error {return c.Render(http.StatusOK, "admin-subscriber", data)}-// ViewSubscriberActivity renders the activity tab (campaign views and link clicks) of a subscriber.-func (a *App) ViewSubscriberActivity(c echo.Context) error {+// ViewSubscriberInfo renders the activity tab (campaign views and link clicks) of a subscriber.+func (a *App) ViewSubscriberInfo(c echo.Context) error {out, err := a.getViewSubscriber(c)if err != nil {return err@@ -237,6 +239,11 @@ func (a *App) ViewSubscriberActivity(c echo.Context) error {Subscriber: out,}+ data.Charts, err = a.core.GetSubscriberCharts(out.ID)+ if err != nil {+ return err+ }+// Parse the JSON activity blobs._ = json.Unmarshal(act.CampaignViews, &data.CampaignViews)_ = json.Unmarshal(act.LinkClicks, &data.LinkClicks)diff --git a/internal/core/subscribers.go b/internal/core/subscribers.goindex 8ca945c0..3a10c98a 100644--- a/internal/core/subscribers.go+++ b/internal/core/subscribers.go@@ -10,6 +10,7 @@ import ("github.com/gofrs/uuid/v5""github.com/jmoiron/sqlx"+ "github.com/jmoiron/sqlx/types""github.com/knadh/listmonk/internal/auth""github.com/knadh/listmonk/models""github.com/labstack/echo/v4"@@ -231,6 +232,16 @@ func (c *Core) GetSubscriberActivity(id int) (models.SubscriberActivity, error)return out, nil}+// GetSubscriberCharts returns subscriber views and clicks.+func (c *Core) GetSubscriberCharts(id int) (types.JSONText, error) {+ var out types.JSONText+ if err := c.q.GetSubscriberCharts.Get(&out, id); err != nil {+ return nil, echo.NewHTTPError(http.StatusInternalServerError,+ c.i18n.Ts("globals.messages.errorFetching", "name", "subscriber charts", "error", pqErrMsg(err)))+ }+ return out, nil+}+// DeleteSubscriberActivity deletes a subscriber's campaign views or link clicks.func (c *Core) DeleteSubscriberActivity(id int, activityType string) error {var stmt *sqlx.Stmtdiff --git a/models/queries.go b/models/queries.goindex 78ecbd34..7a4d3500 100644--- a/models/queries.go+++ b/models/queries.go@@ -36,6 +36,7 @@ type Queries struct {DeleteOrphanSubscribers *sqlx.Stmt `query:"delete-orphan-subscribers"`UnsubscribeByCampaign *sqlx.Stmt `query:"unsubscribe-by-campaign"`ExportSubscriberData *sqlx.Stmt `query:"export-subscriber-data"`+ GetSubscriberCharts *sqlx.Stmt `query:"get-subscriber-charts"`GetSubscriberActivity *sqlx.Stmt `query:"get-subscriber-activity"`DeleteSubscriberCampaignViews *sqlx.Stmt `query:"delete-subscriber-campaign-views"`DeleteSubscriberLinkClicks *sqlx.Stmt `query:"delete-subscriber-link-clicks"`diff --git a/queries/subscribers.sql b/queries/subscribers.sqlindex 099dfc06..e8f9224e 100644--- a/queries/subscribers.sql+++ b/queries/subscribers.sql@@ -496,3 +496,28 @@ clicks AS (SELECTCOALESCE((SELECT JSON_AGG(v) FROM views v), '[]') as campaign_views,COALESCE((SELECT JSON_AGG(c) FROM clicks c), '[]') as link_clicks;+++-- name: get-subscriber-charts+-- Aggregate each event type separately to avoid multiplying views by clicks.+WITH weeks AS (+ SELECT GENERATE_SERIES(DATE_TRUNC('week', CURRENT_DATE - INTERVAL '12 months'),+ DATE_TRUNC('week', CURRENT_DATE), INTERVAL '1 week')::DATE AS date+), views AS (+ SELECT DATE_TRUNC('week', created_at)::DATE AS date, COUNT(*) AS count+ FROM campaign_views+ WHERE subscriber_id = $1+ AND created_at >= CURRENT_DATE - INTERVAL '12 months' AND created_at <= NOW()+ GROUP BY date+), clicks AS (+ SELECT DATE_TRUNC('week', created_at)::DATE AS date, COUNT(*) AS count+ FROM link_clicks+ WHERE subscriber_id = $1+ AND created_at >= CURRENT_DATE - INTERVAL '12 months' AND created_at <= NOW()+ GROUP BY date+)+SELECT JSON_BUILD_OBJECT(+ 'campaign_views', JSON_AGG(JSON_BUILD_OBJECT('date', w.date, 'count', COALESCE(v.count, 0)) ORDER BY w.date),+ 'link_clicks', JSON_AGG(JSON_BUILD_OBJECT('date', w.date, 'count', COALESCE(c.count, 0)) ORDER BY w.date)+)+FROM weeks w LEFT JOIN views v ON v.date = w.date LEFT JOIN clicks c ON c.date = w.date;diff --git a/schema.sql b/schema.sqlindex d13bc292..67a834af 100644--- a/schema.sql+++ b/schema.sql@@ -447,8 +447,6 @@ DROP INDEX IF EXISTS mat_list_subscriber_stats_idx; CREATE UNIQUE INDEX mat_list-- Weekly list charts for the latest twelve months.DROP MATERIALIZED VIEW IF EXISTS mat_list_charts;CREATE MATERIALIZED VIEW mat_list_charts AS- -- Aggregate campaign events before joining lists so multi-list campaigns do not- -- multiply the work over the raw events. Views belong to campaigns, not lists.WITH views AS (SELECT campaign_id, DATE_TRUNC('week', created_at)::DATE AS date, COUNT(*) AS countFROM campaign_viewsdiff --git a/static/admin/assets/css/style.css b/static/admin/assets/css/style.cssindex fd36dc5b..ffd4d3e9 100644--- a/static/admin/assets/css/style.css+++ b/static/admin/assets/css/style.css@@ -1217,7 +1217,8 @@ visual-editor {/* Sections */section.dashboard,-section.lists {+section.lists,+section.subscribers {.chart-box {position: relative;height: 18rem;diff --git a/static/admin/assets/js/views/subscribers.js b/static/admin/assets/js/views/subscribers.jsindex ded17902..5f20ba8f 100644--- a/static/admin/assets/js/views/subscribers.js+++ b/static/admin/assets/js/views/subscribers.js@@ -1,4 +1,5 @@import Alpine from 'alpinejs';+import { lineChart } from '../charts.js';import {api,urls,@@ -349,3 +350,7 @@ function component(sub = null) {document.addEventListener('alpine:init', () => {Alpine.data('subscribersView', component);}, { once: true });++const charts = window._subscriberCharts || {};+lineChart('chart-subscriber-views', charts.campaign_views);+lineChart('chart-subscriber-clicks', charts.link_clicks);diff --git a/static/admin/partials/list-info.html b/static/admin/partials/list-info.htmlindex 375e702a..b93b9fb5 100644--- a/static/admin/partials/list-info.html+++ b/static/admin/partials/list-info.html@@ -14,6 +14,7 @@<a href="{{ URI "/admin/lists" }}?optin={{ $l.Optin }}" title="{{ .L.T "globals.buttons.filter" }} {{ .L.T (printf "lists.optins.%s" $l.Optin) }}">{{ Badge (list (Icon $icon) (.L.T (printf "lists.optins.%s" $l.Optin))) "enum" }}</a>{{ if eq $l.Status "archived" }}{{ Badge (.L.T "lists.archived") "enum status-archived" }}{{ end }}</div>+ <div class="text-small text-light mt-2">{{ NiceDate $l.CreatedAt }}</div></div><div class="col-9">{{ if or $l.Description $l.Tags }}diff --git a/static/admin/partials/subscriber-form.html b/static/admin/partials/subscriber-form.htmlindex 54aa2a39..fcad471d 100644--- a/static/admin/partials/subscriber-form.html+++ b/static/admin/partials/subscriber-form.html@@ -27,22 +27,10 @@</fieldset></section>- <footer class="hstack justify-between mt-6">- <div class="hstack gap-1">- {{- if not .IsNew }}- <button type="button" class="small" data-variant="secondary" title="{{ $root.L.T "globals.messages.clickToCopy" }}" aria-label="{{ $root.L.T "globals.fields.id" }}" @click="copyToClipboard(form.id)">- <strong>{{ $root.L.T "globals.fields.id" }}</strong> <span x-text="form.id"></span>- </button>- <button type="button" class="small" data-variant="secondary" title="{{ $root.L.T "globals.messages.clickToCopy" }}" aria-label="{{ $root.L.T "globals.fields.uuid" }}" @click="copyToClipboard(form.uuid)">- <strong>{{ $root.L.T "globals.fields.uuid" }}</strong> <span x-text="form.uuid"></span>- </button>- {{- end }}- </div>- <div class="hstack gap-3 justify-end">- {{- if $canSave }}- <button type="submit" data-variant="primary" data-testid="btn-save" :disabled="isLoading('subscribers.save')" :aria-busy="isLoading('subscribers.save')">{{ $root.L.T "globals.buttons.save" }}</button>- {{- end }}- </div>+ <footer class="hstack justify-end mt-6">+ {{- if $canSave }}+ <button type="submit" data-variant="primary" data-testid="btn-save" :disabled="isLoading('subscribers.save')" :aria-busy="isLoading('subscribers.save')">{{ $root.L.T "globals.buttons.save" }}</button>+ {{- end }}</footer></div></form>diff --git a/static/admin/partials/subscriber-activity.html b/static/admin/partials/subscriber-info.htmlsimilarity index 72%rename from static/admin/partials/subscriber-activity.htmlrename to static/admin/partials/subscriber-info.htmlindex a84c3ecb..a7018468 100644--- a/static/admin/partials/subscriber-activity.html+++ b/static/admin/partials/subscriber-info.html@@ -1,14 +1,46 @@-{{ define "subscriber-activity" -}}+{{ define "subscriber-info" -}}{{- $d := .Data -}}-<div class="page-content content activity">- <div class="row mt-4">+<div class="vstack gap-6 activity">+ <div class="card">+ <div class="row">+ <div class="col-6">+ <strong>{{ $d.Subscriber.Name }}</strong>+ <div class="text-small text-light">{{ NiceDate $d.Subscriber.CreatedAt }}</div>+ </div>+ <div class="col-6 hstack gap-2 justify-end">+ <button type="button" class="small" data-variant="secondary" title="{{ .L.T "globals.messages.clickToCopy" }}" aria-label="{{ .L.T "globals.fields.id" }}" @click="copyToClipboard(form.id)">+ <strong>{{ .L.T "globals.fields.id" }}</strong> <span x-text="form.id"></span>+ </button>+ <button type="button" class="small" data-variant="secondary" title="{{ .L.T "globals.messages.clickToCopy" }}" aria-label="{{ .L.T "globals.fields.uuid" }}" @click="copyToClipboard(form.uuid)">+ <strong>{{ .L.T "globals.fields.uuid" }}</strong> <span x-text="form.uuid"></span>+ </button>+ </div>+ </div>+ </div>+ <div class="row"><div class="col-4"><div class="card stat-card"><small class="text-light">{{ .L.T "globals.terms.campaigns" }}</small><div class="stat-value">{{ len $d.CampaignViews }}</div></div></div><div class="col-4"><div class="card stat-card"><small class="text-light">{{ .L.T "campaigns.views" }}</small><div class="stat-value">{{ $d.TotalViews }}</div></div></div><div class="col-4"><div class="card stat-card"><small class="text-light">{{ .L.T "campaigns.clicks" }}</small><div class="stat-value">{{ $d.TotalClicks }}</div></div></div></div>+ <section class="row">+ <div class="col-6">+ <article class="card float">+ <h5 class="title">{{ .L.T "campaigns.views" }}</h5>+ <div class="chart-box"><canvas id="chart-subscriber-views" role="img" aria-label="{{ .L.T "campaigns.views" }}"></canvas></div>+ </article>+ </div>+ <div class="col-6">+ <article class="card float">+ <h5 class="title">{{ .L.T "campaigns.clicks" }}</h5>+ <div class="chart-box"><canvas id="chart-subscriber-clicks" role="img" aria-label="{{ .L.T "campaigns.clicks" }}"></canvas></div>+ </article>+ </div>+ </section>+ <script>window._subscriberCharts = {{ ToJSON $d.Charts }};</script>+{{- if $d.CampaignViews }}- <div class="card float page-content has-table mt-8">+ <div class="card float page-content has-table"><h5 class="title">{{ .L.T "campaigns.views" }}</h5><div class="table-wrapper">{{- if $d.Can "subscribers:manage" }}@@ -48,7 +80,7 @@{{- end }}{{- if $d.LinkClicks }}- <div class="card float page-content has-table mt-8">+ <div class="card float page-content has-table"><h5 class="title">{{ .L.T "campaigns.clicks" }}</h5><div class="table-wrapper">{{- if $d.Can "subscribers:manage" }}diff --git a/static/admin/partials/subscriber-lists.html b/static/admin/partials/subscriber-lists.htmlindex 153f42c9..c388c64b 100644--- a/static/admin/partials/subscriber-lists.html+++ b/static/admin/partials/subscriber-lists.html@@ -19,7 +19,12 @@{{- if .Restricted }}<span class="text-light">{{ .Name }}</span>{{- else }}- <a href="{{ URI "/admin/lists" }}/{{ .ID }}" class="unstyled">{{ .Name }}</a>+ <div class="avatar">+ {{ template "avatar-icon" dict "Kind" "list" "Name" .Name "Href" (printf "%s/%d" (URI "/admin/lists") .ID) "Title" (printf "%s %s" ($root.L.T "globals.buttons.view") .Name) }}+ <div class="avatar-label">+ <a href="{{ URI "/admin/lists" }}/{{ .ID }}" class="unstyled">{{ .Name }}</a>+ </div>+ </div>{{- end }}</td><td data-label="{{ $root.L.T "lists.optin" }}">diff --git a/static/admin/views/subscriber.html b/static/admin/views/subscriber.htmlindex 53a0f6fe..e681c5f9 100644--- a/static/admin/views/subscriber.html+++ b/static/admin/views/subscriber.html@@ -43,9 +43,9 @@{{- if not $d.IsNew }}<div role="tablist" data-variant="primary">- <a role="tab" href="{{ $base }}" {{ if eq $d.Tab "profile" }}aria-selected="true"{{ end }}>{{ Icon "user" }} {{ .L.Tc "globals.terms.subscriber" 1 }}</a>+ <a role="tab" href="{{ $base }}" {{ if eq $d.Tab "activity" }}aria-selected="true"{{ end }}>{{ Icon "user" }} {{ .L.T "globals.buttons.view" }}</a>+ <a role="tab" href="{{ $base }}/edit" {{ if eq $d.Tab "edit" }}aria-selected="true"{{ end }}>{{ Icon "edit-2" }} {{ .L.T "globals.buttons.edit" }}</a><a role="tab" href="{{ $base }}/lists" {{ if eq $d.Tab "lists" }}aria-selected="true"{{ end }}>{{ Icon "list" }} {{ .L.Tc "globals.terms.lists" 2 }} ({{ len $sub.ParsedLists }})</a>- <a role="tab" href="{{ $base }}/activity" {{ if eq $d.Tab "activity" }}aria-selected="true"{{ end }}>{{ Icon "activity" }} {{ .L.T "subscribers.activity" }}</a>{{- if $d.Can "bounces:get" }}<a role="tab" href="{{ $base }}/bounces" {{ if eq $d.Tab "bounces" }}aria-selected="true"{{ end }}>{{ Icon "corner-right-down" }} {{ .L.T "globals.terms.bounces" }}</a>{{- end }}@@ -54,14 +54,14 @@{{- if $d.IsNew }}{{ template "subscriber-form" dict "Root" . "Submit" "onSubmitNew" "IsNew" true "CanSave" ($d.Can "subscribers:manage") }}- {{- else if eq $d.Tab "profile" }}+ {{- else if eq $d.Tab "edit" }}{{ template "subscriber-form" dict "Root" . "Submit" "onSubmitUpdate" "CanSave" ($d.Can "subscribers:manage") }}{{- else if eq $d.Tab "lists" }}{{ template "subscriber-lists" dict "Root" . "CanSave" ($d.Can "subscribers:manage") }}{{- else if eq $d.Tab "bounces" }}{{ template "bounces-table" dict "Root" . }}{{- else if eq $d.Tab "activity" }}- {{ template "subscriber-activity" . }}+ {{ template "subscriber-info" . }}{{- end }}</section>diff --git a/static/admin/views/subscribers.html b/static/admin/views/subscribers.htmlindex db4727c1..3ffeb6a0 100644--- a/static/admin/views/subscribers.html+++ b/static/admin/views/subscribers.html@@ -141,11 +141,11 @@</button><menu popover id="sub-actions-{{ .ID }}">{{- if $d.Can "subscribers:manage" }}- <a href="{{ URI "/admin/subscribers" }}/{{ .ID }}" role="menuitem" class="button ghost" data-testid="btn-edit">{{ Icon "edit-2" }} {{ $.L.T "globals.buttons.edit" }}</a>+ <a href="{{ URI "/admin/subscribers" }}/{{ .ID }}/edit" role="menuitem" class="button ghost" data-testid="btn-edit">{{ Icon "edit-2" }} {{ $.L.T "globals.buttons.edit" }}</a>{{- end }}<hr /><a href="{{ URI "/admin/subscribers" }}/{{ .ID }}/lists" role="menuitem" class="button ghost">{{ Icon "list" }} {{ $.L.Tc "globals.terms.lists" 2 }}</a>- <a href="{{ URI "/admin/subscribers" }}/{{ .ID }}/activity" role="menuitem" class="button ghost">{{ Icon "activity" }} {{ $.L.T "subscribers.activity" }}</a>+ <a href="{{ URI "/admin/subscribers" }}/{{ .ID }}" role="menuitem" class="button ghost">{{ Icon "activity" }} {{ $.L.T "subscribers.activity" }}</a>{{- if $d.Can "bounces:get" }}<a href="{{ URI "/admin/subscribers" }}/{{ .ID }}/bounces" role="menuitem" class="button ghost">{{ Icon "corner-right-down" }} {{ $.L.T "globals.terms.bounces" }}</a>{{- end }}diff --git a/tests/specs/subscribers.spec.js b/tests/specs/subscribers.spec.jsindex b7c8250c..2a673a36 100644--- a/tests/specs/subscribers.spec.js+++ b/tests/specs/subscribers.spec.js@@ -234,7 +234,7 @@ test.describe('Subscribers: create, edit & delete', () => {});test('edits a subscriber and blocklists via the status field', async ({ page }) => {- await page.goto(`${SUBSCRIBERS}/1`);+ await page.goto(`${SUBSCRIBERS}/1/edit`);await page.locator('input[name=email]').fill('[email protected]');await page.locator('input[name=name]').fill('Edited Name');await page.locator('select[name=status]').selectOption('blocklisted');@@ -254,13 +254,13 @@ test.describe('Subscribers: create, edit & delete', () => {});test('rejects invalid attribs JSON', async ({ page }) => {- await page.goto(`${SUBSCRIBERS}/1`);+ await page.goto(`${SUBSCRIBERS}/1/edit`);await page.locator('textarea[name=attribs]').fill('{ not valid json');await page.getByTestId('btn-save').click();await expect(page.locator('.toast')).toBeVisible();// No navigation happened: still on the edit page.- expect(page.url()).toContain(`${SUBSCRIBERS}/1`);+ expect(page.url()).toContain(`${SUBSCRIBERS}/1/edit`);});test('exposes a per-row data download link', async ({ page }) => {@@ -632,8 +632,17 @@ test.describe('Subscriber detail: activity tab', () => {await resetDB(browser);});- test('shows the activity stat cards', async ({ page }) => {- await page.goto(`${SUBSCRIBERS}/1/activity`);+ test('shows the overview and weekly charts by default', async ({ page }) => {+ await page.goto(`${SUBSCRIBERS}/1`);+ await expect(page.getByRole('tab').first()).toHaveAttribute('aria-selected', 'true');+ await expect(page.locator('#chart-subscriber-views')).toBeVisible();+ await expect(page.locator('#chart-subscriber-clicks')).toBeVisible();+ const charts = await page.evaluate(() => window._subscriberCharts);+ for (const rows of [charts.campaign_views, charts.link_clicks]) {+ expect(rows.length).toBeGreaterThanOrEqual(52);+ expect(rows.every((row) => row.count === 0)).toBeTruthy();+ expect(rows.map((row) => row.date)).toEqual(rows.map((row) => row.date).sort());+ }const stats = page.locator('.activity .stat-value');await expect(stats).toHaveCount(3);// No campaigns yet: campaigns, views and clicks are all zero.@@ -643,6 +652,17 @@ test.describe('Subscriber detail: activity tab', () => {});});+test('subscriber overview links to edit and preserves the activity URL', async ({ page }) => {+ await page.goto(`${SUBSCRIBERS}/1/activity`);+ await expect(page.locator('#chart-subscriber-views')).toBeVisible();+ await page.getByRole('tab', { name: 'Edit', exact: true }).click();+ await expect(page).toHaveURL(/\/subscribers\/1\/edit$/);+ await expect(page.locator('input[name=email]')).toBeVisible();+ await page.getByRole('tab', { name: 'View', exact: true }).click();+ await expect(page).toHaveURL(/\/subscribers\/1$/);+ await expect(page.locator('#chart-subscriber-clicks')).toBeVisible();+});+test.describe('Domain blocklist', () => {let publicUUID;