New websocket logging

Author: andrewshell

controllers/rpc2.js

@@ -42,7 +42,10 @@ router.post('/', textParser, async function(req, res) {
 
         logEvent(
             'XmlRpc',
-            request.methodName,
+            {
+                methodName: request.methodName,
+                params: request.params
+            },
             dayjs().format('x')
         );
 

public/css/style.css

@@ -196,4 +196,10 @@ tr:hover {
 
 .mb-20 {
     margin-bottom: 20px;
+}
+
+.log-panel {
+    border: 1px solid #e0e0e0;
+    border-radius: 8px;
+    overflow: hidden;
 }

services/app-messages.js

@@ -16,12 +16,6 @@ module.exports = {
             tooManyParams: (method) => `Can't call "${method}" because there are too many parameters.`
         }
     },
-    log: {
-        subscription: (apiUrl, displayUrl, resourceUrl, protocol) => `Subscriber <a href="${apiUrl}">${displayUrl}</a> requests notification when the <a href="${resourceUrl}">resource</a> changes via <i>${protocol}</i> protocol.`,
-        ping: (resourceUrl, result) => `The <a href="${resourceUrl}">resource</a> was said to have changed. We checked and the claim appears to be ${result}.`,
-        notify: (apiUrl, displayUrl, resourceUrl, protocol) => `Subscriber <a href="${apiUrl}">${displayUrl}</a> was notified that <a href="${resourceUrl}">resource</a> has changed via <i>${protocol}</i> protocol.`,
-        notifyFailed: (apiUrl, displayUrl, resourceUrl, protocol) => `Failed to notify subscriber <a href="${apiUrl}">${displayUrl}</a> that <a href="${resourceUrl}">resource</a> has changed via <i>${protocol}</i> protocol.`
-    },
     success: {
         subscription: 'Thanks for the registration. It worked. When the resource updates we\'ll notify you. Don\'t forget to re-register after 24 hours, your subscription will expire in 25. Keep on truckin!',
         ping: 'Thanks for the ping.'

services/log-event.js

@@ -1,7 +1,7 @@
 const getDayjs = require('./dayjs-wrapper'),
     websocket = require('./websocket');
 
-async function logEvent(eventtype, htmltext, startticks, req) {
+async function logEvent(eventtype, data, startticks, req) {
     const dayjs = await getDayjs();
     let secs, time;
 
@@ -14,7 +14,7 @@ async function logEvent(eventtype, htmltext, startticks, req) {
 
     websocket.broadcast({
         eventtype,
-        htmltext,
+        data,
         secs,
         time: new Date(time.utc().format()),
         headers: req.headers

services/notify-subscribers.js

@@ -1,10 +1,8 @@
-const appMessages = require('./app-messages'),
-    config = require('../config'),
+const config = require('../config'),
     getDayjs = require('./dayjs-wrapper'),
     logEvent = require('./log-event'),
     mongodb = require('./mongodb'),
-    notifyOne = require('./notify-one'),
-    url = require('url');
+    notifyOne = require('./notify-one');
 
 async function fetchSubscriptions(resourceUrl) {
     const subscriptions = await mongodb.get('rsscloud')
@@ -30,7 +28,6 @@ async function notifyOneSubscriber(resourceUrl, subscription) {
     const dayjs = await getDayjs();
     const apiurl = subscription.url,
         startticks = dayjs().format('x'),
-        parts = url.parse(apiurl),
         notifyProcedure = subscription.notifyProcedure,
         protocol = subscription.protocol;
 
@@ -43,7 +40,17 @@ async function notifyOneSubscriber(resourceUrl, subscription) {
 
         await logEvent(
             'Notify',
-            appMessages.log.notify(apiurl, parts.host, resourceUrl, parts.protocol),
+            {
+                subscriberUrl: apiurl,
+                notifyProcedure: notifyProcedure,
+                protocol: protocol,
+                resourceUrl: resourceUrl,
+                subscription: {
+                    totalUpdates: subscription.ctUpdates,
+                    consecutiveErrors: subscription.ctConsecutiveErrors,
+                    totalErrors: subscription.ctErrors
+                }
+            },
             startticks
         );
     } catch (err) {
@@ -55,7 +62,18 @@ async function notifyOneSubscriber(resourceUrl, subscription) {
 
         await logEvent(
             'NotifyFailed',
-            appMessages.log.notifyFailed(apiurl, parts.host, resourceUrl, parts.protocol),
+            {
+                subscriberUrl: apiurl,
+                notifyProcedure: notifyProcedure,
+                protocol: protocol,
+                resourceUrl: resourceUrl,
+                subscription: {
+                    totalUpdates: subscription.ctUpdates,
+                    consecutiveErrors: subscription.ctConsecutiveErrors,
+                    totalErrors: subscription.ctErrors
+                },
+                error: err.message
+            },
             startticks
         );
     }

services/ping.js

@@ -69,7 +69,16 @@ async function checkForResourceChange(resource, resourceUrl, startticks) {
 
     await logEvent(
         'Ping',
-        appMessage.log.ping(resourceUrl, resource.flDirty.toString()),
+        {
+            resourceUrl: resourceUrl,
+            changed: resource.flDirty,
+            hash: resource.lastHash,
+            size: resource.lastSize,
+            stats: {
+                totalChecks: resource.ctChecks,
+                totalUpdates: resource.ctUpdates
+            }
+        },
         startticks
     );
 }

services/please-notify.js

@@ -6,8 +6,7 @@ const appMessages = require('./app-messages'),
     logEvent = require('./log-event'),
     mongodb = require('./mongodb'),
     notifyOne = require('./notify-one'),
-    notifyOneChallenge = require('./notify-one-challenge'),
-    url = require('url');
+    notifyOneChallenge = require('./notify-one-challenge');
 
 async function checkresourceUrlStatusCode(resourceUrl) {
     const controller = new AbortController();
@@ -53,8 +52,7 @@ async function upsertSubscriptions(subscriptions) {
 async function notifyApiUrl(notifyProcedure, apiurl, protocol, resourceUrl, diffDomain) {
     const dayjs = await getDayjs();
     const subscriptions = await fetchSubscriptions(resourceUrl),
-        startticks = dayjs().format('x'),
-        parts = url.parse(apiurl);
+        startticks = dayjs().format('x');
 
     await initSubscription(subscriptions, notifyProcedure, apiurl, protocol);
 
@@ -78,7 +76,12 @@ async function notifyApiUrl(notifyProcedure, apiurl, protocol, resourceUrl, diff
 
         await logEvent(
             'Subscribe',
-            appMessages.log.subscription(apiurl, parts.host, resourceUrl, parts.protocol),
+            {
+                subscriberUrl: apiurl,
+                notifyProcedure: notifyProcedure,
+                resourceUrl: resourceUrl,
+                diffDomain: diffDomain
+            },
             startticks
         );
     } catch {

views/view-log.handlebars

@@ -5,27 +5,25 @@
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <title>rssCloud: Log</title>
     <link href="/css/style.css" rel="stylesheet">
-    <script type="module" src="https://esm.sh/@andrewshell/socklog"></script>
-    <style>
-        socklog-viewer {
-            display: block;
-            height: 70vh;
-            border: 1px solid #ccc;
-            border-radius: 4px;
-            margin-top: 10px;
-        }
-        socklog-controls {
-            display: block;
-            margin-top: 20px;
-        }
-    </style>
 </head>
 <body>
     <h1>rssCloud: Log</h1>
     <p>Real-time events on this rssCloud server.</p>
 
-    <socklog-controls></socklog-controls>
-    <socklog-viewer url="ws://{{host}}:{{port}}/wsLog"></socklog-viewer>
+    <script type="module">
+    import 'https://esm.sh/@andrewshell/socklog'
+
+    const viewer = document.getElementById('viewer')
+    const controls = document.getElementById('controls')
+
+    // Connect controls to viewer's log store
+    controls.store = viewer.getStore()
+    </script>
+
+    <div class="log-panel">
+        <socklog-controls id="controls"></socklog-controls>
+        <socklog-viewer id="viewer" url="ws://{{host}}:{{port}}/wsLog"></socklog-viewer>
+    </div>
 
     <p class="mt-20">
         <a href="/">← Back to Home</a>