Streaming output frontend #1622

michellexliu · 2022-10-13T00:28:10Z

Description

Updates the feedback interface to show more details about a submission:

Shows the score breakdown floating on the side
Shows the autograder status (right now is hard-coded as "Completed" since we only show feedback when the autograder is finished running, will eventually have states for "Queued"/"In-Progress")
Only show "Graded by" if it was graded by someone

Problem with autograder score:

Problem without autograder score:

Scrolled to bottom of page:

Side panel with lots of problem categories:

Motivation and Context

Clean up visuals of interface
Allow students to see autograder score breakdown in an easier way
Set up interface to handle newly introduced feedback states for partial output

How Has This Been Tested?

Hello lab autograded feedback
Twosum lab autograded feedback
Broken feedback (last line of feedback is not formatted in the proper {"scores": {...}} format) -> displays output, but doesn't have a score breakdown
Manual feedback
Long autograder output
Released remarks --> remarks load at bottom of page
Unreleased remarks --> remarks section doesn't appear
Semantic Feedback --> loads semantic feedback page instead of regular feedback page
Side panel with lots of problem categories

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have run rubocop for style check. If you haven't, run overcommit --install && overcommit --sign to use pre-commit hook for linting
My change requires a change to the documentation, which is located at Autolab Docs
I have updated the documentation accordingly, included in this PR

…aming-output-frontend

…b/Autolab into streaming-output-frontend

damianhxy · 2022-11-16T02:58:18Z

Looks like the changes here would conflict with #1643 -- I modified the Graded By to include Autograder and Error Handler. If you prefer to hide the Graded By, I can remove the changes from my PR.

victorhuangwq · 2022-11-27T20:43:04Z

Seeing the bigger "Correctness" at the top really tripped me up.

I understand it's leftover from

But since we are already showing all the autograded scores, do we need to repeat that?

victorhuangwq · 2022-11-27T20:43:36Z

Visually, the remarks and all makes sense.

victorhuangwq · 2022-11-27T20:44:42Z

My Remarks does not have a rounded border like the one you have in your screenshot

victorhuangwq

Tested locally and it works. Left some comments, but I will approve it because it's functionally OK.

app/assets/javascripts/feedback.js

victorhuangwq · 2022-11-27T20:46:59Z

app/controllers/assessments_controller.rb

@@ -575,7 +575,7 @@ def viewFeedback
      redirect_to(action: "index") && return
    end
    @jsonFeedback = parseFeedback(@score.feedback)
-    @scoreHash = parseScore(@score.feedback) unless @jsonFeedback.nil?


may. I know why is the nil check removed?

with it there, it wasn't possible to get any of the score info from parseScore unless a json config file was specified for semantic; there's only one small part in parseScore that relies on having @jsonFeedback set, so I just added a nil check there instead so the rest of the function could run

victorhuangwq · 2022-11-27T20:48:18Z

app/controllers/assessments_controller.rb

@@ -594,7 +594,7 @@ def parseScore(feedback)

    score_hash = JSON.parse(feedback)
    score_hash = score_hash["scores"]
-    if @jsonFeedback.key?("_scores_order") == false
+    if @jsonFeedback && @jsonFeedback.key?("_scores_order") == false


NIT: You could perhaps use ruby's safe navigator:
https://mitrev.net/ruby/2015/11/13/the-operator-in-ruby/

Note: if @jsonFeedback is nil then @jsonFeedback&.key?("_scores_order") would be nil, which is not the same as false

Currently it also relies on the behavior of nil ANDed, which is also not very ideal.

victorhuangwq · 2022-11-27T20:48:48Z

app/controllers/assessments_controller.rb

@@ -868,6 +868,7 @@ def valid_asmt_tar(tar_extract)
    tar_extract.each do |entry|
      pathname = entry.full_name
      next if pathname.start_with? "."
+      next if pathname.start_with? "PaxHeader"


what does PaxHeaders stand for?

It's a file that gets added on mac... none of the autograders I tar'ed directly on mac would run without it, so I added it in for now to run, but I think we could look for a better way of handling something like this in the future

could you add a comment on it? so that next time people who look at this code would know

app/views/assessments/viewFeedback.html.erb

michellexliu · 2022-11-28T14:24:17Z

Seeing the bigger "Correctness" at the top really tripped me up.

I understand it's leftover from

But since we are already showing all the autograded scores, do we need to repeat that?

hmmm yeah I at one point did consider just removing it, but I decided to leave it in because for non-autograded problems, there's no other way to see the score for that problem on the page. Would you suggest just hiding it if it's autograded and showing it otherwise? Or updating the styling to make it less prominent? @victorhuangwq

victorhuangwq · 2022-11-28T14:34:03Z

I'm wondering if we could hide it for autograded problems, and show it for non-autograded problems

michellexliu · 2022-11-28T19:53:40Z

I'm wondering if we could hide it for autograded problems, and show it for non-autograded problems

Done! @victorhuangwq

michellexliu added 7 commits October 12, 2022 15:41

fixed width resize issue on float

fc6f6e8

smoother scroll

2e75a7c

display table of grades

684409e

ignore paxheader files from mac tar

0be3939

got rid of bottom border on grade table

d1864d4

added additional comments to code, changed dropshadow to border

83b199c

new line at end of schema.rb

5f996b0

michellexliu changed the title ~~(wip) Streaming output frontend~~ Streaming output frontend Oct 13, 2022

Merge branch 'master' into streaming-output-frontend

1bf5a73

michellexliu marked this pull request as ready for review October 13, 2022 19:37

michellexliu added 4 commits October 13, 2022 15:37

Merge branch 'master' of https://github.com/autolab/Autolab into stre…

643c95c

…aming-output-frontend

Merge branch 'streaming-output-frontend' of https://github.com/autola…

66bee96

…b/Autolab into streaming-output-frontend

show score for problem

2465f5d

updated to include remarks

a046935

victorhuangwq marked this pull request as draft October 23, 2022 18:58

jump to remarks

f6c4050

victorhuangwq marked this pull request as ready for review November 15, 2022 00:37

michellexliu added 2 commits November 27, 2022 14:05

resolve merge conflicts

6bc33a2

replace hex w variable

0be3d75

victorhuangwq self-requested a review November 27, 2022 20:00

victorhuangwq approved these changes Nov 27, 2022

View reviewed changes

added back border around remarks, fixed &. check

060b6e3

only display problem score and graded by for non-autograded

fccbf36

michellexliu added 2 commits November 28, 2022 21:25

Merge branch 'master' into streaming-output-frontend

03c7449

merged master

1b61613

michellexliu merged commit 486e0ae into master Nov 29, 2022

michellexliu deleted the streaming-output-frontend branch November 29, 2022 13:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Streaming output frontend #1622

Streaming output frontend #1622

michellexliu commented Oct 13, 2022 •

edited

Loading

damianhxy commented Nov 16, 2022

victorhuangwq commented Nov 27, 2022

victorhuangwq commented Nov 27, 2022

victorhuangwq commented Nov 27, 2022

victorhuangwq left a comment

victorhuangwq Nov 27, 2022

michellexliu Nov 28, 2022

victorhuangwq Nov 27, 2022

damianhxy Nov 27, 2022

victorhuangwq Nov 27, 2022

victorhuangwq Nov 27, 2022

michellexliu Nov 28, 2022

victorhuangwq Nov 28, 2022

michellexliu commented Nov 28, 2022 •

edited

Loading

victorhuangwq commented Nov 28, 2022

michellexliu commented Nov 28, 2022

Streaming output frontend #1622

Streaming output frontend #1622

Conversation

michellexliu commented Oct 13, 2022 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

damianhxy commented Nov 16, 2022

victorhuangwq commented Nov 27, 2022

victorhuangwq commented Nov 27, 2022

victorhuangwq commented Nov 27, 2022

victorhuangwq left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michellexliu commented Nov 28, 2022 • edited Loading

victorhuangwq commented Nov 28, 2022

michellexliu commented Nov 28, 2022

michellexliu commented Oct 13, 2022 •

edited

Loading

michellexliu commented Nov 28, 2022 •

edited

Loading