Submission Version Switching

[damianhxy]

Description

• Add buttons to switch to prev / next version of a student's submission that contains a specific file
• Make buttons update when switching between files

Motivation and Context

When investigating AIVs, instructors might want to track changes to a specific file across the different versions of a student's submission. This PR adds buttons to enable instructors to easily switch between the different versions.

Note: For single file handin formats, the arrows will effectively work to cycle through the versions.

How Has This Been Tested?

• Create a new assessment with handin format handin.tar
• Submit hello.tar, as well as modified versions (e.g. remove files, add files)
• Ensure that prev / next buttons work as expected (i.e. that they go to the same file, skip versions where the file doesn't exist)
• Ensure that when we change the file selected, the buttons update as expected
• Also check that for single file handin formats (e.g. .c, .pdf) that the arrow buttons serve to enumerate through the versions

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

[victorhuangwq]

@damianhxy could you elaborate what was changed since we last discussed?

At the same time I do have concerns that people might get confused by the [# student / total students] and version / # of versions

[victorhuangwq]

Functionally it looks good to me as described. I would just like some clarification and I think we are good to go.

[damianhxy]

@damianhxy could you elaborate what was changed since we last discussed?

The main difference is that the arrow buttons now work on a per-file basis.

Previously, they would simply bring you to the next or previous version (and reset you to header_position 0). They would be grayed out when you are on the first / last version. But as Iliano pointed out, that isn't very useful from an instructor's perspective.

Now, the arrow buttons operate on a per-file basis. That is to say, clicking them will bring you to the next or previous version that contains the file (i.e. the same filepath). They will also now be grayed out when there is no older / newer version containing the file.

How this works is that when viewing a file (e.g. from an archive), we look through the other versions and search each one for the same filepath. If it exists, we take note of the header_position of the file in that particular version and append it to the querystring of the buttons so that we will jump directly to the same file when switching versions.

Note however that the functionality of the version dropdown remains unchanged, and using it to change versions will reset you to header_position 0 as usual.

At the same time I do have concerns that people might get confused by the [# student / total students] and version / # of versions

Perhaps we can attach a title to the span so that users will see explanatory text when they hover over it?

[victorhuangwq]

I think adding the title would address the issue - good enough fix for now, because I think we might want to reimagine this page in the future.

At the same time I tested this

• Ensure that prev / next buttons work as expected (i.e. that they go to the same file, skip versions where the file doesn't exist)

It works as mentioned. It doesn't skip if I submitted a single file, and then a tar file afterwards however. But I guess that's an okay behavior. (i.e. hello.c, then i submit hello.tar containing abc.c & def.c)

[damianhxy]

It works as mentioned. It doesn't skip if I submitted a single file, and then a tar file afterwards however. But I guess that's an okay behavior. (i.e. hello.c, then i submit hello.tar containing abc.c & def.c)

Yup, I don't expect the handin format to change across versions after all

[victorhuangwq]

LGTM