test: Increase test coverage (#39)

* test: Increase test coverage

* Assert console.error on failed client.login test

* Remove redundant removeMember test

.gitea/workflows/build-dev.yml

@@ -0,0 +1,49 @@
+name: Build Dev instance
+
+on:
+  push:
+    branches: ["develop", "Develop"]
+  pull_request:
+    branches: ["develop", "Develop"]
+    
+  workflow_dispatch:
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Docker BuildX
+        uses: docker/setup-buildx-action@v3
+
+      - name: login to gitea registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ gitea.server_url }}
+          username: ${{ gitea.actor }}
+          password: ${{ secrets.GITEA }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: |
+            engineering.sanya.gay/pluralflux/pluralflux-dev:latest
+
+      - name: Deploy bot
+        uses: appleboy/ssh-action@v1.0.3
+        with:
+          host: ${{ secrets.SSH_HOST }}
+          username: ${{ secrets.SSH_USER }}
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          port: 22
+          script: |
+            cd ${{ secrets.BOT_DIRECTORY }}
+            docker compose pull
+            docker compose up -d pluralflux-dev

.gitea/workflows/build-main.yml

@@ -0,0 +1,49 @@
+name: nodeJS remote worker
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+  workflow_dispatch:
+
+jobs:
+
+  build: 
+    
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        
+      - name: Set up Docker BuildX
+        uses: docker/setup-buildx-action@v3
+
+      - name: login to gitea registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ gitea.server_url }}
+          username: ${{ gitea.actor }}
+          password: ${{ secrets.GITEA }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with: 
+          context: .
+          push: true
+          tags: |
+            engineering.sanya.gay/pluralflux/pluralflux:latest
+ 
+      - name: Deploy bot
+        uses: appleboy/ssh-action@v1.0.3
+        with:
+          host: ${{ secrets.SSH_HOST }}
+          username: ${{ secrets.SSH_USER }}
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          port: 22
+          script: |
+            cd ${{ secrets.BOT_DIRECTORY }}
+            docker compose pull
+            docker compose up -d pluralflux-prod

.gitea/workflows/sync-from-mirror.yaml

@@ -0,0 +1,26 @@
+name: Auto-Sync from Mirror
+on:
+  push:
+    repository: "Pluralflux/Pluralflux"
+    branches: [main,develop]
+
+  workflow_dispatch:
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest 
+    steps:
+      - name: Checkout Fork
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITEA_TOKEN }}
+
+      - name: Pull from Mirror
+        run: |
+          git remote add upstream https://engineering.sanya.gay/PluralFlux/PluralFlux.git
+          git fetch upstream --prune
+          git reset --hard origin/main
+          git push origin "refs/remotes/upstream/*:refs/heads/*" --force-with-lease
+          git merge upstream/main -m "Syncing from github"
+          git push origin main

README.md

@@ -7,8 +7,6 @@ PluralFlux is a proxybot akin to PluralKit and Tupperbox, but for [Fluxer](https
 
 [Sponsor the project](https://github.com/sponsors/pieartsy)
 
-If it's not running at the moment, it's because my computer crashed or something. I'm looking to move running it to a somewhat more permanent solution.
-
 ## Commands
 All commands are prefixed by `pf;`. Currently only a few are implemented.
 

compose.yaml

@@ -22,4 +22,5 @@ services:
     volumes:
       - pgadmindata:/var/lib/pgadmin
 volumes:
-  pgdata:
+  pgdata:
+  pgadmindata:

database/data-source.ts

@@ -7,7 +7,7 @@ env.config();
 
 export const AppDataSource = new DataSource({
     type: "postgres",
-    host: "localhost",
+    host: process.env.POSTGRES_ENDPOINT,
     port: 5432,
     username: "postgres",
     password: process.env.POSTGRES_PASSWORD,
@@ -23,4 +23,4 @@ export const AppDataSource = new DataSource({
         null: "sql-null",
         undefined: "throw",
     },
-});
+});

database/entity/Member.ts

@@ -1,6 +1,7 @@
-import {Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn} from "typeorm"
+import {Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn, Unique} from "typeorm"
 
 @Entity({name: "Member", synchronize: true})
+@Unique("UQ_Member_userid_name", ['userid', 'name'])
 export class Member {
 
     @PrimaryGeneratedColumn()

database/migrations/1772825438973-delete-duplicates.ts

@@ -0,0 +1,17 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class DeleteDuplicates1772825438973 implements MigrationInterface {
+    name= "DeleteDuplicates1772825438973"
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`DELETE
+                                 FROM "Member" a USING "Member" b
+                                 WHERE a.id
+                                     > b.id
+                                   AND a.name = b.name
+                                   AND a.userid = b.userid;`)
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+    }
+
+}

database/migrations/1772830252670-update.ts

@@ -0,0 +1,14 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class Update1772830252670 implements MigrationInterface {
+    name = 'Update1772830252670'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "Member" ADD CONSTRAINT "UQ_Member_userid_name" UNIQUE ("userid", "name")`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "Member" DROP CONSTRAINT "UQ_Member_userid_name"`);
+    }
+
+}

package.json

@@ -35,7 +35,7 @@
   "scripts": {
     "test": "jest",
     "start": "ts-node src/bot.js",
-    "build-db": "tsc",
+    "new-migration": "typeorm-ts-node-commonjs migration:create database/migrations/update",
     "generate-db": "typeorm-ts-node-commonjs migration:generate -d database/data-source.ts database/migrations/update",
     "run-migration": "typeorm-ts-node-commonjs migration:run -d database/data-source.ts"
   }

src/helpers/memberHelper.js

@@ -403,7 +403,7 @@ memberHelper.updateMemberField = async function (authorId, memberName, columnNam
 /**
  * Gets the details for a member.
  *
- * @param {{Members, string[]}} member - The member object
+ * @param {{Member, string[]}} member - The member object
  * @returns {EmbedBuilder} The member's info.
  */
 memberHelper.getMemberInfo = function (member) {

src/repositories/memberRepo.js

@@ -36,12 +36,7 @@ memberRepo.getMembersByAuthor = async function (authorId) {
  * @returns {Promise<number>} Number of results removed.
  */
 memberRepo.removeMember = async function (authorId, memberName) {
-    const deleted = await members.delete({
-        where: {
-            name: ILike(memberName),
-            userid: authorId
-        }
-    })
+    const deleted = await members.delete({ name: ILike(memberName), userid: authorId })
     return deleted.affected;
 }
 
@@ -53,8 +48,8 @@ memberRepo.removeMember = async function (authorId, memberName) {
  * @returns {Promise<Member>} A successful inserted object.
  */
 memberRepo.createMember = async function (createObj) {
-    return members.insert({
-        name: createObj.name, userid: createObj.authorId, displayname: createObj.displayName, proxy: createObj.proxy, propic: createObj.propic
+    return await members.save({
+        name: createObj.name, userid: createObj.userid, displayname: createObj.displayname, proxy: createObj.proxy, propic: createObj.propic
     });
 }
 
@@ -69,12 +64,10 @@ memberRepo.createMember = async function (createObj) {
  * @returns {Promise<number>} A successful update.
  */
 memberRepo.updateMemberField = async function (authorId, memberName, columnName, value) {
-    const updated = await members.update({[columnName]: value}, {
-        where: {
-            name: ILike(memberName),
-            userid: authorId
-        }
-    })
+    const updated = await members.update({
+        name: ILike(memberName),
+        userid: authorId
+    }, {[columnName]: value})
     return updated.affected;
 }
 

tests/bot.test.js

@@ -293,8 +293,23 @@ describe('bot', () => {
         expect(client.login).toHaveBeenCalledWith(process.env.FLUXER_BOT_TOKEN)
     })
 
+    test('login exits with code 1 if client.login fails', async () => {
+        // Arrange
+        let message = "client.login failed";
+        client.login = jest.fn().mockImplementation(() => { throw new Error(message) });
+        jest.spyOn(global.console, 'error').mockImplementation(() => {});
+        jest.spyOn(process, 'exit').mockImplementation(() => {});
+        // Act
+        await login();
+        // Assert
+        expect(console.error).toHaveBeenCalledTimes(1);
+        expect(console.error).toHaveBeenCalledWith('Login failed:', new Error(message));
+        expect(process.exit).toHaveBeenCalledTimes(1);
+        expect(process.exit).toHaveBeenCalledWith(1);
+    })
+
     afterEach(() => {
         // restore the spy created with spyOn
         jest.restoreAllMocks();
     });
-})
+})

tests/helpers/memberHelper.test.js

@@ -67,6 +67,7 @@ describe('MemberHelper', () => {
         });
 
         test.each([
+            [[mockMember.name], null, null, undefined, false, mockMember.name],
             [[mockMember.name, '--help'], null, null, undefined, true, undefined],
             [['new', '--help'], null, null, 'new', true, '--help'],
             [['remove', '--help'], null, null, 'remove', true, '--help'],
@@ -474,6 +475,30 @@ describe('MemberHelper', () => {
         })
     })
 
+    describe('removeMember', () => {
+        test('if removeMember returns a positive number, return a success message', async () => {
+            // Arrange
+            memberRepo.removeMember.mockResolvedValue(1);
+            const expectedReturn = `Member "${mockMember.name}" has been deleted.`;
+            // Act
+            const res = await memberHelper.removeMember(authorId, mockMember.name);
+            // Assert
+            expect(memberRepo.removeMember).toHaveBeenCalledTimes(1);
+            expect(memberRepo.removeMember).toHaveBeenCalledWith(authorId, mockMember.name);
+            expect(res).toEqual(expectedReturn);
+        })
+
+        test('if removeMember returns a negative number, throw error', async () => {
+            // Arrange
+            memberRepo.removeMember.mockResolvedValue(-1);
+            // Act
+            expect(memberHelper.removeMember(authorId, mockMember.name)).rejects.toThrow(new Error(`${enums.err.NO_MEMBER}`));
+            // Assert
+            expect(memberRepo.removeMember).toHaveBeenCalledTimes(1);
+            expect(memberRepo.removeMember).toHaveBeenCalledWith(authorId, mockMember.name);
+        })
+    })
+
     describe('addFullMember', () => {
         test('calls getMemberByName', async () => {
             // Arrange
@@ -504,6 +529,29 @@ describe('MemberHelper', () => {
             expect(memberRepo.createMember).not.toHaveBeenCalled();
         })
 
+        test('if displayName is not filled out, call memberRepo.createMember with null value', async () => {
+            // Arrange
+            memberRepo.getMemberByName.mockResolvedValue();
+            const expectedMemberArgs = {
+                name: mockMember.name,
+                userid: authorId,
+                displayname: null,
+                proxy: null,
+                propic: null
+            }
+            memberRepo.createMember = jest.fn().mockResolvedValue(expectedMemberArgs);
+            const expectedReturn = {
+                member: expectedMemberArgs,
+                errors: [`Display name ${enums.err.NO_VALUE}. ${enums.err.SET_TO_NULL}`]
+            }
+            // Act
+            const res = await memberHelper.addFullMember(authorId, mockMember.name, "     ");
+            // Assert
+            expect(res).toEqual(expectedReturn);
+            expect(memberRepo.createMember).toHaveBeenCalledWith(expectedMemberArgs);
+            expect(memberRepo.createMember).toHaveBeenCalledTimes(1);
+        })
+
         test('if displayname is over 32 characters, call memberRepo.createMember with null value', async () => {
             // Arrange
             memberRepo.getMemberByName.mockResolvedValue();

variables.env

@@ -0,0 +1,7 @@
+FLUXER_BOT_TOKEN=<>
+POSTGRES_PASSWORD=<>
+POSTGRES_ENDPOINT=postgres
+PGADMIN_DEFAULT_EMAIL: <>
+PGADMIN_DEFAULT_PASSWORD: <>
+PGADMIN_CONFIG_SERVER_MODE: 'False'
+PGADMIN_CONFIG_MASTER_PASSWORD_REQUIRED: 'False'