feat: add tests and other such features

.gitignore

@@ -5,4 +5,5 @@ package-lock.json
 config.json
 coverage
 log.txt
-.env
+.env
+oya.png

Dockerfile

@@ -0,0 +1,10 @@
+FROM node:20-alpine AS builder
+WORKDIR /app
+COPY package*.json ./
+RUN npm ci --omit=dev
+
+FROM node:20-alpine
+WORKDIR /app
+COPY --from=builder /app/node_modules ./node_modules
+COPY . .
+CMD ["node", "src/bot.js"]

README.md

@@ -14,11 +14,20 @@ All commands are prefixed by `pf;`. Currently only a few are implemented.
 
 - `pf;help` - Sends the current list of commands.
 
-- `pf;import` - Imports from PluralKit using the JSON file provided by their export command. Importing from other proxy bots is *TBD*. `pf;import` and attach your JSON file to the message. This will only save the fields that are present in the bot currently (the stuff above), not anything else like birthdays or system handles (yet?).
+- `pf;import` - Imports from PluralKit using the JSON file provided by their export command. Importing from other proxy bots is *TBD*. `pf;import` and attach your JSON file to the message. This will only save the fields that are present in the bot currently, not anything else like birthdays or system handles (yet?). **Only one proxy can be set per member currently.**"
 
 - `pf;member` - Accesses the sub-commands related to editing proxy members. The available subcommands are:
-  - `new` - Creates a new member to proxy with, for example: `pf;member new jane`. The member name should ideally be short so you can write other commands with it easily.
-You can optionally add a display name after the member name, for example: `pf;member new jane "Jane Doe | ze/hir"`. If it has spaces, put it in __double quotes__. The length limit is 32 characters.
+  - `new` - Creates a new member to proxy with, for example: `pf;member new jane`. The member name should ideally be short so you can write other commands with it easily. The order of values is `pf;member new [name] [displayname] [proxy] [propic]`, _without brackets_. The name is **required**, but the rest are optional.
+    Usage notes:
+    - If anything has spaces, put it in quotes: `"Jane Doe"`
+    - If anything is unset, and you want to set something after it (for ex: you haven't set a display name, but you want to add a proxy), put the unset value in empty quotes in the same position: "" If you leave it out, the bot will set things wrong.
+    - The maximum length of a display name is 32 characters.
+    - You can't use the same proxy for two different members.
+    - You can also upload an image directly instead of using a url.
+    Examples:
+    - Full example: `pf;member new jane "Jane Doe" J:text https://cdn.pixabay.com/photo/2023/10/20/19/07/aster-8330078_1280.jpg`
+    - Example with gaps: `pf;member new bob "Bob he/him" "" https://cdn.pixabay.com/photo/2016/05/09/11/09/tennis-1381230_1280.jpg
+
   - `remove` - Removes a member based on their name, for example: `pf;member remove jane`.
   - `name` - Updates the name for a specific member based on their current name, for ex: `pf;member john name jane`. The member name should ideally be short so you can write other commands with it easily.
   - `list` - Lists all members in the system.
@@ -27,7 +36,7 @@ You can optionally add a display name after the member name, for example: `pf;me
     1. Pass in a direct remote image URL, for example: `pf;member jane propic <https://cdn.pixabay.com/photo/2020/05/02/02/54/animal-5119676_1280.jpg>`. You can upload images on sites like <https://imgbb.com/>.
     2. Upload an attachment directly.
     **NOTE:** Fluxer does not save your attachments forever, so option #1 is recommended.
-  - `proxy` Updates the proxy tag for a specific member based on their name. The proxy must be formatted with the tags surrounding the word 'text', for example: `pf;member jane proxy Jane:text` or `pf;member amal proxy [text]` This is so the bot can detect what the proxy tags are. Only one proxy can be set per member currently.
+  - `proxy` Updates the proxy tag for a specific member based on their name. The proxy must be formatted with the tags surrounding the word 'text', for example: `pf;member jane proxy Jane:text` or `pf;member amal proxy [text]` This is so the bot can detect what the proxy tags are. **Only one proxy can be set per member currently.**
 
 ## Notes
 - Attaching files to messages with the proxy does not work, due to either the limitations of Fluxer itself :(

babel.config.js

@@ -0,0 +1,8 @@
+// babel.config.js
+module.exports = {
+    env: {
+        test: {
+            plugins: ["@babel/plugin-transform-modules-commonjs"]
+        }
+    }
+};

compose.yaml

@@ -2,6 +2,9 @@ services:
   main:
     build: .
     container_name: pluralflux
+    restart: unless-stopped
+    networks:
+      - pluralflux-net
   postgres:
     image: postgres:latest
     container_name: pluralflux-postgres
@@ -13,20 +16,27 @@ services:
       - pgdata:/var/lib/postgresql
     ports:
       - "5432:5432"
-#  pgadmin:
-#    image: dpage/pgadmin4:latest
-#    ports:
-#      - 5050:80
-#    environment:
-#      # Required by pgAdmin
-#      PGADMIN_DEFAULT_EMAIL: pieartsy@pm.me
-#      PGADMIN_DEFAULT_PASSWORD_FILE: /run/secrets/postgres_pwd
-#      # Don't require the user to login
-#      PGADMIN_CONFIG_SERVER_MODE: 'False'
-#      # Don't require a "master" password after logging in
-#      PGADMIN_CONFIG_MASTER_PASSWORD_REQUIRED: 'False'
-#    secrets:
-#      - postgres_pwd
+    networks:
+      - pluralflux-net
+  pgadmin:
+    image: dpage/pgadmin4:latest
+    container_name: pluralflux-pgadmin
+    ports:
+      - "5050:80"
+    environment:
+      PGADMIN_DEFAULT_EMAIL: code@asterfialla.com
+      PGADMIN_DEFAULT_PASSWORD_FILE: /run/secrets/postgres_pwd
+      PGADMIN_CONFIG_SERVER_MODE: 'False'
+      PGADMIN_CONFIG_MASTER_PASSWORD_REQUIRED: 'False'
+    secrets:
+      - postgres_pwd
+    depends_on:
+      - postgres
+    networks:
+      - pluralflux-net
+
+networks:
+  pluralflux-net:
 
 volumes:
   pgdata:

jest.config.js

@@ -0,0 +1,10 @@
+// jest.config.js
+module.exports = {
+    clearMocks: true,
+    collectCoverage: true,
+    coverageDirectory: "coverage",
+    verbose: true,
+    transform: {
+        "^.+\\.[t|j]sx?$":  require.resolve('babel-jest')
+    },
+};

package.json

@@ -3,14 +3,13 @@
   "version": "1.0.0",
   "description": "",
   "main": "src/bot.js",
-  "type": "module",
   "repository": {
     "type": "git",
     "url": "https://github.com/pieartsy/PluralFlux.git"
   },
   "private": true,
   "dependencies": {
-    "@fluxerjs/core": "^1.0.9",
+    "@fluxerjs/core": "^1.1.5",
     "dotenv": "^17.3.1",
     "pg": "^8.18.0",
     "pg-hstore": "^2.3.4",
@@ -19,6 +18,10 @@
     "tmp": "^0.2.5"
   },
   "devDependencies": {
+    "@babel/core": "^7.29.0",
+    "@babel/plugin-transform-modules-commonjs": "^7.28.6",
+    "@babel/preset-env": "^7.29.0",
+    "babel-jest": "^30.2.0",
     "jest": "^30.2.0"
   },
   "scripts": {

src/bot.js

@@ -1,4 +1,4 @@
-import { Client, Events, GatewayOpcodes } from '@fluxerjs/core';
+import { Client, Events } from '@fluxerjs/core';
 import { messageHelper } from "./helpers/messageHelper.js";
 import {enums} from "./enums.js";
 import {commands} from "./commands.js";
@@ -34,7 +34,7 @@ client.on(Events.MessageCreate, async (message) => {
 
         const commandName = content.slice(messageHelper.prefix.length).split(" ")[0];
         // If there's no command name (ie just the prefix)
-        if (!commandName) await message.reply(enums.help.SHORT_DESC_PLURALFLUX);
+        if (!commandName) return await message.reply(enums.help.SHORT_DESC_PLURALFLUX);
 
         const args = messageHelper.parseCommandArgs(content, commandName);
 
@@ -44,18 +44,40 @@ client.on(Events.MessageCreate, async (message) => {
                 throw e
             });
         }
+        else {
+            await message.reply(enums.err.COMMAND_NOT_RECOGNIZED);
+        }
     }
     catch(error) {
         console.error(error);
-        return await message.reply(error.message);
+        // return await message.reply(error.message);
     }
 });
 
 client.on(Events.Ready, () => {
     console.log(`Logged in as ${client.user?.username}`);
-    console.log(`Serving ${client.guilds.size} guild(s)`);
 });
 
+let guildCount = 0;
+client.on(Events.GuildCreate, () => {
+    guildCount++;
+    callback();
+});
+
+function printGuilds() {
+    console.log(`Serving ${client.guilds.size} guild(s)`);
+}
+
+const callback  = Debounce(printGuilds, 2000);
+
+function Debounce(func, delay) {
+    let timeout = null;
+    return function (...args) {
+        clearTimeout(timeout);
+        timeout = setTimeout(() => func(...args), delay);
+    };
+}
+
 try {
     await client.login(token);
     // await db.check_connection();

src/commands.js

@@ -2,7 +2,7 @@ import {messageHelper} from "./helpers/messageHelper.js";
 import {enums} from "./enums.js";
 import {memberHelper} from "./helpers/memberHelper.js";
 import {EmbedBuilder} from "@fluxerjs/core";
-import {importHelper} from "./import.js";
+import {importHelper} from "./helpers/importHelper.js";
 
 const cmds = new Map();
 
@@ -12,13 +12,17 @@ cmds.set('member', {
         const authorFull = `${message.author.username}#${message.author.discriminator}`
         const attachmentUrl = message.attachments.size > 0 ? message.attachments.first().url : null;
         const attachmentExpires = message.attachments.size > 0 ? message.attachments.first().expires_at : null;
-        const reply = await memberHelper.parseMemberCommand(message.author.id, authorFull, args, attachmentUrl, attachmentExpires).catch(e =>{throw e});
+        const reply = await memberHelper.parseMemberCommand(message.author.id, authorFull, args, attachmentUrl, attachmentExpires).catch(async (e) =>{await message.reply(e.message);});
         if (typeof reply === 'string') {
             return await message.reply(reply);
         }
         else if (reply instanceof EmbedBuilder) {
             await message.reply({embeds: [reply.toJSON()]})
         }
+        else if (typeof reply === 'object') {
+            const errorsText = reply.errors.length > 0 ? reply.errors.join('\n- ') : null;
+            return await message.reply({content: `${reply.success} ${errorsText ? "\nThese errors occurred:\n" + errorsText : ""}`, embeds: [reply.embed.toJSON()]})
+        }
 
     }
 })
@@ -45,12 +49,11 @@ cmds.set('help', {
 
 cmds.set('import', {
     description: enums.help.SHORT_DESC_IMPORT,
-    async execute(message) {
-        if (message.content.includes('--help')) {
+    async execute(message, client, args) {
+        const attachmentUrl = message.attachments.size > 0 ? message.attachments.first().url : null;
+        if ((message.content.includes('--help') || (args[0] === '' && args.length === 1)) && !attachmentUrl ) {
             return await message.reply(enums.help.IMPORT);
         }
-        const attachmentUrl = message.attachments.size > 0 ? message.attachments.first().url : null;
-
         return await importHelper.pluralKitImport(message.author.id, attachmentUrl).then(async (successfullyAdded) => {
             await message.reply(successfullyAdded);
         }).catch(async (error) => {
@@ -59,7 +62,9 @@ cmds.set('import', {
                 let errorsText = `${error.message}.\nThese errors occurred:\n${error.errors.join('\n')}`;
 
                 await message.reply(errorsText).catch(async () => {
-                    await messageHelper.sendMessageAsAttachment(errorsText, message);
+                    const returnedBuffer = messageHelper.returnBufferFromText(errorsText);
+                    await message.reply({content: returnedBuffer.text, files: [{ name: 'text.pdf', data: returnedBuffer.file }]
+                    })
                 });
             }
             // If just one error was returned.

src/db.js → src/database.js

@@ -10,18 +10,18 @@ if (!password) {
     process.exit(1);
 }
 
-const database = {};
+const db = {};
 
 const sequelize = new Sequelize('postgres', 'postgres', password, {
     host: 'localhost',
     logging: false,
     dialect: 'postgres'
 });
 
-database.sequelize = sequelize;
-database.Sequelize = Sequelize;
+db.sequelize = sequelize;
+db.Sequelize = Sequelize;
 
-database.members = sequelize.define('Member', {
+db.members = sequelize.define('Member', {
     userid: {
         type: DataTypes.STRING,
         allowNull: false,
@@ -41,7 +41,7 @@ database.members = sequelize.define('Member', {
     }
 });
 
-database.systems = sequelize.define('System', {
+db.systems = sequelize.define('System', {
     userid: {
         type: DataTypes.STRING,
     },
@@ -59,8 +59,8 @@ database.systems = sequelize.define('System', {
 /**
  * Checks Sequelize database connection.
  */
-database.check_connection = async function() {
-        await sequelize.authenticate().then(async (result) => {
+db.check_connection = async function() {
+        await sequelize.authenticate().then(async () => {
             console.log('Connection has been established successfully.');
             await syncModels();
         }).catch(err => {
@@ -81,4 +81,4 @@ async function syncModels() {
     });
 }
 
-export const db = database;
+export const database = db;