Skip to content

Show Deprecated macros warning in PG editor and library Browser #2752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Show Deprecated macros warning in PG editor and library Browser #2752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0dfbc93
Warn instructors if using deprecated_macros.
somiaj Jun 21, 2025
41dd678
Added some <p></p> tags...
pstaabp Jun 23, 2025
257cc36
Get the list of deprecated macros from the macrosList.
pstaabp Jun 24, 2025
2693b62
A bit of code cleanup.
pstaabp Jun 25, 2025
5351653
Improvements to showing the deprecated macros warning.
drgrice1 Jun 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions htdocs/js/PGProblemEditor/pgproblemeditor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,6 +512,17 @@
container.innerHTML = data.pg_flags.comment;
iframe.after(container);
}
if (data.deprecated_macros?.length) {
const container = document.createElement('div');
container.classList.add('alert', 'alert-danger', 'mx-2', 'p-2');
container.innerHTML =
'Warning!! This problem uses the following deprecated macros:' +
'<ul class="my-1">' +
data.deprecated_macros.reduce((acc, item) => `${acc}<li>${item}</li>`, '') +
'</ul>If this is an OPL problem, please report this issue to the OPL. ' +
'If this is a custom problem, please update the problem to use modern macros.';
iframe.after(container);
}

iframe.addEventListener(
'load',
Expand Down
11 changes: 11 additions & 0 deletions htdocs/js/RenderProblem/renderproblem.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,17 @@
container.innerHTML = data.pg_flags.comment;
iframe.after(container);
}
if (data.deprecated_macros?.length) {
const container = document.createElement('div');
container.classList.add('alert', 'alert-danger', 'p-2');
container.innerHTML =
'Warning!! This problem uses the following deprecated macros:' +
'<ul class="my-1">' +
data.deprecated_macros.reduce((acc, item) => `${acc}<li>${item}</li>`, '') +
'</ul>If this is an OPL problem, please report this issue to the OPL. ' +
'If this is a custom problem, please update the problem to use modern macros.';
iframe.after(container);
}
iFrameResize(
{
checkOrigin: false,
Expand Down
7 changes: 6 additions & 1 deletion lib/FormatRenderedProblem.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,12 @@ sub formatRenderedProblem {

return $ws->c->render(%template_params) if $formatName eq 'json' || !$ws->{inputs_ref}{send_pg_flags};
return $ws->c->render(
json => { html => $ws->c->render_to_string(%template_params)->to_string, pg_flags => $rh_result->{flags} });
json => {
html => $ws->c->render_to_string(%template_params)->to_string,
pg_flags => $rh_result->{flags},
deprecated_macros => $rh_result->{deprecated_macros}
}
);
}

sub saveGradeToLTI {
Expand Down
11 changes: 10 additions & 1 deletion lib/WeBWorK/Utils/Rendering.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,8 @@ sub renderPG ($c, $effectiveUser, $set, $problem, $psvn, $formFields, $translati
$ret->{internal_debug_messages} = $pg->{pgcore}->get_internal_debug_messages;
$ret->{warning_messages} = $pg->{pgcore}->get_warning_messages();
$ret->{debug_messages} = $pg->{pgcore}->get_debug_messages();
$ret->{PG_ANSWERS_HASH} = {

$ret->{PG_ANSWERS_HASH} = {
map {
$_ => {
response_obj => unbless($pg->{pgcore}{PG_ANSWERS_HASH}{$_}->response_obj),
Expand All @@ -286,6 +287,14 @@ sub renderPG ($c, $effectiveUser, $set, $problem, $psvn, $formFields, $translati
keys %{ $pg->{pgcore}{PG_alias}{resource_list} }
};
$ret->{PERSISTENCE_HASH} = $pg->{pgcore}{PERSISTENCE_HASH};

# Get a list of the deprecated macros used in the problem.
my @deprecated_macros;
for (keys %{ $pg->{pgcore}{PG_loadMacros}{macroFileList} }) {
my @dirs = split('/', $_);
push(@deprecated_macros, $dirs[-1]) if $dirs[-2] eq 'deprecated';
}
$ret->{deprecated_macros} = \@deprecated_macros;
}

# Save the problem source. This is used by Caliper::Entity. Why?
Expand Down
5 changes: 3 additions & 2 deletions lib/WebworkWebservice/RenderProblem.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,8 +279,9 @@ async sub renderProblem {
psvn => $psvn,
problem_seed => $problemSeed,
resource_list => $pg->{resource_list},
warning_messages => ref $pg->{warning_messages} eq 'ARRAY' ? $pg->{warning_messages} : [],
debug_messages => ref $pg->{debug_messages} eq 'ARRAY' ? $pg->{debug_messages} : [],
warning_messages => ref $pg->{warning_messages} eq 'ARRAY' ? $pg->{warning_messages} : [],
debug_messages => ref $pg->{debug_messages} eq 'ARRAY' ? $pg->{debug_messages} : [],
deprecated_macros => ref $pg->{deprecated_macros} eq 'ARRAY' ? $pg->{deprecated_macros} : [],
internal_debug_messages => ref $pg->{internal_debug_messages} eq 'ARRAY'
? $pg->{internal_debug_messages}
: [],
Expand Down