ScriptRunner for Confluence now features autocomplete for CQL! This feature will dynamically show query options when you type a CQL query in Enhanced Search.
Groovy 4 update
We have updated ScriptRunner for Confluence Server/Data Center to Groovy 4!
Our primary motivator for this update is to provide support for JDK 17. Groovy 3 doesn't support JDK 17, and with Jira 9.5.0 and Confluence 8.0 being JDK 17 compatible, an upgrade to Groovy 4 is necessary.
So, apart from JDK 17 compatibility, what comes with this update, and how will it benefit you?
New features in Groovy 4
The following are the most significant new features that have been added in Groovy 4 :
- Switch expressions which, unlike switch statements, are optimized towards branches that handle one case and break out rather than fall through to the next case.
- Sealed types
- Ranges have been enhanced with support for ranges open on the left, for example,
3<..5, or both sides, for example,
- Support for annotating generic types, for example
List<@IntRange(min = 0, max = 10) Integer>
Please have a look at the Groovy 4 Release Notes for a complete list of new features.
Breaking changes in Groovy 4
Groovy 4 contains a number of breaking changes. The ones which are the most significant and likely to affect ScriptRunner users are listed below. Please have a look at the Groovy 4 Release Notes for a complete list of breaking changes.
1) Legacy package removal
Groovy 3 provided duplicate versions of numerous classes (in old and new packages) to allow Groovy users to migrate towards the new JPMS-compliant package names - see the section about it in Groovy 3 Release Notes for more details. Groovy 4 no longer provides duplicate legacy classes.
For backwards compatibility reasons ScriptRunner still ships with the deprecated version of
groovy.xml.XmlParser. We recommend you don't use these legacy classes going forward and use their equivalents that can be found in
2) Changes related to how Groovy code accesses private fields from within closures
Groovy developers are currently attempting to improve how its code accesses private fields in certain scenarios where such access is expected but problematic. For example, within closure definitions where subclasses or inner classes are involved (GROOVY-5438). You may notice breakages in Groovy 4 code in such scenarios until they fix this issue.
3) Change to
intersect() default Groovy method
intersect() default Groovy method used to draw elements from the second argument passed to it, but now it draws elements from the first argument passed to it - see GROOVY-10275.
4) Changes to the resolution of properties with both a getter and isser returning different types
This Breaking Change will mostly affect Jira API users, but it could affect uncommon parts of the Confluence API. We do not expect this issue to be widespread when using ScriptRunner for Confluence.
We've included information about a common example in the Jira API that you could use to solve issues you uncover when working with uncommon parts of the Confluence API.
An isser is a method to retrieve boolean properties. Instead of the method name starting with
For properties that have a getter and an isser returning different types (for example, JiraAuthenticationContext#getLoggedInUser and JiraAuthenticationContext#isLoggedInUser) when accessing the property, instead of calling one of the methods (for example,
From Groovy 4 if you have custom classes, or are using external classes that implement conflicting isser and getter methods, and you are using the property syntax to get the getter value, you must re-write the logic to use the getter method directly.
For example, this class demonstrates conflicting isser and getter methods:
From Groovy 4, this should be written as:
For backward compatibility reasons, ScriptRunner ships with a patch to keep the old Groovy 3 behaviour for two conflicting Jira API properties commonly used in customer scripts:
We've included this patch as these properties will likely be heavily used in users' scripts. This means you do not need to change any code using these properties
Important notice for Java 17 users
There is a current omission in the Confluence archive that may cause compatibility issues with Java 17. You need to manually add the following JVM flag to avoid these issues:
See Atlassian’s knowledge base guide on configuring system properties for information on how to configure system properties and therefore add the JVM flag.
These flags are required to address module encapsulation introduced in Java 9 and later, which can cause issues when using reflection or accessing certain internal APIs. We are working closely with Atlassian to address this issue in future releases.
Deprecated SrSpecification class removed
Authors of script plugins may be used to writing tests which extend the deprecated
com.onresolve.scriptrunner.canned.common.admin.SrSpecification class. This class has been removed. Authors of tests for their scripts should extend the
spock.lang.Specification class directly. Tests should still be picked up by Test Runner built-in script as normal.