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

This is mostly a release focusing on improving the new Notifications feature, in order to make it as polished and usable as possible before the end of the year (i.e. before the end of the Cycle and before we elect a new LTS release). It also contains several bug fixes.

New and Noteworthy (since XWiki 9.9)

Full list of issues fixed and Dashboard for 9.10.

For Users

Improved Notifications email layout

 
The email layout for notifications has been totally redesigned.

Improved Notifications UI

 
The notifications menu is more clear now, and a link to see what has changed is available in the details of each event, when you click on the date.

Filter users in notifications

 
You now have the ability to black list some users in the notifications you receive (by default you follow everyone).

For Admins

• Filesystem attachment improvements: A few of the long standing issues in the filesystem attachments storage have been fixed:

  • Deleted attachments are now available on the "Deleted Attachments" tab of the Page Index
  • The attachment porter script is not needed anymore (XWiki supports mixed attachment storage which means database attachment will stay in the database and keep working after changing the default store)
  • Various other bugfixes

For Developers

No changes!

Upgrades

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

• CSS4J 0.38
• httpclient 4.5.4
• Jetty 9.4.8.v20171121
• JGroups 4.0.8
• snakeyaml 1.19
• JSON-Java 20171018
• Aspectj 1.8.13
• Apache PDFBox 2.0.8
• cssparser 0.9.24
• JNR POSIX 3.0.42
• JNR FFI 2.1.7
• Jackson 2.9.2
• commons-compress 1.15
• commons-io 2.6
• commons-codec 1.11
• Apache Commons Lang 3.7
• ASM 6.0

Translations

The following translations have been updated: 

• French
• Czech
• Polish

Tested Browsers & Databases

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

	Browser	Test Result
	Google Chrome 62	Not Tested
	Mozilla Firefox 57	Not Tested
	Microsoft Edge 16	Jira Tickets Marked as Fixed in the Release Notes + New and Noteworthy Features
	Internet Explorer 11	Not Tested

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

	Database	Test Result
	HyperSQL	Not Tested
	MySQL 5.7	Not Tested
	Oracle 11.2	Not Tested
	PostgreSQL 10	Jira Tickets Marked as Fixed in the Release Notes + New and Noteworthy Features

Known issues

• Bugs we know about

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 9.10-rc-1

• XWiki#getURLContent() and XWiki#getURLContentAsBytes() now require Programming Rights. If you had wiki pages using those API, make sure that they are saved with a user having Programming Rights.

API Breakages

The following APIs were modified since XWiki 9.9:

• Young API
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method org.xwiki.notifications.filters.expression.ExpressionNode org.xwiki.notifications.filters.NotificationFilter::filterExpression(org.xwiki.model.reference.DocumentReference, org.xwiki.notifications.filters.NotificationFilterType)
    
    ## New:
    method org.xwiki.notifications.filters.expression.ExpressionNode org.xwiki.notifications.filters.NotificationFilter::filterExpression(org.xwiki.model.reference.DocumentReference, org.xwiki.notifications.filters.NotificationFilterType, org.xwiki.notifications.NotificationFormat)
• Young API
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method void org.xwiki.notifications.filters.watch.WatchedUserReference::<init>(java.lang.String)
    
    ## New:
    method void org.xwiki.notifications.filters.watch.WatchedUserReference::<init>(java.lang.String, org.xwiki.notifications.filters.internal.user.EventUserFilterPreferencesGetter)
• Young API
  • Violation type:
    java.method.addedToInterface
  • Code:
    ## Old:
    null
    
    ## New:
    method org.xwiki.eventstream.RecordableEventDescriptor org.xwiki.eventstream.RecordableEventDescriptorManager::getDescriptorForEventType(java.lang.String, boolean) throws org.xwiki.eventstream.EventStreamException
• Young API
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::generateEmailSubject(org.xwiki.notifications.CompositeEvent) throws org.xwiki.notifications.NotificationException
    
    ## New:
    method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::generateEmailSubject(org.xwiki.notifications.CompositeEvent, java.lang.String) throws org.xwiki.notifications.NotificationException
• Young API
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::renderHTML(org.xwiki.notifications.CompositeEvent) throws org.xwiki.notifications.NotificationException
    
    ## New:
    method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::renderHTML(org.xwiki.notifications.CompositeEvent, java.lang.String) throws org.xwiki.notifications.NotificationException
• Young API
  • Violation type:
    java.method.numberOfParametersChanged
  • Code:
    ## Old:
    method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::renderPlainText(org.xwiki.notifications.CompositeEvent) throws org.xwiki.notifications.NotificationException
    
    ## New:
    method java.lang.String org.xwiki.notifications.notifiers.email.NotificationEmailRenderer::renderPlainText(org.xwiki.notifications.CompositeEvent, java.lang.String) throws org.xwiki.notifications.NotificationException

Credits

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

Alex Cotiugă
Clément Aubin
Ecaterina Moraru (Valica)
Eduard Moraru
Marius Dumitru Florea
Thomas Mortagne
Vincent Massol