Implement the CSV download feature to download projects selected on the My Projects page.

[entrotech]

Overview

Users need to be able to download a CSV file from the My Projects Page that includes projects based on any of three different criteria:

• Projects that have been selected by checking the checkbox in the first column, OR
• Projects that meet all the current filter criteria, OR
• All Project that the user can view (regardless of the current filter criteria).

Action Items

• Current implementation has a Download All to CSV button. As is, the CSV data for all projects is calculated when the page loads, and the button is only rendered when this calculation is complete. This implementation is driven by the react-csv library which requires that the CSV data be retrieved from the database and formatted before the button is rendered. Since the CSV button is rarely used, this means that the calculation is normally not used, so the calculation and load on the database and network is wasted. We need to re-implement the Download All Projects code such that the CSV data is fetched and formatted only if the user actually chooses to use the feature.
• The Download Selected Projects to CSV is not yet implemented, but can essentially re-use the code for the Dowload All to CSV feature.
• The Download Filtered Projects to CSV is also not et implemented, but can also re-use essentially the same code.
• Find a CSV library that allows execution of the fetching and formatting only when the user chooses one of the CSV options. It's ok if this step takes a while (especially for a large number of projects), since the feature will be rarely used, and the user should expect to wait for it to be generated.
• The UI design is specified in Issue Design Mockup: Admin view of my projects page #1641 showing a download icon in the Multi-Select Toolbar. Hovering over the download icon brings up a tooltip that allows users to be pick either Download All or Download Selected. It might be better if we pop up a dialog that allows the user to choose one of the three options from radio buttons, possibly an option to give the downloaded file a name and then shows a progress bar as the file is generated and eventually saved.

Resources/Instructions

• Implement a "Download to CSV" feature #1420
• Remove the N/A columns from the CSV export file #1574
• Reorder the CSV columns #1604
• Multiple project data csv file download functionality #1626

[Parisajf]

Emily said in an email at 2024-04-22:

I compared the proposed/new columns to the calculator and it looks pretty good. The two things I noted are not related to the elimination of the "NA" columns:

• I think "Bike Bonus" is missing from both the old and new output.
• It would make sense to have a column for the text input of the User-Defined Strategy.

I'm also curious about the output for the test case. The strategies that use drop-down menus appear to have "Y" or "N" as the output. The strategies that use checkboxes appear to have "TRUE" or are blank as the output. I think having blank strategies is potentially confusing. Instead, every strategy field could use Y or N; that would be consistent across the board. Unless there's a reason that drop-down and checkbox strategies should appear different in the csv output? The one exception will be the User-Defined Strategy, which should show the user's input of a number of points, and narrative about the Strategy.

We can discuss next week if there are any questions.