From d9fdaf19303af7f8cd8f86ecb00535d471015fe1144369ad6920678979c40bdb Mon Sep 17 00:00:00 2001 From: AidarKC Date: Mon, 16 Nov 2026 12:13:42 +0300 Subject: [PATCH] =?UTF-8?q?=D0=92=D0=BA=D0=BB=D1=8E=D1=87=D0=B8=D1=82?= =?UTF-8?q?=D1=8C=20=D0=B4=D0=B8=D0=B0=D0=B3=D0=BD=D0=BE=D1=81=D1=82=D0=B8?= =?UTF-8?q?=D0=BA=D1=83=20=D0=BE=D1=88=D0=B8=D0=B1=D0=BE=D0=BA=20=D0=B1?= =?UTF-8?q?=D1=80=D0=B0=D1=83=D0=B7=D0=B5=D1=80=D0=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../system/Net_ClientErrorLog_Handler.java | 143 ++++++++------ .../entyties/Net_ClientErrorLog_Request.java | 8 + SHiNE-server/src/main/resources/logback.xml | 18 ++ VERSION.properties | 4 +- docs/API/05_Technical_Requests_API.md | 24 ++- shine-UI/index.html | 2 +- shine-UI/js/app.js | 57 ++++-- shine-UI/js/i18n/locales/en.json | 5 +- shine-UI/js/i18n/locales/ru.json | 5 +- shine-UI/js/pages/developer-settings-view.js | 17 +- shine-UI/js/services/auth-service.js | 21 +- shine-UI/js/services/client-error-reporter.js | 180 +++++++++--------- shine-UI/js/services/ws-client.js | 19 +- .../tests/client-error-reporting.test.mjs | 93 +++++++++ 14 files changed, 382 insertions(+), 214 deletions(-) create mode 100644 shine-UI/tests/client-error-reporting.test.mjs diff --git a/SHiNE-server/shine-server-net-protocol/src/main/java/server/logic/ws_protocol/JSON/handlers/system/Net_ClientErrorLog_Handler.java b/SHiNE-server/shine-server-net-protocol/src/main/java/server/logic/ws_protocol/JSON/handlers/system/Net_ClientErrorLog_Handler.java index 6afc8f01..b5ed9ed1 100644 --- a/SHiNE-server/shine-server-net-protocol/src/main/java/server/logic/ws_protocol/JSON/handlers/system/Net_ClientErrorLog_Handler.java +++ b/SHiNE-server/shine-server-net-protocol/src/main/java/server/logic/ws_protocol/JSON/handlers/system/Net_ClientErrorLog_Handler.java @@ -13,88 +13,113 @@ import server.logic.ws_protocol.JSON.utils.NetExceptionResponseFactory; import server.logic.ws_protocol.WireCodes; import java.net.SocketAddress; +import java.net.InetSocketAddress; +import java.util.HashMap; +import java.util.Iterator; +import java.util.Map; -/** - * ClientErrorLog — технический endpoint для фронтенд-ошибок. - * Не требует авторизации: клиент должен иметь возможность отправить ошибку - * даже если логин/сессия ещё не установлены. - */ +/** Единая точка диагностики ошибок браузера (доступна до авторизации). */ public class Net_ClientErrorLog_Handler implements JsonMessageHandler { + private static final Logger log = LoggerFactory.getLogger("client.frontend"); + private static final long WINDOW_MS = 60_000L; + private static final int MAX_PER_SOURCE = 60; + private static final int MAX_ALL = 1200; + private static final int MAX_SOURCES = 4096; + private static final Map rateLimits = new HashMap<>(); + private static long globalWindow = 0; + private static int globalCount = 0; + private static int cleanCounter = 0; - private static final Logger log = LoggerFactory.getLogger(Net_ClientErrorLog_Handler.class); + private static final class Bucket { + long start; + int count; + Bucket(long now) { start = now; } + } @Override public Net_Response handle(Net_Request baseRequest, ConnectionContext ctx) { Net_ClientErrorLog_Request req = (Net_ClientErrorLog_Request) baseRequest; - - if (req.getMessage() == null || req.getMessage().isBlank()) { - return NetExceptionResponseFactory.error( - req, - WireCodes.Status.BAD_REQUEST, - "BAD_FIELDS", - "Поле message обязательно для ClientErrorLog" - ); + if (req.getMessage() == null || req.getMessage().isBlank() || invalidSize(req)) { + return NetExceptionResponseFactory.error(req, WireCodes.Status.BAD_REQUEST, + "BAD_FIELDS", "Недопустимый размер или отсутствие message в ClientErrorLog"); } long serverTs = System.currentTimeMillis(); - String login = safe(ctx != null ? ctx.getLogin() : null); - String sessionId = safe(ctx != null ? ctx.getSessionId() : null); - String remote = safe(remoteAddress(ctx)); - - log.error( - "CLIENT_FRONTEND_ERROR kind={} clientTs={} serverTs={} login={} sessionId={} remote={} route={} href={} sourceUrl={} line={} column={} requestOp={} requestIdRef={} message={} userAgent={} context={}", - clip(req.getKind(), 64), - req.getClientTs(), - serverTs, - clip(login, 64), - clip(sessionId, 128), - clip(remote, 128), - clip(req.getRoute(), 200), - clip(req.getHref(), 240), - clip(req.getSourceUrl(), 240), - req.getLineNumber(), - req.getColumnNumber(), - clip(req.getRequestOp(), 64), - clip(req.getRequestIdRef(), 128), - clip(req.getMessage(), 500), - clip(req.getUserAgent(), 240), - clip(req.getContextJson(), 2000) - ); - - if (req.getStack() != null && !req.getStack().isBlank()) { - log.error("CLIENT_FRONTEND_ERROR_STACK requestId={} stack={}", - clip(req.getRequestId(), 128), - clip(req.getStack(), 8000)); + boolean accepted = allow(remoteAddress(ctx), serverTs); + if (accepted) { + log.error("CLIENT_FRONTEND_ERROR id={} clientVersion={} kind={} clientTs={} serverTs={} login={} " + + "route={} sourceUrl={} line={} column={} requestOp={} requestIdRef={} message={} " + + "userAgent={} context={} stack={}", + clip(req.getErrorId(), 48), clip(req.getClientVersion(), 80), + clip(req.getKind(), 64), req.getClientTs(), serverTs, + clip(ctx != null ? ctx.getLogin() : null, 64), clip(req.getRoute(), 150), + clip(req.getSourceUrl(), 240), req.getLineNumber(), req.getColumnNumber(), + clip(req.getRequestOp(), 64), clip(req.getRequestIdRef(), 128), + clip(req.getMessage(), 500), clip(req.getUserAgent(), 240), + clip(req.getContextJson(), 800), clip(req.getStack(), 6000)); } - Net_ClientErrorLog_Response resp = new Net_ClientErrorLog_Response(); resp.setOp(req.getOp()); resp.setRequestId(req.getRequestId()); resp.setStatus(WireCodes.Status.OK); - resp.setAccepted(true); + resp.setAccepted(accepted); // false = ограничение частоты, отчёт не записан resp.setServerTs(serverTs); return resp; } - private static String remoteAddress(ConnectionContext ctx) { - if (ctx == null) return ""; - Session ws = ctx.getWsSession(); - if (ws == null) return ""; - SocketAddress remote = ws.getRemoteAddress(); - return remote != null ? remote.toString() : ""; + private static boolean invalidSize(Net_ClientErrorLog_Request req) { + return length(req.getMessage()) > 500 || length(req.getStack()) > 6000 + || length(req.getContextJson()) > 800 || length(req.getKind()) > 64 + || length(req.getSourceUrl()) > 240 || length(req.getUserAgent()) > 240 + || length(req.getErrorId()) > 48 || length(req.getClientVersion()) > 80 + || length(req.getRoute()) > 150 || length(req.getHref()) > 240 + || length(req.getRequestOp()) > 64 || length(req.getRequestIdRef()) > 128; } - private static String safe(String value) { - return value == null ? "" : value.trim(); + private static int length(String value) { return value == null ? 0 : value.length(); } + + // Ограничение по IP WebSocket (не по полю JSON, которое клиент может подделать). + private static synchronized boolean allow(String source, long now) { + if (now - globalWindow >= WINDOW_MS) { globalWindow = now; globalCount = 0; } + if (globalCount >= MAX_ALL) return false; + if (rateLimits.size() >= MAX_SOURCES || ++cleanCounter % 128 == 0) { + Iterator> it = rateLimits.entrySet().iterator(); + while (it.hasNext()) { + if (now - it.next().getValue().start >= WINDOW_MS) it.remove(); + } + } + Bucket bucket = rateLimits.get(source); + if (bucket == null) { + if (rateLimits.size() >= MAX_SOURCES) return false; + bucket = new Bucket(now); + rateLimits.put(source, bucket); + } + if (now - bucket.start >= WINDOW_MS) { bucket.start = now; bucket.count = 0; } + if (bucket.count >= MAX_PER_SOURCE) return false; + bucket.count++; + globalCount++; + return true; + } + + private static String remoteAddress(ConnectionContext ctx) { + if (ctx == null) return "unknown"; + Session session = ctx.getWsSession(); + if (session == null) return "unknown"; + SocketAddress remote = session.getRemoteAddress(); + // Адрес не записывается в журнал и хранится только как ключ лимита на 1 минуту. + if (remote instanceof InetSocketAddress inet) { + return inet.getAddress() != null ? inet.getAddress().getHostAddress() : inet.getHostString(); + } + return remote != null ? remote.toString() : "unknown"; } private static String clip(String value, int maxLen) { - String cleaned = safe(value) - .replace('\n', ' ') - .replace('\r', ' '); - if (cleaned.length() <= maxLen) { - return cleaned; - } - return cleaned.substring(0, Math.max(0, maxLen - 3)) + "..."; + if (value == null) return ""; + String clean = value.replaceAll("[\\p{Cntrl}]", " ") + .replaceAll("(?i)\\bBearer\\s+[^\\s,;]+", "Bearer [REDACTED]") + .replaceAll("(?i)\\b(password|passwd|token|secret|privateKey|sessionId|authorization|apiKey|storagePwd)\\s*[:=]\\s*[^\\s,;}&]+", "$1=[REDACTED]") + .replaceAll("[A-Za-z0-9_+/=-]{96,}", "[REDACTED_LONG_VALUE]") + .replaceAll("(?i)[?&](token|key|password|secret|session|auth|code|signature)=[^&#\\s]+", "[REDACTED_PARAM]"); + return clean.length() <= maxLen ? clean : clean.substring(0, Math.max(0, maxLen - 3)) + "..."; } } diff --git a/SHiNE-server/shine-server-net-protocol/src/main/java/server/logic/ws_protocol/JSON/handlers/system/entyties/Net_ClientErrorLog_Request.java b/SHiNE-server/shine-server-net-protocol/src/main/java/server/logic/ws_protocol/JSON/handlers/system/entyties/Net_ClientErrorLog_Request.java index 54b7ed8d..3de8ee1c 100644 --- a/SHiNE-server/shine-server-net-protocol/src/main/java/server/logic/ws_protocol/JSON/handlers/system/entyties/Net_ClientErrorLog_Request.java +++ b/SHiNE-server/shine-server-net-protocol/src/main/java/server/logic/ws_protocol/JSON/handlers/system/entyties/Net_ClientErrorLog_Request.java @@ -26,6 +26,8 @@ import server.logic.ws_protocol.JSON.entyties.Net_Request; */ public class Net_ClientErrorLog_Request extends Net_Request { + private String errorId; + private String clientVersion; private String kind; private String message; private String stack; @@ -40,6 +42,12 @@ public class Net_ClientErrorLog_Request extends Net_Request { private String requestIdRef; private String contextJson; + public String getErrorId() { return errorId; } + public void setErrorId(String errorId) { this.errorId = errorId; } + + public String getClientVersion() { return clientVersion; } + public void setClientVersion(String clientVersion) { this.clientVersion = clientVersion; } + public String getKind() { return kind; } public void setKind(String kind) { this.kind = kind; } diff --git a/SHiNE-server/src/main/resources/logback.xml b/SHiNE-server/src/main/resources/logback.xml index 37579bd7..cf8ddead 100644 --- a/SHiNE-server/src/main/resources/logback.xml +++ b/SHiNE-server/src/main/resources/logback.xml @@ -18,6 +18,24 @@ + + + ${LOG_DIR}/client-errors.log + + ${LOG_DIR}/client-errors.%d{yyyy-MM-dd}.%i.log.gz + 10MB + 14 + 150MB + + + %d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %msg%n + + + + + + + %highlight(%-5level) %cyan(%logger{20}) - %msg%n diff --git a/VERSION.properties b/VERSION.properties index fd5e366a..d6cbfb41 100644 --- a/VERSION.properties +++ b/VERSION.properties @@ -1,2 +1,2 @@ -client.version=1.20.51 -server.version=1.16.26 +client.version=1.20.52 +server.version=1.16.27 diff --git a/docs/API/05_Technical_Requests_API.md b/docs/API/05_Technical_Requests_API.md index 84f51356..b3f05e0f 100644 --- a/docs/API/05_Technical_Requests_API.md +++ b/docs/API/05_Technical_Requests_API.md @@ -511,19 +511,21 @@ "op": "ClientErrorLog", "requestId": "err-001", "payload": { + "errorId": "ERR-A7F29C1201CD", + "clientVersion": "20261116-client-error-reporting-v1", "kind": "global_error", - "message": "TypeError: failed", + "message": "TypeError: client exception", "stack": "...", "sourceUrl": "https://shineup.me/app.js", "lineNumber": 10, "columnNumber": 20, - "route": "#/channel-view/own-0", - "href": "https://shineup.me/#/channel-view/own-0", + "route": "/channels", + "href": "https://shineup.me", "userAgent": "...", "clientTs": 1774700000123, "requestOp": "GetChannelMessages", "requestIdRef": "GetChannelMessages-123", - "contextJson": "{\"screen\":\"channels\"}" + "contextJson": "{\"pageVisibility\":\"visible\",\"pageId\":\"channels\"}" } } ``` @@ -545,7 +547,19 @@ ### Специфические коды ошибок `ClientErrorLog` -- `400 / BAD_FIELDS` — обязательные поля ошибки не заполнены. +- `400 / BAD_FIELDS` — нет `message` или превышены ограничения размеров полей. +- `200` + `payload.accepted=false` — отчёт **не записан** из-за ограничений частоты; повторов и очереди нет. + +### Диагностика SHiNE UI v1 (16.11.2026) + +- Критические JS-ошибки и неожиданные ответы WS API (статус `500–599`, кроме `507`) отправляются **автоматически**, без переключателя в инструментах разработчика; обычные `4xx` не считаются багом. +- Транспорт: только текущий WebSocket `ClientErrorLog`, без отдельного HTTP и без локальной очереди. При отсутствии соединения отчёт не отправляется; клиент не утверждает обратное. +- Серверный журнал: `logs/client-errors.log` (Logback `client.frontend`, без дублирования в `app.log`); ежедневная/размерная ротация, история 14 дней, до 150 MB суммарно. Диагностика звонков `CallDeliveryReport` остаётся в своём журнале. +- Поля `errorId` и `clientVersion` необязательные для внешних клиентов; `errorId` связывает уведомление пользователя с записью в журнале. +- Для необработанных ошибок/сбоев UI клиент передаёт тип исключения и кадры стека, но **не произвольный текст исключения**, который может содержать данные переписки. Клиент отбрасывает произвольный `context`, оставляя только технические поля: `pageId`, `reasonType`, `pageProtocol`, `timeoutMs`, `code`, `status`, `pendingOps`. URL передаются без query/hash, приватные ключи, содержимое сообщений, пароли и токены не должны включаться. Сервер дополнительно очищает и ограничивает строки; **не следует отправлять конфиденциальные данные даже при ручном вызове API**. +- Сервер ограничивает частоту: до 60 отчётов с одного IP и 1200 всего за 60 секунд; длины полей ограничены, число источников ограничено. IP используется временно для ограничения частоты и не записывается в отдельный журнал. +- Уведомление «отчёт принят» показывается только при `status=200` и `accepted=true`. Это означает, что сервер принял отчёт на обработку, но не является долговременной гарантией записи на диск. +- Отправка диагностики не инициирует повтор исходной операции, в том числе блокчейн-платежа или доната. --- diff --git a/shine-UI/index.html b/shine-UI/index.html index 52a2bac1..5976a470 100644 --- a/shine-UI/index.html +++ b/shine-UI/index.html @@ -39,7 +39,7 @@ }());