Skip to content

Fix pb-message boilerplate templates ignored by generic container - #3157

Open
salman2013 wants to merge 2 commits into
openedx:masterfrom
salman2013:salman/fix-fb-message-template-issue
Open

Fix pb-message boilerplate templates ignored by generic container#3157
salman2013 wants to merge 2 commits into
openedx:masterfrom
salman2013:salman/fix-fb-message-template-issue

Conversation

@salman2013

@salman2013 salman2013 commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Summary

Bug:
When inside a Problem Builder (or other StudioContainerWithNestedXBlocksMixin) container block, the "Add Component" buttons for pb-message variants (Message complete / incomplete / Max attempts) all create the same default block, ignoring the selected boilerplate template.
For detail look at this comment: #3058 (comment)

Ticket: #3156

What we fixed in this PR:

  • Buttons for blocks declared via StudioContainerWithNestedXBlocksMixin (e.g. pb-message complete/incomplete/max-attempts) were ignoring the boilerplate_name from their template spec, so every variant always created the default block.
  • Fixed by passing firstTemplate?.boilerplateName from the button onClick through to the handleCreateNewCourseXBlock API call as boilerplate.

Test Results:

Screenshot 2026-07-24 at 10 27 27 PM Screenshot 2026-07-24 at 10 28 08 PM

Buttons for blocks declared via StudioContainerWithNestedXBlocksMixin
(e.g. pb-message complete/incomplete/max-attempts) were ignoring the
boilerplate_name from their template spec, so every variant always
created the default block.

Two fixes in AddComponent.tsx:
- Pass firstTemplate?.boilerplateName from the button onClick to
  handleCreateNewXBlock so the selected variant is forwarded.
- Forward it as boilerplate in the handleCreateNewCourseXBlock call
  inside the default handler branch so the backend applies the
  correct template.

Closes openedx#3156

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jul 24, 2026
@openedx-webhooks

openedx-webhooks commented Jul 24, 2026

Copy link
Copy Markdown

Thanks for the pull request, @salman2013!

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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Jul 24, 2026
@salman2013
salman2013 marked this pull request as draft July 24, 2026 17:22
@salman2013 salman2013 changed the title fix: pass boilerplate to generic container add-component buttons Fix pb-message boilerplate templates ignored by generic container Jul 24, 2026
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov

codecov Bot commented Jul 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.79%. Comparing base (211a16c) to head (a03122c).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3157   +/-   ##
=======================================
  Coverage   95.79%   95.79%           
=======================================
  Files        1398     1398           
  Lines       33473    33473           
  Branches     7886     7875   -11     
=======================================
  Hits        32064    32064           
  Misses       1350     1350           
  Partials       59       59           

☔ View full report in Codecov by Harness.
📢 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.

@salman2013
salman2013 marked this pull request as ready for review July 24, 2026 17:42
@farhan
farhan requested a review from Copilot July 27, 2026 08:28

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes creation of container-declared component variants (e.g., Problem Builder pb-message complete/incomplete/max-attempts) so the selected template’s boilerplate_name is forwarded into the create-XBlock API call, instead of always creating the default block.

Changes:

  • Forward firstTemplate?.boilerplateName from generic container “Add Component” buttons into handleCreateNewXBlock(...).
  • Include the forwarded value as boilerplate in the generic/default handleCreateNewCourseXBlock(...) request payload.
  • Add a regression test asserting boilerplate is passed for a generic container block button click.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/course-unit/add-component/AddComponent.tsx Wires template boilerplate through the generic container button click path into the create-XBlock request.
src/course-unit/add-component/AddComponent.test.tsx Adds a test ensuring the boilerplate name is included in the create-XBlock call for a generic container block.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +236 to +241
handleCreateNewCourseXBlock({
type,
category: type,
boilerplate: moduleName,
parentLocator: blockId,
});

@farhan farhan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forwarding some of the suggestions compiled in assistance with the @claude.

I will like to have @bradenmacdonald its major review as I have very limited experience on frontend repos.

type,
category: type,
boilerplate: moduleName,
parentLocator: blockId,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • boilerplate: moduleName is always added to the object, even when moduleName is undefined. In JS, 'boilerplate' in obj returns false when the key is absent and true when it is present with value undefined
  • This follows the same pattern as the existing openassessment and html cases in this file, so the PR code is in parity.
  • But consider applying it to the PR code ...(moduleName ? { boilerplate: moduleName } : {}).

parentLocator: blockId,
});
});

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new test covers the happy path (boilerplate present → forwarded). Consider adding a sibling test for the inverse: a generic container block whose template has no boilerplate_name.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: In Eng Review

Development

Successfully merging this pull request may close these issues.

5 participants