Wiki source code of Release Notes for XWiki 17.2.0
Last modified by Simon Urli on 2025/03/31
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{velocity}} | ||
| 2 | #if ($doc.getValue('released') != 1) | ||
| 3 | {{warning}}This version has not yet been released.{{/warning}} | ||
| 4 | #end | ||
| 5 | {{/velocity}} | ||
| 6 | |||
| 7 | {{velocity}} | ||
| 8 | #set ($rnObject = $doc.getObject('ReleaseNotes.Code.ReleaseNoteClass')) | ||
| 9 | #set ($product = $rnObject.product) | ||
| 10 | #set ($version = $rnObject.version) | ||
| 11 | #set ($versionPrefix = $stringtool.substringBefore($version, '-')) | ||
| 12 | #set ($versionParts = $stringtool.split($versionPrefix, '.')) | ||
| 13 | #set ($isRC = $version.contains('rc')) | ||
| 14 | #set ($isFinal = !$isRC) | ||
| 15 | #set ($isFirstFinal = $isFinal && ($versionParts.size() == 2 || $versionParts[2] == 0)) | ||
| 16 | #set ($isBugFix = $isFinal && $versionParts.size() == 3 && $versionParts[2] > 0) | ||
| 17 | {{/velocity}} | ||
| 18 | |||
| 19 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 20 | {{toc/}} | ||
| 21 | {{/box}} | ||
| 22 | |||
| 23 | This is the release notes for [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]] and [[XWiki Platform>>http://platform.xwiki.org]]. They share the same release notes as they are released together and have the same version. | ||
| 24 | |||
| 25 | This release makes it possible for users with just edit right to re-order pages in the navigation, fixes bugs and improves the performance of XWiki in particular for larger instances. This release contains security fixes, with the [[highest severity being 8.7/10>>doc:dev:Community.SecurityPolicy.WebHome||anchor="HSeverity"]]. | ||
| 26 | |||
| 27 | {{velocity}} | ||
| 28 | {{jiraBlockersFor version="$version" id="xwikiorg"/}} | ||
| 29 | {{/velocity}} | ||
| 30 | |||
| 31 | = New and Noteworthy (since {{velocity}}$product{{/velocity}} 17.1.0) = | ||
| 32 | |||
| 33 | [[Full list of issues fixed and Dashboard for 17.2.0>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=15995]]. | ||
| 34 | |||
| 35 | {{velocity}} | ||
| 36 | #if ($isBugFix) | ||
| 37 | {{jira style="list" url="https://jira.xwiki.org" fields="type, status, key, summary" source="jql"}} | ||
| 38 | resolution = Fixed AND component != "Development Issues only" and component != "Development Issues only - Test" AND project in (XCOMMONS, XRENDERING, XWIKI) AND fixVersion in ($version) | ||
| 39 | {{/jira}} | ||
| 40 | #else | ||
| 41 | {{releasenotechanges/}} | ||
| 42 | #end | ||
| 43 | {{/velocity}} | ||
| 44 | |||
| 45 | === Upgrades === | ||
| 46 | |||
| 47 | The following runtime dependencies have been upgraded (they have a different release cycle than [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]] and [[XWiki Platform>>http://platform.xwiki.org]]): | ||
| 48 | |||
| 49 | {{velocity}} | ||
| 50 | #if ($isFirstFinal) | ||
| 51 | #set ($affectedVersions = "${version}-rc-1, ${version}") | ||
| 52 | #else | ||
| 53 | #set ($affectedVersions = "${version}") | ||
| 54 | #end | ||
| 55 | {{jira url="https://jira.xwiki.org" source="jql" style="list"}} | ||
| 56 | project in (XWIKI, XCOMMONS, XRENDERING) AND issuetype = Task AND fixVersion in ($affectedVersions) AND component = "Dependency Upgrades" | ||
| 57 | {{/jira}} | ||
| 58 | {{/velocity}} | ||
| 59 | |||
| 60 | = Translations = | ||
| 61 | |||
| 62 | The following translations have been updated: | ||
| 63 | |||
| 64 | {{language codes="es, fr, zh, zh_TW"/}} | ||
| 65 | |||
| 66 | {{comment}} | ||
| 67 | TODO: uncomment and update with proper link when the report is ready. | ||
| 68 | |||
| 69 | = Tested Browsers & Databases = | ||
| 70 | |||
| 71 | {{include reference="TestReports.<test report page>"/}} | ||
| 72 | {{/comment}} | ||
| 73 | |||
| 74 | {{comment}} | ||
| 75 | TODO: uncomment and update with proper links when the report is ready. | ||
| 76 | |||
| 77 | = Performances tests compared to <last super stable version> = | ||
| 78 | |||
| 79 | {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}} | ||
| 80 | |||
| 81 | More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]]. | ||
| 82 | {{/comment}} | ||
| 83 | |||
| 84 | = Security Issues = | ||
| 85 | |||
| 86 | Security issues are not listed in issue lists or dashboards to avoid disclosing ways to use them, but they will appear automatically in them once they're disclosed. See the [[XWiki Security Policy>>dev:Community.SecurityPolicy.WebHome]] for more details. | ||
| 87 | |||
| 88 | = Known issues = | ||
| 89 | |||
| 90 | * [[Bugs we know about>>https://jira.xwiki.org/issues/?jql=category%20%3D%2010000%20AND%20issuetype%20%3D%20Bug%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20updated%20DESC]] | ||
| 91 | |||
| 92 | = Backward Compatibility and Migration Notes = | ||
| 93 | |||
| 94 | == General Notes == | ||
| 95 | |||
| 96 | * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added: | ||
| 97 | ** ##xwiki.cfg## | ||
| 98 | ** ##xwiki.properties## | ||
| 99 | ** ##web.xml## | ||
| 100 | ** ##hibernate.cfg.xml## | ||
| 101 | * Add ##xwiki.store.migration=1## in ##xwiki.cfg## so that XWiki will attempt to automatically migrate your current database to any new schema. Make sure you backup your Database before doing anything. | ||
| 102 | |||
| 103 | == Issues specific to {{velocity}}$product $version{{/velocity}} == | ||
| 104 | |||
| 105 | === Protection against concurrent modification of cached document === | ||
| 106 | |||
| 107 | It's considered bad practice to directly modify the document from the cache (mainly because it can badly impact other requests/threads). This version introduces automatic protections to avoid this situation as much as possible by doing the following: if the XWikiDocument instance in the document store has been modified, any attempt to access it will result in the reloading of the document from the store and the replacement of the "corrupted" document from the cache. | ||
| 108 | |||
| 109 | But also a warning is logged when the mistake is made so that the related code is identified and fixed, because the protection cannot fix all cases, for example: | ||
| 110 | |||
| 111 | {{code language="none"}} | ||
| 112 | 2025-03-28 09:52:08,317 [qtp1024429571-324 - http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/addAnnotationTranslation/pages/WebHome/annotations?media=json] WARN c.x.x.d.XWikiDocument - Abusive modification of the cached document [xwiki:addAnnotationTranslation.WebHome()] | ||
| 113 | java.lang.IllegalStateException: Abusive modification of the cached document | ||
| 114 | at com.xpn.xwiki.doc.XWikiDocument.setMetaDataDirty(XWikiDocument.java:2457) | ||
| 115 | at ... | ||
| 116 | {{/code}} | ||
| 117 | |||
| 118 | To avoid the warning, one must clone the XWikiDocument before modifying it. That's something that has already been done automatically for a long time when using the Document script API. | ||
| 119 | It would be great to report those warnings if you encounter any, but it's also possible to disable them easily because they are considered deprecation logs: control them using the property logging.deprecated.enabled in the xwiki.properties configuration file. | ||
| 120 | |||
| 121 | == API Breakages == | ||
| 122 | |||
| 123 | The following APIs were modified since {{velocity}}$product{{/velocity}} 17.1.0: | ||
| 124 | |||
| 125 | {{velocity}} | ||
| 126 | {{backwardCompatibilityReport134 version="$version"/}} | ||
| 127 | {{/velocity}} | ||
| 128 | |||
| 129 | = Credits = | ||
| 130 | |||
| 131 | The following people have contributed code and translations to this release (sorted alphabetically): | ||
| 132 | |||
| 133 | * Alex Cotiugă | ||
| 134 | * Alvaro | ||
| 135 | * Anmol | ||
| 136 | * Gankov Andrey | ||
| 137 | * LEE CHENG WEI | ||
| 138 | * LucasC | ||
| 139 | * Manuel Leduc | ||
| 140 | * Marius Dumitru Florea | ||
| 141 | * Mend Renovate | ||
| 142 | * Michael Hamann | ||
| 143 | * Simon Urli | ||
| 144 | * Thomas Mortagne | ||
| 145 | * Vincent Massol | ||
| 146 | * dependabot[bot] | ||
| 147 | * slauriere | ||
| 148 | * zon1002 |
