From 6c6e0b98ca29a87d5b7edcb35365c8a665e2cbb6 Mon Sep 17 00:00:00 2001 From: Daniel Prinz Date: Sun, 16 Jun 2024 10:22:02 +0200 Subject: [PATCH] 2024-06 Course Update: Redis Rate Limiter (#7) * 2024-06-add-redis-rate-limiter * remove bin --- .github/workflows/gradle.yml | 4 + .../mn-rate-limit/.editorconfig | 16 ++ Learn-Micronaut-v4/mn-rate-limit/.gitignore | 15 ++ Learn-Micronaut-v4/mn-rate-limit/README.md | 13 + .../mn-rate-limit/build.gradle.kts | 63 +++++ .../mn-rate-limit/gradle.properties | 1 + .../gradle/wrapper/gradle-wrapper.properties | 7 + Learn-Micronaut-v4/mn-rate-limit/gradlew | 249 ++++++++++++++++++ Learn-Micronaut-v4/mn-rate-limit/gradlew.bat | 92 +++++++ .../mn-rate-limit/micronaut-cli.yml | 6 + .../mn-rate-limit/settings.gradle.kts | 4 + .../com/danielprinz/udemy/Application.java | 10 + .../udemy/ratelimit/TimeController.java | 64 +++++ .../src/main/resources/application.yml | 11 + .../src/main/resources/logback.xml | 16 ++ .../udemy/ratelimit/TimeControllerTest.java | 62 +++++ 16 files changed, 633 insertions(+) create mode 100644 Learn-Micronaut-v4/mn-rate-limit/.editorconfig create mode 100644 Learn-Micronaut-v4/mn-rate-limit/.gitignore create mode 100644 Learn-Micronaut-v4/mn-rate-limit/README.md create mode 100644 Learn-Micronaut-v4/mn-rate-limit/build.gradle.kts create mode 100644 Learn-Micronaut-v4/mn-rate-limit/gradle.properties create mode 100644 Learn-Micronaut-v4/mn-rate-limit/gradle/wrapper/gradle-wrapper.properties create mode 100644 Learn-Micronaut-v4/mn-rate-limit/gradlew create mode 100644 Learn-Micronaut-v4/mn-rate-limit/gradlew.bat create mode 100644 Learn-Micronaut-v4/mn-rate-limit/micronaut-cli.yml create mode 100644 Learn-Micronaut-v4/mn-rate-limit/settings.gradle.kts create mode 100644 Learn-Micronaut-v4/mn-rate-limit/src/main/java/com/danielprinz/udemy/Application.java create mode 100644 Learn-Micronaut-v4/mn-rate-limit/src/main/java/com/danielprinz/udemy/ratelimit/TimeController.java create mode 100644 Learn-Micronaut-v4/mn-rate-limit/src/main/resources/application.yml create mode 100644 Learn-Micronaut-v4/mn-rate-limit/src/main/resources/logback.xml create mode 100644 Learn-Micronaut-v4/mn-rate-limit/src/test/java/com/danielprinz/udemy/ratelimit/TimeControllerTest.java diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index 8d4d6f0..b4e69f5 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -45,3 +45,7 @@ jobs: - name: Build mn-web-socket run: gradle clean build working-directory: ./Learn-Micronaut-v4/mn-web-socket + + - name: Build mn-rate-limit + run: gradle clean build + working-directory: ./Learn-Micronaut-v4/mn-rate-limit diff --git a/Learn-Micronaut-v4/mn-rate-limit/.editorconfig b/Learn-Micronaut-v4/mn-rate-limit/.editorconfig new file mode 100644 index 0000000..dbc0739 --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/.editorconfig @@ -0,0 +1,16 @@ +# Editor configuration, see http://editorconfig.org +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = space +trim_trailing_whitespace = true + +[*.{conf,java,xml,yml}] +indent_size = 2 + +[*.md] +max_line_length = off +trim_trailing_whitespace = false diff --git a/Learn-Micronaut-v4/mn-rate-limit/.gitignore b/Learn-Micronaut-v4/mn-rate-limit/.gitignore new file mode 100644 index 0000000..5a03bc3 --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/.gitignore @@ -0,0 +1,15 @@ +Thumbs.db +.DS_Store +.gradle +build/ +target/ +out/ +.micronaut/ +.idea +*.iml +*.ipr +*.iws +.project +.settings +.classpath +.factorypath diff --git a/Learn-Micronaut-v4/mn-rate-limit/README.md b/Learn-Micronaut-v4/mn-rate-limit/README.md new file mode 100644 index 0000000..d4f3e8e --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/README.md @@ -0,0 +1,13 @@ +## MN Rate Limit + +Showcase Redis Rate Limit: https://redis.io/glossary/rate-limiting/ + +## Local Redis + +We use Micronaut Test resources to spin up a local Redis instance. If you want to control it yourself you can also run a +Redis instance yourself. +Ensure to set the `redis.uri` in the `application.yml` file. + +`docker run --name my-redis -p 6379:6379 redis:7-alpine` + +https://hub.docker.com/_/redis diff --git a/Learn-Micronaut-v4/mn-rate-limit/build.gradle.kts b/Learn-Micronaut-v4/mn-rate-limit/build.gradle.kts new file mode 100644 index 0000000..7d49b79 --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/build.gradle.kts @@ -0,0 +1,63 @@ +plugins { + id("com.github.johnrengelman.shadow") version "8.1.1" + id("io.micronaut.application") version "4.4.0" + id("io.micronaut.test-resources") version "4.4.0" + id("io.micronaut.aot") version "4.4.0" +} + +version = "0.1" +group = "com.danielprinz.udemy" + +repositories { + mavenCentral() +} + +dependencies { + annotationProcessor("io.micronaut:micronaut-http-validation") + annotationProcessor("io.micronaut.serde:micronaut-serde-processor") + implementation("io.micronaut.redis:micronaut-redis-lettuce") + implementation("io.micronaut.serde:micronaut-serde-jackson") + compileOnly("io.micronaut:micronaut-http-client") + runtimeOnly("ch.qos.logback:logback-classic") + runtimeOnly("org.yaml:snakeyaml") + testImplementation("io.micronaut:micronaut-http-client") +} + + +application { + mainClass = "com.danielprinz.udemy.Application" +} +java { + sourceCompatibility = JavaVersion.toVersion("21") + targetCompatibility = JavaVersion.toVersion("21") +} + + +graalvmNative.toolchainDetection = false +micronaut { + runtime("netty") + testRuntime("junit5") + processing { + incremental(true) + annotations("com.danielprinz.udemy.*") + } + aot { + // Please review carefully the optimizations enabled below + // Check https://micronaut-projects.github.io/micronaut-aot/latest/guide/ for more details + optimizeServiceLoading = false + convertYamlToJava = false + precomputeOperations = true + cacheEnvironment = true + optimizeClassLoading = true + deduceEnvironment = true + optimizeNetty = true + replaceLogbackXml = true + } +} + + +tasks.named("dockerfileNative") { + jdkVersion = "21" +} + + diff --git a/Learn-Micronaut-v4/mn-rate-limit/gradle.properties b/Learn-Micronaut-v4/mn-rate-limit/gradle.properties new file mode 100644 index 0000000..ba63eab --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/gradle.properties @@ -0,0 +1 @@ +micronautVersion=4.5.0 diff --git a/Learn-Micronaut-v4/mn-rate-limit/gradle/wrapper/gradle-wrapper.properties b/Learn-Micronaut-v4/mn-rate-limit/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..a441313 --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/Learn-Micronaut-v4/mn-rate-limit/gradlew b/Learn-Micronaut-v4/mn-rate-limit/gradlew new file mode 100644 index 0000000..1aa94a4 --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed 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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/Learn-Micronaut-v4/mn-rate-limit/gradlew.bat b/Learn-Micronaut-v4/mn-rate-limit/gradlew.bat new file mode 100644 index 0000000..25da30d --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/Learn-Micronaut-v4/mn-rate-limit/micronaut-cli.yml b/Learn-Micronaut-v4/mn-rate-limit/micronaut-cli.yml new file mode 100644 index 0000000..da369c9 --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/micronaut-cli.yml @@ -0,0 +1,6 @@ +applicationType: default +defaultPackage: com.danielprinz.udemy +testFramework: junit +sourceLanguage: java +buildTool: gradle_kotlin +features: [app-name, gradle, http-client-test, java, java-application, junit, logback, micronaut-aot, micronaut-build, micronaut-http-validation, netty-server, readme, redis-lettuce, serialization-jackson, shade, static-resources, test-resources, yaml, yaml-build] diff --git a/Learn-Micronaut-v4/mn-rate-limit/settings.gradle.kts b/Learn-Micronaut-v4/mn-rate-limit/settings.gradle.kts new file mode 100644 index 0000000..ebc9b59 --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/settings.gradle.kts @@ -0,0 +1,4 @@ + + +rootProject.name="mn-rate-limit" + diff --git a/Learn-Micronaut-v4/mn-rate-limit/src/main/java/com/danielprinz/udemy/Application.java b/Learn-Micronaut-v4/mn-rate-limit/src/main/java/com/danielprinz/udemy/Application.java new file mode 100644 index 0000000..13e4faf --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/src/main/java/com/danielprinz/udemy/Application.java @@ -0,0 +1,10 @@ +package com.danielprinz.udemy; + +import io.micronaut.runtime.Micronaut; + +public class Application { + + public static void main(String[] args) { + Micronaut.run(Application.class, args); + } +} diff --git a/Learn-Micronaut-v4/mn-rate-limit/src/main/java/com/danielprinz/udemy/ratelimit/TimeController.java b/Learn-Micronaut-v4/mn-rate-limit/src/main/java/com/danielprinz/udemy/ratelimit/TimeController.java new file mode 100644 index 0000000..d7c6cfb --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/src/main/java/com/danielprinz/udemy/ratelimit/TimeController.java @@ -0,0 +1,64 @@ +package com.danielprinz.udemy.ratelimit; + +import io.lettuce.core.api.StatefulRedisConnection; +import io.micronaut.http.HttpHeaders; +import io.micronaut.http.HttpResponse; +import io.micronaut.http.HttpStatus; +import io.micronaut.http.annotation.Controller; +import io.micronaut.http.annotation.Get; +import io.micronaut.scheduling.TaskExecutors; +import io.micronaut.scheduling.annotation.ExecuteOn; +import java.time.Clock; +import java.time.LocalTime; +import java.util.Optional; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Controller("/time") +@ExecuteOn(TaskExecutors.BLOCKING) +public class TimeController { + + private static final Logger LOG = LoggerFactory.getLogger(TimeController.class); + private static final int QUOTA_PER_MINUTE = 10; + private final StatefulRedisConnection redis; + + public TimeController(StatefulRedisConnection redis) { + this.redis = redis; + } + + @Get() + public HttpResponse time(HttpHeaders headers) { + var clientId = Optional.ofNullable(headers.get("x-client-id")).orElse("ANONYMOUS"); + final var key = "TIMECONTROLLER::TIME::" + clientId; + return checkQuotaAndGetTime(key, LocalTime.now()); + } + + @Get("/utc") + public HttpResponse timeUtc() { + final var key = "TIMECONTROLLER::TIMEUTC"; + return checkQuotaAndGetTime(key, LocalTime.now(Clock.systemUTC())); + } + + private HttpResponse checkQuotaAndGetTime(String key, LocalTime localTime) { + var redisQuota = Optional.ofNullable(redis.sync().get(key)) + .orElse("0"); + if (Integer.parseInt(redisQuota) >= QUOTA_PER_MINUTE) { + var err = String.format("Rate limit reached %s %s/%s", key, redisQuota, QUOTA_PER_MINUTE); + LOG.info(err); + return HttpResponse.status(HttpStatus.TOO_MANY_REQUESTS, err); + } + LOG.info("Current quota of {} is {}/{}", key, redisQuota, QUOTA_PER_MINUTE); + increaseQuota(key); + + return HttpResponse.ok(localTime.toString()); + } + + private void increaseQuota(final String redisKey) { + var commands = redis.sync(); + commands.multi(); + commands.incrby(redisKey, 1); + var remainingSeconds = 60 - LocalTime.now().getSecond(); + commands.expire(redisKey, remainingSeconds); + commands.exec(); + } +} diff --git a/Learn-Micronaut-v4/mn-rate-limit/src/main/resources/application.yml b/Learn-Micronaut-v4/mn-rate-limit/src/main/resources/application.yml new file mode 100644 index 0000000..2f51539 --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/src/main/resources/application.yml @@ -0,0 +1,11 @@ +micronaut: + application: + name: mn-rate-limit +redis: + # uri: ${REDIS_URI:`redis://localhost`} + ssl: false + timeout: 30s +test-resources: + containers: + redis: + image-name: redis:7-alpine diff --git a/Learn-Micronaut-v4/mn-rate-limit/src/main/resources/logback.xml b/Learn-Micronaut-v4/mn-rate-limit/src/main/resources/logback.xml new file mode 100644 index 0000000..d9ed8ac --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/src/main/resources/logback.xml @@ -0,0 +1,16 @@ + + + + + + %cyan(%d{HH:mm:ss.SSS}) %gray([%thread]) %highlight(%-5level) %magenta(%logger{36}) - %msg%n + + + + + + + + + diff --git a/Learn-Micronaut-v4/mn-rate-limit/src/test/java/com/danielprinz/udemy/ratelimit/TimeControllerTest.java b/Learn-Micronaut-v4/mn-rate-limit/src/test/java/com/danielprinz/udemy/ratelimit/TimeControllerTest.java new file mode 100644 index 0000000..d6f1c98 --- /dev/null +++ b/Learn-Micronaut-v4/mn-rate-limit/src/test/java/com/danielprinz/udemy/ratelimit/TimeControllerTest.java @@ -0,0 +1,62 @@ +package com.danielprinz.udemy.ratelimit; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; + +import io.micronaut.http.HttpRequest; +import io.micronaut.http.HttpStatus; +import io.micronaut.http.client.HttpClient; +import io.micronaut.http.client.annotation.Client; +import io.micronaut.http.client.exceptions.HttpClientResponseException; +import io.micronaut.test.extensions.junit5.annotation.MicronautTest; +import jakarta.inject.Inject; +import java.util.stream.IntStream; +import org.junit.jupiter.api.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@MicronautTest +class TimeControllerTest { + + private static final Logger LOG = LoggerFactory.getLogger(TimeControllerTest.class); + + @Inject + @Client("/time") + HttpClient client; + + @Test + void triggerRateLimitOnTimeEndpoint() { + final var path = "/"; + IntStream.rangeClosed(0, 9) + .forEach(count -> + retrieve(path) + ); + + var result = assertThrows(HttpClientResponseException.class, + () -> retrieve(path) + ); + assertEquals("Client '/time': Rate limit reached TIMECONTROLLER::TIME::test 10/10", result.getMessage()); + assertEquals(HttpStatus.TOO_MANY_REQUESTS, result.getStatus()); + } + + @Test + void triggerRateLimitOnTimeUtcEndpoint() { + final var path = "/utc"; + IntStream.rangeClosed(0, 9) + .forEach(count -> + retrieve(path) + ); + var result = assertThrows(HttpClientResponseException.class, + () -> retrieve(path) + ); + assertEquals("Client '/time': Rate limit reached TIMECONTROLLER::TIMEUTC 10/10", result.getMessage()); + assertEquals(HttpStatus.TOO_MANY_REQUESTS, result.getStatus()); + } + + private void retrieve(String path) { + client.toBlocking().exchange(HttpRequest.GET(path) + .header("x-client-id", "test") + ); + } + +}