Autoformat Problem XBlock Source Files for Consistency (2/3) #37487

irtazaakram · 2025-10-15T07:01:11Z

This PR applies consistent formatting across all Problem XBlock–related files to align with the formatting conventions used in the xblocks-contrib extraction. The goal is to minimize noise during the extraction review and ensure that only functional differences remain when moving the Problem XBlock out of edx-platform.

We are in the process of extracting the Problem XBlock into xblocks-contrib/problem, where all code and templates are already formatted consistently. To make the migration diff easier for reviewers—and to avoid unnecessary churn caused by formatting—we are pre-formatting the corresponding files inside edx-platform using the same tools and configuration.

Related PR: openedx/xblocks-contrib#63
#37476

HTML / Template Files

There's no known mako template formatter. so we will format html files after converting them to django templates.

JavaScript / CSS Files

prettier --write \
xmodule/capa/tests/test_files/js/mersenne-twister-min.js \
xmodule/capa/tests/test_files/js/test_problem_display.js \
xmodule/capa/tests/test_files/js/test_problem_generator.js \
xmodule/capa/tests/test_files/js/test_problem_grader.js \
xmodule/capa/tests/test_files/js/xproblem.js \
xmodule/js/spec/capa/display_spec.js \
xmodule/js/spec/capa/imageinput_spec.js \
xmodule/js/spec/collapsible_spec.js \
xmodule/js/spec/helper.js \
xmodule/js/src/capa/display.js \
xmodule/js/src/capa/imageinput.js \
xmodule/js/src/capa/schematic.js \
xmodule/js/src/collapsible.js \
xmodule/js/src/javascript_loader.js \
xmodule/js/src/problem/edit.js \
xmodule/static/css-builtin-blocks/ProblemBlockDisplay.css \
xmodule/static/css-builtin-blocks/ProblemBlockEditor.css

YAML Files

prettier --write "xmodule/templates/problem/**/*.y?(a)ml"

No logic changes — formatting only
Consistent style across Problem XBlock files

Testing:

During testing on the sandbox, the following problems were observed to be non-functional, but this is not caused by the changes in this PR

Custom JavaScript Display & Grading
Custom Python-evaluated input

Relevant issue: #36538

xmodule/js/src/javascript_loader.js

xmodule/js/src/problem/edit.js

open-craft-grove · 2025-11-11T12:29:17Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-11-11T13:33:55Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-11-11T14:38:17Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-11-17T09:57:59Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-11-17T11:33:52Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-11-27T09:31:13Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-11-28T10:42:42Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-12-01T09:59:37Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

xmodule/js/src/javascript_loader.js

open-craft-grove · 2025-12-01T16:22:46Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-12-01T16:51:29Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-12-02T09:52:25Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

xmodule/js/src/javascript_loader.js

irtazaakram · 2025-12-03T08:10:56Z

xmodule/js/src/problem/edit.js

+        });
+
+        // split scripts and preformatted sections, and wrap paragraphs
+        splits = xml.split(/(<\/?(?:script|pre|label|description)[^>]*>)/gi);


Addressed issue https://github.com/openedx/edx-platform/security/code-scanning/534

irtazaakram · 2025-12-03T08:13:25Z

xmodule/js/src/capa/display.js

+        var answers;
+        answers = response.answers;
+        $.each(answers, function (key, value) {
+          var safeKey = key.replace(/\\/g, "\\\\").replace(/:/g, "\\:").replace(/\./g, "\\."); // fix for courses which use url_names with colons & periods, e.g. problem:question1, question1.1


Addressed issues:
https://github.com/openedx/edx-platform/security/code-scanning/535
https://github.com/openedx/edx-platform/security/code-scanning/545
https://github.com/openedx/edx-platform/security/code-scanning/547

irtazaakram · 2025-12-03T08:15:11Z

xmodule/js/src/capa/display.js

+        var answer, choice, inputId, i, len, results, $element, $inputLabel, $inputStatus;
+        $element = $(element);
+        inputId = $element.attr("id").replace(/inputtype_/, "");
+        var safeId = inputId.replace(/\\/g, "\\\\").replace(/:/g, "\\:").replace(/\./g, "\\."); // fix for courses which use url_names with colons & periods, e.g. problem:question1, question1.1


Addressed Issues:
https://github.com/openedx/edx-platform/security/code-scanning/536
https://github.com/openedx/edx-platform/security/code-scanning/546
https://github.com/openedx/edx-platform/security/code-scanning/548

irtazaakram · 2025-12-03T08:16:36Z

xmodule/js/src/javascript_loader.js

+        if (!(src_escaped in loaded)) {
+          loaded[src_escaped] = true;
+          s = document.createElement("script");
+          s.setAttribute("src", src_escaped);


Addressed Issues:
https://github.com/openedx/edx-platform/security/code-scanning/551
https://github.com/openedx/edx-platform/security/code-scanning/552
https://github.com/openedx/edx-platform/security/code-scanning/533
https://github.com/openedx/edx-platform/security/code-scanning/553

open-craft-grove · 2025-12-03T10:32:25Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-12-03T11:35:52Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-12-03T12:04:13Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-12-03T12:32:23Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-12-04T06:49:25Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-12-08T13:37:04Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

salman2013 · 2025-12-08T13:43:46Z

The PR looks good to me, I believe the fixes as you explained me will improve things. Please keep an eye on the logs after the merge. Few tests are pending once that will pass then you can merge it.

salman2013

LGTM

…#37487) * fix: run prettier on problem block code * fix: codeql issues

irtazaakram marked this pull request as draft October 15, 2025 07:01

github-advanced-security bot found potential problems Oct 15, 2025

View reviewed changes

xmodule/js/src/javascript_loader.js Fixed Show fixed Hide fixed

xmodule/js/src/problem/edit.js Fixed Show fixed Hide fixed

irtazaakram force-pushed the autoformat-problemblock-js-html-css-yaml branch from 424f7c6 to de9e343 Compare October 20, 2025 10:05

irtazaakram mentioned this pull request Oct 29, 2025

Format Problem XBlock Files in edx-platform openedx/public-engineering#436

Closed

irtazaakram force-pushed the autoformat-problemblock-js-html-css-yaml branch 2 times, most recently from b155f98 to fb2e660 Compare November 11, 2025 11:48

irtazaakram added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Nov 11, 2025

irtazaakram added create-sandbox open-craft-grove should create a sandbox environment from this PR and removed create-sandbox open-craft-grove should create a sandbox environment from this PR labels Nov 12, 2025

fix: run prettier on problem block code

dd866be

irtazaakram force-pushed the autoformat-problemblock-js-html-css-yaml branch 2 times, most recently from 069382b to ab72bf9 Compare December 1, 2025 15:49

github-advanced-security bot found potential problems Dec 1, 2025

View reviewed changes

xmodule/js/src/javascript_loader.js Fixed Show fixed Hide fixed

irtazaakram force-pushed the autoformat-problemblock-js-html-css-yaml branch from ab72bf9 to 85df359 Compare December 2, 2025 09:11

irtazaakram force-pushed the autoformat-problemblock-js-html-css-yaml branch from bda2c75 to b574e9c Compare December 3, 2025 07:06

github-advanced-security bot found potential problems Dec 3, 2025

View reviewed changes

xmodule/js/src/javascript_loader.js Fixed Show fixed Hide fixed

irtazaakram force-pushed the autoformat-problemblock-js-html-css-yaml branch 2 times, most recently from ee30435 to 0b84a2c Compare December 3, 2025 07:22

github-advanced-security bot found potential problems Dec 3, 2025

View reviewed changes

xmodule/js/src/javascript_loader.js Fixed Show fixed Hide fixed

fix: codeql issues

9209971

irtazaakram force-pushed the autoformat-problemblock-js-html-css-yaml branch from 0b84a2c to 9209971 Compare December 3, 2025 07:38

Merge branch 'master' into autoformat-problemblock-js-html-css-yaml

e9a00b1

irtazaakram commented Dec 3, 2025

View reviewed changes

Merge branch 'master' into autoformat-problemblock-js-html-css-yaml

f32aac8

irtazaakram marked this pull request as ready for review December 4, 2025 07:57

irtazaakram requested review from farhan and salman2013 as code owners December 4, 2025 07:57

Merge branch 'master' into autoformat-problemblock-js-html-css-yaml

7a17a17

salman2013 reviewed Dec 8, 2025

View reviewed changes

salman2013 approved these changes Dec 8, 2025

View reviewed changes

irtazaakram merged commit c3e8542 into master Dec 8, 2025
53 checks passed

irtazaakram deleted the autoformat-problemblock-js-html-css-yaml branch December 8, 2025 15:01

irtazaakram changed the title ~~Autoformat Problem XBlock Source Files for Consistency (2/2)~~ Autoformat Problem XBlock Source Files for Consistency (2/3) Dec 15, 2025

mraman-2U pushed a commit to mraman-2U/edx-platform that referenced this pull request Dec 24, 2025

Autoformat Problem XBlock Source Files for Consistency (2/2) (openedx…

9522d0f

…#37487) * fix: run prettier on problem block code * fix: codeql issues

Autoformat Problem XBlock Source Files for Consistency (2/3) #37487

Autoformat Problem XBlock Source Files for Consistency (2/3) #37487

Conversation

irtazaakram commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

HTML / Template Files

JavaScript / CSS Files

YAML Files

Testing:

Uh oh!

Uh oh!

Uh oh!

open-craft-grove commented Nov 11, 2025

Uh oh!

open-craft-grove commented Nov 11, 2025

Uh oh!

open-craft-grove commented Nov 11, 2025

Uh oh!

open-craft-grove commented Nov 17, 2025

Uh oh!

open-craft-grove commented Nov 17, 2025

Uh oh!

open-craft-grove commented Nov 27, 2025

Uh oh!

open-craft-grove commented Nov 28, 2025

Uh oh!

open-craft-grove commented Dec 1, 2025

Uh oh!

Uh oh!

open-craft-grove commented Dec 1, 2025

Uh oh!

open-craft-grove commented Dec 1, 2025

Uh oh!

open-craft-grove commented Dec 2, 2025

Uh oh!

Uh oh!

Uh oh!

irtazaakram Dec 3, 2025

Choose a reason for hiding this comment

Uh oh!

irtazaakram Dec 3, 2025

Choose a reason for hiding this comment

Uh oh!

irtazaakram Dec 3, 2025

Choose a reason for hiding this comment

Uh oh!

irtazaakram Dec 3, 2025

Choose a reason for hiding this comment

Uh oh!

open-craft-grove commented Dec 3, 2025

Uh oh!

open-craft-grove commented Dec 3, 2025

Uh oh!

open-craft-grove commented Dec 3, 2025

Uh oh!

open-craft-grove commented Dec 3, 2025

Uh oh!

open-craft-grove commented Dec 4, 2025

Uh oh!

open-craft-grove commented Dec 8, 2025

Uh oh!

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

Uh oh!

Uh oh!

salman2013 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

irtazaakram commented Oct 15, 2025 •

edited

Loading

salman2013 commented Dec 8, 2025 •

edited

Loading