CDS 8 adjustments

Author: oklemenz2

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## Version 1.1.0 - 2024-07-xx
+## Version 1.1.0 - 2024-07-16
 
 ### Added
 

package-lock.json

@@ -50,21 +50,21 @@
   },
   "devDependencies": {
     "@cap-js-community/websocket": "./",
-    "@cap-js/sqlite": "^1.7.2",
-    "@eslint/js": "^9.6.0",
-    "@sap/cds": "^7.9.3",
-    "@sap/cds-dk": "^7.9.4",
+    "@cap-js/sqlite": "^1.7.3",
+    "@eslint/js": "^9.7.0",
+    "@sap/cds": "^8.0.3",
+    "@sap/cds-dk": "^8.0.2",
     "@socket.io/redis-adapter": "^8.3.0",
     "@socket.io/redis-streams-adapter": "^0.2.2",
     "@types/express": "^4.17.21",
-    "eslint": "^9.6.0",
+    "eslint": "^9.7.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-jest": "^28.6.0",
     "eslint-plugin-n": "^17.9.0",
     "globals": "^15.8.0",
     "jest": "^29.7.0",
     "passport": "^0.7.0",
-    "prettier": "^3.3.2",
+    "prettier": "^3.3.3",
     "socket.io-client": "^4.7.5"
   },
   "license": "Apache-2.0",

package.json

@@ -186,7 +186,7 @@ class SocketServer {
    * @returns {[function]} Returns a list of middleware functions
    */
   afterMiddlewares() {
-    return [];
+    return [this.removeWrapNext.bind(this)];
   }
 
   /**
@@ -196,7 +196,16 @@ class SocketServer {
   middlewares() {
     function wrapMiddleware(middleware) {
       return (socket, next) => {
-        return middleware(socket.request, socket.request.res, next);
+        let nextCalled = false;
+        const wrapNext = (err) => {
+          delete socket.request._next;
+          if (!nextCalled) {
+            nextCalled = true;
+            next(err);
+          }
+        };
+        socket.request._next = wrapNext;
+        return middleware(socket.request, socket.request.res, wrapNext);
       };
     }
 
@@ -213,14 +222,26 @@ class SocketServer {
     return middlewares.concat(this.afterMiddlewares());
   }
 
+  removeWrapNext(socket, next) {
+    const req = socket.request;
+    let error;
+    try {
+      delete req._next;
+    } catch (err) {
+      error = err;
+    } finally {
+      next(error);
+    }
+  }
+
   /**
    * Mock the HTTP response object and make available at req.res
    * @param {Object} socket Server socket
    * @param {function} next Call next
    */
   mockResponse(socket, next) {
     const req = socket.request;
-    let error = null;
+    let error;
     try {
       // Mock response (not available in websocket, CDS middlewares need it)
       const res = req.res ?? {};
@@ -245,13 +266,17 @@ class SocketServer {
         return res;
       };
       res.json ??= (json) => {
-        this.respond(socket, res.statusCode, JSON.stringify(json));
-        res.body = json;
+        res.send(JSON.stringify(json));
+        return res;
+      };
+      res.sendStatus ??= (statusCode) => {
+        res.status(statusCode);
+        res.send(res.body || "" + statusCode);
         return res;
       };
       res.send ??= (text) => {
-        this.respond(socket, res.statusCode, text);
         res.body = text;
+        this.respond(socket, res.statusCode, text);
         return res;
       };
       res.end ??= () => {
@@ -275,7 +300,7 @@ class SocketServer {
    */
   applyAuthCookie(socket, next) {
     const req = socket.request;
-    let error = null;
+    let error;
     try {
       // Apply cookie to authorization header
       if (["mocked"].includes(cds.env.requires?.auth?.kind) && !req.headers.authorization && req.headers.cookie) {

src/socket/base.js

@@ -128,9 +128,16 @@ class SocketIOServer extends SocketServer {
     to.emit(event, data);
   }
 
+  respond(socket, statusCode, body) {
+    super.respond(socket, statusCode, body);
+    if (statusCode >= 400 && socket.request?._next) {
+      socket.request?._next(new Error(body));
+    }
+  }
+
   close(socket) {
     if (socket) {
-      socket.disconnect();
+      socket.disconnect(true);
     } else {
       this.io.close();
     }

src/socket/socket.io.js

@@ -7,7 +7,7 @@ const auth = require("./auth");
 
 async function connect(service, options = {}) {
   const port = cds.app.server.address().port;
-  const socket = ioc(`http://localhost:${port}/${service}${options?.id ? "?id=options?.id" : ""}`, {
+  const socket = ioc(`http://localhost:${port}/${service}${options?.id ? `?id=${options?.id}` : ""}`, {
     path: "/ws",
     extraHeaders: {
       authorization: options?.authorization || auth.alice,
@@ -20,7 +20,9 @@ async function connect(service, options = {}) {
     socket.once("connect", () => {
       resolve(socket);
     });
-    socket.once("connect_error", reject);
+    socket.once("connect_error", (err) => {
+      reject(err);
+    });
   });
 }
 
@@ -51,10 +53,10 @@ async function waitForNoEvent(socket, event, timeout = 100) {
   return new Promise((resolve, reject) => {
     const timeoutId = setTimeout(() => {
       resolve();
-    }, timeout);
+    }, timeout).unref();
     socket.once(event, (result) => {
       clearTimeout(timeoutId);
-      reject(result);
+      reject(new Error(JSON.stringify(result)));
     });
   });
 }

test/_env/util/socket.io.js

@@ -61,12 +61,12 @@ async function waitForNoEvent(socket, event, timeout = 100) {
   return new Promise((resolve, reject) => {
     const timeoutId = setTimeout(() => {
       resolve();
-    }, timeout);
+    }, timeout).unref();
     socket._listeners.push((message) => {
       const payload = JSON.parse(message);
       if (payload.event === event) {
         clearTimeout(timeoutId);
-        reject(payload.data);
+        reject(new Error(JSON.stringify(payload.data)));
       }
     });
   });

test/_env/util/ws.js

@@ -85,7 +85,8 @@ describe("Base", () => {
       "x-correlation-id": "123",
     });
     expect(req.res.json({ A: 1 })).toBe(req.res);
-    expect(req.res.body).toEqual({ A: 1 });
+    expect(req.res.body).toEqual('{"A":1}');
+    expect(req.res.sendStatus(200)).toBe(req.res);
     expect(req.res.send("Good Day!")).toBe(req.res);
     expect(req.res.body).toEqual("Good Day!");
     expect(req.res.end()).toBe(req.res);

test/base/base.test.js

@@ -2,7 +2,7 @@
 
 const cds = require("@sap/cds");
 
-const { connect, disconnect, emitEvent } = require("../_env/util/socket.io");
+const { connect } = require("../_env/util/socket.io");
 const auth = require("../_env/util/auth");
 
 cds.test(__dirname + "/../_env");
@@ -13,28 +13,12 @@ cds.env.websocket = {
 };
 
 describe("Auth", () => {
-  let socket;
-
-  beforeAll(async () => {
-    socket = await connect("chat", {
-      authorization: auth.invalid,
-    });
-  });
-
-  afterAll(async () => {
-    await disconnect(socket);
-  });
-
-  // TODO: CDS basic-auth does not call next(err). Socket.IO client is not connected and promise is pending
-  test.skip("Invalid Auth", async () => {
-    await new Promise((resolve) => {
-      socket.on("disconnect", (event) => {
-        expect(event).toBeDefined();
-        resolve();
-      });
-    });
-    await emitEvent(socket, "message", { text: "test" });
-    cds.ws.close(socket);
+  test("Invalid Auth", async () => {
+    await expect(
+      connect("chat", {
+        authorization: auth.invalid,
+      }),
+    ).rejects.toThrow(new Error("401"));
     cds.ws.close();
   });
 });

test/socketio/auth_socket.io.test.js

@@ -25,6 +25,7 @@ describe("OData", () => {
 
   afterAll(async () => {
     await disconnect(socket);
+    await disconnect(socketOther);
   });
 
   test("Identifier Event", async () => {