Documentation Required PBF bug PR-4.4-dev Pending

User tests: Successful: Unsuccessful:

avatar wilsonge
wilsonge
21 Dec 2022

Pull Request for Issue #39458 .

Summary of Changes

Fixes the fact we were returning a rendered html document to the controller which was then being totally ignored. Instead the view now returns void in a similar approach to how HTML documents are rendered. This is technically a b/c break as the return type has changed. However as the controller has never used this value and the document is re-rendered as part of the Application package for display on screen the chances of this impacting any extensions is exceptionally low. But I've put this against the 4.3 branch to be safe

Testing Instructions

Drone tests continue to pass showing there is no difference in the api behaviour before and after this PR. Users can choose any endpoint and behaviour should be unchanged whilst there should be a negligible performance increase as we don't double render the document.

Link to documentations

Please select:

  • Documentation link for docs.joomla.org:

  • No documentation changes for docs.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

avatar joomla-cms-bot joomla-cms-bot - change - 21 Dec 2022
Category Libraries
avatar wilsonge wilsonge - open - 21 Dec 2022
avatar wilsonge wilsonge - change - 21 Dec 2022
Status New Pending
avatar wilsonge wilsonge - change - 21 Dec 2022
The description was changed
avatar wilsonge wilsonge - edited - 21 Dec 2022
1b8ad44 21 Dec 2022 avatar wilsonge Fix
avatar wilsonge wilsonge - change - 21 Dec 2022
Labels Added: PR-4.3-dev
avatar obuisard
obuisard - comment - 15 Jul 2023

It's a shame we did not include this in 4.3, I apologize for the oversight. George @wilsonge then we would not have any issue including this in 5.0. What do you thing Harald @Hackwar?

avatar richard67
richard67 - comment - 25 Sep 2023

It's a shame we did not include this in 4.3, I apologize for the oversight. George @wilsonge then we would not have any issue including this in 5.0. What do you thing Harald @Hackwar?

@obuisard You wanted to ping Harald @HLeithner , but you've pinged Hannes ?

avatar HLeithner
HLeithner - comment - 30 Sep 2023

This pull request has been automatically rebased to 4.4-dev.

avatar HLeithner
HLeithner - comment - 18 Oct 2023

@MacJoom @laoneo would you like to merge this into 4.4? I mean it's not a bug that breaks anything, so I think moving it to 5.1 would make sense. What you think?

avatar laoneo
laoneo - comment - 18 Oct 2023

I would say 6.0 is the right target branch as George pointed out the bc break, even when it is minor.

avatar richard67
richard67 - comment - 25 Oct 2023

I would also need to be documented in the migration developer docs and maybe also deprecation comments.

avatar wilsonge wilsonge - change - 27 Mar 2024
Labels Added: Documentation Required PBF bug PR-4.4-dev
Removed: PR-4.3-dev
avatar HLeithner HLeithner - change - 24 Apr 2024
Title
Fix components rendering the document for no reason
[4.4] Fix components rendering the document for no reason
avatar HLeithner HLeithner - edited - 24 Apr 2024
avatar HLeithner
HLeithner - comment - 15 Nov 2024

This pull request has been automatically rebased to 5.2-dev.

avatar HLeithner HLeithner - change - 15 Nov 2024
Title
[4.4] Fix components rendering the document for no reason
[5.2] Fix components rendering the document for no reason
avatar HLeithner HLeithner - edited - 15 Nov 2024

Add a Comment

Login with GitHub to post a comment