Static type checking (STC) provides information about whether your script is correctly written.
Groovy is a dynamic language, which means that method and property names are looked up when your code is run, not when it’s compiled (like Java).
Let’s look at the following simple, but complete, script:
We call the method
bar() on the object
foo. This script compiles without errors, but you get a
MissingPropertyExceptionwhen you run the script because
foo hasn’t been defined. This behaviour is useful because there are circumstances that could make this code execute successfully, like an object called
foo or a closure
getFoo() being passed to the script’s binding.
Although Groovy is a dynamic language, we can compile scripts in a manner that checks method and property references at compilation. The STC feature shows you problems in your scripts when you are writing them, as opposed to when they execute.
When your scripts are executed, they are always compiled dynamically. When they are compiled for the STC, the resulting generated bytecode is thrown away.
There are limitations to the type checker. It is possible to write code that shows errors, but it is valid and executes fine. Some of these situations are:
Using certain builders
Using closures where the parameter types can’t be inferred
However, if you write code like this, you probably use an IDE, which does not work with the STC.
Additionally, your code could have runtime errors that won’t be found until the code executes.
If we were writing a condition where we wanted to check the number of issues returned from a search is zero, we might inadvertently write:
boolean empty = isssues.total = 0
STC is telling us that we are trying to set the total, rather than retrieve it. We meant to use the
boolean empty = isssues.total == 0
Code areas will show a green dot, which tells us that the code is syntactically correct, and the methods and properties have been checked.
STC in the cloud will provide additional help for the script context, ensuring that properties access matches the JSON Schema provided by Atlassian.