see changelog 6.0.0

Author: GrosSacASac

.gitignore

@@ -74,4 +74,4 @@ js/network/socketiyo/examples/upload
 js/network/forms/upload/
 js/network/socketiyo-client/built/
 js/network/socketiyo/built/socketiyo.es.js
-.vscode/settings.json
+**/.vscode/settings.json

js/network/onewaydata/changelog.md

@@ -0,0 +1,17 @@
+# 6.0.0
+
+ * Start Changelog
+ * Use node protocol
+ * Completed Readme
+ * Better handling of badly formatted requests
+ * Set reconnection time to 10000ms
+ * Add possibility to change reconnection time with reconnectionTime
+ * Replaced path option with general purpose condition
+ * Use the following to keep using path
+
+```js
+const path = ...
+const condition = (request) => {
+    request.url === path;
+};
+```

js/network/onewaydata/examples/server.js

@@ -1,8 +1,8 @@
 
-import http from "http";
-import fs from "fs";
-import url from "url";
-import path from "path";
+import http from "node:http";
+import fs from "node:fs";
+import url from "node:url";
+import path from "node:path";
 import {
     createEventStream,
     sendOne,
@@ -12,17 +12,24 @@ import {
     useDefaultLogging
 } from "../source/defaultLogging.js";
 
+
 const __filename = url.fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
 const PORT = 8080;
+
+
 const server = http.createServer((req, res) => {
     if (req.url === `/`) {
         fs.createReadStream(`${__dirname}/client.html`).pipe(res);
     }
 });
 
-const eventStream = createEventStream({ server, path: `/sse` });
+const path = `/sse`;
+const condition = (request) => {
+    request.url === path;
+};
+const eventStream = createEventStream({ server, condition });
 useDefaultLogging({ eventStream });
 
 
@@ -38,5 +45,6 @@ setInterval(() => {
     eventStream.send({
         event: `football/goal`,
         data: `team 1`,
+        id: String(Date.now()),
     });
-}, 10000);
+}, 5000);

js/network/onewaydata/package.json

@@ -35,7 +35,8 @@
   "files": [
     "source",
     "readme.md",
-    "license.txt"
+    "license.txt",
+    "changelog.md"
   ],
   "repository": {
     "type": "git",

js/network/onewaydata/readme.md

@@ -13,17 +13,34 @@ to be used with [EventSource API](https://developer.mozilla.org/en-US/docs/Web/A
 ## usage
 
 ```js
-import { createEventStream } from "onewaydata";
+import { 
+    createEventStream,
+    sendOne,
+    RECONNECT,
+    CONNECT,
+    DISCONNECT,
+    defaultChannel,
+} from "onewaydata";
 import { useDefaultLogging } from "onewaydata/source/defaultLogging.js";
 
 
 const server = ...
-
-const eventStream = createEventStream({server, path: `/sse`});
+const path = `/sse`;
+const condition = (request) => {
+    request.url === path;
+};
+const eventStream = createEventStream({server, condition, reconnectionTime: 5000 });
 useDefaultLogging({ eventStream });
 
 
-eventStream.send({ data: `something`,  event: `eventName`});
+eventStream.send({ data: `data only`)});
+eventStream.send({ data: `something`,  event: `eventName`, id: String(Date.now())});
+eventStream.on(RECONNECT, ({lastId, response}) => {
+    if (lastId) {
+        // opportunity to resume with sendOne
+        sendOne(response, `here is what you missed since last disconnection`)
+    }
+})
 ```
 
 ### with express/polka
@@ -53,6 +70,10 @@ See [examples](./examples)
 https://hpbn.co/server-sent-events-sse/
 
 
+### Changelog
+
+[changelog.md](./changelog.md)
+
 ### License
 
 [CC0](./license.txt)

js/network/onewaydata/source/onewaydata.js

@@ -13,11 +13,13 @@ const MIME = `text/event-stream`;
 const LAST_ID = `Last-Event-ID`;
 const defaultChannel = `message`;
 const HTTP_OK = 200;
+const HTTP_PROBLEM = 400;
 
-// fields
+// SSE fields 
 const DATA = `data`;
 const ID = `id`;
 const EVENT = `event`;
+const RETRY = `retry`;
 
 const RECONNECT = Symbol();
 const CONNECT = Symbol();
@@ -70,14 +72,16 @@ const isValidRequestForServerSentEvents = (request) => {
 
 
 const createEventStream = (options) => {
-    const { path, server, asMiddleWare } = options;
+    const { condition, server, asMiddleWare, reconnectionTime = 10 ** 4 } = options;
     const eventStream = Emitter({ lastEventId: 0 });
 
     let responses = [];
     let onRequest;
 
     const requestHandler = (request, response) => {
         if (!isValidRequestForServerSentEvents(request)) {
+            response.writeHead(HTTP_PROBLEM);
+            response.end();
             return false;
         }
 
@@ -98,6 +102,8 @@ const createEventStream = (options) => {
                 lastId,
                 response,
             });
+        } else {
+            response.write(`${RETRY}: ${reconnectionTime}\n\n`)
         }
 
         socket.once(`close`, () => {
@@ -145,11 +151,9 @@ const createEventStream = (options) => {
         };
     } else {
         onRequest = (request, response) => {
-            const requestPath = request.url;
-            if (requestPath !== path) {
-                return;
+            if (condition(request)) {
+                requestHandler(request, response, responses);
             }
-            requestHandler(request, response, responses);
         };
         server.on(`request`, onRequest);
     }