Remove hard-coded <br /> from batch API

Created on 21 August 2015, over 9 years ago

Updated 24 January 2025, 3 days ago

Problem/Motivation

#2548147: All batch labels are HTML escaped → shows we have three hard-coded <br /> tags in batch API. In general there's almost always a better option than a break tag. Opening this to see if we can remove them.

Steps to reproduce

Need to trigger an error in a batch process.

To test this issue this has been achieved by manually editing a file to break the installer.
However as there is automated testing - and a batch testing module we can

Allow enabling test modules via ->
```
$settings[&#039;extension_discovery_scan_tests&#039;] = TRUE; 
```
in settings.php or settings.local.php if configured
Install batch_test module via the UI or drush
Edit web/core/modules/system/tests/modules/batch_test/src/Controller/BatchTestController.php to introduce an error and visit the appropriate batch. Ideally there would be a test here for this. Perhaps this can be added.
For example edit '_batch_test_title_callback' to be '_batch_test_title_callbackx' then visit /batch-test/test-title
View the output - see the
in the html and in drupalSettings.

Proposed resolution

For the html - instead of concatenating strings with line breaks between them use an inline template to do this

Remaining tasks

Add a test that demonstrates a failing batch to make testing this easy. And ensure we are not changing the output
Reroll the latest patch against the latest codebase - probably shift to MR. This addresses the line break in drupalSettings only
Address the linebreak in the html output - probably via the same method as above.

User interface changes

Goal here is no changes to UI - we are just shifting where the line break is in code.

Introduced terminology

None

API changes

None

Data model changes

None

Release notes snippet

Note required.

🐛 Bug report

Status

Needs work

Version

11.0 🔥

Component

batch system

Created by

🇬🇧United Kingdom catch

Live updates comments and jobs are added and updated live.

CSS
It involves the content or handling of Cascading Style Sheets.

markup

DrupalCampES

DevDaysSeville

KharkivCS

Needs issue summary update
Issue summaries save everyone time if they are kept up-to-date. See Update issue summary task instructions.

Incomplete comments

Merge Requests

!11016Remove hard-coded <br /> from batch API
Open
🇮🇳India prem suthar
updated 7 minutes ago

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment 3 days ago →
🇳🇿New Zealand luke.stewart
Summarising the above.

Seems a shame this didn't get over the line.

I've checked and the line break tags are still present in 11.x

Updating the summary based on the above.
Comment 3 days ago →
🇳🇿New Zealand luke.stewart
Comment 3 days ago →
🇳🇿New Zealand luke.stewart
Not sure if this actually really requires a test but this would add some coverage to the batch on error behaviour ?
Comment 1 day ago →
🇺🇸United States nicxvan
I can't imagine this would need a test.

First step would be to convert the most recent patch to an mr.
Comment about 1 hour ago →
🇮🇳India prem suthar Ahemdabad- Gujrat , Jodhpur - Rajsthan
prem suthar → made their first commit to this issue’s fork.
Merge request !11016added the MR form the recent patch as per #69. → (Open) created by prem suthar

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024

Remove hard-coded <br /> from batch API

Problem/Motivation

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

Merge Requests

!11016Remove hard-coded <br /> from batch APIOpen

Comments & Activities

!11016Remove hard-coded <br /> from batch API
Open