From 5126e0fd77e6de74fc5c466ff245887db4dda646 Mon Sep 17 00:00:00 2001
From: Luca <30503695+tameTNT@users.noreply.github.com>
Date: Tue, 10 Sep 2024 16:56:57 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=8F=97=EF=B8=8F=20Remove=20concept=20of?=
 =?UTF-8?q?=20unranked=20projects=20and=20move=20to=20batch=20submission?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Towards addressing issue #1.

Under the new system (not yet developed) unranked teams will not exist
and rankings will be submitted in batches.
---
 client/src/components/judge/ProjectEntry.tsx |  2 +-
 client/src/pages/admin/settings.tsx          | 43 +++++++++++++++++++-
 client/src/pages/judge/index.tsx             | 28 +++++++++++--
 client/src/types.d.ts                        |  1 +
 server/models/options.go                     | 24 ++++++-----
 server/ranking/borda.go                      | 12 +++---
 server/ranking/borda_test.go                 |  8 ++--
 server/router/admin.go                       | 13 +++---
 8 files changed, 97 insertions(+), 34 deletions(-)

diff --git a/client/src/components/judge/ProjectEntry.tsx b/client/src/components/judge/ProjectEntry.tsx
index 7645b3b..1950528 100644
--- a/client/src/components/judge/ProjectEntry.tsx
+++ b/client/src/components/judge/ProjectEntry.tsx
@@ -18,7 +18,7 @@ const ProjectEntry = ({ project }: ProjectEntryProps) => {
     if (project.id === -1) {
         return (
             <div>
-                <h3 className="text-xl grow mt-4">Unsorted Projects below here...</h3>
+                <h3 className="text-xl grow mt-4">Unranked projects below here...</h3>
             </div>
         );
     }
diff --git a/client/src/pages/admin/settings.tsx b/client/src/pages/admin/settings.tsx
index a0532c9..72df2f0 100644
--- a/client/src/pages/admin/settings.tsx
+++ b/client/src/pages/admin/settings.tsx
@@ -23,6 +23,7 @@ const AdminSettings = () => {
     const [dropPopup, setDropPopup] = useState(false);
     const [judgingTimer, setJudgingTimer] = useState('');
     const [categories, setCategories] = useState('');
+    const [rankingBatchSize, setRankingBatchSize] = useState(8);
     const [loading, setLoading] = useState(true);
 
     async function getOptions() {
@@ -45,6 +46,10 @@ const AdminSettings = () => {
         const cats = res.data?.categories.join(', ');
         setCategories(cats ?? '');
 
+        // Set ranking batch size
+        const rbs = res.data?.ranking_batch_size;
+        setRankingBatchSize(rbs ?? 8)
+
         setLoading(false);
     }
 
@@ -111,6 +116,19 @@ const AdminSettings = () => {
         getOptions();
     };
 
+    const updateRankingBatchSize = async () => {
+        const res = await postRequest<OkResponse>('/admin/categories', 'admin', {
+            ranking_batch_size: rankingBatchSize,
+        });
+        if (res.status !== 200 || res.data?.ok !== 1) {
+            errorAlert(res);
+            return;
+        }
+
+        alert('Ranking Batch Size updated!');
+        getOptions();
+    }
+
     const resetClock = async () => {
         const res = await postRequest<OkResponse>('/admin/clock/reset', 'admin', null);
         if (res.status !== 200 || res.data?.ok !== 1) {
@@ -234,11 +252,34 @@ const AdminSettings = () => {
                 <Button
                     type="primary"
                     onClick={updateCategories}
-                    className="mt-4 w-auto md:w-auto px-4 py-2"
+                    className="mt-4 w-auto md:w-auto px-4 py-2 mb-8"  // lucatodo:  add white inner outline to buttons on focus?
                 >
                     Update Categories
                 </Button>
 
+                <SubSection>Set Ranking Batch Size</SubSection>
+                <Description>
+                    Set how many projects judges rank at a time (must be at least 2 obviously).
+                    Judges can rank and reorder projects freely before submitting a batch of the specified size.
+                </Description>
+                <input
+                    className="w-full h-14 px-4 text-2xl border-lightest border-2 rounded-sm focus:border-primary focus:border-4 focus:outline-none"
+                    type="number"
+                    min="2"
+                    placeholder="8"
+                    value={rankingBatchSize}
+                    onChange={(e) => {
+                        setRankingBatchSize(parseInt(e.target.value));
+                    }}
+                />
+                <Button
+                    type="primary"
+                    onClick={updateRankingBatchSize}
+                    className="mt-4 w-auto md:w-auto px-4 py-2"
+                >
+                    Update Ranking Batch Size
+                </Button>
+
                 <Section>Project Numbers</Section>
 
                 <SubSection>Reassign Project Numbers</SubSection>
diff --git a/client/src/pages/judge/index.tsx b/client/src/pages/judge/index.tsx
index e40f952..590a938 100644
--- a/client/src/pages/judge/index.tsx
+++ b/client/src/pages/judge/index.tsx
@@ -30,6 +30,7 @@ const Judge = () => {
     const navigate = useNavigate();
     const [judge, setJudge] = useState<Judge | null>(null);
     const [projects, setProjects] = useState<SortableJudgedProject[]>([]);
+    const [allRanked, setAllRanked] = useState(false)
     const [loaded, setLoaded] = useState(false);
     const [projCount, setProjCount] = useState(0);
     const [activeId, setActiveId] = useState<number | null>(null);
@@ -125,6 +126,8 @@ const Judge = () => {
         const combinedProjects = [...rankedProjects, dummy, ...unrankedProjects];
 
         setProjects(combinedProjects);
+        setAllRanked(rankedProjects.length === 3);  // lucatodo: use rank batch size variable;
+        // lucatodo: rankedProjects won't be variable we want to find length of. new variable probable: batchProjects?
         setLoaded(true);
     }, [judge]);
 
@@ -169,6 +172,7 @@ const Judge = () => {
     const saveSort = async (newProjects: SortableJudgedProject[]) => {
         // Split index
         const splitIndex = newProjects.findIndex((p) => p.id === -1);
+        setAllRanked(newProjects.length>0 && splitIndex === newProjects.length-1);  // lucatodo: use rank batch size variable equality, not >0
 
         // Get the ranked projects
         const rankedProjects = newProjects.slice(0, splitIndex);
@@ -189,6 +193,7 @@ const Judge = () => {
             <Container noCenter className="px-2 pb-4">
                 <h1 className="text-2xl my-2">Welcome, {judge?.name}!</h1>
                 <div className="w-full mb-6">
+                    {/* lucatodo: disable button if all projects in batch seen */}
                     <Button type="primary" full square href="/judge/live">
                         Next Project
                     </Button>
@@ -199,10 +204,12 @@ const Judge = () => {
                     </div>
                 </div>
                 <div className="flex justify-evenly">
-                    <StatBlock name="Seen" value={judge?.seen_projects.length as number} />
-                    <StatBlock name="Total Projects" value={projCount} />
+                    <StatBlock name="Seen" value={judge?.seen_projects.length as number}/>
+                    <StatBlock name="Total Projects" value={projCount}/>
                 </div>
                 <h2 className="text-primary text-xl font-bold mt-4">Rank Projects</h2>
+                {/* lucatodo: only update scores on submission? query this (only relevant if prioritisation implemented, issue #5 */}
+                <p className="italic text-light">NB: Relative project order is tracked on the admin panel even before your submit a batch.</p>
                 <div className="h-[1px] w-full bg-light my-2"></div>
                 <DndContext
                     sensors={sensors}
@@ -212,15 +219,28 @@ const Judge = () => {
                 >
                     <SortableContext items={projects} strategy={verticalListSortingStrategy}>
                         {projects.map((item) => (
-                            <SortableItem key={item.id} item={item} />
+                            <SortableItem key={item.id} item={item}/>
                         ))}
                     </SortableContext>
                     <DragOverlay>
                         {activeId ? (
-                            <SortableItem item={projects.find((p) => p.id === activeId)} />
+                            <SortableItem item={projects.find((p) => p.id === activeId)}/>
                         ) : null}
                     </DragOverlay>
                 </DndContext>
+                <div className="w-full mt-4">
+                    <div className="flex justify-center italic text-light text-center">
+                        {/* lucatodo: update X with variable limit */}
+                        {/* lucatodo: text updates if judging is ended manually to allow 'early' submission (see issue #4) */}
+                        Please rank all your projects.<br/>
+                        You can only submit rankings in batches of X projects.
+                    </div>
+                    <Button type="primary" full square href="" disabled={!allRanked}>
+                        {/* lucatodo: add button functionality (inc. alert to confirm submission) */}
+                        Submit Rankings
+                        <p className="text-sm italic">And move onto next batch</p>
+                    </Button>
+                </div>
             </Container>
         </>
     );
diff --git a/client/src/types.d.ts b/client/src/types.d.ts
index 78a87c2..ce372f2 100644
--- a/client/src/types.d.ts
+++ b/client/src/types.d.ts
@@ -112,6 +112,7 @@ interface Options {
     clock: ClockState;
     judging_timer: number;
     categories: string[];
+    ranking_batch_size: number;
 }
 
 interface FetchResponse<T> {
diff --git a/server/models/options.go b/server/models/options.go
index 679ab0d..e09217b 100644
--- a/server/models/options.go
+++ b/server/models/options.go
@@ -3,20 +3,22 @@ package models
 import "go.mongodb.org/mongo-driver/bson/primitive"
 
 type Options struct {
-	Id           primitive.ObjectID `bson:"_id,omitempty" json:"id"`
-	Ref          int64              `bson:"ref" json:"ref"`
-	CurrTableNum int64              `bson:"curr_table_num" json:"curr_table_num"`
-	Clock        ClockState         `bson:"clock" json:"clock"`
-	JudgingTimer int64              `bson:"judging_timer" json:"judging_timer"`
-	Categories   []string           `bson:"categories" json:"categories"`
+	Id               primitive.ObjectID `bson:"_id,omitempty" json:"id"`
+	Ref              int64              `bson:"ref" json:"ref"`
+	CurrTableNum     int64              `bson:"curr_table_num" json:"curr_table_num"`
+	Clock            ClockState         `bson:"clock" json:"clock"`
+	JudgingTimer     int64              `bson:"judging_timer" json:"judging_timer"`
+	Categories       []string           `bson:"categories" json:"categories"`
+	RankingBatchSize int64              `bson:"ranking_batch_size" json:"ranking_batch_size"`
 }
 
 func NewOptions() *Options {
 	return &Options{
-		Ref:          0,
-		CurrTableNum: 0,
-		JudgingTimer: 300,
-		Clock:        *NewClockState(),
-		Categories:   []string{"Creativity/Innovation", "Technical Competence/Execution", "Research/Design", "Presentation"},
+		Ref:              0,
+		CurrTableNum:     0,
+		JudgingTimer:     300,
+		Clock:            *NewClockState(),
+		Categories:       []string{"Creativity/Innovation", "Technical Competence/Execution", "Research/Design", "Presentation"},
+		RankingBatchSize: 8,
 	}
 }
diff --git a/server/ranking/borda.go b/server/ranking/borda.go
index 2953066..6d904db 100644
--- a/server/ranking/borda.go
+++ b/server/ranking/borda.go
@@ -8,7 +8,7 @@ import (
 
 type JudgeRanking struct {
 	Rankings []primitive.ObjectID `json:"rankings"`
-	Unranked []primitive.ObjectID `json:"unranked"`
+	//Unranked []primitive.ObjectID `json:"unranked"`
 }
 
 type RankedObject struct {
@@ -34,11 +34,11 @@ func rankingToPairwise(judgeRanking JudgeRanking) []Comparison {
 	}
 
 	// Loop through each project in the ranking and compare it to all the unranked projects
-	for _, winner := range judgeRanking.Rankings {
-		for _, loser := range judgeRanking.Unranked {
-			pairwise = append(pairwise, Comparison{winner, loser})
-		}
-	}
+	//for _, winner := range judgeRanking.Rankings {
+	//	for _, loser := range judgeRanking.Unranked {
+	//		pairwise = append(pairwise, Comparison{winner, loser})
+	//	}
+	//}
 
 	return pairwise
 }
diff --git a/server/ranking/borda_test.go b/server/ranking/borda_test.go
index 3264389..d3f6e63 100644
--- a/server/ranking/borda_test.go
+++ b/server/ranking/borda_test.go
@@ -19,19 +19,19 @@ func TestCalcRanking(t *testing.T) {
 	jrs := []ranking.JudgeRanking{
 		{
 			Rankings: []primitive.ObjectID{obj1, obj5, obj3},
-			Unranked: []primitive.ObjectID{obj4, obj2},
+			//Unranked: []primitive.ObjectID{obj4, obj2},
 		},
 		{
 			Rankings: []primitive.ObjectID{obj5, obj4, obj2},
-			Unranked: []primitive.ObjectID{obj3, obj1},
+			//Unranked: []primitive.ObjectID{obj3, obj1},
 		},
 		{
 			Rankings: []primitive.ObjectID{obj1, obj5, obj2},
-			Unranked: []primitive.ObjectID{obj3, obj4},
+			//Unranked: []primitive.ObjectID{obj3, obj4},
 		},
 		{
 			Rankings: []primitive.ObjectID{obj2, obj1, obj5},
-			Unranked: []primitive.ObjectID{obj5, obj3},
+			//Unranked: []primitive.ObjectID{obj5, obj3},
 		},
 	}
 
diff --git a/server/router/admin.go b/server/router/admin.go
index 3cb7fa0..134d6e6 100644
--- a/server/router/admin.go
+++ b/server/router/admin.go
@@ -393,16 +393,15 @@ func GetScores(ctx *gin.Context) {
 	// Create an array of {Rankings: [], Unranked: []}
 	judgeRankings := make([]ranking.JudgeRanking, 0)
 	for _, judge := range judges {
-		unranked := make([]primitive.ObjectID, 0)
-		for _, proj := range judge.SeenProjects {
-			if !contains(judge.Rankings, proj.ProjectId) {
-				unranked = append(unranked, proj.ProjectId)
-			}
-		}
+		//for _, proj := range judge.SeenProjects {
+		//	if !contains(judge.Rankings, proj.ProjectId) {
+		//		unranked = append(unranked, proj.ProjectId)
+		//	}
+		//}
 
 		judgeRankings = append(judgeRankings, ranking.JudgeRanking{
 			Rankings: judge.Rankings,
-			Unranked: unranked,
+			//Unranked: unranked,
 		})
 	}