From b1b38bf9380dfb538d9459efa4e1a7b0b87ca7a2 Mon Sep 17 00:00:00 2001
From: Cheyu Tu <cheyut@andrew.cmu.edu>
Date: Thu, 10 Oct 2024 20:06:40 -0400
Subject: [PATCH] Added tests and credits

---
 src/topics/favorite.js  |  1 +
 test/topics/favorite.js | 83 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 84 insertions(+)
 create mode 100644 test/topics/favorite.js

diff --git a/src/topics/favorite.js b/src/topics/favorite.js
index a321299f9e..e52946de39 100644
--- a/src/topics/favorite.js
+++ b/src/topics/favorite.js
@@ -3,6 +3,7 @@
 
 const db = require('../database');
 
+// Credit: partially written by ChatGPT
 module.exports = function (Topics) {
 	Topics.toggleFavorite = async function (tid, uid) {
 		const exists = await Topics.exists(tid);
diff --git a/test/topics/favorite.js b/test/topics/favorite.js
new file mode 100644
index 0000000000..57354ccb58
--- /dev/null
+++ b/test/topics/favorite.js
@@ -0,0 +1,83 @@
+'use strict';
+
+const assert = require('assert');
+const db = require('../database');
+
+const Topics = {};
+require('../../src/topics/favorite')(Topics); // Corrected path
+
+describe('Topics', function () {
+	let dbCalls;
+
+	beforeEach(function () {
+		dbCalls = {
+			setAdd: [],
+			sortedSetAdd: [],
+			setRemove: [],
+			sortedSetRemove: [],
+			isSortedSetMember: []
+		};
+
+		db.setAdd = async (...args) => { dbCalls.setAdd.push(args); };
+		db.sortedSetAdd = async (...args) => { dbCalls.sortedSetAdd.push(args); };
+		db.setRemove = async (...args) => { dbCalls.setRemove.push(args); };
+		db.sortedSetRemove = async (...args) => { dbCalls.sortedSetRemove.push(args); };
+		db.isSortedSetMember = async (...args) => { dbCalls.isSortedSetMember.push(args); return false; };
+		Topics.exists = async () => true;
+	});
+
+	describe('.toggleFavorite()', function () {
+		it('should throw an error if topic does not exist', async function () {
+			Topics.exists = async () => false;
+			try {
+				await Topics.toggleFavorite(1, 1);
+			} catch (err) {
+                assert.strictEqual(err.message, '[[error:no-topic]]');
+            }
+        });
+
+        it('should unfavorite a topic if already favorited', async function () {
+            db.isSortedSetMember = async () => true;
+            const result = await Topics.toggleFavorite(1, 1);
+            assert.strictEqual(result, false);
+            assert.deepStrictEqual(dbCalls.setRemove, [['tid:1:favoriters', 1]]);
+            assert.deepStrictEqual(dbCalls.sortedSetRemove, [['uid:1:favorite_tids', 1]]);
+        });
+
+        it('should favorite a topic if not already favorited', async function () {
+            db.isSortedSetMember = async () => false;
+            const result = await Topics.toggleFavorite(1, 1);
+            assert.strictEqual(result, true);
+            assert.deepStrictEqual(dbCalls.setAdd, [['tid:1:favoriters', 1]]);
+            assert.strictEqual(dbCalls.sortedSetAdd.length, 1);
+            assert.strictEqual(dbCalls.sortedSetAdd[0][0], 'uid:1:favorite_tids');
+            assert.strictEqual(dbCalls.sortedSetAdd[0][2], 1);
+        });
+    });
+
+    describe('.favorite()', function () {
+        it('should add a topic to favorites', async function () {
+            await Topics.favorite(1, 1);
+            assert.deepStrictEqual(dbCalls.setAdd, [['tid:1:favoriters', 1]]);
+            assert.strictEqual(dbCalls.sortedSetAdd.length, 1);
+            assert.strictEqual(dbCalls.sortedSetAdd[0][0], 'uid:1:favorite_tids');
+            assert.strictEqual(dbCalls.sortedSetAdd[0][2], 1);
+        });
+    });
+
+    describe('.unfavorite()', function () {
+        it('should remove a topic from favorites', async function () {
+            await Topics.unfavorite(1, 1);
+            assert.deepStrictEqual(dbCalls.setRemove, [['tid:1:favoriters', 1]]);
+            assert.deepStrictEqual(dbCalls.sortedSetRemove, [['uid:1:favorite_tids', 1]]);
+        });
+    });
+
+    describe('.isFavorited()', function () {
+        it('should check if a topic is favorited', async function () {
+            const result = await Topics.isFavorited(1, 1);
+            assert.strictEqual(result, false);
+            assert.deepStrictEqual(dbCalls.isSortedSetMember, [['uid:1:favorite_tids', 1]]);
+        });
+    });
+});
\ No newline at end of file