Add a new key for feeds to set active status

Reviewed-on: #24

.gitea/workflows/DRBv3_docs.yaml

@@ -0,0 +1,56 @@
+name: Update Wiki from JSDoc
+
+on:
+  push:
+    branches:
+      - main
+  # schedule:
+  #   - cron: '0 0 * * 1' # Every Monday at midnight (UTC)
+
+
+env:
+  NODE_ENV: development
+
+jobs:
+  update-wiki:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Generate JSDoc
+        run: npm run docs
+
+      - name: Checkout the wiki repository
+        uses: actions/checkout@v4
+        with:
+          repository: logan/drb-server.wiki # Replace with your wiki repository
+          path: wiki
+
+      - name: Output Generated Documentation
+        run: |
+          cat Home.md
+          ls
+
+      - name: Update wiki
+        run: |
+          cp -rf Home.md wiki/Home.md
+          cd wiki
+          git config user.name "gitea-actions"
+          git config user.email "gitea-actions@cusano.net"
+          git add .
+          # Check if there are any changes to commit
+          if git diff --cached --quiet; then
+            echo "No changes to commit."
+          else
+            git commit -m "Update wiki from JSDoc"
+            git push
+          fi

.gitea/workflows/DRBv3_linting.yaml

@@ -5,6 +5,8 @@ on:
     branches:
       - main
   pull_request:
+    branches:
+      - "*"
 
 jobs:
   lint-js:

.gitea/workflows/DRBv3_tests.yaml

@@ -3,7 +3,7 @@ name: DRB Tests
 on:
   pull_request:
     branches:
-      - main
+      - "*"
   push:
     branches:
       - main

.gitignore

@@ -302,3 +302,6 @@ op25/
 
 # Ignore any local run scripts for development
 *.bat
+
+# Ignore the auto-generated docs folder
+/docs

Dockerfile

@@ -12,7 +12,7 @@ RUN npm install -g node-gyp
 RUN npm install
 
 # Copy the rest of the application code to the working directory
-COPY . .
+COPY ./src ./src
 
 # Expose the port on which your Node.js application will run
 EXPOSE 3420

eslint.config.mjs

@@ -14,15 +14,19 @@ const compat = new FlatCompat({
 });
 
 export default [
+  // Apply ESLint recommended settings first
   ...compat.extends().map((config) => ({
     ...config,
+    files: ["src/**/*.mjs", "src/**/*.js", "src/**/*.cjs"],
+  })),
+
+  // Custom rules and plugin configuration
+  {
     plugins: {
       "unused-imports": unusedImports,
     },
-    files: ["**/*.mjs", "**/*.js", "**/*.cjs"],
     rules: {
-      ...config.rules,
-      // ...other your custom rules
+      // Custom rules here
       "no-console": "warn",
       "no-unused-vars": "off", // or "@typescript-eslint/no-unused-vars": "off",
       "unused-imports/no-unused-imports": "error",
@@ -35,8 +39,9 @@ export default [
           argsIgnorePattern: "^_",
         },
       ],
+      "prettier/prettier": "warn", // Integrate prettier
+    },
   },
-  })),
   prettierConfig, // Turns off all ESLint rules that have the potential to interfere with Prettier rules.
   eslintPluginPrettierRecommended,
 ];

jsdoc.conf

@@ -0,0 +1,10 @@
+{
+  "source": {
+    "includePattern": ".+([mc]?js(doc|x)?)$"
+  }, 
+  "plugins": ["node_modules/jsdoc-babel"],
+  "babel": {
+    "presets": [ "es2015" ],
+    "plugins": [ "transform-async-to-generator" ]
+  }
+}

makefile

@@ -21,10 +21,6 @@ run:
 				-e MONGO_URL=${MONGO_URL} \
 				-e DISCORD_TOKEN=${DISCORD_TOKEN} \
 				-e RSS_REFRESH_INTERVAL=${RSS_REFRESH_INTERVAL} \
-				-e WELCOME_CHANNEL_ID=${WELCOME_CHANNEL_ID} \
-				-e IGNORED_CHANNEL_IDS=${IGNORED_CHANNEL_IDS} \
-				-e LINKCOP_RESTRICTED_CHANNEL_IDS=${LINKCOP_RESTRICTED_CHANNEL_IDS} \
-				-e DRB_SERVER_INITIAL_PROMPT=${DRB_SERVER_INITIAL_PROMPT} \
 				-e OPENAI_API_KEY=${OPENAI_API_KEY} \
 				-e LOG_LOCATION="./logs/server.log" \
 				-p ${SERVER_PORT}:${SERVER_PORT} \

package.json

@@ -2,22 +2,27 @@
   "name": "drb-server",
   "version": "3.0.0",
   "description": "",
-  "main": "server.js",
+  "main": "src/server.js",
   "scripts": {
+    "docs": "jsdoc2md -c jsdoc.conf src/*js > Home.md",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "mocha --timeout 5000",
-    "start": "node server.js"
+    "start": "node src/server.js"
   },
   "author": "Logan Cusano",
   "license": "ISC",
   "type": "module",
   "devDependencies": {
+    "babel-plugin-transform-async-to-generator": "^6.24.1",
+    "babel-preset-es2015": "^6.24.1",
     "chai": "^5.1.1",
     "eslint": "^9.9.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-unused-imports": "^4.1.3",
+    "jsdoc-babel": "^0.5.0",
+    "jsdoc-to-markdown": "^8.0.3",
     "mocha": "^10.4.0",
     "prettier": "^3.3.3",
     "socket.io-client": "^4.7.5"

src/discordBot/addons/linkCop.mjs

@@ -2,10 +2,7 @@ import { DebugBuilder } from "../../modules/debugger.mjs";
 const log = new DebugBuilder("server", "discordBot.addons.linkCop");
 import { gptHandler } from "../modules/gptHandler.mjs";
 import dotenv from "dotenv";
-import {
-  getGuildConfig,
-  setGuildConfig,
-} from "../../modules/mongo-wrappers/mongoConfigWrappers.mjs";
+import { getGuildConfig } from "../../modules/mongo-wrappers/mongoConfigWrappers.mjs";
 dotenv.config();
 
 const linkRegExp = /http[s]?:\/\/\S+/g;

src/discordBot/commands/rssRemove.mjs

@@ -1,6 +1,5 @@
 import { SlashCommandBuilder } from "discord.js";
 import { DebugBuilder } from "../../modules/debugger.mjs";
-import { removeSource } from "../../rss-manager/sourceManager.mjs";
 import {
   getAllFeeds,
   deleteFeedByTitle,

src/discordBot/discordBot.mjs

@@ -1,9 +1,6 @@
 import { DebugBuilder } from "../modules/debugger.mjs";
 import { Client, GatewayIntentBits, Collection } from "discord.js";
-import {
-  registerActiveCommands,
-  unregisterAllCommands,
-} from "./modules/registerCommands.mjs";
+import { registerActiveCommands } from "./modules/registerCommands.mjs";
 import { RSSController } from "../rss-manager/rssController.mjs";
 import { join, dirname } from "path";
 import { readdirSync } from "fs";

src/discordBot/events/guildMemberAdd.mjs

@@ -4,12 +4,7 @@ import dotenv from "dotenv";
 dotenv.config();
 import { Events } from "discord.js";
 import { gptHandler } from "../modules/gptHandler.mjs";
-import {
-  getGuildConfig,
-  setGuildConfig,
-  getConfig,
-  setConfig,
-} from "../../modules/mongo-wrappers/mongoConfigWrappers.mjs";
+import { getGuildConfig } from "../../modules/mongo-wrappers/mongoConfigWrappers.mjs";
 
 export const name = Events.GuildMemberAdd;
 

src/discordBot/events/messageCreate.mjs

@@ -6,10 +6,7 @@ import { Events } from "discord.js";
 import { gptInteraction } from "../addons/gptInteraction.mjs";
 import { linkCop } from "../addons/linkCop.mjs";
 import PresenceManager from "../modules/presenceManager.mjs";
-import {
-  getGuildConfig,
-  setGuildConfig,
-} from "../../modules/mongo-wrappers/mongoConfigWrappers.mjs";
+import { getGuildConfig } from "../../modules/mongo-wrappers/mongoConfigWrappers.mjs";
 
 export const name = Events.MessageCreate;
 

src/discordBot/modules/presenceManager.mjs

@@ -4,10 +4,13 @@ import {
 } from "../../modules/mongo-wrappers/mongoConfigWrappers.mjs";
 import { ActivityType, PresenceUpdateStatus } from "discord.js";
 
+/**
+ * Control the presence or activity of the discord bot.
+ */
 class PresenceManager {
   /**
    * Creates an instance of PresenceManager.
-   * @param {import('discord.js').Client} client - The Discord client instance.
+   * @param {Client} client - The Discord client instance.
    */
   constructor(client) {
     this.client = client;

src/discordBot/modules/wrappers.mjs

@@ -4,7 +4,6 @@ import {
   checkIfNodeIsConnectedToVC,
   getNodeDiscordID,
   getNodeDiscordUsername,
-  checkIfNodeHasOpenDiscordClient,
   getNodeCurrentListeningSystem,
   requestNodeJoinSystem,
 } from "../../modules/socketServerWrappers.mjs";
@@ -86,9 +85,8 @@ export const getAvailableNodes = async (nodeIo, guildId, system) => {
     openSockets.map(async (openSocket) => {
       openSocket = await nodeIo.sockets.sockets.get(openSocket);
       // Check if the node has an existing open client (meaning the radio is already being listened to)
-      const hasOpenClient = await checkIfNodeHasOpenDiscordClient(openSocket);
-      if (hasOpenClient) {
       let currentSystem = await getNodeCurrentListeningSystem(openSocket);
+      if (currentSystem) {
         if (currentSystem != system.name) {
           log.INFO(
             "Node is listening to a different system than requested",

src/modules/mongo-wrappers/mongoConfigWrappers.mjs

@@ -60,7 +60,7 @@ export const getGuildConfig = async (guildId, key) => {
   try {
     const config = await getDocumentByFields(
       collectionName,
-      ["guildId", guildId],
+      ["guild", Number(guildId)],
       ["key", key],
     );
     log.DEBUG(
@@ -82,7 +82,7 @@ export const setGuildConfig = async (guildId, key, value) => {
     const result = await upsertDocumentByFields(
       collectionName,
       value,
-      ["guildId", guildId],
+      ["guild", Number(guildId)],
       ["key", key],
     );
     log.DEBUG(`Guild ${guildId} configuration for key "${key}" set:`, value);
@@ -98,7 +98,7 @@ export const deleteGuildConfig = async (guildId, key) => {
   try {
     const result = await deleteDocumentByFields(
       collectionName,
-      ["guildId", guildId],
+      ["guild", Number(guildId)],
       ["key", key],
     );
     log.DEBUG(

src/modules/mongo-wrappers/mongoFeedsWrappers.mjs

@@ -71,6 +71,22 @@ export const updateFeedByLink = async (link, updatedFields) => {
   }
 };
 
+// Wrapper for deactivating a feed by link
+export const deactivateFeedByLink = async (link) => {
+  try {
+    const updatedCount = await updateDocumentByField(
+      feedCollectionName,
+      "link",
+      link,
+      [{'active':false}]
+    );
+    return updatedCount;
+  } catch (error) {
+    log.ERROR("Error deleting feed by link:", error);
+    throw error;
+  }
+};
+
 // Wrapper for deleting a feed by link
 export const deleteFeedByLink = async (link) => {
   try {

src/rss-manager/feedHandler.mjs

@@ -51,6 +51,10 @@ export const updateFeeds = async (client) => {
 
     const sourcePromiseArray = records.map(async (source) => {
       log.DEBUG("Processing source:", source.title);
+      // Check if the feed is active
+      if (!source.active) {
+        return
+      }
 
       try {
         const parsedFeed = await parser.parseURL(source.link);

src/rss-manager/sourceManager.mjs

@@ -3,7 +3,7 @@ const log = new DebugBuilder("server", "sourceManager");
 import {
   createFeed,
   getFeedByLink,
-  deleteFeedByLink,
+  deactivateFeedByLink,
 } from "../modules/mongo-wrappers/mongoFeedsWrappers.mjs";
 
 class SourceManager {
@@ -48,7 +48,7 @@ class SourceManager {
         return;
       }
 
-      const results = await deleteFeedByLink(sourceURL);
+      const results = await deactivateFeedByLink(sourceURL);
       if (!results) {
         log.WARN(`Failed to remove source: ${sourceURL}`);
         return;
@@ -70,6 +70,7 @@ class SourceManager {
         category,
         guild_id: guildId,
         channel_id: channelId,
+        active: true
       };
       const record = await createFeed(feed);
       log.DEBUG("Source added:", record);

src/server.js

@@ -1,11 +1,8 @@
 import { DebugBuilder } from "./modules/debugger.mjs";
 const log = new DebugBuilder("server", "server");
-import { nodeIo, app, server } from "./modules/socketServer.mjs";
+import { nodeIo, server } from "./modules/socketServer.mjs";
 import { loadAddons } from "./modules/addonManager.mjs";
-import {
-  serverClient,
-  addEnabledEventListeners,
-} from "./discordBot/discordBot.mjs";
+import { serverClient } from "./discordBot/discordBot.mjs";
 
 import dotenv from "dotenv";
 dotenv.config();

test/socketServerWrappers.test.js

@@ -4,11 +4,11 @@ import ioClient from "socket.io-client";
 import {
   deleteNodeByNuid,
   getNodeByNuid,
-} from "../modules/mongo-wrappers/mongoNodesWrappers.mjs";
+} from "../src/modules/mongo-wrappers/mongoNodesWrappers.mjs";
 import {
   deleteSystemByName,
   getSystemByName,
-} from "../modules/mongo-wrappers/mongoSystemsWrappers.mjs";
+} from "../src/modules/mongo-wrappers/mongoSystemsWrappers.mjs";
 import {
   nodeDisconnectWrapper,
   checkIfNodeHasOpenDiscordClient,
@@ -19,8 +19,8 @@ import {
   requestBotLeaveServer,
   requestNodeJoinSystem,
   requestNodeUpdate,
-} from "../modules/socketServerWrappers.mjs";
-import { nodeIo } from "../modules/socketServer.mjs";
+} from "../src/modules/socketServerWrappers.mjs";
+import { nodeIo } from "../src/modules/socketServer.mjs";
 
 import dotenv from "dotenv";
 dotenv.config();