Release Notes for XWiki 10.3

Last modified by Thomas Mortagne on 2021/08/30

Contrary to what was announced attachments content are still located in the database by default. The default have been moved to "file" in 10.5RC1.

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.

In this version you will automatically get a notification when changes are made to pages you worked on. It also introduces the protection against editing pages coming from extensions to avoid crashing errors and ease upgrades.

This release contains a bug that can affect the scalability of the service. Until the proper fix, it is highly recommended to make sure that the "autowatch" feature of the notifications is turned off. Note that starting with XWiki 10.7 (10.7RC1 to be precise), "autowatch" is turned off by default.
 
You can do that by adding in the xwiki.properties file the following lines:

# Disable autowatch until the following issue is fixed:
# https://jira.xwiki.org/browse/XWIKI-15445
xwiki.plugin.watchlist.automaticwatch=none

New and Noteworthy (since XWiki 10.2)

Full list of issues fixed and Dashboard for 10.3.

For Users

Edit protection

 
As with delete and rename operations, if a user tries to modify a page belonging to an Extension, a warning will be displayed to explain that it's very risky and it should be avoided.

10.4 will introduce configuration that helps the user have more control on this behavior (disable edit completely without even a warning, allow a user to hide this warning, etc.).

Auto Notifications on changes

 
Thanks to an improvement to the AutoWatch feature of the notifications, users now get notified on changes done to pages they previously edited.

For Admins

No changes!

For Developers

New document type in XAR extensions

 
It's now possible to indicate a type for each entry in a XAR extension. The type indicates what actions are allowed for a document once it's installed (edit, delete) and how it should be handled during upgrade (merge, skip, overwrite, etc.). See XAR package format for more details about this new property.

Priority between Notification Filters

 
Notifications Filter has now a getPriority() method, to handle advanced use-cases when a filter needs to have priority over some others.

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: 

Tested Browsers & Databases

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

BrowserTest Result
Chrome30.pngGoogle Chrome 66Not Tested
Firefox30.pngMozilla Firefox 59Not Tested
Edge30.pngMicrosoft Edge 16Not Tested
IE30.pngInternet Explorer 11Jira Tickets Marked as Fixed in the Release Notes + New and Noteworthy Features

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

DatabaseTest Result
hypersql.pngHyperSQLNot Tested
mysql.pngMySQL 5.7Not Tested
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 10Jira Tickets Marked as Fixed in the Release Notes + New and Noteworthy Features

Known issues

Backward Compatibility and Migration Notes

General Notes

When upgrading make sure you compare your xwiki.cfg, xwiki.properties and web.xml files with the newest version since some configuration parameters may have been modified or added. Note that you should add xwiki.store.migration=1 so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.

Issues specific to XWiki 10.3

Filesystem storage by default for deleted attachments and documents

New deleted attachments and documents will now be stored in the filesystem by default. If you really don't want that you can go to xwiki.cfg and set hibernate value for all the properties in the section Stores with both "hibernate" and "file" support in XWiki Standard..

Note that existing deleted attachments or documents are not moved to filesystem but keep working since XWiki now supports mixed storage for those. So if you don't want to place any deleted attachment/document on the filesystem store make sure to move the configuration to "hibernate" before executing the Distribution Wizard.

Warning when editing a page

10.3 introduces edit protection for standard pages but also indicates which page is OK to edit. In 10.3 most pages are protected (it's the default). If you get a warning on what should be a valid page don't hesitate to report it since we are still tuning this feature.

API Breakages

The following APIs were modified since XWiki 10.2:

  • Young API
    • Violation type:
      java.method.returnTypeChanged
    • Code:
      ## Old:
      method boolean org.xwiki.notifications.filters.NotificationFilter::filterEvent(org.xwiki.eventstream.Event, org.xwiki.model.reference.DocumentReference, org.xwiki.notifications.NotificationFormat)

      ## New:
      method org.xwiki.notifications.filters.NotificationFilter.FilterPolicy org.xwiki.notifications.filters.NotificationFilter::filterEvent(org.xwiki.eventstream.Event, org.xwiki.model.reference.DocumentReference, org.xwiki.notifications.NotificationFormat)

Credits

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

  • Alex Cotiugă
  • Clemens Klein-Robbenhaar
  • Clément Aubin
  • Ecaterina Moraru (Valica)
  • Eduard Moraru
  • Guillaume Delhumeau
  • Marc Sladek
  • Marius Dumitru Florea
  • Thomas Mortagne
  • Vincent Massol
Tags:
   

Get Connected