fixing Grails 5 config access (Accessing config through dot notation is deprecated)

davidkron · davidkron · commit c005a35347b6 · 2021-09-03T21:46:31.000+02:00
diff --git a/grails-app/services/grails/plugins/mail/MailService.groovy b/grails-app/services/grails/plugins/mail/MailService.groovy
@@ -35,13 +35,13 @@ class MailService implements InitializingBean, DisposableBean, GrailsConfigurati
 
     static transactional = false
 
-    Config configuration
+    MailConfig configuration
     MailMessageBuilderFactory mailMessageBuilderFactory
 	ThreadPoolExecutor mailExecutorService
 
 	private static final Integer DEFAULT_POOL_SIZE = 5
 
-    MailMessage sendMail(Config config, @DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = MailMessageBuilder) Closure callable) {
+    MailMessage sendMail(MailConfig config, @DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = MailMessageBuilder) Closure callable) {
         if (isDisabled()) {
             log.warn("Sending emails disabled by configuration option")
             return
@@ -55,20 +55,29 @@ class MailService implements InitializingBean, DisposableBean, GrailsConfigurati
         return messageBuilder.sendMessage(mailExecutorService)
     }
 
+	MailMessage sendMail(Config config, @DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = MailMessageBuilder) Closure callable) {
+		return sendMail(new MailConfig(config), callable)
+	}
+
     MailMessage sendMail(@DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = MailMessageBuilder) Closure callable) {
         return sendMail(configuration, callable)
     }
 
 
     boolean isDisabled() {
-        configuration.getProperty('grails.mail.disabled',Boolean, false)
+        configuration.disabled
     }
 
 	void setPoolSize(Integer poolSize){
 		mailExecutorService.setMaximumPoolSize(poolSize ?: DEFAULT_POOL_SIZE)
 		mailExecutorService.setCorePoolSize(poolSize ?: DEFAULT_POOL_SIZE)
 	}
 
+	@Override
+	void setConfiguration(Config config) {
+		configuration = new MailConfig(config)
+	}
+
 	@Override
 	public void destroy() throws Exception {
 		mailExecutorService.shutdown()
@@ -79,7 +88,7 @@ class MailService implements InitializingBean, DisposableBean, GrailsConfigurati
 	public void afterPropertiesSet() throws Exception {
 		mailExecutorService = new ThreadPoolExecutor(1, 1, 60, TimeUnit.SECONDS, new LinkedBlockingQueue<Runnable>())
 
-		Integer poolSize = configuration.getProperty('grails.mail.poolSize', Integer)
+		Integer poolSize = configuration.poolSize
 		try{
 			((ThreadPoolExecutor)mailExecutorService).allowCoreThreadTimeOut(true)
 		}catch(MissingMethodException e){
diff --git a/src/main/groovy/grails/plugins/mail/MailConfig.groovy b/src/main/groovy/grails/plugins/mail/MailConfig.groovy
@@ -0,0 +1,51 @@
+package grails.plugins.mail
+
+import grails.config.Config
+import groovy.transform.EqualsAndHashCode
+import org.grails.config.NavigableMap
+
+@EqualsAndHashCode
+class MailConfig {
+
+    final boolean disabled
+    final String overrideAddress
+    final String from
+    final String to
+
+    final Integer poolSize
+    final String encoding
+    final String jndiName
+    final String protocol
+    final String host
+    final Integer port
+    final String username
+    final String password
+    final Properties props
+
+    MailConfig(Config config) {
+        disabled = config.getProperty('grails.mail.disabled', Boolean, false)
+        overrideAddress = config.getProperty('grails.mail.overrideAddress')
+        from = config.getProperty('grails.mail.default.from')
+        to = config.getProperty('grails.mail.default.to')
+        poolSize = config.getProperty('grails.mail.poolSize', Integer)
+        encoding = config.getProperty('grails.mail.encoding')
+        jndiName = config.getProperty('grails.mail.jndiName')
+        protocol = config.getProperty('grails.mail.protocol')
+        host = config.getProperty('grails.mail.host')
+        port = config.getProperty('grails.mail.port', Integer)
+        username = config.getProperty('grails.mail.username')
+        password = config.getProperty('grails.mail.password')
+
+        Map props = config.getProperty('grails.mail.props', Map)
+        if (props != null) {
+            if (props instanceof NavigableMap) {
+                this.props = props.toProperties()
+            } else {
+                this.props = new Properties()
+                this.props.putAll(props)
+            }
+        } else {
+            this.props = null
+        }
+    }
+}
diff --git a/src/main/groovy/grails/plugins/mail/MailGrailsPlugin.groovy b/src/main/groovy/grails/plugins/mail/MailGrailsPlugin.groovy
@@ -68,13 +68,13 @@ sendMail {
     ]
 
     Integer mailConfigHash
-    ConfigObject mailConfig
+    MailConfig mailConfig
     boolean createdSession = false
 
 
      Closure doWithSpring() { 
         {->
-            mailConfig = grailsApplication.config.grails.mail
+            mailConfig = new MailConfig(grailsApplication.config)
             mailConfigHash = mailConfig.hashCode()
 
             configureMailSender(delegate, mailConfig)
@@ -93,7 +93,7 @@ sendMail {
 
 
     void onConfigChange(Map<String, Object> event) {
-        ConfigObject newMailConfig = event.source.grails.mail
+        MailConfig newMailConfig = new MailConfig(event.source)
         Integer newMailConfigHash = newMailConfig.hashCode()
 
         if (newMailConfigHash != mailConfigHash) {
@@ -114,7 +114,7 @@ sendMail {
         }
     }
 
-    def configureMailSender(builder, config) {
+    def configureMailSender(builder, MailConfig config) {
         builder.with {
             if (config.jndiName && !springConfig.containsBean("mailSession")) {
                 mailSession(JndiObjectFactoryBean) {
@@ -153,8 +153,8 @@ sendMail {
                     password = config.password
                 if (config.protocol)
                     protocol = config.protocol
-                if (config.props instanceof Map && config.props)
-                    javaMailProperties = config.props.toFlatConfig()
+                if (config.props)
+                    javaMailProperties = config.props
             }
         }
     }
diff --git a/src/main/groovy/grails/plugins/mail/MailMessageBuilder.groovy b/src/main/groovy/grails/plugins/mail/MailMessageBuilder.groovy
@@ -72,12 +72,16 @@ class MailMessageBuilder {
     }
 
     MailMessageBuilder(MailSender mailSender, Config config, MailMessageContentRenderer mailMessageContentRenderer = null) {
+        this(mailSender, new MailConfig(config), mailMessageContentRenderer)
+    }
+
+    MailMessageBuilder(MailSender mailSender, MailConfig config, MailMessageContentRenderer mailMessageContentRenderer = null) {
         this.mailSender = mailSender
         this.mailMessageContentRenderer = mailMessageContentRenderer
 
-        this.overrideAddress = config.getProperty('grails.mail.overrideAddress')
-        this.defaultFrom = overrideAddress ?: config.getProperty('grails.mail.default.from')
-        this.defaultTo = overrideAddress ?: config.getProperty('grails.mail.default.to')
+        this.overrideAddress = config.overrideAddress
+        this.defaultFrom = overrideAddress ?: config.from
+        this.defaultTo = overrideAddress ?: config.to
     }
 
     private MailMessage getMessage() {
diff --git a/src/main/groovy/grails/plugins/mail/MailMessageBuilderFactory.groovy b/src/main/groovy/grails/plugins/mail/MailMessageBuilderFactory.groovy
@@ -30,7 +30,7 @@ class MailMessageBuilderFactory {
     MailSender mailSender
     MailMessageContentRenderer mailMessageContentRenderer
 
-    MailMessageBuilder createBuilder(Config config) {
+    MailMessageBuilder createBuilder(MailConfig config) {
         new MailMessageBuilder(mailSender, config, mailMessageContentRenderer)
     }
 

Original file line number	Diff line number	Diff line change
`@@ -68,13 +68,13 @@ sendMail {`
`68`	`68`	`]`
`69`	`69`
`70`	`70`	`Integer mailConfigHash`
`71`		`- ConfigObject mailConfig`
	`71`	`+ MailConfig mailConfig`
`72`	`72`	`boolean createdSession = false`
`73`	`73`
`74`	`74`
`75`	`75`	`Closure doWithSpring() {`
`76`	`76`	`{->`
`77`		`- mailConfig = grailsApplication.config.grails.mail`
	`77`	`+ mailConfig = new MailConfig(grailsApplication.config)`
`78`	`78`	`mailConfigHash = mailConfig.hashCode()`
`79`	`79`
`80`	`80`	`configureMailSender(delegate, mailConfig)`
`@@ -93,7 +93,7 @@ sendMail {`
`93`	`93`
`94`	`94`
`95`	`95`	`void onConfigChange(Map<String, Object> event) {`
`96`		`- ConfigObject newMailConfig = event.source.grails.mail`
	`96`	`+ MailConfig newMailConfig = new MailConfig(event.source)`
`97`	`97`	`Integer newMailConfigHash = newMailConfig.hashCode()`
`98`	`98`
`99`	`99`	`if (newMailConfigHash != mailConfigHash) {`
`@@ -114,7 +114,7 @@ sendMail {`
`114`	`114`	`}`
`115`	`115`	`}`
`116`	`116`
`117`		`- def configureMailSender(builder, config) {`
	`117`	`+ def configureMailSender(builder, MailConfig config) {`
`118`	`118`	`builder.with {`
`119`	`119`	`if (config.jndiName && !springConfig.containsBean("mailSession")) {`
`120`	`120`	`mailSession(JndiObjectFactoryBean) {`
`@@ -153,8 +153,8 @@ sendMail {`
`153`	`153`	`password = config.password`
`154`	`154`	`if (config.protocol)`
`155`	`155`	`protocol = config.protocol`
`156`		`- if (config.props instanceof Map && config.props)`
`157`		`- javaMailProperties = config.props.toFlatConfig()`
	`156`	`+ if (config.props)`
	`157`	`+ javaMailProperties = config.props`
`158`	`158`	`}`
`159`	`159`	`}`
`160`	`160`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class MailMessageBuilderFactory {`
`30`	`30`	`MailSender mailSender`
`31`	`31`	`MailMessageContentRenderer mailMessageContentRenderer`
`32`	`32`
`33`		`- MailMessageBuilder createBuilder(Config config) {`
	`33`	`+ MailMessageBuilder createBuilder(MailConfig config) {`
`34`	`34`	`new MailMessageBuilder(mailSender, config, mailMessageContentRenderer)`
`35`	`35`	`}`
`36`	`36`