Adding section on Data Downloads for Pending Tasks by jacobo-dominguez-wgu · Pull Request #74 · openedx/frontend-app-instruct

jacobo-dominguez-wgu · 2025-12-03T16:50:15Z

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 · 2025-12-03T16:50:21Z

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:

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 · 2025-12-03T16:53:49Z

Codecov Report

❌ Patch coverage is 96.96970% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 75.68%. Comparing base (5b0d465) to head (906bea9).
⚠️ Report is 25 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%   75.68%   +75.68%     
==========================================
  Files          5       63       +58     
  Lines          7      765      +758     
  Branches       0      147      +147     
==========================================
+ Hits           0      579      +579     
- Misses         7      181      +174     
- Partials       0        5        +5

☔ 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 · 2025-12-09T18:52:08Z

can you rebase your PR against main pls?

mphilbrick211 · 2026-01-06T22:00:25Z

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

src/dataDownloads/components/DataDownloadTable.tsx

src/components/PendingTasks.test.tsx

src/components/ObjectCell.tsx

src/data/apiHook.ts

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 · 2026-01-08T21:55:42Z

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.

wgu-jesse-stewart · 2026-02-10T20:19:53Z

src/components/PendingTasks.tsx

+      <DataTable
+        columns={tableColumns}
+        data={tasks}
+        isLoading={isLoading}


This is always be false by the time we get to this branch because the return on line 31. Is this a required prop?

wgu-jesse-stewart · 2026-02-10T20:21:17Z

src/components/PendingTasks.test.tsx

+
+    const { container } = renderWithProviders(<PendingTasks />);
+    const toggleButton = screen.getByRole('button');
+    await waitFor(() => toggleButton.click());


waitFor is meant for assertions that need to wait for async state updates, does this click event need it? Could you use await userEvent.click(toggleButton); here?

You are right, removing all of them,

wgu-jesse-stewart · 2026-02-10T20:23:53Z

src/components/ObjectCell.tsx

+
+const ObjectCell = ({ value }: ObjectCellProps) => {
+  return (
+    <pre style={{ whiteSpace: 'pre-wrap', wordBreak: 'break-word' }}>


I don't love inline styles like this, can you find an alternative? Maybe the "text-nowrap" helper will work for your needs? https://paragon-openedx.netlify.app/foundations/css-utilities/

wgu-jesse-stewart

Approved, but with a few questions/comments

src/components/PendingTasks.tsx

diana-villalvazo-wgu · 2026-02-10T21:40:10Z

src/data/apiHook.ts

+export const usePendingTasks = (courseId: string) => {
+  return useQuery({
+    queryKey: pendingTasksQueryKey.byCourse(courseId),
+    queryFn: async () => fetchPendingTasks(courseId),


should we enable this only if there is a courseId?

diana-villalvazo-wgu · 2026-02-10T21:40:38Z

src/dataDownloads/components/DataDownloadTable.tsx

+          Cell: DownloadCustomCell,
+        }
+      ]}
+      RowStatusComponent={() => null}


i think we can remove this prop if it is not used

diana-villalvazo-wgu · 2026-02-10T21:41:15Z

src/dataDownloads/data/api.ts

+
+export const generateReportLink = async (courseId, reportType) => {
+  const { data } = await getAuthenticatedHttpClient()
+  // TODO: Validate if url is correct once the new API endpoint is available


this 2 are still a todo?

diana-villalvazo-wgu · 2026-02-10T21:41:51Z

src/dataDownloads/data/apiHook.ts

+export const useGeneratedReports = (courseId: string) => (
+  useQuery({
+    queryKey: queryKeys.generatedReports(courseId),
+    queryFn: () => getGeneratedReports(courseId),


same do we need to add enable only when there is a courseId?

diana-villalvazo-wgu · 2026-02-10T22:12:51Z

@jacobo-dominguez-wgu this PR is ready to merge? or it needs to be merged after downloads page #68 ?

jacobo-dominguez-wgu · 2026-02-10T22:18:21Z

@jacobo-dominguez-wgu this PR is ready to merge? or it needs to be merged after downloads page #68 ?

It has a lot of code from that pr, it still needs to be merged after.

jacobo-dominguez-wgu · 2026-02-19T20:41:21Z

@diana-villalvazo-wgu @wgu-jesse-stewart This PR is not being blocked anymore, Can you give a final review?

diana-villalvazo-wgu

LGTM 🚀

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 3, 2025

openedx-webhooks added this to Contributions Dec 3, 2025

github-project-automation bot moved this to Needs Triage in Contributions Dec 3, 2025

jacobo-dominguez-wgu force-pushed the data-pending-tasks branch from 557f88d to d475d43 Compare December 3, 2025 20:44

jacobo-dominguez-wgu marked this pull request as ready for review December 3, 2025 20:50

jacobo-dominguez-wgu added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Dec 3, 2025

jacobo-dominguez-wgu requested review from a team, diana-villalvazo-wgu and wgu-jesse-stewart December 3, 2025 20:50

mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Dec 3, 2025

jacobo-dominguez-wgu force-pushed the data-pending-tasks branch 2 times, most recently from 65129d3 to 6a754c6 Compare December 10, 2025 16:08

openedx-webhooks added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Dec 10, 2025

jacobo-dominguez-wgu mentioned this pull request Dec 10, 2025

Adding pending task section on course info page #78

Merged

6 tasks

wgu-jesse-stewart reviewed Jan 8, 2026

View reviewed changes

src/dataDownloads/components/DataDownloadTable.tsx Show resolved Hide resolved

wgu-jesse-stewart reviewed Jan 8, 2026

View reviewed changes

src/components/PendingTasks.test.tsx Outdated Show resolved Hide resolved

wgu-jesse-stewart reviewed Jan 8, 2026

View reviewed changes

src/components/ObjectCell.tsx Outdated Show resolved Hide resolved

wgu-jesse-stewart reviewed Jan 8, 2026

View reviewed changes

src/data/apiHook.ts Outdated Show resolved Hide resolved

wgu-jesse-stewart requested changes Jan 8, 2026

View reviewed changes

jacobo-dominguez-wgu requested a review from wgu-jesse-stewart January 8, 2026 21:55

wgu-jesse-stewart reviewed Feb 10, 2026

View reviewed changes

wgu-jesse-stewart approved these changes Feb 10, 2026

View reviewed changes

jacobo-dominguez-wgu force-pushed the data-pending-tasks branch 2 times, most recently from 02151dc to 92cc116 Compare February 10, 2026 21:30

diana-villalvazo-wgu reviewed Feb 10, 2026

View reviewed changes

src/components/PendingTasks.tsx Show resolved Hide resolved

diana-villalvazo-wgu reviewed Feb 10, 2026

View reviewed changes

jacobo-dominguez-wgu force-pushed the data-pending-tasks branch from 92cc116 to fb86c48 Compare February 10, 2026 22:05

jacobo-dominguez-wgu force-pushed the data-pending-tasks branch from fb86c48 to 1505219 Compare February 19, 2026 20:26

feat: adding pending tasks section

906bea9

jacobo-dominguez-wgu force-pushed the data-pending-tasks branch from 1505219 to 906bea9 Compare February 19, 2026 20:30

jacobo-dominguez-wgu requested review from diana-villalvazo-wgu and wgu-jesse-stewart February 19, 2026 20:39

diana-villalvazo-wgu approved these changes Feb 19, 2026

View reviewed changes

diana-villalvazo-wgu merged commit 6543749 into openedx:main Feb 19, 2026
6 checks passed

github-project-automation bot moved this from Ready for Review to Done in Contributions Feb 19, 2026

diana-villalvazo-wgu deleted the data-pending-tasks branch February 19, 2026 20:52

Conversation

jacobo-dominguez-wgu commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Best Practices Checklist

Uh oh!

openedx-webhooks commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

diana-villalvazo-wgu commented Dec 9, 2025

Uh oh!

mphilbrick211 commented Jan 6, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wgu-jesse-stewart left a comment

Choose a reason for hiding this comment

Uh oh!

jacobo-dominguez-wgu commented Jan 8, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wgu-jesse-stewart Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wgu-jesse-stewart left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

diana-villalvazo-wgu commented Feb 10, 2026

Uh oh!

jacobo-dominguez-wgu commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jacobo-dominguez-wgu commented Feb 19, 2026

Uh oh!

diana-villalvazo-wgu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jacobo-dominguez-wgu commented Dec 3, 2025 •

edited

Loading

openedx-webhooks commented Dec 3, 2025 •

edited

Loading

codecov bot commented Dec 3, 2025 •

edited

Loading

wgu-jesse-stewart Feb 10, 2026 •

edited

Loading

jacobo-dominguez-wgu commented Feb 10, 2026 •

edited

Loading