Release Notes for XWiki 10.11-rc-1

Last modified by Thomas Mortagne on 2018/12/27

This is the release notes for XWiki Commons, XWiki Rendering and XWiki Platform. They share the same release notes as they are released together and have the same version.

This version is mostly a stabilization release for the 10.x end of cycle. We've added a way to rapidly empty the wiki's recycle bin, that contains all the deleted pages. We've also polished the asynchronous execution and caching of panels added in the previous version, that makes the panels render faster. Plus we added many other improvements and bugfixes.

New and Noteworthy (since XWiki 10.10)

Full list of issues fixed and Dashboard for 10.11.

All Changes

  • Bug Closed XWIKI-15992 The Locale parameter is not taken into account in two of the LocalizationScriptService#render methods
  • Improvement Closed XWIKI-15985 Add ability to specify forbidden servlet engines in Docker tests
  • Bug Closed XWIKI-15980 Setting a main wiki skin or a filesystem skin is much harder with the new picker
  • Bug Closed XWIKI-15979 Global Menu is displayed (with error) in subwiki for a local user
  • Bug Closed XWIKI-15978 Shutting down an idle XWiki instance takes over 30 seconds
  • Bug Closed XWIKI-15976 Asynchronous panels encoding problem
  • Improvement Closed XWIKI-15971 Have annotation values override system properties in Docker-based tests
  • Bug Closed XWIKI-15965 Possible Nullpointerexception when importing/loading a document containing an attachment without the size information
  • Bug Closed XWIKI-15964 The search page goes back to showing the first 10 results if you navigate beyond 1000 results
  • Task Closed XWIKI-15963 Upgrade to CKEditor Integration 1.29
  • Bug Closed XWIKI-15962 Asynchronous panels generate external URLs
  • Bug Closed XWIKI-15961 A page appears more then once in the "My Recent Modifications" when it has more then one translation
  • Task Closed XWIKI-15959 Upgrade to Rome 1.12.0
  • Task Closed XWIKI-15958 Upgrade to Apache PDFBox 2.0.13
  • Improvement Closed XWIKI-15957 Introduce a debug mode to make it simpler to get debug information in the Docker Test framework
  • Bug Closed XWIKI-15956 Suggest Fails To Display Current Value Correctly On Edit
  • Bug Closed XWIKI-15955 Empty Stack left in each Thread which executed a Display Macro
  • Bug Closed XWIKI-15953 Rating a page containing dots in its name is not possible
  • Improvement Closed XWIKI-15949 The XAR parser should not use the xclass property element name
  • Bug Closed XWIKI-15948 Inconsistency between an xclass name and its tag name
  • Improvement Closed XWIKI-15944 Add ability to pass test resources to Docker-based tests
  • Bug Closed XWIKI-15943 Panels disappear when clicking on the Reset button
  • Bug Closed XWIKI-15942 Script right is tested in the context of the current document
  • Bug Closed XWIKI-15938 "Tips" panel can't be drag and dropped anymore
  • Bug Closed XWIKI-15936 'Skin' page picker is missing on instances created through Distribution Wizard
  • Improvement Closed XWIKI-15935 Replace async right with a client id system
  • Task Closed XWIKI-15934 Upgrade to JNR Constants 0.9.12
  • Improvement Closed XWIKI-15932 Order class properties from most specific to common in panels, ui extensions and wiki macros
  • Improvement Closed XWIKI-15931 Add ability to specify profiles for Docker-based tests
  • Bug Closed XWIKI-15929 'Tips' Panel is not translated when changing language
  • Bug Closed XWIKI-15925 Random async exception with panels MyRecentModifications
  • Task Closed XWIKI-15919 Upgrade to JNR POSIX 3.0.47
  • Task Closed XWIKI-15917 Upgrade to Pygments 2.3.1
  • Bug Closed XWIKI-15912 Improper "rename log" string is displayed when user is performing a page copy
  • Bug Closed XWIKI-15908 Cerulean theme is selected by default in the Page Administration
  • Improvement Closed XWIKI-15904 Allow tests to have access to the configuration for Docker tests
  • Improvement Closed XWIKI-15903 Allow configuring SSH ports that are forwarded in Docker tests
  • Improvement Closed XWIKI-15902 Allow adding JARs to XWiki's WEB-INF/lib when testing with Docker
  • Bug Closed XWIKI-15899 Global users cannot recover their password from a subwiki due to macro errors
  • Bug Closed XWIKI-15886 Impossible to change the notification "applications settings" if emails are disabled
  • Bug Closed XWIKI-15881 Configured default interval for notification mails is not really taken into account in many cases
  • Improvement Closed XWIKI-15880 Create a button to delete all from the recycle bin
  • Improvement Closed XWIKI-15876 Display Skin Pages With Their Real Name
  • Bug Closed XWIKI-15870 Warning message when copying a page
  • Bug Closed XWIKI-15863 Reverting or deleting the current version breaks attachment links
  • Bug Closed XWIKI-15851 Skin drop-down suggestions should display only pages containing XWiki.XWikiSkins objects
  • Bug Closed XWIKI-15848 A user cannot programmatically unwatch the main wiki upon creation
  • Improvement Closed XWIKI-15827 Add support for binding a specific input to a macro parameter type
  • Improvement Closed XWIKI-15825 Use feature and grouping parameters to the Include macro descriptor
  • Bug Closed XWIKI-15788 Duplicate attachments in email notifications
  • Bug Closed XWIKI-15713 History tab indicate that the page does not exist when the history is empty
  • Bug Closed XWIKI-15707 "Scope" attribute missing for .notifPreferences table headers
  • Bug Closed XWIKI-14908 Huge status produced when setting empty input source in Filter Stream Converter application
  • Bug Closed XWIKI-14635 Unsupported character exception is warned in console when downloading attachment
  • Bug Closed XRENDERING-545 FigureTypeRecognizer not recognizing tables when there's a MetaData block inside Figure blocks
  • Bug Closed XRENDERING-543 Figure and FigureCaption macro should not mandate content so that they can be edited online directly
  • Improvement Closed XRENDERING-542 Expose the feature property in parameter descriptors
  • Improvement Closed XRENDERING-535 Expose the groups property in parameter descriptors
  • Bug Closed XCOMMONS-1538 Don't use java tmp dir for XAR plugin integration tests
  • Improvement Closed XCOMMONS-1530 Add support for feature parameters in property descriptors
  • Improvement Closed XCOMMONS-1528 Add support for grouped parameters in property descriptors
  • New Feature Closed XCOMMONS-1527 Create an HTML Displayer interface

For Users

Delete all from the recycle bin


It is now possible to permanently delete all pages that have been already deleted, in order to clean the recycle bin. See Index Application Documentation.

For Admins

No changes!

For Developers

Use RequestFactory to create a request from the refactoring script service


The refactoring script service has been refactored: you need to access the new RequestFactory in order to create any kind of request.
For example a script using :

#set ($renameRequest = $services.refactoring.createRenameRequest($source, 'NewName')) 

should now use: 

#set ($renameRequest = $services.refactoring.requestFactory.createRenameRequest($source, 'NewName')) 

All the API related to refactoring operations themselves remains at the same place. See the Refactoring Module Documentation for all information.

Upgrades

The following runtime dependencies have been upgraded (they have a different release cycle than XWiki Commons, XWiki Rendering and XWiki Platform):

Translations

The following translations have been updated: 

  • Catalan
  • Czech
  • French
  • Russian
  • Ukrainian

Tested Browsers & Databases

Here is the list of browsers we support and how they have been tested for this release:

 BrowserTests performed and results
Chrome30.pngGoogle Chrome 71Not Tested
Firefox30.pngMozilla Firefox 64Not Tested
Edge30.pngMicrosoft Edge 17Smoke tests
IE30.pngInternet Explorer 11New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes
Safari30.pngSafari 12Not Tested

Here is the list of databases we support and how they have been tested for this release:

 DatabaseTests performed and results
hypersql.pngHyperSQL 2.4.1Not Tested
mysql.pngMySQL 5.7Smoke tests
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 10New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes

Here is the list of Servlet Containers we support and how they have been tested for this release:

 Servlet ContainerTests performed and results
tomcat-icon.pngTomcatNot Tested
jetty-icon.pngJetty (XWiki Standalone packaging)New and Noteworthy Features + Jira Tickets Marked as Fixed in the Release Notes
jetty-icon.pngJettyNot Tested

Known issues

Backward Compatibility and Migration Notes

General Notes

  • When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
    • xwiki.cfg
    • xwiki.properties
    • web.xml
    • hibernate.cfg.xml
  • 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.

API Breakages

The following APIs were modified since XWiki 10.10:

  • As RssMacro now inherits from AbstractBoxMacro, its parameter class needs to inherits from BoxMacroParameters. This could only break compatibility if a class inheriting from RssMacroParameters defines a method with same name and parameters than in BoxMacroParameters but different return type. We consider this risk as acceptable since the chances are very low and in case it occurs, the fix for the user would be easy.
    • Violation type:
      java.class.nonFinalClassInheritsFromNewClass
    • Code:
      ## Old:
      class org.xwiki.rendering.macro.rss.RssMacroParameters

      ## New:
      class org.xwiki.rendering.macro.rss.RssMacroParameters
  • Young API
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::deleteFilterPreference(java.lang.String) throws org.xwiki.notifications.NotificationException

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::deleteFilterPreference(org.xwiki.model.reference.DocumentReference, java.lang.String) throws org.xwiki.notifications.NotificationException
  • Young API
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::saveFilterPreferences(java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>)

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::saveFilterPreferences(org.xwiki.model.reference.DocumentReference, java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>)
  • Young API
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::setFilterPreferenceEnabled(java.lang.String, boolean) throws org.xwiki.notifications.NotificationException

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::setFilterPreferenceEnabled(org.xwiki.model.reference.DocumentReference, java.lang.String, boolean) throws org.xwiki.notifications.NotificationException
  • Young API
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::deleteFilterPreference(java.lang.String) throws org.xwiki.notifications.NotificationException

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::deleteFilterPreference(org.xwiki.model.reference.DocumentReference, java.lang.String) throws org.xwiki.notifications.NotificationException
  • Young API
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::saveFilterPreferences(java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>) throws org.xwiki.notifications.NotificationException

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::saveFilterPreferences(org.xwiki.model.reference.DocumentReference, java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>) throws org.xwiki.notifications.NotificationException
  • Young API
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::setFilterPreferenceEnabled(java.lang.String, boolean) throws org.xwiki.notifications.NotificationException

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::setFilterPreferenceEnabled(org.xwiki.model.reference.DocumentReference, java.lang.String, boolean) throws org.xwiki.notifications.NotificationException

Credits

The following people have contributed code and translations to this release (sorted alphabetically):

Adel Atallah
Alex Cotiugă
Alfons Soriano
Ecaterina Moraru (Valica)
Guillaume Delhumeau
Marius Dumitru Florea
Rostyslav Fitsyk
Sergiu Dumitriu
Simon Urli
slauriere
Thomas Mortagne
Vincent Massol
xrichard

Tags:
Created by Ecaterina Moraru (Valica) on 2018/12/07
   

Get Connected