Merge pull request eugenp#5520 from rockoder/zuul_throttling

Zuul throttling
khacdinh · Nov 3, 2018 · ea52c02 · ea52c02
2 parents df8158a + 6f87196
commit ea52c02
Show file tree

Hide file tree

Showing 5 changed files with 250 additions and 0 deletions.
diff --git a/spring-cloud/spring-cloud-zuul-ratelimit/pom.xml b/spring-cloud/spring-cloud-zuul-ratelimit/pom.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+
+	<groupId>com.baeldung.spring.cloud</groupId>
+	<artifactId>spring-cloud-zuul-ratelimit</artifactId>
+	<version>0.0.1-SNAPSHOT</version>
+	<packaging>jar</packaging>
+
+	<name>spring-cloud-zuul-ratelimit</name>
+	<description>Demo project for Spring Boot</description>
+
+	<parent>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-starter-parent</artifactId>
+		<version>2.0.6.RELEASE</version>
+		<relativePath/> <!-- lookup parent from repository -->
+	</parent>
+
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+		<java.version>1.8</java.version>
+		<spring-cloud.version>Finchley.SR1</spring-cloud.version>
+	</properties>
+
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>com.marcosbarbero.cloud</groupId>
+			<artifactId>spring-cloud-zuul-ratelimit</artifactId>
+			<version>2.2.0.RELEASE</version>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-data-jpa</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>com.h2database</groupId>
+			<artifactId>h2</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.springframework.cloud</groupId>
+				<artifactId>spring-cloud-dependencies</artifactId>
+				<version>${spring-cloud.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-maven-plugin</artifactId>
+			</plugin>
+		</plugins>
+	</build>
+
+
+</project>
diff --git a/...c/main/java/com/baeldung/spring/cloud/zuulratelimitdemo/ZuulRatelimitDemoApplication.java b/...c/main/java/com/baeldung/spring/cloud/zuulratelimitdemo/ZuulRatelimitDemoApplication.java
@@ -0,0 +1,14 @@
+package com.baeldung.spring.cloud.zuulratelimitdemo;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.cloud.client.SpringCloudApplication;
+import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
+
+@EnableZuulProxy
+@SpringCloudApplication
+public class ZuulRatelimitDemoApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(ZuulRatelimitDemoApplication.class, args);
+    }
+}
diff --git a/.../main/java/com/baeldung/spring/cloud/zuulratelimitdemo/controller/GreetingController.java b/.../main/java/com/baeldung/spring/cloud/zuulratelimitdemo/controller/GreetingController.java
@@ -0,0 +1,21 @@
+package com.baeldung.spring.cloud.zuulratelimitdemo.controller;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+
+@Controller
+@RequestMapping("/greeting")
+public class GreetingController {
+
+    @GetMapping("/simple")
+    public ResponseEntity<String> getSimple() {
+        return ResponseEntity.ok("Hi!");
+    }
+
+    @GetMapping("/advanced")
+    public ResponseEntity<String> getAdvanced() {
+        return ResponseEntity.ok("Hello, how you doing?");
+    }
+}
diff --git a/spring-cloud/spring-cloud-zuul-ratelimit/src/main/resources/application.yml b/spring-cloud/spring-cloud-zuul-ratelimit/src/main/resources/application.yml
@@ -0,0 +1,23 @@
+zuul:
+  routes:
+    serviceSimple:
+      path: /greeting/simple
+      url: forward:/
+    serviceAdvanced:
+      path: /greeting/advanced
+      url: forward:/
+  ratelimit:
+    enabled: true
+    repository: JPA
+    policy-list:
+      serviceSimple:
+      - limit: 5
+        refresh-interval: 60
+        type:
+        - origin
+      serviceAdvanced:
+      - limit: 1
+        refresh-interval: 2
+        type:
+        - origin
+  strip-prefix: true
diff --git a/...t/java/com/baeldung/spring/cloud/zuulratelimitdemo/controller/GreetingControllerTest.java b/...t/java/com/baeldung/spring/cloud/zuulratelimitdemo/controller/GreetingControllerTest.java
@@ -0,0 +1,112 @@
+package com.baeldung.spring.cloud.zuulratelimitdemo.controller;
+
+import static com.marcosbarbero.cloud.autoconfigure.zuul.ratelimit.support.RateLimitConstants.HEADER_LIMIT;
+import static com.marcosbarbero.cloud.autoconfigure.zuul.ratelimit.support.RateLimitConstants.HEADER_QUOTA;
+import static com.marcosbarbero.cloud.autoconfigure.zuul.ratelimit.support.RateLimitConstants.HEADER_REMAINING;
+import static com.marcosbarbero.cloud.autoconfigure.zuul.ratelimit.support.RateLimitConstants.HEADER_REMAINING_QUOTA;
+import static com.marcosbarbero.cloud.autoconfigure.zuul.ratelimit.support.RateLimitConstants.HEADER_RESET;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import static org.springframework.http.HttpStatus.OK;
+import static org.springframework.http.HttpStatus.TOO_MANY_REQUESTS;
+
+import java.util.concurrent.TimeUnit;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.ResponseEntity;
+import org.springframework.test.context.junit4.SpringRunner;
+
+@AutoConfigureTestDatabase
+@RunWith(SpringRunner.class)
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+public class GreetingControllerTest {
+
+    private static final String SIMPLE_GREETING = "/greeting/simple";
+    private static final String ADVANCED_GREETING = "/greeting/advanced";
+
+    @Autowired
+    private TestRestTemplate restTemplate;
+
+    @Test
+    public void whenRequestNotExceedingCapacity_thenReturnOkResponse() {
+        ResponseEntity<String> response = this.restTemplate.getForEntity(SIMPLE_GREETING, String.class);
+        HttpHeaders headers = response.getHeaders();
+        String key = "rate-limit-application_serviceSimple_127.0.0.1";
+
+        String limit = headers.getFirst(HEADER_LIMIT + key);
+        String remaining = headers.getFirst(HEADER_REMAINING + key);
+        String reset = headers.getFirst(HEADER_RESET + key);
+
+        assertEquals(limit, "5");
+        assertEquals(remaining, "4");
+        assertEquals(reset, "60000");
+
+        assertEquals(OK, response.getStatusCode());
+    }
+
+    @Test
+    public void whenRequestExceedingCapacity_thenReturnTooManyRequestsResponse() throws InterruptedException {
+        ResponseEntity<String> response = this.restTemplate.getForEntity(ADVANCED_GREETING, String.class);
+        HttpHeaders headers = response.getHeaders();
+        String key = "rate-limit-application_serviceAdvanced_127.0.0.1";
+        assertHeaders(headers, key, false, false);
+        assertEquals(OK, response.getStatusCode());
+
+        for (int i = 0; i < 2; i++) {
+            response = this.restTemplate.getForEntity(ADVANCED_GREETING, String.class);
+        }
+
+        headers = response.getHeaders();
+        String limit = headers.getFirst(HEADER_LIMIT + key);
+        String remaining = headers.getFirst(HEADER_REMAINING + key);
+        String reset = headers.getFirst(HEADER_RESET + key);
+
+        assertEquals(limit, "1");
+        assertEquals(remaining, "0");
+        assertNotEquals(reset, "2000");
+
+        assertEquals(TOO_MANY_REQUESTS, response.getStatusCode());
+
+        TimeUnit.SECONDS.sleep(2);
+
+        response = this.restTemplate.getForEntity(ADVANCED_GREETING, String.class);
+        headers = response.getHeaders();
+        assertHeaders(headers, key, false, false);
+        assertEquals(OK, response.getStatusCode());
+    }
+
+    private void assertHeaders(HttpHeaders headers, String key, boolean nullable, boolean quotaHeaders) {
+        String quota = headers.getFirst(HEADER_QUOTA + key);
+        String remainingQuota = headers.getFirst(HEADER_REMAINING_QUOTA + key);
+        String limit = headers.getFirst(HEADER_LIMIT + key);
+        String remaining = headers.getFirst(HEADER_REMAINING + key);
+        String reset = headers.getFirst(HEADER_RESET + key);
+
+        if (nullable) {
+            if (quotaHeaders) {
+                assertNull(quota);
+                assertNull(remainingQuota);
+            } else {
+                assertNull(limit);
+                assertNull(remaining);
+            }
+            assertNull(reset);
+        } else {
+            if (quotaHeaders) {
+                assertNotNull(quota);
+                assertNotNull(remainingQuota);
+            } else {
+                assertNotNull(limit);
+                assertNotNull(remaining);
+            }
+            assertNotNull(reset);
+        }
+    }
+}