Adding section on Data Downloads for Pending Tasks

[jacobo-dominguez-wgu]

Description

This pr adds the section of Pending Tasks into the Data Downloads Tab to display the ongoing report generation tasks, in case of no tasks in progress it displays a "No tasks currently running" message.

Supporting information

It needs to be reviewed after #68 since it includes part of the code from that pr.
Closes #44

Testing instructions

• npm install && npm run dev
• Go to http://apps.local.openedx.io:8080/instructor/:courseId:/data_download
• Scroll down to the Pending tasks section
• To populate the table trigger reports generation or mock the api call to
  POST http://local.openedx.io:8000/courses/:courseId:/instructor/api/list_instructor_tasks with this response data:

{
  "tasks": [
    {
      "task_type": "enrollment_report_csv",
      "task_input": {
        "course_id": "course-v1:Example+Course+2023",
        "report_type": "enrolled_students"
      },
      "task_id": "abc123-def456-789ghi",
      "requester": "instructor@example.edu",
      "task_state": "SUCCESS",
      "created": "2023-12-01T10:30:00Z",
      "task_output": {
        "download_url": "https://example.com/reports/enrollment_report_20231201.csv",
        "file_size": 2048576,
        "rows_count": 1250
      },
      "duration_sec": 45,
      "status": "Completed",
      "task_message": "Enrollment report generated successfully"
    },
  ]
}

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

• Any new files are using TypeScript (.ts, .tsx).
• Deprecated propTypes, defaultProps, and injectIntl patterns are not used in any new or modified code.
• Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
• Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
• All new i18n messages in messages.ts files have a description for translators to use.
• Imports avoid using ../. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

[openedx-webhooks]

Thanks for the pull request, @jacobo-dominguez-wgu!

This repository is currently maintained by @openedx/committers-frontend-app-instruct.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

---

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[codecov]

Codecov Report

❌ Patch coverage is 98.79518% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 81.13%. Comparing base (5b0d465) to head (556fc33).
⚠️ Report is 9 commits behind head on main.

Files with missing lines	Patch %	Lines
src/utils/formatters.ts	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##            main      #74       +/-   ##
==========================================
+ Coverage   0.00%   81.13%   +81.13%     
==========================================
  Files          5       37       +32     
  Lines          7      318      +311     
  Branches       0       63       +63     
==========================================
+ Hits           0      258      +258     
- Misses         7       60       +53     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[diana-villalvazo-wgu]

can you rebase your PR against main pls?

[mphilbrick211]

Hi @jacobo-dominguez-wgu and @diana-villalvazo-wgu! Is this still in progress?

[wgu-jesse-stewart]

Looks like we have a typo here - this file should be PendingTasks.test.tsx

[jacobo-dominguez-wgu]

FIxed

[wgu-jesse-stewart]

Passing empty string as fallback for null object seems odd - should this be parseObject(value ?? null) or parseObject(value ?? {})?

[wgu-jesse-stewart]

Consider whether usePendingTasks might be better suited as a useQuery rather than useMutation - even though the endpoint incorrectly uses POST, it's semantically a read operation, which would give you automatic fetching, caching, and optional polling without needing the manual useEffect.

[jacobo-dominguez-wgu]

changed to useQuery

[wgu-jesse-stewart]

This is great - good separation of concerns with dedicated components and hooks. Nice work. I just have a few suggestions and some questions.

• What's the polling/refresh strategy? Auto-refresh every X seconds?
• Should completed tasks eventually disappear from this list?
• Is there a maximum number of tasks displayed?

[jacobo-dominguez-wgu]

This is great - good separation of concerns with dedicated components and hooks. Nice work. I just have a few suggestions and some questions.

• What's the polling/refresh strategy? Auto-refresh every X seconds?
• Should completed tasks eventually disappear from this list?
• Is there a maximum number of tasks displayed?

Thanks!
This is using the default strategy wich is no automatic refresh.
Yes, the tasks automatically disappear once completed.
There is not a max number of tasks specified.