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

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

Description

Implements the api and apiHooks to get the draft history entries, published history groups, and the published entries of a group.
Implements:
- HistoryCreatedLogGroup: Group for the create event
- HistoryDraftLogGroup: Group and entries for draft changes.
- HistoryPublishLogGroup: Group and entries for published changes.
- HistoryComponentLog: Renders all the history for a component.
Which user roles will this change impact? "Course Author".

Supporting information

Github issue (implemented component scope): Library: Object History Log #2805
Depends on:
- feat: Python api and rest api for History log logic [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

Use this branch of edx-platform: feat: Python api and rest api for History log logic [FC-0123] openedx-platform#38178
Install this branch of openedx-core: feat: New history log api functions [FC-0123] openedx-core#501
Go to a content library
Create a new component.
Click in the component to open the component sidebar
Go to the Details tab of the sidebar.
Check the history log, verify the created state.
Made some changes in the component.
Check the draft changes list in the history log.
Publish the component.
Check the new publish group in the history log. Open the publish group, verify the entries.
Made some changes in the components.
Go to the library info sidebar and discard the changes.
Check the history log in the component, verify that the draft group is gone.
Made some changes and publish the component.
Verify that the new publish group doesn't have the discarded 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

The implementation of history log for containers will be done in another PR

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 94.78261% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.51%. Comparing base (4d7d91b) to head (6a805e8).
⚠️ Report is 3 commits behind head on master.

Files with missing lines	Patch %	Lines
src/library-authoring/data/api.ts	66.66%	4 Missing ⚠️
src/library-authoring/data/apiHooks.ts	95.83%	1 Missing ⚠️
...-authoring/generic/history-log/HistoryLogGroup.tsx	98.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2948      +/-   ##
==========================================
- Coverage   95.51%   95.51%   -0.01%     
==========================================
  Files        1329     1333       +4     
  Lines       30557    30691     +134     
  Branches     6930     6959      +29     
==========================================
+ Hits        29186    29313     +127     
- Misses       1303     1322      +19     
+ Partials       68       56      -12

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

…all library or container

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

rpenido · 2026-03-27T21:05:13Z

src/library-authoring/component-info/ComponentDetails.tsx

 import { ComponentAdvancedInfo } from './ComponentAdvancedInfo';
 import { ComponentUsage } from './ComponentUsage';
 import messages from './messages';
+import { HistoryComponentLog } from '../generic/history-log/HistoryLog';


nit

Suggested change

import { HistoryComponentLog } from '../generic/history-log/HistoryLog';

import { HistoryComponentLog } from '@src/generic/history-log/HistoryLog';

rpenido · 2026-03-27T21:16:33Z

src/library-authoring/data/apiHooks.ts

+/**
+ * Returns the draft history of a library block.
+ */
+export const useLibraryBlockDraftHistory = (usageKey: string | undefined) => (


nit

Suggested change

export const useLibraryBlockDraftHistory = (usageKey: string | undefined) => (

export const useLibraryBlockDraftHistory = (usageKey?: string) => (

rpenido · 2026-03-27T21:16:57Z

src/library-authoring/data/apiHooks.ts

+/**
+ * Returns the publish history of a library block.
+ */
+export const useLibraryBlockPublishHistory = (usageKey: string | undefined) => (


nit

Suggested change

export const useLibraryBlockPublishHistory = (usageKey: string | undefined) => (

export const useLibraryBlockPublishHistory = (usageKey?: string) => (

rpenido · 2026-03-27T21:17:24Z

src/library-authoring/data/apiHooks.ts

+  usageKey: string | undefined,
+  publishGroupId: string | undefined,


nit

Suggested change

usageKey: string | undefined,

publishGroupId: string | undefined,

usageKey?: string,

publishGroupId?: string,

rpenido · 2026-03-27T21:18:19Z

src/library-authoring/data/apiHooks.ts

+/**
+ * Returns the creation entry for a library block.
+ */
+export const useLibraryBlockCreationEntry = (usageKey: string | undefined) => (


nit

Suggested change

export const useLibraryBlockCreationEntry = (usageKey: string | undefined) => (

export const useLibraryBlockCreationEntry = (usageKey?: string) => (

rpenido · 2026-03-27T21:19:23Z

src/library-authoring/generic/history-log/HistoryLog.test.tsx

+  mockLibraryBlockPublishHistory,
+  mockLibraryBlockPublishHistoryEntries,
+  mockLibraryBlockCreationEntry,
+} from '../../data/api.mocks';


Suggested change

} from '../../data/api.mocks';

} from '@src/data/api.mocks';

rpenido · 2026-03-27T21:26:52Z

src/library-authoring/generic/history-log/HistoryLog.test.tsx

+/**
+ * Finds the innermost element whose full textContent (normalized whitespace) matches the given regex.
+ * Useful when text is split across child elements (e.g. by an icon).
+ * Requiring that no direct child also matches ensures we get the deepest matching element.
+ */
+const findByTextContent = (pattern: RegExp) => screen.findByText((_, el) => {
+  if (!el) return false;
+  const normalizedText = (el.textContent ?? '').replace(/\s+/g, ' ').trim();
+  if (!pattern.test(normalizedText)) return false;
+  return !Array.from(el.children).some(
+    (child) => pattern.test((child.textContent ?? '').replace(/\s+/g, ' ').trim()),
+  );
+});


We have a similar matchInnerText function on testUtils.tsx.
Can you check if it fits your case here or, if not, move this function to testUtils.tsx so we can reuse it?

rpenido · 2026-03-27T21:29:37Z

src/library-authoring/generic/history-log/HistoryLog.test.tsx

+    renderComponent(mockLibraryBlockCreationEntry.usageKey);
+    const trigger = await findByTextContent(/Test Component is a draft/i);
+    expect(trigger).toBeInTheDocument();
+    fireEvent.click(trigger);


Can you check if userEvent works here? I think we are using it in the new tests and moving away from fireEvent.

feat: HistoryLog and HistoryLogGroup created

9bec4a7

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

ChrisChV added 2 commits March 19, 2026 19:28

feat: HistoryLog for components implemented

bf3dca1

test: Adding tests for HistoryComponentLog

ad87592

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

feat: Show profile images in history log

01ec66c

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

fix: Invalidate history log queries when publish/discard changes for …

6a805e8

…all library or container

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

This was referenced Mar 24, 2026

feat: Python api and rest api for History log logic [FC-0123] openedx/openedx-platform#38178

Draft

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

Draft

ChrisChV added 3 commits March 24, 2026 18:29

feat: Add block type icon and title to groups and entries

0881f5d

feat: Truncate titles in histoy log entries

1f1ece7

feat: Update the history log to use the create entry

22b3f3e

rpenido approved these changes Mar 27, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: History log in content library components [FC-0123]#2948

feat: History log in content library components [FC-0123]#2948
ChrisChV wants to merge 8 commits intoopenedx:masterfrom
open-craft:chris/FAL-4330-history-log

ChrisChV commented Mar 17, 2026 •

edited

Loading

Uh oh!

openedx-webhooks commented Mar 17, 2026 •

edited

Loading

Uh oh!

codecov bot commented Mar 24, 2026 •

edited

Loading

Uh oh!

rpenido left a comment

Uh oh!

rpenido Mar 27, 2026

Uh oh!

rpenido Mar 27, 2026

Uh oh!

rpenido Mar 27, 2026

Uh oh!

rpenido Mar 27, 2026

Uh oh!

rpenido Mar 27, 2026

Uh oh!

rpenido Mar 27, 2026

Uh oh!

rpenido Mar 27, 2026

Uh oh!

rpenido Mar 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	import { HistoryComponentLog } from '../generic/history-log/HistoryLog';
	import { HistoryComponentLog } from '@src/generic/history-log/HistoryLog';

	export const useLibraryBlockDraftHistory = (usageKey: string \| undefined) => (
	export const useLibraryBlockDraftHistory = (usageKey?: string) => (

	export const useLibraryBlockPublishHistory = (usageKey: string \| undefined) => (
	export const useLibraryBlockPublishHistory = (usageKey?: string) => (

		usageKey: string \| undefined,
		publishGroupId: string \| undefined,

	export const useLibraryBlockCreationEntry = (usageKey: string \| undefined) => (
	export const useLibraryBlockCreationEntry = (usageKey?: string) => (

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!

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ChrisChV commented Mar 17, 2026 •

edited

Loading

openedx-webhooks commented Mar 17, 2026 •

edited

Loading

codecov bot commented Mar 24, 2026 •

edited

Loading