changed redis client to ioredis

Author: Kushagra Singh Bisen

README.md

@@ -6,6 +6,8 @@ An initial architecutre (not final) of the Solid Stream Notifications Cache is s
 
 ![Solid Stream Notifications Cache Architecture](./architecture.png)
 
+- In the current architecture, we only work with the webhook notification of the solid pods and cache them. We don't support websocket notifications yet as they are not very scalabble.(but would appreciate a PR for that in case you wish to implement it).
+
 ## License
 This code is copyrighted by [Ghent University - imec](https://www.ugent.be/ea/idlab/en) and released under the [MIT License](./LICENSE). 
 

package-lock.json

@@ -17,6 +17,7 @@
     "devDependencies": {
         "@types/bunyan": "^1.8.11",
         "@types/jest": "^29.2.4",
+        "@types/node": "^20.11.24",
         "eslint": "^8.57.0",
         "eslint-plugin-jest": "^27.9.0",
         "eslint-plugin-jsdoc": "^48.2.0",
@@ -29,6 +30,6 @@
         "@types/redis": "^4.0.11",
         "@typescript-eslint/parser": "^7.1.0",
         "bunyan": "^1.8.15",
-        "redis": "^4.6.13"
+        "ioredis": "^5.3.2"
     }
 }

package.json

@@ -28,9 +28,9 @@ program
 
 program
     .command('cache-notifications')
-    .description('Starts the cache service for notifications from the solid server(s).')
+    .description('Starts the cache service for notifications from the LDES stream stored in the solid server(s).')
     .option('-p, --port <port>', 'The port where the HTTP server will listen.', '8085')
-    .option('-p --pod <pod>', 'The location of the Solid Pod', 'http://localhost:3000/aggregation_pod/')
+    .option('-l --ldes <ldes>', 'The location of the LDES Stream', 'http://localhost:3000/aggregation_pod/aggregation/')
     .action((options: any) => {
         new CacheServiceHTTPServer(options.port, options.pod, logger);
     });

src/index.ts

@@ -11,27 +11,21 @@ describe('CacheService', () => {
         await cacheService.disconnect();
     });
 
-    it('should_connect_to_the_cache', async () => {
-        const connected = await cacheService.connect();
-        expect(connected).toBe(true);
-    });
-
     it('should_set_and_get_a_value', async () => {
-        await cacheService.connect();
         await cacheService.set('key', 'value');
         const value = await cacheService.get('key');
         expect(value).toBe('value');
     });
 
     it('should_delete_a_value', async () => {
-        await cacheService.connect();
         await cacheService.set('key', 'value');
         await cacheService.delete('key');
         const value = await cacheService.get('key');
         expect(value).toBe(null);
     });
 
     it('should_close_the_connection', async () => {
-      
+        const is_disconnected = await cacheService.disconnect();
+        expect(is_disconnected).toBe(true);
     });
 }); 

src/service/CacheService.test.ts

@@ -1,16 +1,17 @@
-import { createClient } from "redis";
+import { Redis } from "ioredis";
 /**
  * A service for interacting with the Redis cache.
  * @class CacheService
  */
 export class CacheService {
-    private client: any;
+    public client: any;
     /**
      * Creates an instance of CacheService.
      * @memberof CacheService
      */
     constructor() {
-        this.client = createClient({});
+        // defaults to localhost:6379 if no options are provided, which is the default for Redis.
+        this.client = new Redis({});
         this.setupListeners();
     }
     /**
@@ -66,6 +67,7 @@ export class CacheService {
      */
     async disconnect() {
         await this.client.quit();
+        return true;
     }
 
     /**