Grails

Immutable class from plugin fails to compile on first try, succeeds afterwards

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Critical Critical
  • Resolution: Fixed
  • Affects Version/s: 1.3.6
  • Fix Version/s: 2.0-M2
  • Component/s: Plugins
  • Labels:
    None
  • Testcase included:
    yes

Description

When a plugin contains an Immutable class (annotated with @Immutable), an application with this plugin installed sometimes fails to compile, giving this stacktrace:

[groovyc] org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed:
[groovyc] General error during canonicalization: Explicit constructors not allowed for @Immutable class: ImmutableExample
[groovyc]
[groovyc] java.lang.RuntimeException: Explicit constructors not allowed for @Immutable class: ImmutableExample
[groovyc] at org.codehaus.groovy.transform.ImmutableASTTransformation.createConstructor(ImmutableASTTransformation.java:308)
[groovyc] at org.codehaus.groovy.transform.ImmutableASTTransformation.visit(ImmutableASTTransformation.java:117)
[groovyc] at org.codehaus.groovy.transform.ASTTransformationVisitor.visitClass(ASTTransformationVisitor.java:129)
...

This only happens the first time you compile the application, and only when another plugin is also installed. I have been able to reproduce it with the shiro plugin and with the spring-security-core plugin.

Steps to reproduce:

1. create a new plugin 'immutable-bug-plugin'
2. in this plugin, create a Groovy class 'ImmutableExample', annotated with @Immutable. The class should be under src/groovy
3. in this same plugin, create a service, 'ImmutableService'. In a service method, a new instance of the ImmutableExample class should be created, for example: def example = new ImmutableExample('hello', 'world')
4. create a new application 'immutable-bug-demo'
5. in the BuildConfig, add an inline dependency to the plugin you just created: grails.plugin.location.'immutable-bug-plugin'='../immutable-bug-plugin'
6. install the shiro plugin in the application
7. execute 'grails run-app': the compilation will fail
8. execute 'grails run-app' again: the compilation will succeed

A sample plugin and application was attached to this issue.

Issue Links

depends on

Task - A task that needs to be done. GRAILS-7981 Upgrade to Groovy 1.8.2

  • Blocker - Blocks development and/or testing work, production could not run.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Goran Ehrsson added a comment -

I also got hit by this strange problem today.
Plugin-A contains an immutable class:

@Immutable
final class MessageKey implements Serializable {
    Integer tenant
    String code
    Locale locale
}

Plugin-B has an inline dependency on Plugin-A

grails.plugin.location.'plugin-a'="../plugin-a"

grails 'clean' followed by 'run-app' in Plugin-B gives the above exception. Repeated 'run-app' still gives the exception.

However 'clean' followed by 'compile' followed by 'run-app' works.

I was under the impression that 'run-app' did a 'compile' automatically.

I'm using Grails 1.3.6

Show
Goran Ehrsson added a comment - I also got hit by this strange problem today. Plugin-A contains an immutable class: @Immutable final class MessageKey implements Serializable { Integer tenant String code Locale locale } Plugin-B has an inline dependency on Plugin-A grails.plugin.location.'plugin-a'="../plugin-a" grails 'clean' followed by 'run-app' in Plugin-B gives the above exception. Repeated 'run-app' still gives the exception. However 'clean' followed by 'compile' followed by 'run-app' works. I was under the impression that 'run-app' did a 'compile' automatically. I'm using Grails 1.3.6
Hide
Permalink
Goran Ehrsson added a comment -

This is reproducable every time. I'm on Grails 1.3.7 now and this is very annoying.

Show
Goran Ehrsson added a comment - This is reproducable every time. I'm on Grails 1.3.7 now and this is very annoying.
Hide
Permalink
Jurgen Lust added a comment -

This is also affecting the Spring Security Core plugin: when a Groovy class is annotated with @Immutable in a plugin, then the following Exception is thrown when trying to access a secure url in an application using this plugin:

> A NullPointerException is thrown at
> at org.codehaus.groovy.grails.plugins.springsecurity.SpringSecurityUtils.isAjax(SpringSecurityUtils.java:299)

Checking the source code, I noticed that this is caused by the fact that

> ReflectionUtils.getConfigProperty("ajaxHeader");

returns null. So I started experimenting a little bit in the Bootstrap.groovy, and digging through the source code of the Spring Security Core plugin.

ReflectionUtils.getConfigProperty(name) looks like this:

> def value = SpringSecurityUtils.securityConfig
> for (String part in name.split('
.'))

{ > value = value."$part" > }
> value
>

So I tried calling both this method, and a copy of its body in Bootstrap.groovy:

> def value = SpringSecurityUtils.securityConfig
> for (String part in "ajaxHeader".split('
.')) {> value = value."$part"> }

> println value
> println ReflectionUtils.getConfigProperty("ajaxHeader")
>

The result was this:

> X-Requested-With
> null
>

So, calling the copy of the method body gave me the correct result, while calling the static method itself returned null.

Removing the @Immutable annotation solves the problem.

I'm using Grails 1.3.7 and spring-security-core 1.1.2

Show
Jurgen Lust added a comment - This is also affecting the Spring Security Core plugin: when a Groovy class is annotated with @Immutable in a plugin, then the following Exception is thrown when trying to access a secure url in an application using this plugin: > A NullPointerException is thrown at > at org.codehaus.groovy.grails.plugins.springsecurity.SpringSecurityUtils.isAjax(SpringSecurityUtils.java:299) Checking the source code, I noticed that this is caused by the fact that > ReflectionUtils.getConfigProperty("ajaxHeader"); returns null. So I started experimenting a little bit in the Bootstrap.groovy, and digging through the source code of the Spring Security Core plugin. ReflectionUtils.getConfigProperty(name) looks like this: > def value = SpringSecurityUtils.securityConfig > for (String part in name.split(' .')) { > value = value."$part" > } > value > So I tried calling both this method, and a copy of its body in Bootstrap.groovy: > def value = SpringSecurityUtils.securityConfig > for (String part in "ajaxHeader".split(' .')) {> value = value."$part"> } > println value > println ReflectionUtils.getConfigProperty("ajaxHeader") > The result was this: > X-Requested-With > null > So, calling the copy of the method body gave me the correct result, while calling the static method itself returned null. Removing the @Immutable annotation solves the problem. I'm using Grails 1.3.7 and spring-security-core 1.1.2
Hide
Permalink
Enrique Medina Montenegro added a comment -

Jurgen,

Is removing the @Immutable annotation a workaround so far?

Which exact classes in Spring Security need to have that annotation removed?

Thanks.

Show
Enrique Medina Montenegro added a comment - Jurgen, Is removing the @Immutable annotation a workaround so far? Which exact classes in Spring Security need to have that annotation removed? Thanks.
Hide
Permalink
Sami Mäkelä added a comment -

I have the same scenario:

  • Foo -class annotated with Immutable under src/groovy
  • Bar -service that uses Foo -class

-> Compilation of the plugin fails to the same exception

Show
Sami Mäkelä added a comment - I have the same scenario: Foo -class annotated with Immutable under src/groovy Bar -service that uses Foo -class -> Compilation of the plugin fails to the same exception
Hide
Permalink
Ewan Dawson added a comment -

I'm seeing the same problem, this time with an @Immutable class under grails-app/routes (I'm using the routing plugin).

Show
Ewan Dawson added a comment - I'm seeing the same problem, this time with an @Immutable class under grails-app/routes (I'm using the routing plugin).
Hide
Permalink
Graeme Rocher added a comment -

Caused by http://jira.codehaus.org/browse/GROOVY-4825

Show
Graeme Rocher added a comment - Caused by http://jira.codehaus.org/browse/GROOVY-4825
Hide
Permalink
Paul King added a comment -

Please try out the jar here to see if it fixes your problem:
http://snapshots.repository.codehaus.org/org/codehaus/groovy/groovy-all/1.7.11-SNAPSHOT/

Show
Paul King added a comment - Please try out the jar here to see if it fixes your problem: http://snapshots.repository.codehaus.org/org/codehaus/groovy/groovy-all/1.7.11-SNAPSHOT/

People

  • Assignee:
    Unassigned
    Reporter:
    Jurgen Lust
Vote (4)
Watch (5)

Dates

  • Created:
    Updated:
    Resolved: