/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    https://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.apache.grails.testing.latency

import groovy.transform.CompileStatic

import org.springframework.boot.autoconfigure.AutoConfiguration
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication
import org.springframework.boot.context.properties.EnableConfigurationProperties
import org.springframework.boot.web.servlet.FilterRegistrationBean
import org.springframework.context.annotation.Bean
import org.springframework.core.Ordered

/**
 * Auto-configuration that registers the {@link LatencyFilter} when
 * {@code grails.testing.latency.enabled} is {@code true}.
 * <p>
 * The filter is registered with the highest precedence so that the configured delay applies
 * to the entire request processing pipeline, mirroring what a slow network or server would
 * look like to an HTTP client or browser driving the application under test.
 *
 * @see LatencyProperties
 */
@CompileStatic
@AutoConfiguration
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
@ConditionalOnProperty(prefix = 'grails.testing.latency', name = 'enabled', havingValue = 'true')
@EnableConfigurationProperties(LatencyProperties)
class LatencyAutoConfiguration {

    @Bean
    FilterRegistrationBean<LatencyFilter> latencyFilter(LatencyProperties latencyProperties) {
        FilterRegistrationBean<LatencyFilter> registration = new FilterRegistrationBean<>()
        registration.filter = new LatencyFilter(latencyProperties)
        registration.urlPatterns = latencyProperties.urlPatterns
        registration.order = Ordered.HIGHEST_PRECEDENCE
        registration
    }
}
