From 0c2fb9d5ec1259d104a245c9869a36f78a071202 Mon Sep 17 00:00:00 2001 From: James Xylight Date: Wed, 30 Jul 2025 18:15:27 -0700 Subject: [PATCH] feat (?): add a button for photon instances that enable to let users enable diagnostics --- src/lib/i18n/en.json | 8 +++ src/routes/api/diagnostic/+server.ts | 25 +++++++++ src/routes/settings/+page.svelte | 80 ++++++++++++++++++++++++++++ 3 files changed, 113 insertions(+) create mode 100644 src/routes/api/diagnostic/+server.ts diff --git a/src/lib/i18n/en.json b/src/lib/i18n/en.json index c1d3558d..dcf56d2a 100644 --- a/src/lib/i18n/en.json +++ b/src/lib/i18n/en.json @@ -723,6 +723,14 @@ "export": "Export", "import": "Import", "reset": "Reset", + "usageInfo": { + "title": "Send usage info", + "body": "You can help the development of Photon by sending information about how you use the app. This is entirely opt-in, and nothing is shared when you don't explicitly ask to.\n\nThe data under 'payload' will be sent to `https://{{hostname}}/api/diagnostic` via `POST`, and such data will be handled by the owner(s) of **{{hostname}}**.", + "profiles": "Profile count and instances (no usernames)", + "settings": "Your chosen photon settings", + "device": "Info about your device", + "payload": "Payload" + }, "navigation": { "title": "Navigation", "dockPos": { diff --git a/src/routes/api/diagnostic/+server.ts b/src/routes/api/diagnostic/+server.ts new file mode 100644 index 00000000..2b7dfa88 --- /dev/null +++ b/src/routes/api/diagnostic/+server.ts @@ -0,0 +1,25 @@ +import type { RequestHandler } from '@sveltejs/kit' +import { env as envPrivate } from '$env/dynamic/private' + +// this is a very rudimentary 'security' system. +export const POST: RequestHandler = async ({ request, getClientAddress }) => { + const body = await request.json() + + const payload = { + theme: body.theme, + profiles: body.profiles, + settings: body.settings, + } + + await fetch(envPrivate.PRIVATE_DIAGNOSTICS_URL, { + body: JSON.stringify(payload), + headers: { + Authorization: envPrivate.PRIVATE_DIAGNOSTIC_KEY, + 'Content-Type': 'application/json', + // so that any upstream diagnostic server can handle abuse + 'x-forwarded-for': getClientAddress(), + }, + }) + + return new Response(JSON.stringify({ success: true, storedData: payload })) +} diff --git a/src/routes/settings/+page.svelte b/src/routes/settings/+page.svelte index 7579c224..f236192b 100644 --- a/src/routes/settings/+page.svelte +++ b/src/routes/settings/+page.svelte @@ -35,6 +35,7 @@ Bars2, Bars3, BarsArrowDown, + Beaker, BookOpen, BugAnt, Calendar, @@ -69,9 +70,54 @@ import Section from './Section.svelte' import Setting from './Setting.svelte' import ToggleSetting from './ToggleSetting.svelte' + import { page } from '$app/state' + import Markdown from '$lib/components/markdown/Markdown.svelte' + let importing = $state(false) let importText = $state('') + let diagnostic = $state({ + open: false, + profile: false, + settings: false, + device: false, + }) + + let diagPayload = $derived(calculatePayload(diagnostic)) + + function calculatePayload(args: { + profile: boolean + settings: boolean + device: boolean + }) { + // eslint-disable-next-line + let payload: Record = {} + + if (args.profile) { + payload.profiles = { + count: profile.meta.profiles.length, + instances: [profile.meta.profiles.map(i => i.instance)], + } + } + if (args.settings) { + payload.settings = $state.snapshot(settings) + } + if (args.device) { + payload.device = { + userAgent: navigator.userAgent, + windowSize: { + width: window.innerWidth, + height: window.innerHeight, + ratio: window.devicePixelRatio, + }, + language: navigator.language, + platform: navigator.platform, + } + } + + return payload + } + let localeMap: Map< string, { @@ -132,6 +178,27 @@ {/if} +{#if diagnostic.open} + + +
+ + {$t('settings.usageInfo.profiles')} + + + {$t('settings.usageInfo.settings')} + + + {$t('settings.usageInfo.device')} + +
+      {JSON.stringify(diagPayload, undefined, 2)}
+    
+
+{/if} +
{$t('settings.title')} {#snippet extended()} @@ -204,6 +271,19 @@ +{#if env.PUBLIC_DIAGNOSTICS.toLowerCase() == 'true'} + +{/if} +