feat: History log in content library components and containers [FC-0123] by ChrisChV · Pull Request #2948 · openedx/frontend-app-authoring

ChrisChV · 2026-03-17T22:25:10Z

Description

See openedx/openedx-platform#38178 to understand the Pre-Verawood and Post-Verawood logic.

Implements the API functions and hooks to fetch:
- Draft history entries for components and containers.
- Published history groups for components and containers.
- Published entries within a history group.
- Creation entry for components and containers.
Implements:
- HistoryCreatedLogGroup: Group for the create event.
- HistoryDraftLogGroup: Group and entries for draft changes (collapsible).
- HistoryPublishLogGroup: Group and entries for published changes (lazy-loaded on expand).
- HistoryComponentLog: Renders the full history for a library component.
- HistoryContainerLog: Renders the full history for a library container (unit/section/subsection).
- ContainerDetails: New "Details" tab in the container sidebar that shows the container history log.
Which user roles will this change impact? Library Author.

Supporting information

Github issue (implemented component scope): Library: Object History Log #2805
Depends on:
- feat: History log logic for Components and Containers [FC-0123] openedx-platform#38178
- feat: New history log api functions [FC-0123] openedx-core#501
Internal ticket: https://tasks.opencraft.com/browse/FAL-4330

Testing instructions

Follow the instructions in order:

Pre-Verawood setup

Use the main branch.
Go to a content library
Create a new unit and a new component in the unit
Make some edits in the component and publish the component.
Make some edits in the unit and publish the unit.
Make some edits in the unit and in the component, and publish the unit.

Test Components: Pre-Verawood

Use this branch of edx-platform: feat: History log logic for Components and Containers [FC-0123] openedx-platform#38178
Install this branch of openedx-core: feat: New history log api functions [FC-0123] openedx-core#501
TEMP make a rebase/merge of this PR: refactor: Upgrade to openedx-core 0.44.0 (for OEP-68) openedx-platform#38402 in edx-platform
Go to the content library.
Click in the component to open the component sidebar.
Go to the Details tab of the sidebar.
Check the history log:
- Verify the creation group
- Verify the first publish group after the creation group. Verify that you can only see the component edits and says: "Author published Component".
- Verify the second publish group. Verify that you can only see the component edits and says: "Author published Component".

** Test Containers: Pre-Verawood**

Go to the content library
Click in the container to open the container sidebar.
Go to the Details tab of the sidebar.
Check the history log:
- Verify the creation group
- Verify the first publish group after the creation group. Verify that you can only see the component edits and says
- Verify the second publish group after the creation group. Verify that you can only see the unit edits and says
- After, verify that there are two more publish groups, one for the unit changes and the other for the component changes.

Post-Verawood setup

Make some edits in the component and publish the component.
Make some edits in the unit and publish the unit.
Make some edits in the unit and in the component, and publish the unit.

Test Components: Post-Verawood

Go to the content library.
Click in the component to open the component sidebar.
Go to the Details tab of the sidebar.
Check the history log:
- Verify the third publish group. Verify that you can only see the component edits and says: "Author published Component".
- Verify the fourth publish group. Verify that you can only see the component edits and says: "Author published Unit".
Make some edits in the component. Verify the Draft group.

Test Containers: Post-Verawood

Go to the content library
Click in the container to open the container sidebar.
Go to the Details tab of the sidebar.
Check the history log:
- Verify the fourth publish group. Verify that you can only see the component changes.
- Verify the fifth publish group. Verify that you can only see the unit changes.
- Verify the sixth publish group. Verify that you can see the unit and the component changes.

To test with more contributors

Create 6 users with access to the library (can be superusers)
Update the profile image of the users: Go to the learner dashboard > Profile and update the image.
With each user, made updates to the component.
Verify the draft list group in the history log. Verify the profile images in each entry.
Publish the changes.
Verify the contributors in the new publish group. Verify the contributors count. Verify that only five contributor profile images are rendered.

Other information

Missing features

Delete group for deleted components in containers.
Import group: When importing a library, the components/containers must have only one import group.
Show discarded changes edits.

Note: The basics have been implemented to meet the Verawood cut on time.

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).
Avoid propTypes and defaultProps in any new or modified code.
Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
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.
Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

openedx-webhooks · 2026-03-17T22:25:16Z

Thanks for the pull request, @ChrisChV!

This repository is currently maintained by @bradenmacdonald.

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 · 2026-03-24T18:37:51Z

Codecov Report

❌ Patch coverage is 97.56098% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.48%. Comparing base (f36b869) to head (66d1b91).
⚠️ Report is 19 commits behind head on master.

Files with missing lines	Patch %	Lines
...-authoring/generic/history-log/HistoryLogGroup.tsx	96.36%	2 Missing ⚠️
...ing/generic/history-log/HistoryLogGroupEntries.tsx	92.85%	2 Missing ⚠️
src/library-authoring/data/apiHooks.ts	97.61%	1 Missing ⚠️
...thoring/generic/history-log/ContributorAvatars.tsx	94.11%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2948      +/-   ##
==========================================
+ Coverage   95.47%   95.48%   +0.01%     
==========================================
  Files        1383     1392       +9     
  Lines       32642    32899     +257     
  Branches     7498     7585      +87     
==========================================
+ Hits        31165    31415     +250     
- Misses       1408     1415       +7     
  Partials       69       69

☔ 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.

rpenido

LGTM 👍
Thank you for your work, @ChrisChV!

I tested this using the instructions from the PR
I read through the code
I checked for accessibility issues
Includes documentation

…erawood logic

rpenido · 2026-04-23T21:31:44Z

Hi @ChrisChV!

I had a component from the last test. Then I created a Unit, added the component to the unit and published it.
This is how the History for the Unit looks like:

It makes sense to show the unit creation first, but the timeline is not in order. Not sure if this is expected.

rpenido · 2026-04-23T22:07:49Z

Hi @ChrisChV! Everything worked as expected! Good work here!

Note: I had to make a small change to fix local_key the error after merging the other branch.

ChrisChV · 2026-04-28T17:18:07Z

Hi @bradenmacdonald, it's ready for your review

crathbun428 · 2026-04-28T18:54:14Z

@ChrisChV and @rpenido - Yeah, I think I would expect the most recent edits and changes at the top of the log and the older stuff at the bottom. Please let me know if you have any follow-up questions!

ChrisChV · 2026-04-29T00:57:38Z

I had a component from the last test. Then I created a Unit, added the component to the unit and published it.
This is how the History for the Unit looks like:
It makes sense to show the unit creation first, but the timeline is not in order. Not sure if this is expected.

@rpenido @bradenmacdonald fixed in b80e89f

rpenido · 2026-04-29T03:56:54Z

LGTM 👍
Thank you for your work, @ChrisChV!

I tested this using the instructions from the PR
I read through the code
I checked for accessibility issues
Includes documentation

bradenmacdonald

Oooh this is awesome!

I have a lot of minor suggestions, but nothing that's blocking. Feel free to incorporate any of them now or later or never.

bradenmacdonald · 2026-04-29T19:47:28Z

+    return !Array.from(el.children).some(
+      (child) => pattern.test(((child as Element).textContent ?? '').replace(/\s+/g, ' ').trim()),
+    );
+  });


This findByDeepTextContent helper looks nice! 😎

bradenmacdonald · 2026-04-29T20:18:12Z

+      size={size}
+      src={imgError ? undefined : src}
+      alt={username || intl.formatMessage(messages.historyEntryDefaultUser)}
+      onError={() => setImgError(true)}


For a future follow-up: This imgError handling seems like it should be contained within the <Avatar component already, and you shouldn't have to wrap it in ContributorAvatar just to get proper error handling and default values.

…atars.tsx and HistoryLogGroupEntries.tsx

bradenmacdonald · 2026-04-29T21:44:59Z

Thanks for those changes based on my feedback! Ready to merge anytime 🚀

ormsbee · 2026-04-30T05:47:02Z

@ChrisChV: Congrats on getting this in!

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 17, 2026

ChrisChV marked this pull request as draft March 17, 2026 22:25

openedx-webhooks added this to Contributions Mar 17, 2026

github-project-automation Bot moved this to Needs Triage in Contributions Mar 17, 2026

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Mar 23, 2026

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Mar 23, 2026

ChrisChV changed the title ~~feat: History log in content library objects~~ feat: History log in content library components Mar 24, 2026

ChrisChV changed the title ~~feat: History log in content library components~~ feat: History log in content library components [FC-0123] Mar 24, 2026

ChrisChV marked this pull request as ready for review March 24, 2026 21:18

This was referenced Mar 24, 2026

feat: History log logic for Components and Containers [FC-0123] openedx/openedx-platform#38178

Merged

feat: New history log api functions [FC-0123] openedx/openedx-core#501

Merged

rpenido approved these changes Mar 27, 2026

View reviewed changes

navinkarkera reviewed Apr 6, 2026

View reviewed changes

Comment thread src/library-authoring/generic/history-log/HistoryLog.tsx Outdated

mphilbrick211 moved this from Waiting on Author to In Eng Review in Contributions Apr 6, 2026

navinkarkera mentioned this pull request Apr 8, 2026

feat: compare library component versions #2986

Open

7 tasks

ChrisChV added 2 commits April 19, 2026 21:17

feat: History log for Components

aaee15c

feat: Added HistoryContainerLog && refactor to use new Pre and Post V…

0ad4c1a

…erawood logic

ChrisChV force-pushed the chris/FAL-4330-history-log branch from 625d241 to 0ad4c1a Compare April 20, 2026 02:48

ChrisChV added 2 commits April 20, 2026 18:24

fix: Undefined changeBy in History log

d3fcc4d

fix: Broken tests

204ff86

ChrisChV changed the title ~~feat: History log in content library components [FC-0123]~~ feat: History log in content library components and containers [FC-0123] Apr 21, 2026

ChrisChV added 2 commits April 20, 2026 20:05

test: add tests to fix coverage

8724d51

fix: Broken published groups

ece3b9e

ChrisChV requested a review from rpenido April 22, 2026 18:30

ChrisChV added 2 commits April 24, 2026 16:35

feat: Add created entry in history log

1773c33

refactor: Use new contributor field

5f84b9b

ChrisChV requested a review from bradenmacdonald April 28, 2026 16:43

fix: Delete contributorsCount in the code

e7d4498

refactor: split container publish history groups by creation time

b80e89f

bradenmacdonald reviewed Apr 29, 2026

View reviewed changes

Comment thread src/library-authoring/generic/history-log/HistoryLogGroup.tsx Outdated

fix: Broken null contributors

74872c3

bradenmacdonald approved these changes Apr 29, 2026

View reviewed changes

ChrisChV added 2 commits April 29, 2026 16:26

fix: nits on the code

0f85ada

refactor: Moving components from HistoryLogGroup.tsx to ContributorAv…

66d1b91

…atars.tsx and HistoryLogGroupEntries.tsx

ChrisChV enabled auto-merge (squash) April 29, 2026 21:45

ChrisChV merged commit 3a8eb99 into openedx:master Apr 29, 2026
7 checks passed

github-project-automation Bot moved this from In Eng Review to Done in Contributions Apr 29, 2026

Conversation

ChrisChV commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Other information

Best Practices Checklist

Uh oh!

openedx-webhooks commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

rpenido left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rpenido commented Apr 23, 2026

Uh oh!

rpenido commented Apr 23, 2026

Uh oh!

ChrisChV commented Apr 28, 2026

Uh oh!

crathbun428 commented Apr 28, 2026

Uh oh!

ChrisChV commented Apr 29, 2026

Uh oh!

rpenido commented Apr 29, 2026

Uh oh!

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bradenmacdonald Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bradenmacdonald commented Apr 29, 2026

Uh oh!

Uh oh!

ormsbee commented Apr 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

ChrisChV commented Mar 17, 2026 •

edited

Loading

openedx-webhooks commented Mar 17, 2026 •

edited

Loading

codecov Bot commented Mar 24, 2026 •

edited

Loading