Release Notes for XWiki 13.9-rc-1

Last modified by Manuel Leduc on 2023/05/04

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 release introduces an experimental realtime Wiki editor (superseding the existing Realtime Collaborative Plain WikiText Editor contributed extension) and an experimental WYSIWYG editor (superseding the existing Visual Realtime Collaborative Editor contributed extension). They are not bundled yet in XWiki Standard but we plan to do this soon. For developers there's a new API available, called Netflux (superseding the existing Realtime Netflux Backend contributed extension), to write realtime-enabled extensions on top of XWiki.

The following regressions were introduced in this release (and found after it was released). Please check them out and if they impact you we recommend waiting to upgrade to a version where they are fixed.

New and Noteworthy (since XWiki 13.8)

Full list of issues fixed and Dashboard for 13.9.

For Users

Experimental Realtime Wiki Editor

 
We cleaned up the Realtime Collaborative Plain WikiText Editor contributed extension and integrated it in the XWiki platform. It's not bundled yet in XWiki Standard but you can still try it out by installing it and following the documentation page.

Experimental Realtime WYSIWYG Editor

 
We cleaned up the Visual Realtime Collaborative Editor contributed extension and integrated it in the XWiki platform. It's not bundled yet in XWiki Standard but you can still try it out by installing it and following the documentation page.

For Admins

No changes!

For Developers

Realtime Communication (Netflux)

 
The new Netflux module provides support for real-time WebSocket-based communication in XWiki by offering:

  • a script service and a REST resource to help create and retrieve communication channels.
  • a WebSocket server end-point used to join channels and to exchange channel or direct user messages.

This can be used along with the Netflux Client to implement realtime-enabled extensions on top of XWiki (e.g. a chat application).

Miscellaneous

  • New event query helper: SimpleEventQuery now have helpers to manipulate custom event properties. It's done by calling parameter() to "switch" the next comparison to be about custom parameters instead of standard Event fields. See Event Stream Module for more details.

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:

 BrowserTested on:
Chrome30.pngGoogle Chrome 95
IE30.pngInternet Explorer 11
Firefox30.pngMozilla Firefox 93Not Tested
Edge30.pngMicrosoft Edge 94Not Tested
Safari30.pngSafari 14Not Tested

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

 DatabaseTested on:
hypersql.pngHyperSQL 2.5.2Not Tested
mariadb.pngMariaDB 10.6Not Tested
postgresql.pngPostgreSQL 14
mysql.pngMySQL 8
oracle.pngOracle 19cNot Tested

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

 Servlet ContainerTested on:
tomcat-icon.pngTomcat 9.0.54
jetty-icon.pngJetty 9.4.29 (XWiki Standalone packaging)
jetty-icon.pngJetty 9.4.29Not 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 13.8:

Unknown Criticality

These violationq are missing a criticality and need to be fixed.

  • Not a breakage
    • Violation type:
      java.class.noLongerInheritsFromClass
    • Code:
      ## Old:
      class org.xwiki.crypto.script.ScriptingCertificateStore

      ## New:
      class org.xwiki.crypto.script.ScriptingCertificateStore
  • Not a breakage
    • Violation type:
      java.class.nonFinalClassInheritsFromNewClass
    • Code:
      ## Old:
      class org.xwiki.crypto.script.ScriptingCertificateStore

      ## New:
      class org.xwiki.crypto.script.ScriptingCertificateStore
  • Not a breakage
    • Violation type:
      java.class.noLongerInheritsFromClass
    • Code:
      ## Old:
      class org.xwiki.crypto.script.ScriptingKeyStore

      ## New:
      class org.xwiki.crypto.script.ScriptingKeyStore
  • Not a breakage
    • Violation type:
      java.class.nonFinalClassInheritsFromNewClass
    • Code:
      ## Old:
      class org.xwiki.crypto.script.ScriptingKeyStore

      ## New:
      class org.xwiki.crypto.script.ScriptingKeyStore

Credits

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

  • Jarle Sandmo
  • Lavinia Florean
  • Manuel Leduc
  • Marius Dumitru Florea
  • Michael Hamann
  • Simon Urli
  • Thomas Mortagne
  • Vincent Massol
  • xrichard

Get Connected