Merge pull request #8 from grails-plugins/more-feedback

Use auto-configuration and config properties

Author: jdaugherty

docs/src/docs/configuration.adoc

@@ -9,7 +9,7 @@ This ensures that performance timing information is available during development
 
 === Configuration Options
 
-All configuration options are specified in your `application.yml` or `application.groovy` file under the `grails.plugins.servertiming` namespace.
+All configuration options are specified in your `application.yml` or `application.groovy` file under the `grails.plugins.serverTiming` namespace.
 
 ==== Enabling/Disabling the Plugin
 

plugin/grails-app/controllers/org/grails/plugins/servertiming/ServerTimingInterceptor.groovy

@@ -1,9 +1,14 @@
 package org.grails.plugins.servertiming
 
 import groovy.transform.CompileStatic
+import groovy.util.logging.Slf4j
+
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.core.env.Environment
 
 import grails.artefact.Interceptor
-import groovy.util.logging.Slf4j
+import org.grails.plugins.servertiming.config.EnabledCondition
+import org.grails.plugins.servertiming.config.ServerTimingConfig
 import org.grails.plugins.servertiming.core.TimingMetric
 
 /**
@@ -14,15 +19,18 @@ import org.grails.plugins.servertiming.core.TimingMetric
 @CompileStatic
 class ServerTimingInterceptor implements Interceptor {
 
-    String metricKey = ServerTimingUtils.instance.metricKey
+    private String metricKey
 
-    ServerTimingInterceptor() {
-        if (ServerTimingUtils.instance.enabled) {
+    @Autowired
+    ServerTimingInterceptor(Environment env, ServerTimingConfig config) {
+        if (EnabledCondition.matches(env)) {
             log.debug("Server Timing metrics are enabled. Set 'grails.plugins.serverTiming.enabled' to false to disable them.")
             matchAll()
         } else {
             log.debug("Server Timing metrics are disabled. Set 'grails.plugins.serverTiming.enabled' to true to enable them.")
         }
+
+        metricKey = config.metricKey
     }
 
     @Override

plugin/src/main/groovy/org/grails/plugins/servertiming/ServerTimingAutoConfiguration.groovy

@@ -0,0 +1,54 @@
+package org.grails.plugins.servertiming
+
+import groovy.transform.CompileStatic
+import groovy.util.logging.Slf4j
+
+import org.springframework.boot.autoconfigure.AutoConfiguration
+import org.springframework.boot.context.event.ApplicationReadyEvent
+import org.springframework.boot.context.properties.EnableConfigurationProperties
+import org.springframework.boot.web.servlet.FilterRegistrationBean
+import org.springframework.context.ApplicationListener
+import org.springframework.context.ConfigurableApplicationContext
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Conditional
+import org.springframework.context.annotation.Configuration
+import org.springframework.core.Ordered
+
+import org.grails.plugins.servertiming.config.EnabledCondition
+import org.grails.plugins.servertiming.config.ServerTimingConfig
+
+@Slf4j
+@CompileStatic
+@AutoConfiguration
+@Configuration(proxyBeanMethods = false)
+@EnableConfigurationProperties(ServerTimingConfig)
+class ServerTimingAutoConfiguration {
+
+    @Bean
+    @Conditional(EnabledCondition)
+    ServerTimingFilter serverTimingFilter() {
+        new ServerTimingFilter()
+    }
+
+    @Bean
+    @Conditional(EnabledCondition)
+    FilterRegistrationBean<ServerTimingFilter> serverTimingFilterRegistration(ServerTimingFilter serverTimingFilter) {
+        new FilterRegistrationBean<ServerTimingFilter>().tap {
+            filter = serverTimingFilter
+            urlPatterns = ['/*']
+            order = Ordered.HIGHEST_PRECEDENCE + 100
+            name = 'serverTimingFilter'
+        }
+    }
+
+    @Bean
+    ApplicationListener<ApplicationReadyEvent> serverTimingAutoConfigLogger(ConfigurableApplicationContext context) {
+        { event ->
+            def applied = !context.getBeanProvider(ServerTimingFilter).stream().findAny().empty
+            def message = applied ?
+                    'Applying {} plugin' :
+                    '{} plugin is disabled. Set \'grails.plugins.serverTiming.enabled\' to true to enable it.'
+            log.debug(message, ServerTimingGrailsPlugin.pluginName)
+        } as ApplicationListener
+    }
+}

plugin/src/main/groovy/org/grails/plugins/servertiming/ServerTimingFilter.groovy

@@ -2,6 +2,7 @@ package org.grails.plugins.servertiming
 
 import groovy.transform.CompileStatic
 import groovy.util.logging.Slf4j
+
 import jakarta.servlet.Filter
 import jakarta.servlet.FilterChain
 import jakarta.servlet.FilterConfig
@@ -10,9 +11,13 @@ import jakarta.servlet.ServletRequest
 import jakarta.servlet.ServletResponse
 import jakarta.servlet.http.HttpServletRequest
 import jakarta.servlet.http.HttpServletResponse
-import org.grails.plugins.servertiming.core.TimingMetric
+
+import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.core.Ordered
 
+import org.grails.plugins.servertiming.config.ServerTimingConfig
+import org.grails.plugins.servertiming.core.TimingMetric
+
 /**
  * A Servlet Filter that wraps responses to ensure Server Timing headers are added to HTTP responses.
  *
@@ -25,11 +30,14 @@ import org.springframework.core.Ordered
 @CompileStatic
 class ServerTimingFilter implements Filter, Ordered {
 
+    @Autowired
+    ServerTimingConfig config
+
     private String metricKey
 
     @Override
     void init(FilterConfig filterConfig) throws ServletException {
-        metricKey = ServerTimingUtils.instance.metricKey
+        metricKey = config.metricKey
     }
 
     @Override

plugin/src/main/groovy/org/grails/plugins/servertiming/ServerTimingGrailsPlugin.groovy

@@ -1,9 +1,8 @@
 package org.grails.plugins.servertiming
 
-import grails.plugins.Plugin
 import groovy.util.logging.Slf4j
-import org.springframework.boot.web.servlet.FilterRegistrationBean
-import org.springframework.core.Ordered
+
+import grails.plugins.Plugin
 
 /**
  * Grails plugin that provides Server Timing header support for HTTP responses.
@@ -26,16 +25,17 @@ import org.springframework.core.Ordered
  * </ul>
  *
  * @see ServerTimingFilter
- * @see ServerTimingUtils
  */
 @Slf4j
 class ServerTimingGrailsPlugin extends Plugin {
 
+    static final pluginName = 'Server Timing'
+
     /** Minimum Grails version required for this plugin */
     def grailsVersion = '7.0.0  > *'
 
     /** Plugin title */
-    def title = 'Server Timing'
+    def title = pluginName
 
     /** Plugin author */
     def author = 'James Daugherty'
@@ -51,45 +51,4 @@ class ServerTimingGrailsPlugin extends Plugin {
 
     /** Source control management information */
     def scm = [url: 'https://github.com/grails-plugins/grails-server-timing']
-
-    /**
-     * Registers Spring beans for the Server Timing functionality.
-     *
-     * <p>When the plugin is enabled, this method registers:</p>
-     * <ul>
-     *   <li><strong>serverTimingFilter</strong> - The {@link ServerTimingFilter} bean</li>
-     *   <li><strong>serverTimingFilterRegistration</strong> - A {@link FilterRegistrationBean}
-     *       that configures the filter to intercept all requests</li>
-     * </ul>
-     *
-     * @return a closure that defines the Spring bean configuration
-     */
-    Closure doWithSpring() {
-        { ->
-            if (ServerTimingUtils.instance.enabled) {
-                serverTimingFilter(ServerTimingFilter)
-
-                serverTimingFilterRegistration(FilterRegistrationBean) {
-                    filter = ref('serverTimingFilter')
-                    urlPatterns = ['/*']
-                    order = Ordered.HIGHEST_PRECEDENCE + 100
-                    name = 'serverTimingFilter'
-                }
-            }
-        }
-    }
-
-    /**
-     * Performs initialization tasks after the Spring application context is available.
-     *
-     * <p>Logs whether the plugin is enabled or disabled based on the configuration.</p>
-     */
-    @Override
-    void doWithApplicationContext() {
-        if (ServerTimingUtils.instance.enabled) {
-            log.debug('Applying {} plugin', title)
-        } else {
-            log.debug('{} plugin is disabled. Set \'grails.plugins.serverTiming.enabled\' to true to enable it.', title)
-        }
-    }
 }

plugin/src/main/groovy/org/grails/plugins/servertiming/ServerTimingUtils.groovy

@@ -0,0 +1,25 @@
+package org.grails.plugins.servertiming.config
+
+import groovy.transform.CompileStatic
+
+import org.springframework.context.annotation.Condition
+import org.springframework.context.annotation.ConditionContext
+import org.springframework.core.env.Environment
+import org.springframework.core.type.AnnotatedTypeMetadata
+
+@CompileStatic
+class EnabledCondition implements Condition {
+
+    @Override
+    boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
+        matches(context.environment)
+    }
+
+    static boolean matches(Environment env) {
+        def explicitConfigValue = env.getProperty('grails.plugins.server-timing.enabled', Boolean, null)
+        if (explicitConfigValue != null && explicitConfigValue == false) {
+            return false
+        }
+        explicitConfigValue || env.matchesProfiles('development', 'test')
+    }
+}

plugin/src/main/groovy/org/grails/plugins/servertiming/config/EnabledCondition.groovy

@@ -0,0 +1,14 @@
+package org.grails.plugins.servertiming.config
+
+import groovy.transform.CompileStatic
+
+import org.springframework.boot.context.properties.ConfigurationProperties
+
+@CompileStatic
+@ConfigurationProperties('grails.plugins.server-timing')
+class ServerTimingConfig {
+
+    Boolean enabled = null
+    String metricKey = 'GrailsServerTiming'
+
+}

plugin/src/main/groovy/org/grails/plugins/servertiming/config/ServerTimingConfig.groovy

@@ -0,0 +1 @@
+org.grails.plugins.servertiming.ServerTimingAutoConfiguration

plugin/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -0,0 +1,15 @@
+{
+  "properties": [
+    {
+      "name": "grails.plugins.server-timing.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Whether Server Timing is enabled. If not set, resolves to true in development and test, false in production"
+    },
+    {
+      "name": "grails.plugins.server-timing.metric-key",
+      "type": "java.lang.String",
+      "description": "Request attribute key for storing metrics. Change only if you have a naming conflict.",
+      "defaultValue": "GrailsServerTiming"
+    }
+  ]
+}