feat: add simple app ping (#580)

* feat: add simple ping

* refactor: make ping run on server and show errors

* fix: format issues

* fix: missing translation for enabled ping option for app

* refactor: remove ping queue as no longer needed

* chore: address pull request feedback

* test: add some unit tests

* fix: format issues

* fix: deepsource issues

packages/redis/src/index.ts

@@ -1,8 +1,12 @@
-import { createQueueChannel, createSubPubChannel } from "./lib/channel";
+import { createListChannel, createQueueChannel, createSubPubChannel } from "./lib/channel";
 
 export { createCacheChannel } from "./lib/channel";
 
 export const exampleChannel = createSubPubChannel<{ message: string }>("example");
+export const pingChannel = createSubPubChannel<{ url: string; statusCode: number } | { url: string; error: string }>(
+  "ping",
+);
+export const pingUrlChannel = createListChannel<string>("ping-url");
 export const queueChannel = createQueueChannel<{
   name: string;
   executionDate: Date;

packages/redis/src/lib/channel.ts

@@ -51,7 +51,40 @@ export const createSubPubChannel = <TData>(name: string) => {
   };
 };
 
-const cacheClient = createRedisConnection();
+const getSetClient = createRedisConnection();
+
+/**
+ * Creates a new redis channel for a list
+ * @param name name of channel
+ * @returns list channel object
+ */
+export const createListChannel = <TItem>(name: string) => {
+  const listChannelName = `list:${name}`;
+  return {
+    /**
+     * Get all items in list
+     * @returns an array of all items
+     */
+    getAllAsync: async () => {
+      const items = await getSetClient.lrange(listChannelName, 0, -1);
+      return items.map((item) => superjson.parse<TItem>(item));
+    },
+    /**
+     * Remove an item from the channels list by item
+     * @param item item to remove
+     */
+    removeAsync: async (item: TItem) => {
+      await getSetClient.lrem(listChannelName, 0, superjson.stringify(item));
+    },
+    /**
+     * Add an item to the channels list
+     * @param item item to add
+     */
+    addAsync: async (item: TItem) => {
+      await getSetClient.lpush(listChannelName, superjson.stringify(item));
+    },
+  };
+};
 
 /**
  * Creates a new cache channel.
@@ -68,7 +101,7 @@ export const createCacheChannel = <TData>(name: string, cacheDurationMs: number
      * @returns data or null if not found or expired
      */
     getAsync: async () => {
-      const data = await cacheClient.get(cacheChannelName);
+      const data = await getSetClient.get(cacheChannelName);
       if (!data) return null;
 
       const parsedData = superjson.parse<{ data: TData; timestamp: Date }>(data);
@@ -84,13 +117,13 @@ export const createCacheChannel = <TData>(name: string, cacheDurationMs: number
      * @returns data or new data if not present or expired
      */
     consumeAsync: async (callback: () => Promise<TData>) => {
-      const data = await cacheClient.get(cacheChannelName);
+      const data = await getSetClient.get(cacheChannelName);
 
       const getNewDataAsync = async () => {
         logger.debug(`Cache miss for channel '${cacheChannelName}'`);
         const newData = await callback();
         const result = { data: newData, timestamp: new Date() };
-        await cacheClient.set(cacheChannelName, superjson.stringify(result));
+        await getSetClient.set(cacheChannelName, superjson.stringify(result));
         logger.debug(`Cache updated for channel '${cacheChannelName}'`);
         return result;
       };
@@ -115,14 +148,14 @@ export const createCacheChannel = <TData>(name: string, cacheDurationMs: number
      * Invalidate the cache channels data.
      */
     invalidateAsync: async () => {
-      await cacheClient.del(cacheChannelName);
+      await getSetClient.del(cacheChannelName);
     },
     /**
      * Set the data in the cache channel.
      * @param data data to be stored in the cache channel
      */
     setAsync: async (data: TData) => {
-      await cacheClient.set(cacheChannelName, superjson.stringify({ data, timestamp: new Date() }));
+      await getSetClient.set(cacheChannelName, superjson.stringify({ data, timestamp: new Date() }));
     },
   };
 };