Adapter loading robustness

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.4.1 - 2024-12-xx
+## Version 1.4.1 - 2024-12-02
 
 ### Fixed
 

package-lock.json

@@ -51,16 +51,16 @@
   "devDependencies": {
     "@cap-js-community/websocket": "./",
     "@cap-js/sqlite": "^1.7.7",
-    "@eslint/js": "^9.15.0",
+    "@eslint/js": "^9.16.0",
     "@sap/cds": "^8.5.0",
     "@sap/cds-dk": "^8.5.0",
     "@socket.io/redis-adapter": "^8.3.0",
     "@socket.io/redis-streams-adapter": "^0.2.2",
-    "eslint": "^9.15.0",
+    "eslint": "^9.16.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-jest": "^28.9.0",
     "eslint-plugin-n": "^17.14.0",
-    "globals": "^15.12.0",
+    "globals": "^15.13.0",
     "jest": "^29.7.0",
     "passport": "^0.7.0",
     "prettier": "^3.4.1",

package.json

@@ -358,7 +358,7 @@ class SocketServer {
    * @returns {*} Implementation module
    */
   static require(impl, context = "") {
-    if (impl.startsWith("./") || impl.startsWith("../")) {
+    if (impl.startsWith("./") || impl.startsWith("../") || impl.startsWith("/")) {
       return require(path.join(process.cwd(), impl));
     } else if (context) {
       try {

src/socket/base.js

@@ -261,34 +261,36 @@ class SocketIOServer extends SocketServer {
         let client;
         let subClient;
         const options = { ...config?.options };
-        const adapterFactory = SocketServer.require(config.impl);
-        switch (config.impl) {
-          case "@socket.io/redis-adapter":
-            if (await redis.connectionCheck(config)) {
-              client = await redis.createPrimaryClientAndConnect(config);
-              if (client) {
-                subClient = await redis.createSecondaryClientAndConnect(config);
-                if (subClient) {
-                  this.adapter = adapterFactory.createAdapter(client, subClient, options);
+        const adapterFactory = SocketServer.require(config.impl, "adapter");
+        if (adapterFactory) {
+          switch (config.impl) {
+            case "@socket.io/redis-adapter":
+              if (await redis.connectionCheck(config)) {
+                client = await redis.createPrimaryClientAndConnect(config);
+                if (client) {
+                  subClient = await redis.createSecondaryClientAndConnect(config);
+                  if (subClient) {
+                    this.adapter = adapterFactory.createAdapter(client, subClient, options);
+                  }
                 }
               }
-            }
-            break;
-          case "@socket.io/redis-streams-adapter":
-            if (await redis.connectionCheck(config)) {
-              client = await redis.createPrimaryClientAndConnect(config);
-              if (client) {
-                this.adapter = adapterFactory.createAdapter(client, options);
+              break;
+            case "@socket.io/redis-streams-adapter":
+              if (await redis.connectionCheck(config)) {
+                client = await redis.createPrimaryClientAndConnect(config);
+                if (client) {
+                  this.adapter = adapterFactory.createAdapter(client, options);
+                }
               }
-            }
-            break;
-          default:
-            this.adapter = adapterFactory.createAdapter(this, options, config);
-            break;
-        }
-        if (this.adapter) {
-          this.io.adapter(this.adapter);
-          this.adapterActive = true;
+              break;
+            default:
+              this.adapter = adapterFactory.createAdapter(this, options, config);
+              break;
+          }
+          if (this.adapter) {
+            this.io.adapter(this.adapter);
+            this.adapterActive = true;
+          }
         }
       }
     } catch (err) {

src/socket/socket.io.js

@@ -267,9 +267,11 @@ class SocketWSServer extends SocketServer {
       const config = { ...this.config?.adapter };
       if (config.impl) {
         const adapterFactory = SocketServer.require(config.impl, "adapter");
-        this.adapter = new adapterFactory(this, config);
-        await this.adapter?.setup?.();
-        this.adapterActive = !!this.adapter?.client;
+        if (adapterFactory) {
+          this.adapter = new adapterFactory(this, config);
+          await this.adapter?.setup?.();
+          this.adapterActive = !!this.adapter?.client;
+        }
       }
     } catch (err) {
       LOG?.error(err);

src/socket/ws.js

@@ -31,11 +31,13 @@
     "websocket": {
       "kind": "ws",
       "impl": null,
-      "adapter": {
-        "impl": "redis",
-        "local": true,
-        "options": {
-          "key": "websocket"
+      "[ws]": {
+        "adapter": {
+          "impl": "redis",
+          "local": true,
+          "options": {
+            "key": "websocket"
+          }
         }
       },
       "[socketio]": {

test/_env/package.json

@@ -0,0 +1,38 @@
+"use strict";
+
+const cds = require("@sap/cds");
+
+const { connect, disconnect, emitEvent } = require("../_env/util/socket.io");
+const xsenv = require("@sap/xsenv");
+
+jest.mock("redis", () => require("../_env/mocks/redis"));
+
+jest.spyOn(xsenv, "serviceCredentials").mockReturnValue({ uri: "uri" });
+
+cds.test(__dirname + "/../_env");
+
+cds.env.websocket.kind = "socket.io";
+cds.env.websocket.adapter = {
+  impl: "./test/_env/mocks/redisCustomAdapter.js",
+  local: true,
+  options: {
+    key: "websocket",
+  },
+};
+
+describe("Redis", () => {
+  let socket;
+
+  beforeAll(async () => {
+    socket = await connect("/ws/chat");
+  });
+
+  afterAll(async () => {
+    disconnect(socket);
+  });
+
+  test("Redis Custom Adapter", async () => {
+    const result = await emitEvent(socket, "message", { text: "test" });
+    expect(result).toBe("test");
+  });
+});