ab501459a4
Implements the hybrid scope agreed on in #663: two native adapters (Umami + Rybbit) for trackers we'd keep maintained, plus a Custom script-paste mode for everyone else (Plausible, Matomo, Pirsch, GA4, GoatCounter, Fathom, Cloudflare Web Analytics). Phase 2 (Plausible native, deeper metrics) explicitly deferred until someone asks. ## Architecture **Backend `services/trackers/`**: - `TrackerAdapter` shape (single method): `fetchDeviceBreakdown` → `{ desktop, mobile, tablet } | null`. Null = route falls back to access_logs heuristic. - `umamiAdapter.js` — extracted from the `services/umamiClient.js` that landed in #662. Same 10 test contract preserved. - `rybbitAdapter.js` — new. Hits `/api/site/{id}/breakdown?dimension= device` with Bearer auth, accepts both bare-array and `{data:[...]}` envelope variants, tolerates `sessions`/`visitors`/`value`/`count` metric keys. - `customScriptSanitiser.js` — sanitize-html with a tracker-tight allowlist (`<script>` / `<noscript>` / `<link rel=preconnect| dns-prefetch>` / `<meta>`). Strips event-handler attributes, `javascript:` and `data:` URLs. - `index.js` factory: `resolveAdapter()` reads `analytics_tracker_provider` setting → dispatches. Back-compat: when provider is unset, infers `umami` from the legacy `analytics_umami_enabled` flag so #662 installs keep working without an admin touching settings. **Backend routes**: - `adminDashboard.js /analytics`: now goes through `resolveAdapter()`. Old `fetchUmamiDeviceBreakdown` direct import removed; both `umamiClient.js` and its test file deleted (replaced by the adapter shape). - `adminSettings.js PUT /analytics`: validates the new `analytics_tracker_provider` enum, sanitises any incoming `analytics_custom_head_html` on save via the sanitiser. Masks the new `analytics_rybbit_api_key` on every GET — same pattern as Umami's API key and recaptcha secret. - `publicSettings.js`: emits `analytics_tracker_provider`, `rybbit_url`/`rybbit_website_id` (only when provider=rybbit), and the pre-sanitised `analytics_custom_head_html` (only when provider=custom). Legacy `umami_*` fields stay for back-compat. **Frontend**: - `analytics.service.ts` reworked into a provider-aware shape. `initialize({provider, ...config})` dispatches to Umami / Rybbit / Custom / None. `track()` calls dispatch to `window.umami.track` / `window.rybbit.event` / no-op based on the loaded provider. - `App.tsx` `AnalyticsBootstrap` reads `analytics_tracker_provider` from public-settings and routes to the right `initialize` call. Legacy `umami_enabled`-based path preserved as fallback when the new field is missing. - `AnalyticsTab.tsx` (Settings → Analytics) reworked with a "Provider" dropdown switching between None / Umami / Rybbit / Custom panels. Each panel renders its own config fields; Custom panel surfaces an explicit CSP-reminder banner. - `useSettingsState.ts` shape extended with `tracker_provider`, `rybbit_url`/`rybbit_website_id`/`rybbit_api_key`, `custom_head_html`. Save mutation keeps `umami_enabled` in sync with `tracker_provider==='umami'` for back-compat with downstream consumers (publicSettings shape, embedded iframe). - `publicSettings.service.ts` type extended. **i18n**: EN + DE for the provider heading + description + dropdown options + Rybbit fields + Custom HTML field + CSP warning. ## Custom mode — script execution caveat When the gallery `<head>` receives the custom HTML, simply assigning innerHTML to a container element wouldn't execute the embedded `<script>` tags (per the HTML spec, dynamically-inserted scripts via innerHTML are non-running). `analytics.service.ts:120-130` re-creates each `<script>` element manually so the browser actually evaluates it. Non-script nodes (link, meta, noscript) move in directly. ## Tests **Backend** (42 cases, all pass locally): - `umamiAdapter.test.js` (10) — pinned from the original `umamiClient.test.js`: missing-config / URL shape / encoding / payload normalisation / `laptop`→`desktop` / unknown buckets / empty / non-2xx / invalid JSON / network error. - `rybbitAdapter.test.js` (9) — same shape adapted for Rybbit: bare-array + envelope payload, `sessions`/`visitors`/`dimension` key tolerance, encoding, failure modes. - `trackerFactory.test.js` (6) — resolves null for `none`/`custom`, correct adapter for `umami`/`rybbit`, back-compat path via legacy `analytics_umami_enabled`, garbage-provider defensive null. - `customScriptSanitiser.test.js` (12) — Plausible-style passthrough, Umami-style passthrough, inline body passthrough, `<noscript>` allowed, `<link rel="preconnect|dns-prefetch">` allowed, `<link rel="stylesheet">` stripped, disallowed tags stripped, `javascript:`/`data:` URLs stripped, `on*` event handlers stripped, defensive on malformed input. - `analyticsDateMerge.test.js` (5) — preserved from #662. **Frontend**: full 84-case vitest suite green; tsc + eslint clean on changed files. Adapter changes are narrow refactors of code covered by backend tests; no new analytics-page unit test added. ## End-to-end smoke (dockerised backend + my changes mounted) ``` test 1 (back-compat: no provider, umami_enabled=true) → factory returns umami adapter, /analytics returns devicesSource:access_logs (umami fetch to fake host fails gracefully). ✓ test 2 (invalid provider value) → 400 "analytics_tracker_provider must be one of: none, umami, rybbit, custom" ✓ test 3 (save custom HTML with XSS payload) → stored sanitised: `<script>alert(1)</script>evil<script async defer data-domain="x.com" src="https://plausible.io/js/script.js"></script>` (<div> stripped; script tags survive but CSP `script-src 'self'` still blocks inline + non-allowlisted external at runtime) ✓ test 4 (public-settings exposes the provider switch) → `analytics_tracker_provider: 'custom'`, `analytics_custom_head_html: '<sanitised>'` ✓ ``` ## Out of scope (next discussions) - **Plausible native** — covered via Custom mode for now; native is Phase 2 if someone explicitly asks. - **CSP "trusted domains" admin input** — Phase 1.5. For now operators add their tracker domain to nginx/proxy CSP manually; the new CSP-reminder banner in the Custom panel makes that clear. - **Refactor `(window as any).umami.track(...)` direct calls** in PhotoLightbox/PhotoGrid to go through `analyticsService.track()` so events fire on the right tracker. Currently a no-op when Umami isn't loaded; functional but not optimal. Closes #663 Phase 1.
92 lines
3.4 KiB
JavaScript
92 lines
3.4 KiB
JavaScript
/**
|
|
* Factory tests for the pluggable-tracker registry (#663 Phase 1).
|
|
*
|
|
* Pins the contract that drives `adminDashboard.js` analytics route:
|
|
* - Returns null for 'none' / 'custom' / unset → route falls back to access_logs.
|
|
* - Returns an Umami adapter shape for provider='umami'.
|
|
* - Returns a Rybbit adapter shape for provider='rybbit'.
|
|
* - Back-compat: when `analytics_tracker_provider` is unset, infers
|
|
* 'umami' from the legacy `analytics_umami_enabled` flag.
|
|
* - Invalid provider strings fall through to the legacy back-compat path
|
|
* rather than crashing (defensive).
|
|
*/
|
|
|
|
const path = require('path');
|
|
const fs = require('fs');
|
|
const os = require('os');
|
|
|
|
process.env.NODE_ENV = 'test';
|
|
process.env.TEST_DATABASE_PATH = path.join(
|
|
fs.mkdtempSync(path.join(os.tmpdir(), 'picpeak-tracker-fact-')), 'db.sqlite',
|
|
);
|
|
|
|
const { bootCrmDb } = require('../integration/helpers/crmDb');
|
|
const trackers = require('../../src/services/trackers');
|
|
|
|
let db; let cleanup;
|
|
|
|
beforeAll(async () => {
|
|
({ db, cleanup } = await bootCrmDb());
|
|
}, 30000);
|
|
|
|
afterAll(async () => { if (cleanup) await cleanup(); });
|
|
|
|
beforeEach(async () => {
|
|
await db('app_settings').del();
|
|
});
|
|
|
|
async function setSetting(key, value) {
|
|
await db('app_settings').insert({
|
|
setting_key: key,
|
|
setting_value: JSON.stringify(value),
|
|
setting_type: 'analytics',
|
|
updated_at: new Date(),
|
|
});
|
|
}
|
|
|
|
describe('resolveAdapter (#663)', () => {
|
|
test('returns null when provider=\'none\'', async () => {
|
|
await setSetting('analytics_tracker_provider', 'none');
|
|
expect(await trackers.resolveAdapter()).toBeNull();
|
|
});
|
|
|
|
test('returns null when provider=\'custom\' (no metrics adapter, just a script slot)', async () => {
|
|
await setSetting('analytics_tracker_provider', 'custom');
|
|
expect(await trackers.resolveAdapter()).toBeNull();
|
|
});
|
|
|
|
test('back-compat: provider unset + legacy umami_enabled=true → umami adapter', async () => {
|
|
await setSetting('analytics_umami_enabled', true);
|
|
await setSetting('analytics_umami_url', 'https://u.example');
|
|
await setSetting('analytics_umami_website_id', 'w-1');
|
|
await setSetting('analytics_umami_api_key', 'k-1');
|
|
const adapter = await trackers.resolveAdapter();
|
|
expect(adapter).not.toBeNull();
|
|
expect(adapter.provider).toBe('umami');
|
|
});
|
|
|
|
test('provider=\'umami\' explicit → umami adapter with stored secrets', async () => {
|
|
await setSetting('analytics_tracker_provider', 'umami');
|
|
await setSetting('analytics_umami_url', 'https://u.example');
|
|
await setSetting('analytics_umami_website_id', 'w-1');
|
|
await setSetting('analytics_umami_api_key', 'k-1');
|
|
const adapter = await trackers.resolveAdapter();
|
|
expect(adapter.provider).toBe('umami');
|
|
});
|
|
|
|
test('provider=\'rybbit\' → rybbit adapter with stored secrets', async () => {
|
|
await setSetting('analytics_tracker_provider', 'rybbit');
|
|
await setSetting('analytics_rybbit_url', 'https://r.example');
|
|
await setSetting('analytics_rybbit_website_id', 'r-1');
|
|
await setSetting('analytics_rybbit_api_key', 'rk-1');
|
|
const adapter = await trackers.resolveAdapter();
|
|
expect(adapter.provider).toBe('rybbit');
|
|
});
|
|
|
|
test('garbage provider value falls through to legacy back-compat (defensive)', async () => {
|
|
await setSetting('analytics_tracker_provider', 'plausible-not-yet-supported');
|
|
// No legacy umami_enabled → resolves to null (= 'none')
|
|
expect(await trackers.resolveAdapter()).toBeNull();
|
|
});
|
|
});
|