[BD-05] [TNL-7308] Add ORA Zipped File Download for Submission Text + Attached Files

[0x29a]

This PR adds new button to the course instructor dashboard:

Click on this button spawns a task, which downloads all submission files (texts and attachments), puts them into zip archive and uploads it to reports storage.

Structure of generated zip file:

.
└── CourseId
    ├── BlockId1
    │   ├── StudentId1
    │   │   ├── attachments
    │   │   │   ├── SomeFile1
    │   │   │   └── SomeFile2
    │   │   ├── part_0.txt
    │   │   └── part_1.txt
    │   └── StudentId2
    │       ├── part_0.txt
    │       └── part_1.txt
    ├── BlockId2
    │   └── StudentId3
    │       ├── attachments
    │       │   └── SomeFile4
    │       └── part_0.txt
    └── downloads.csv

Where downloads.csv is a list of all downloaded files with their metadata: description, size, etc.

JIRA tickets:

• TNL-7308
• BLENDED-474

Dependencies:
This PR depends on openedx/edx-ora2#1453

Sandbox URL: https://pr24541.sandbox.opencraft.hosting

Merge deadline: None

Testing instructions:

(skip if you're testing with sandbox) To test this, you need to install ORA with related change:

1. Go to $devstack_root/src.
2. Clone OpenCraft's ORA repo here:

   git clone https://github.com/open-craft/edx-ora2
   

3. Switch cloned ORA to branch with new aggregate method:

   cd edx-ora2 & git checkout 0x29a/bb2651/ora_zipped_data
   

4. Go back to $devstack_root/src.
5. Install the ORA in the platform containers:

   # From the devstack folder $devstack_root/devstack:
   make lms-shell
   > pip install -e /edx/src/edx-ora2
   # Then exit the shell and run
   make studio-shell
   > pip install -e /edx/src/edx-ora2
   

(skip if you're testing with sandbox) After you installed ORA with related changes, you need to switch edx-platform to new branch:

1. Go to $devstack_root/edx-platform

2. Add new remote:

   git remote add opencraft https://github.com/open-craft/edx-platform.git
   

3. Fetch branch with changes:

   git fetch opencraft 0x29a/bb2651/ora_zipped_data
   

4. Switch repo to this branch:

   git checkout 0x29a/bb2651/ora_zipped_data
   

   Platform should restart automatically, but if not, do that manually. And now you should see new button in instructors dashboard.

Now you need to prepare some data to be exported:

1. Add ORA block to existing course via studio. Before publishing it, adjust its settings to require only 1 peer assessment and require attachments:
   
   

2. Add a few answers with attachments.

3. Click on download button:
   

4. Soon you should see new report at the bottom of dashboard:
   

5. This report should contain all submission attachments with .csv file describing each download.
   Example of CSV: downloads.csv.zip

Reviewers

• @xitij2000
• edX reviewer[s] TBD

[openedx-webhooks]

Thanks for the pull request, @0x29a! I've created BLENDED-474 to keep track of it in Jira. More details are on the BD-05 project page.

When this pull request is ready, tag your edX technical lead.

[xitij2000]

I think the code can be cleaned up a bit but looks good so far! I need to test it.

I think more of this code should be moved to the ORA repo, perhaps most if not all of the report generation. I feel like it's more tied to how ORA works than how edx-platform works.

[xitij2000]

Thanks for adding these detailed docs!

[xitij2000]

👍

• I tested this: followed the testing instruction
• I read through the code
• [na] I checked for accessibility issues
• [na] Includes documentation

[xitij2000]

nit: We can just assume Python3 now, since there is need for backwards-compatibility.

[0x29a]

@davestgermain I changed extract to export and fixed all failing CI checks.

[davestgermain]

Thanks. Could you squash the commits?
I'll merge this on Monday, the 24th

[0x29a]

Could you squash the commits?

Thanks @davestgermain, done.

[edx-status-bot]

Your PR has finished running tests. There were no failures.

[edx-pipeline-bot]

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

[edx-pipeline-bot]

EdX Release Notice: This PR has been deployed to the production environment.