Skip to content

Commit 1e94af9

Browse files
alexangione419ntietje1
alexangione419
and
ntietje1
authored
Fix/student work metrics (#199)
* webhooks app stuff * update git ignore * updated * progress * student work page metrics 2/3 working * yay 3/3 working * yay we are so working * change from my env file * formatting * cleanup * lint fix * removed my stuff from git ignore * things are working and epic now * epic data graph * remove print --------- Co-authored-by: Nick Tietje <[email protected]>
1 parent 740e8fa commit 1e94af9

File tree

12 files changed

+292
-131
lines changed

12 files changed

+292
-131
lines changed

‎.gitignore

-2
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,6 @@ terraform/.terraform/
6060
*/terraform.tfstate*
6161
*/terraform.tfvars
6262

63-
#Alex env files
64-
backend/.env.alex
6563

6664
# Misc
6765
TODO.txt

‎backend/internal/github/github.go

+3
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,9 @@ type GitHubBaseClient interface { //All methods in the SHARED client
7070
// Create a new branch in a repository
7171
CreateBranch(ctx context.Context, owner, repo, baseBranch, newBranchName string) (*github.Reference, error)
7272

73+
// List the branches in a repository
74+
ListBranches(ctx context.Context, owner string, repo string, opts *github.ListOptions) ([]*github.Branch, error)
75+
7376
// Get the details of a pull request
7477
GetPullRequest(ctx context.Context, owner string, repo string, pullNumber int) (*github.PullRequest, error)
7578

‎backend/internal/github/sharedclient/sharedclient.go

+13-1
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,20 @@ func (api *CommonAPI) ListRepositoriesByOrg(ctx context.Context, orgName string,
4343

4444
func (api *CommonAPI) ListCommits(ctx context.Context, owner string, repo string, opts *github.CommitsListOptions) ([]*github.RepositoryCommit, error) {
4545
commits, _, err := api.Client.Repositories.ListCommits(ctx, owner, repo, opts)
46+
if err != nil {
47+
return nil, fmt.Errorf("error listing commits: %v", err)
48+
}
49+
50+
return commits, nil
51+
}
52+
53+
func (api *CommonAPI) ListBranches(ctx context.Context, owner string, repo string, opts *github.ListOptions) ([]*github.Branch, error) {
54+
branches, _, err := api.Client.Repositories.ListBranches(ctx, owner, repo, opts)
55+
if err != nil {
56+
return nil, fmt.Errorf("error listing branches: %v", err)
57+
}
4658

47-
return commits, err
59+
return branches, nil
4860
}
4961

5062
func (api *CommonAPI) getBranchHead(ctx context.Context, owner, repo, branchName string) (*github.Reference, error) {

‎backend/internal/handlers/classrooms/assignments/assignments.go

+31-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"github.com/CamPlume1/khoury-classroom/internal/models"
1313
"github.com/CamPlume1/khoury-classroom/internal/utils"
1414
"github.com/gofiber/fiber/v2"
15+
"github.com/google/go-github/github"
1516
"github.com/jackc/pgx/v5"
1617
)
1718

@@ -517,16 +518,45 @@ func (s *AssignmentService) GetFirstCommitDate() fiber.Handler {
517518

518519
func (s *AssignmentService) GetCommitCount() fiber.Handler {
519520
return func(c *fiber.Ctx) error {
521+
classroomID, err := strconv.Atoi(c.Params("classroom_id"))
522+
if err != nil {
523+
return errs.BadRequest(err)
524+
}
525+
520526
assignmentID, err := strconv.Atoi(c.Params("assignment_id"))
521527
if err != nil {
522528
return errs.BadRequest(err)
523529
}
524530

525-
totalCommits, err := s.store.GetTotalWorkCommits(c.Context(), assignmentID)
531+
works, err := s.store.GetWorks(c.Context(), classroomID, assignmentID)
526532
if err != nil {
527533
return errs.InternalServerError()
528534
}
529535

536+
totalCommits := 0
537+
for _, work := range works {
538+
var branchOpts github.ListOptions
539+
branches, err := s.appClient.ListBranches(c.Context(), work.OrgName, work.RepoName, &branchOpts)
540+
if err != nil {
541+
return errs.GithubAPIError(err)
542+
}
543+
var allCommits []*github.RepositoryCommit
544+
545+
for _, branch := range branches {
546+
var opts github.CommitsListOptions
547+
// Assumes a single contirbutor, KHO-144
548+
opts.Author = work.Contributors[0].GithubUsername
549+
opts.SHA = *branch.Name
550+
commits, err := s.appClient.ListCommits(c.Context(), work.OrgName, work.RepoName, &opts)
551+
if err != nil {
552+
return errs.GithubAPIError(err)
553+
}
554+
allCommits = append(allCommits, commits...)
555+
}
556+
totalCommits += len(allCommits)
557+
558+
}
559+
530560
return c.Status(http.StatusOK).JSON(fiber.Map{
531561
"assignment_id": assignmentID,
532562
"total_commits": totalCommits,

‎backend/internal/handlers/classrooms/assignments/works/works.go

+95-9
Original file line numberDiff line numberDiff line change
@@ -275,9 +275,43 @@ func (s *WorkService) GetCommitCount() fiber.Handler {
275275
return err
276276
}
277277

278+
totalCount := work.CommitAmount
279+
// Zero either implies bad data or no commits, double check to be safe
280+
if totalCount == 0 {
281+
var branchOpts github.ListOptions
282+
branches, err := s.appClient.ListBranches(c.Context(), work.OrgName, work.RepoName, &branchOpts)
283+
if err != nil {
284+
return errs.GithubAPIError(err)
285+
}
286+
var allCommits []*github.RepositoryCommit
287+
288+
for _, branch := range branches {
289+
var opts github.CommitsListOptions
290+
// Assumes a single contirbutor, KHO-144
291+
opts.Author = work.Contributors[0].GithubUsername
292+
opts.SHA = *branch.Name
293+
commits, err := s.appClient.ListCommits(c.Context(), work.OrgName, work.RepoName, &opts)
294+
if err != nil {
295+
return errs.GithubAPIError(err)
296+
}
297+
allCommits = append(allCommits, commits...)
298+
}
299+
totalCount = len(allCommits)
300+
301+
// If there were commits, update the student work
302+
if totalCount != 0 {
303+
work.StudentWork.CommitAmount = totalCount
304+
_, err := s.store.UpdateStudentWork(c.Context(), work.StudentWork)
305+
if err != nil {
306+
return errs.InternalServerError()
307+
}
308+
}
309+
}
310+
311+
278312
return c.Status(http.StatusOK).JSON(fiber.Map{
279313
"work_id": work.ID,
280-
"commit_count": work.CommitAmount,
314+
"commit_count": totalCount,
281315
})
282316
}
283317
}
@@ -289,15 +323,29 @@ func (s *WorkService) GetCommitsPerDay() fiber.Handler {
289323
return err
290324
}
291325

292-
var opts github.CommitsListOptions
293-
opts.Author = work.Contributors[0].GithubUsername
294-
commits, err := s.appClient.ListCommits(c.Context(), work.OrgName, work.RepoName, &opts)
295-
if err != nil {
296-
return errs.GithubAPIError(err)
297-
}
326+
327+
var branchOpts github.ListOptions
328+
branches, err := s.appClient.ListBranches(c.Context(), work.OrgName, work.RepoName, &branchOpts)
329+
if err != nil {
330+
return errs.GithubAPIError(err)
331+
}
332+
var allCommits []*github.RepositoryCommit
333+
334+
for _, branch := range branches {
335+
var opts github.CommitsListOptions
336+
// Assumes a single contirbutor, KHO-144
337+
opts.Author = work.Contributors[0].GithubUsername
338+
opts.SHA = *branch.Name
339+
commits, err := s.appClient.ListCommits(c.Context(), work.OrgName, work.RepoName, &opts)
340+
if err != nil {
341+
return errs.GithubAPIError(err)
342+
}
343+
allCommits = append(allCommits, commits...)
344+
}
345+
298346

299347
commitDatesMap := make(map[time.Time]int)
300-
for _, commit := range commits {
348+
for _, commit := range allCommits {
301349
commitDate := commit.GetCommit().GetCommitter().Date
302350
if commitDate != nil {
303351
// Standardize times to midday UTC
@@ -319,9 +367,47 @@ func (s *WorkService) GetFirstCommitDate() fiber.Handler {
319367
return err
320368
}
321369

370+
fcd := work.FirstCommitDate
371+
372+
if fcd == nil {
373+
var branchOpts github.ListOptions
374+
branches, err := s.appClient.ListBranches(c.Context(), work.OrgName, work.RepoName, &branchOpts)
375+
if err != nil {
376+
return errs.GithubAPIError(err)
377+
}
378+
fmt.Println(branches)
379+
var allCommits []*github.RepositoryCommit
380+
381+
for _, branch := range branches {
382+
var opts github.CommitsListOptions
383+
// Assumes a single contirbutor, KHO-144
384+
opts.Author = work.Contributors[0].GithubUsername
385+
opts.SHA = *branch.Name
386+
commits, err := s.appClient.ListCommits(c.Context(), work.OrgName, work.RepoName, &opts)
387+
if err != nil {
388+
return errs.GithubAPIError(err)
389+
}
390+
allCommits = append(allCommits, commits...)
391+
}
392+
393+
394+
395+
if len(allCommits) > 0 {
396+
fcd = allCommits[len(allCommits)-1].GetCommit().GetCommitter().Date
397+
398+
work.StudentWork.FirstCommitDate = fcd
399+
_, err := s.store.UpdateStudentWork(c.Context(), work.StudentWork)
400+
if err != nil {
401+
return errs.InternalServerError()
402+
}
403+
404+
}
405+
406+
}
407+
322408
return c.Status(http.StatusOK).JSON(fiber.Map{
323409
"work_id": work.ID,
324-
"first_commit_at": work.FirstCommitDate,
410+
"first_commit_at": fcd,
325411
})
326412
}
327413
}

‎backend/internal/storage/postgres/works.go

+6-10
Original file line numberDiff line numberDiff line change
@@ -221,19 +221,15 @@ func (db *DB) UpdateStudentWork(ctx context.Context, studentWork models.StudentW
221221
SET assignment_outline_id = $1,
222222
repo_name = $2,
223223
unique_due_date = $3,
224-
manual_feedback_score = $4,
225-
auto_grader_score = $5,
226-
grades_published_timestamp = $6,
227-
work_state = $7,
228-
commit_amount = $8,
229-
first_commit_date = $9,
230-
last_commit_date = $10
231-
WHERE id = $11
224+
grades_published_timestamp = $4,
225+
work_state = $5,
226+
commit_amount = $6,
227+
first_commit_date = $7,
228+
last_commit_date = $8
229+
WHERE id = $9
232230
`, studentWork.AssignmentOutlineID,
233231
studentWork.RepoName,
234232
studentWork.UniqueDueDate,
235-
studentWork.ManualFeedbackScore,
236-
studentWork.AutoGraderScore,
237233
studentWork.GradesPublishedTimestamp,
238234
studentWork.WorkState,
239235
studentWork.CommitAmount,

‎frontend/src/api/assignments.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -277,5 +277,6 @@ export const getAssignmentTotalCommits = async (
277277
throw new Error("Network response was not ok");
278278
}
279279
const resp = await response.json();
280-
return resp;
280+
console.log("totoa", resp.total_commits)
281+
return resp.total_commits;
281282
};

‎frontend/src/api/student_works.ts

+5-3
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ export const getFirstCommit = async (
100100
): Promise<Date> => {
101101
const response = await fetch(
102102
`${base_url}/classrooms/classroom/${classroomID}/assignments/assignment/${assignmentID}/works/work/${studentWorkID}/first-commit`,
103-
{
103+
{
104104
method: "GET",
105105
credentials: "include",
106106
headers: {
@@ -111,8 +111,10 @@ export const getFirstCommit = async (
111111
if (!response.ok) {
112112
throw new Error("Network response was not ok");
113113
}
114-
const resp = ((await response.json()) as Date);
115-
return resp;
114+
const resp = (await response.json());
115+
const date = resp.first_commit_at as Date
116+
return date;
117+
116118
}
117119

118120
export const getTotalCommits = async (

‎frontend/src/hooks/useAssignment.ts

+20
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import {
44
getAssignmentIndirectNav,
55
getAssignments,
66
getAssignmentTemplate,
7+
getAssignmentTotalCommits,
78
postAssignmentToken,
89
} from "@/api/assignments";
910
import {
@@ -114,6 +115,25 @@ export const useAssignmentTemplate = (classroomId: number | undefined, assignmen
114115
});
115116
};
116117

118+
/**
119+
* Provides the number of commits made for this assignment
120+
*
121+
* @param classroomId - The ID of the classroom to fetch the template for.
122+
* @param assignmentId - The ID of the assignment to fetch the template for.
123+
* @returns The the number of commits made for this assignment.
124+
*/
125+
export const useAssignmentTotalCommits = (classroomId: number | undefined, assignmentId: number | undefined) => {
126+
return useQuery({
127+
queryKey: ['totalAssignmentCommits', classroomId, assignmentId],
128+
queryFn: async () => {
129+
if (!classroomId || !assignmentId) return null;
130+
console.log("called...")
131+
return await getAssignmentTotalCommits(classroomId, assignmentId);
132+
},
133+
enabled: !!classroomId && !!assignmentId
134+
});
135+
};
136+
117137
/**
118138
* Provides the acceptance metrics for an assignment.
119139
*

‎frontend/src/main.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ const queryClient = new QueryClient({
4444
}),
4545
defaultOptions: {
4646
queries: {
47-
staleTime: 5 * 1000, // 5 seconds
48-
gcTime: 5 * 60 * 1000, // 5 minutes
47+
staleTime: 0, // 5 * 1000, // 5 seconds
48+
gcTime: 0, //5 * 60 * 1000, // 5 minutes
4949
refetchOnMount: true,
5050
retry: 1,
5151
},

‎frontend/src/pages/Assignments/Assignment/index.tsx

+7-12
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import Pill from "@/components/Pill";
1919
import "./styles.css";
2020
import { StudentWorkState } from "@/types/enums";
2121
import { removeUnderscores } from "@/utils/text";
22-
import { useAssignment, useStudentWorks, useAssignmentInviteLink, useAssignmentTemplate, useAssignmentMetrics } from "@/hooks/useAssignment";
22+
import { useAssignment, useStudentWorks, useAssignmentInviteLink, useAssignmentTemplate, useAssignmentMetrics, useAssignmentTotalCommits } from "@/hooks/useAssignment";
2323
import { ErrorToast } from "@/components/Toast";
2424

2525
ChartJS.register(...registerables);
@@ -31,21 +31,19 @@ const Assignment: React.FC = () => {
3131
const base_url: string = import.meta.env.VITE_PUBLIC_FRONTEND_DOMAIN as string;
3232

3333
const { data: assignment } = useAssignment(selectedClassroom?.id, Number(assignmentID));
34-
const { data: studentWorks, isLoading: isLoadingWorks } = useStudentWorks(
34+
const { data: studentWorks } = useStudentWorks(
3535
selectedClassroom?.id,
3636
Number(assignmentID)
3737
);
3838
const { data: inviteLink = "", error: linkError } = useAssignmentInviteLink(selectedClassroom?.id, assignment?.id, base_url);
39+
40+
const { data: totalAssignmentCommits } = useAssignmentTotalCommits(selectedClassroom?.id, assignment?.id);
3941
const { data: assignmentTemplate, error: templateError } = useAssignmentTemplate(selectedClassroom?.id, assignment?.id);
4042
const { acceptanceMetrics, gradedMetrics, error: metricsError } = useAssignmentMetrics(selectedClassroom?.id, Number(assignmentID));
4143

4244
const assignmentTemplateLink = assignmentTemplate ? `https://github.com/${assignmentTemplate.template_repo_owner}/${assignmentTemplate.template_repo_name}` : "";
43-
const totalCommits = isLoadingWorks ? 0 : studentWorks?.reduce((total, work) => total + work.commit_amount, 0);
44-
const firstCommitDate = isLoadingWorks ? null : studentWorks?.reduce((earliest, work) => {
45-
if (!work.first_commit_date) return earliest;
46-
if (!earliest) return new Date(work.first_commit_date);
47-
return new Date(work.first_commit_date) < earliest ? new Date(work.first_commit_date) : earliest;
48-
}, null as Date | null);
45+
46+
4947

5048
useEffect(() => {
5149
if (linkError || templateError || metricsError) {
@@ -104,11 +102,8 @@ const Assignment: React.FC = () => {
104102
<div className="Assignment__metrics">
105103
<h2>Metrics</h2>
106104
<MetricPanel>
107-
<Metric title="First Commit Date">
108-
{firstCommitDate ? formatDate(firstCommitDate) : "N/A"}
109-
</Metric>
110105
<Metric title="Total Commits">
111-
{totalCommits?.toString() ?? "N/A"}
106+
{totalAssignmentCommits ? totalAssignmentCommits.toString() : 0}
112107
</Metric>
113108
</MetricPanel>
114109

0 commit comments

Comments
 (0)