From b6b92dbe37c49f448380479c2c45bcd50fd5f8f5 Mon Sep 17 00:00:00 2001 From: GauravGuptaDeveloper Date: Tue, 23 Jan 2024 22:48:11 +0530 Subject: [PATCH 1/3] rate-limiter 1.0 Commit --- rate-limiter/.gitignore | 39 +++ rate-limiter/build.gradle | 38 +++ rate-limiter/gradlew | 249 ++++++++++++++++++ rate-limiter/gradlew.bat | 92 +++++++ rate-limiter/settings.gradle | 1 + .../ratelimiter/RateLimiterApplication.java | 61 +++++ .../algorithm/FixedWindowCounter.java | 73 +++++ .../algorithm/SlidingWindowCounter.java | 39 +++ .../algorithm/SlidingWindowLog.java | 42 +++ .../ratelimiter/algorithm/TokenBucket.java | 72 +++++ .../controller/LimiterController.java | 20 ++ .../com/learning/ratelimiter/dto/Token.java | 15 ++ .../exception/DefaultExceptionHandler.java | 18 ++ .../filters/FixedWindowCounterFilter.java | 49 ++++ .../filters/SlidingWindowCounterFilter.java | 49 ++++ .../filters/SlidingWindowLogFilter.java | 46 ++++ .../filters/TokenBucketFilter.java | 42 +++ .../service/FixedWindowCounterService.java | 24 ++ .../SlidingWindowCounterRedisService.java | 119 +++++++++ .../service/SlidingWindowCounterService.java | 184 +++++++++++++ .../service/SlidingWindowLogService.java | 52 ++++ .../service/TokenBucketService.java | 41 +++ .../src/main/resources/application.properties | 1 + ...RateLimiterApplicationTestsController.java | 13 + 24 files changed, 1379 insertions(+) create mode 100644 rate-limiter/.gitignore create mode 100644 rate-limiter/build.gradle create mode 100644 rate-limiter/gradlew create mode 100644 rate-limiter/gradlew.bat create mode 100644 rate-limiter/settings.gradle create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/RateLimiterApplication.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/FixedWindowCounter.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/SlidingWindowCounter.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/SlidingWindowLog.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/TokenBucket.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/controller/LimiterController.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/dto/Token.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/exception/DefaultExceptionHandler.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/filters/FixedWindowCounterFilter.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/filters/SlidingWindowCounterFilter.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/filters/SlidingWindowLogFilter.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/filters/TokenBucketFilter.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/service/FixedWindowCounterService.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowCounterRedisService.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowCounterService.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowLogService.java create mode 100644 rate-limiter/src/main/java/com/learning/ratelimiter/service/TokenBucketService.java create mode 100644 rate-limiter/src/main/resources/application.properties create mode 100644 rate-limiter/src/test/java/com/learning/ratelimiter/RateLimiterApplicationTestsController.java diff --git a/rate-limiter/.gitignore b/rate-limiter/.gitignore new file mode 100644 index 0000000..a3ad656 --- /dev/null +++ b/rate-limiter/.gitignore @@ -0,0 +1,39 @@ +HELP.md +.gradle +gradle/ +report/ +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ diff --git a/rate-limiter/build.gradle b/rate-limiter/build.gradle new file mode 100644 index 0000000..fc446fe --- /dev/null +++ b/rate-limiter/build.gradle @@ -0,0 +1,38 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '2.7.17' + id 'io.spring.dependency-management' version '1.0.15.RELEASE' +} + +group = 'com.learning' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '1.8' +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-web' + implementation('org.springframework.boot:spring-boot-starter-data-redis') { + exclude group: 'io.lettuce.lettuce-core' + } + implementation 'com.github.houbb:redis-client-jedis:0.0.3' + compileOnly 'org.projectlombok:lombok' + developmentOnly 'org.springframework.boot:spring-boot-devtools' + annotationProcessor 'org.projectlombok:lombok' + testImplementation 'org.springframework.boot:spring-boot-starter-test' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/rate-limiter/gradlew b/rate-limiter/gradlew new file mode 100644 index 0000000..0adc8e1 --- /dev/null +++ b/rate-limiter/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=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=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, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +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/rate-limiter/gradlew.bat b/rate-limiter/gradlew.bat new file mode 100644 index 0000000..93e3f59 --- /dev/null +++ b/rate-limiter/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. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +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/rate-limiter/settings.gradle b/rate-limiter/settings.gradle new file mode 100644 index 0000000..c547b74 --- /dev/null +++ b/rate-limiter/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'rate-limiter' diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/RateLimiterApplication.java b/rate-limiter/src/main/java/com/learning/ratelimiter/RateLimiterApplication.java new file mode 100644 index 0000000..2dc5d03 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/RateLimiterApplication.java @@ -0,0 +1,61 @@ +package com.learning.ratelimiter; + +import com.learning.ratelimiter.algorithm.FixedWindowCounter; +import com.learning.ratelimiter.algorithm.SlidingWindowCounter; +import com.learning.ratelimiter.algorithm.SlidingWindowLog; +import com.learning.ratelimiter.algorithm.TokenBucket; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.annotation.Bean; +import org.springframework.data.redis.connection.jedis.JedisConnectionFactory; +import org.springframework.data.redis.core.RedisTemplate; +import org.springframework.data.redis.serializer.StringRedisSerializer; +import org.springframework.scheduling.annotation.EnableScheduling; + +@SpringBootApplication +@EnableScheduling +public class RateLimiterApplication { + + public static void main(String[] args) { + SpringApplication.run(RateLimiterApplication.class, args); + } + + // @Bean + public TokenBucket tokenBucket() { + return new TokenBucket(5); + } + + // @Bean + public FixedWindowCounter fixedWindowCounter() { + return new FixedWindowCounter(30, 5); + } + + // @Bean + public SlidingWindowLog slidingWindowLog() { + return new SlidingWindowLog(30, 5); + } + + @Bean + public SlidingWindowCounter slidingWindowCounter() { + return new SlidingWindowCounter(120L, 7L); + } + + @Bean + JedisConnectionFactory jedisConnectionFactory() { + JedisConnectionFactory jedisConnectionFactory = new JedisConnectionFactory(); + jedisConnectionFactory.setHostName("localhost"); + jedisConnectionFactory.setPort(6379); + return jedisConnectionFactory; + } + + @Bean + public RedisTemplate redisTemplate() { + RedisTemplate template = new RedisTemplate<>(); + template.setConnectionFactory(jedisConnectionFactory()); + + template.setKeySerializer(new StringRedisSerializer()); + template.setValueSerializer(new StringRedisSerializer()); + + return template; + } +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/FixedWindowCounter.java b/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/FixedWindowCounter.java new file mode 100644 index 0000000..90f8313 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/FixedWindowCounter.java @@ -0,0 +1,73 @@ +package com.learning.ratelimiter.algorithm; + +import lombok.Data; +import lombok.extern.slf4j.Slf4j; + +import java.time.LocalDateTime; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.atomic.AtomicLong; + +@Data +@Slf4j +public final class FixedWindowCounter { + private int windowFrameSize; + private int requests; + + private AtomicLong atomicLong; +// private BlockingQueue blockingQueue; + + ExecutorService executor = Executors.newFixedThreadPool(1); + + public FixedWindowCounter(int windowFrameSize, int requests) { + this.windowFrameSize = windowFrameSize; + this.requests = requests; + + this.atomicLong = new AtomicLong(0); +// this.blockingQueue = new ArrayBlockingQueue<>(requests); + + executor.execute(this::emptyBlockingQueueAfterTInterval); + } + + private void emptyBlockingQueueAfterTInterval() { + while (true) { + log.info("{} Starting at {} of blocking queue size as {}", + Thread.currentThread().getName(), LocalDateTime.now(), +// this.blockingQueue.size() + this.atomicLong.get() + ); +// this.blockingQueue.clear(); + this.atomicLong.getAndSet(0); + try { + log.info("{} Sleeping for {}", Thread.currentThread().getName(), windowFrameSize * 1000L); + Thread.sleep(windowFrameSize * 1000L); + } catch (InterruptedException e) { + throw new RuntimeException(e); + } + } + } + + public void putInQueue(String ip) { + String timestamp = LocalDateTime.now().toString(); + try { +// this.blockingQueue.add(timestamp); + this.atomicLong.getAndIncrement(); +// log.info("Queue is {}", this.blockingQueue); + log.info("Atomic long value is {}", this.atomicLong); + } catch (IllegalStateException ex) { + log.info("Dropping request due to full capacity {} at {}", ip, timestamp); + } + } + + public void pop() { + try { +// this.blockingQueue.take(); +// log.info("One request is complete! Dropping from queue. and now request size is {}", +// this.blockingQueue.size()); + this.atomicLong.getAndDecrement(); + log.info("Decementing the request which is complete!, {}", atomicLong.get()); + } catch (Exception e) { + throw new RuntimeException(e); + } + } +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/SlidingWindowCounter.java b/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/SlidingWindowCounter.java new file mode 100644 index 0000000..2268f92 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/SlidingWindowCounter.java @@ -0,0 +1,39 @@ +package com.learning.ratelimiter.algorithm; + +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.annotation.JsonSerialize; +import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer; +import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer; +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; +import lombok.extern.slf4j.Slf4j; + +import java.time.LocalDateTime; +import java.time.format.DateTimeFormatter; + +@Slf4j +@Data +@AllArgsConstructor +@NoArgsConstructor +public class SlidingWindowCounter { + + private long windowFrameSize; + private long threshold; + private long previousRecordCount; + private long currentRecordCount; + + @JsonDeserialize(using = LocalDateTimeDeserializer.class) + @JsonSerialize(using = LocalDateTimeSerializer.class) + private LocalDateTime currentRecordTimestamp; + + public SlidingWindowCounter(long windowFrameSizeSeconds, long threshold) { + this.threshold = threshold; + this.windowFrameSize = windowFrameSizeSeconds; + + currentRecordCount = 0; + currentRecordTimestamp = LocalDateTime.now().withNano(0); + + previousRecordCount = 0; + } +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/SlidingWindowLog.java b/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/SlidingWindowLog.java new file mode 100644 index 0000000..dda7f66 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/SlidingWindowLog.java @@ -0,0 +1,42 @@ +package com.learning.ratelimiter.algorithm; + +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.time.LocalDateTime; +import java.util.concurrent.ConcurrentLinkedDeque; + +public class SlidingWindowLog { + + private ConcurrentLinkedDeque slidingWindowList; + private int windowtime; + private int threshold; + + public SlidingWindowLog(int windowtime, int request) { + this.windowtime = windowtime; + this.threshold = request; + this.slidingWindowList = new ConcurrentLinkedDeque<>(); + } + + public ConcurrentLinkedDeque getSlidingWindowList() { + return slidingWindowList; + } + + public int getWindowtime() { + return windowtime; + } + + public int getThreshold() { + return threshold; + } + + @Data + @AllArgsConstructor + @NoArgsConstructor + public static class SlidingWindow { + private String requestIP; + private LocalDateTime localDateTime; + } + +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/TokenBucket.java b/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/TokenBucket.java new file mode 100644 index 0000000..ed53aa5 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/algorithm/TokenBucket.java @@ -0,0 +1,72 @@ +package com.learning.ratelimiter.algorithm; + +import com.learning.ratelimiter.dto.Token; +import lombok.extern.slf4j.Slf4j; +import org.springframework.scheduling.annotation.Scheduled; +import org.springframework.stereotype.Component; + +import java.time.LocalDateTime; +import java.util.Map; +import java.util.Queue; +import java.util.UUID; +import java.util.concurrent.ArrayBlockingQueue; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.ConcurrentHashMap; + +@Slf4j +public class TokenBucket { + + ConcurrentHashMap> ipBasedTokenBucket = new ConcurrentHashMap<>(); + int threshold; + + public TokenBucket(int n) { + this.threshold = n; + } + + public boolean registerIpBucket(String ip) { + if (ipBasedTokenBucket.containsKey(ip)) { + log.debug("Already registered ip {}", ip); + return false; + } else { + // for the first time, we will set threshold of queue and insert tokens. + BlockingQueue value = new ArrayBlockingQueue<>(threshold); + for (int idx = 0; idx < threshold; idx++) { + value.add(new Token(UUID.randomUUID().toString(), LocalDateTime.now())); + } + + ipBasedTokenBucket.put(ip, value); + return true; + } + } + + public void deregisterIpFromBucket(String ip) { + ipBasedTokenBucket.remove(ip); + } + + @Scheduled(cron = "*/30 * * * * ?") + public void insertTokenPerIp() { + if (ipBasedTokenBucket.isEmpty()) { + log.info("IpBased Token Bucket is empty"); + return; + } + for (Map.Entry> entry : ipBasedTokenBucket.entrySet()) { + Queue value = entry.getValue(); + if (value.size() == threshold) { + //.. Discard the token. + log.info("Bucket is full! Therefore, no need to add more tokens." + + "Printing ip {} ipBasedTokenBucket {}", entry.getKey(), ipBasedTokenBucket); + } else { + // TODO : no need to add this loop right now! + +// while (value.size() != threshold) { + value.add(new Token(UUID.randomUUID().toString(), LocalDateTime.now())); +// } + } + } + log.info("IPBasedTokenBucket is {}", ipBasedTokenBucket); + } + + public ConcurrentHashMap> getIpBasedTokenBucket() { + return ipBasedTokenBucket; + } +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/controller/LimiterController.java b/rate-limiter/src/main/java/com/learning/ratelimiter/controller/LimiterController.java new file mode 100644 index 0000000..3df20a9 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/controller/LimiterController.java @@ -0,0 +1,20 @@ +package com.learning.ratelimiter.controller; + +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@RequestMapping("/") +public class LimiterController { + + @GetMapping("limited") + public String limitedApi() { + return "Limited! don't over use me."; + } + + @GetMapping("unlimited") + public String unlimitedApi() { + return "Unlimited! Let's Go!"; + } +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/dto/Token.java b/rate-limiter/src/main/java/com/learning/ratelimiter/dto/Token.java new file mode 100644 index 0000000..9593ebc --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/dto/Token.java @@ -0,0 +1,15 @@ +package com.learning.ratelimiter.dto; + +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.time.LocalDateTime; + +@Data +@AllArgsConstructor +@NoArgsConstructor +public class Token { + private String id; + private LocalDateTime timestamp; +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/exception/DefaultExceptionHandler.java b/rate-limiter/src/main/java/com/learning/ratelimiter/exception/DefaultExceptionHandler.java new file mode 100644 index 0000000..ee18167 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/exception/DefaultExceptionHandler.java @@ -0,0 +1,18 @@ +package com.learning.ratelimiter.exception; + +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.ControllerAdvice; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.ResponseBody; +import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler; + +@ControllerAdvice +public class DefaultExceptionHandler extends ResponseEntityExceptionHandler { + + @ExceptionHandler({RuntimeException.class}) + @ResponseBody + public ResponseEntity handleAuthenticationException(Exception ex) { + return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Too many request from same ip."); + } +} \ No newline at end of file diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/filters/FixedWindowCounterFilter.java b/rate-limiter/src/main/java/com/learning/ratelimiter/filters/FixedWindowCounterFilter.java new file mode 100644 index 0000000..08eae6e --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/filters/FixedWindowCounterFilter.java @@ -0,0 +1,49 @@ +package com.learning.ratelimiter.filters; + +import com.learning.ratelimiter.service.FixedWindowCounterService; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpStatus; +import org.springframework.stereotype.Component; + +import javax.servlet.Filter; +import javax.servlet.FilterChain; +import javax.servlet.ServletException; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +//@Component +@Slf4j +public class FixedWindowCounterFilter implements Filter { + +// @Autowired + FixedWindowCounterService fixedWindowCounterService; + + @Override + public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) + throws IOException, ServletException { + try { + String remoteHost = request.getRemoteHost(); + boolean isRequestAllowed = fixedWindowCounterService.isRequestAllowed(); + if(!isRequestAllowed){ + throw new RuntimeException("Too many Requests"); + } + log.info("Is Request allowed? {} to ip {}", isRequestAllowed, remoteHost); + fixedWindowCounterService.addRequest(remoteHost); + chain.doFilter(request, response); + // we don't need this. +// fixedWindowCounterService.completeRequest(); + } catch (RuntimeException ex) { + log.error("Caught runtime exception : {}", ex.getMessage()); + HttpServletResponse httpServletResponse = (HttpServletResponse) response; + + httpServletResponse.setContentType("text/html"); + httpServletResponse.setStatus(HttpStatus.TOO_MANY_REQUESTS.value()); + httpServletResponse.getWriter().write(ex.getMessage()); + } + } + + +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/filters/SlidingWindowCounterFilter.java b/rate-limiter/src/main/java/com/learning/ratelimiter/filters/SlidingWindowCounterFilter.java new file mode 100644 index 0000000..02148a9 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/filters/SlidingWindowCounterFilter.java @@ -0,0 +1,49 @@ +package com.learning.ratelimiter.filters; + +import com.learning.ratelimiter.service.SlidingWindowCounterRedisService; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpStatus; +import org.springframework.stereotype.Component; + +import javax.servlet.Filter; +import javax.servlet.FilterChain; +import javax.servlet.ServletException; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +@Component +@Slf4j +public class SlidingWindowCounterFilter implements Filter { + +// @Autowired +// SlidingWindowCounterService slidingWindowCountService; + + @Autowired + SlidingWindowCounterRedisService slidingWindowCountService; + + @Override + public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) + throws IOException, ServletException { + try { + String remoteHost = request.getRemoteHost(); + boolean isRequestAllowed = slidingWindowCountService.isRequestAllowed(remoteHost); + if (!isRequestAllowed) { + throw new RuntimeException("Too many Requests"); + } + log.info("Is Request allowed? {} to ip {}", isRequestAllowed, remoteHost); + chain.doFilter(request, response); + } catch (RuntimeException ex) { + log.error("Caught runtime exception : {}", ex.getMessage()); + HttpServletResponse httpServletResponse = (HttpServletResponse) response; + + httpServletResponse.setContentType("text/html"); + httpServletResponse.setStatus(HttpStatus.TOO_MANY_REQUESTS.value()); + httpServletResponse.getWriter().write(ex.getMessage()); + } + } + + +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/filters/SlidingWindowLogFilter.java b/rate-limiter/src/main/java/com/learning/ratelimiter/filters/SlidingWindowLogFilter.java new file mode 100644 index 0000000..63320ef --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/filters/SlidingWindowLogFilter.java @@ -0,0 +1,46 @@ +package com.learning.ratelimiter.filters; + +import com.learning.ratelimiter.service.SlidingWindowLogService; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpStatus; +import org.springframework.stereotype.Component; + +import javax.servlet.Filter; +import javax.servlet.FilterChain; +import javax.servlet.ServletException; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +//@Component +@Slf4j +public class SlidingWindowLogFilter implements Filter { + +// @Autowired + SlidingWindowLogService slidingWindowLogService; + + @Override + public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) + throws IOException, ServletException { + try { + String remoteHost = request.getRemoteHost(); + boolean isRequestAllowed = slidingWindowLogService.isRequestAllowed(remoteHost); + if(!isRequestAllowed){ + throw new RuntimeException("Too many Requests"); + } + log.info("Is Request allowed? {} to ip {}", isRequestAllowed, remoteHost); + chain.doFilter(request, response); + } catch (RuntimeException ex) { + log.error("Caught runtime exception : {}", ex.getMessage()); + HttpServletResponse httpServletResponse = (HttpServletResponse) response; + + httpServletResponse.setContentType("text/html"); + httpServletResponse.setStatus(HttpStatus.TOO_MANY_REQUESTS.value()); + httpServletResponse.getWriter().write(ex.getMessage()); + } + } + + +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/filters/TokenBucketFilter.java b/rate-limiter/src/main/java/com/learning/ratelimiter/filters/TokenBucketFilter.java new file mode 100644 index 0000000..960a252 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/filters/TokenBucketFilter.java @@ -0,0 +1,42 @@ +package com.learning.ratelimiter.filters; + +import com.learning.ratelimiter.dto.Token; +import com.learning.ratelimiter.service.TokenBucketService; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpStatus; +import org.springframework.stereotype.Component; + +import javax.servlet.Filter; +import javax.servlet.FilterChain; +import javax.servlet.ServletException; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +//@Component +@Slf4j +public class TokenBucketFilter implements Filter { + +// @Autowired + TokenBucketService tokenBucketService; + + @Override + public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) + throws IOException, ServletException { + try { + String remoteHost = request.getRemoteHost(); + Token token = tokenBucketService.getToken(remoteHost); + log.info("Assigning token {} to ip {}", token, remoteHost); + chain.doFilter(request, response); + } catch (RuntimeException ex) { + log.error("Caught runtime exception : {}", ex.getMessage()); + HttpServletResponse httpServletResponse = (HttpServletResponse) response; + + httpServletResponse.setContentType("text/html"); + httpServletResponse.setStatus(HttpStatus.TOO_MANY_REQUESTS.value()); + httpServletResponse.getWriter().write(ex.getMessage()); + } + } +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/service/FixedWindowCounterService.java b/rate-limiter/src/main/java/com/learning/ratelimiter/service/FixedWindowCounterService.java new file mode 100644 index 0000000..69be76a --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/service/FixedWindowCounterService.java @@ -0,0 +1,24 @@ +package com.learning.ratelimiter.service; + +import com.learning.ratelimiter.algorithm.FixedWindowCounter; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +@Component +public class FixedWindowCounterService { + +// @Autowired + FixedWindowCounter fixedWindowCounter; + + public boolean isRequestAllowed() { + return fixedWindowCounter.getAtomicLong().get() < fixedWindowCounter.getRequests(); + } + + public void completeRequest() { + fixedWindowCounter.pop(); + } + + public void addRequest(String remoteHost) { + fixedWindowCounter.putInQueue(remoteHost); + } +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowCounterRedisService.java b/rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowCounterRedisService.java new file mode 100644 index 0000000..55fd691 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowCounterRedisService.java @@ -0,0 +1,119 @@ +package com.learning.ratelimiter.service; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.learning.ratelimiter.algorithm.SlidingWindowCounter; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.redis.core.RedisTemplate; +import org.springframework.stereotype.Component; + +import java.time.LocalDateTime; +import java.time.ZoneId; + +@Component +@Slf4j +public class SlidingWindowCounterRedisService { + + @Autowired + RedisTemplate redisTemplate; + + @Autowired + private SlidingWindowCounter slidingWindowCounter; + + @Autowired + private ObjectMapper objectMapper; + + public boolean isRequestAllowed(String ip) { + + boolean isAllowed = true; + + String cachedValue = redisTemplate.opsForValue().get(ip); + + if (cachedValue != null) { + try { + slidingWindowCounter = objectMapper.readValue(cachedValue, SlidingWindowCounter.class); + } catch (JsonProcessingException e) { + throw new RuntimeException(e); + } + } + + LocalDateTime currentWindowRecordTimestamp = LocalDateTime.now().withNano(0); + + LocalDateTime objectCurrentRecordWindowTimestamp = slidingWindowCounter.getCurrentRecordTimestamp(); + + if (currentWindowRecordTimestamp.isEqual(objectCurrentRecordWindowTimestamp)) { + if (slidingWindowCounter.getCurrentRecordCount() < slidingWindowCounter.getThreshold()) { + checkAndSetIfFirstRequest(); + slidingWindowCounter.setCurrentRecordCount(slidingWindowCounter.getCurrentRecordCount() + 1); + } else { + isAllowed = false; + } + } else { + if (isWindowExpired(objectCurrentRecordWindowTimestamp, currentWindowRecordTimestamp, slidingWindowCounter.getWindowFrameSize() * 1000)) { + slidingWindowCounter.setPreviousRecordCount(slidingWindowCounter.getCurrentRecordCount()); + slidingWindowCounter.setCurrentRecordTimestamp(currentWindowRecordTimestamp); + + slidingWindowCounter.setCurrentRecordCount(1); + } else { + if (isRateLimited(currentWindowRecordTimestamp, objectCurrentRecordWindowTimestamp, + slidingWindowCounter)) { + isAllowed = false; + } else { + checkAndSetIfFirstRequest(); + slidingWindowCounter + .setCurrentRecordCount(slidingWindowCounter.getCurrentRecordCount() + 1); + } + } + } + + try { + redisTemplate.opsForValue().set(ip, objectMapper.writeValueAsString(slidingWindowCounter)); + } catch (JsonProcessingException e) { + throw new RuntimeException(e); + } + + return isAllowed; + } + + private void checkAndSetIfFirstRequest() { + if (slidingWindowCounter.getCurrentRecordCount() == 0) { + slidingWindowCounter.setCurrentRecordCount(1); + } + } + + private boolean isRateLimited(LocalDateTime currentWindowRecordTimestamp, + LocalDateTime objectCurrentRecordWindowTimestamp, + SlidingWindowCounter slidingWindowCounter) { + + long currentObjectCount = slidingWindowCounter.getCurrentRecordCount(); + long threshold = slidingWindowCounter.getThreshold(); + long windowFrameSize = slidingWindowCounter.getWindowFrameSize(); + long currentTimestampEpoch = currentWindowRecordTimestamp.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli(); + long objectRecordEpoch = objectCurrentRecordWindowTimestamp.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli(); + + float currentPercentageWeight = (float) (currentTimestampEpoch - objectRecordEpoch) / (windowFrameSize * 1000); + + float previousWindowWeight = 1 - currentPercentageWeight; + + log.info("CurrentWindowTimestamp is {} and objectRecordTimeStamp is {}", + currentWindowRecordTimestamp, objectCurrentRecordWindowTimestamp); + + log.info("PERCENTAGE IS {} and {} -- {}, {}", + previousWindowWeight, currentPercentageWeight, slidingWindowCounter.getPreviousRecordCount(), currentObjectCount); + + long value = (long) Math.ceil(previousWindowWeight * slidingWindowCounter.getPreviousRecordCount()) + + currentObjectCount; + + log.info("Hence value is {}", value); + + return value > threshold; +// return ((long) Math.ceil(previousWindowWeight) * currentObjectCount) >= threshold; + } + + private boolean isWindowExpired(LocalDateTime objectCurrentWindowTimestamp, LocalDateTime currentWindowTimestamp, long frameSize) { + return (currentWindowTimestamp.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli() - frameSize) >= + objectCurrentWindowTimestamp.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli(); + } + +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowCounterService.java b/rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowCounterService.java new file mode 100644 index 0000000..1b9ab0a --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowCounterService.java @@ -0,0 +1,184 @@ +package com.learning.ratelimiter.service; + +import com.learning.ratelimiter.algorithm.SlidingWindowCounter; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import java.time.LocalDateTime; +import java.time.ZoneId; + +//@Service +@Slf4j +public class SlidingWindowCounterService { + + @Autowired + private SlidingWindowCounter slidingWindowCounter; + + public boolean isRequestAllowed(String ip) { + + LocalDateTime currentWindowRecordTimestamp = LocalDateTime.now().withNano(0); + + LocalDateTime objectCurrentRecordWindowTimestamp = slidingWindowCounter.getCurrentRecordTimestamp(); + + if (currentWindowRecordTimestamp.isEqual(objectCurrentRecordWindowTimestamp)) { + if (slidingWindowCounter.getCurrentRecordCount() < slidingWindowCounter.getThreshold()) { + checkAndSetIfFirstRequest(); + slidingWindowCounter.setCurrentRecordCount(slidingWindowCounter.getCurrentRecordCount() + 1); + return true; + } else { + return false; + } + } else { + if (isWindowExpired(objectCurrentRecordWindowTimestamp, currentWindowRecordTimestamp, slidingWindowCounter.getWindowFrameSize() * 1000)) { + slidingWindowCounter.setPreviousRecordCount(slidingWindowCounter.getCurrentRecordCount()); + slidingWindowCounter.setCurrentRecordTimestamp(currentWindowRecordTimestamp); + slidingWindowCounter.setCurrentRecordCount(0); + } else { + if (isRateLimited(currentWindowRecordTimestamp, objectCurrentRecordWindowTimestamp, + slidingWindowCounter)) { + return false; + } else { + checkAndSetIfFirstRequest(); + slidingWindowCounter + .setCurrentRecordCount(slidingWindowCounter.getCurrentRecordCount() + 1); + } + } + } + + return true; + } + + private boolean isRateLimited(LocalDateTime currentWindowRecordTimestamp, + LocalDateTime objectCurrentRecordWindowTimestamp, + SlidingWindowCounter slidingWindowCounter) { + + long currentObjectCount = slidingWindowCounter.getCurrentRecordCount(); + long threshold = slidingWindowCounter.getThreshold(); + long windowFrameSize = slidingWindowCounter.getWindowFrameSize(); + long currentTimestampEpoch = currentWindowRecordTimestamp.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli(); + long objectRecordEpoch = objectCurrentRecordWindowTimestamp.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli(); + + float currentPercentageWeight = (float) (currentTimestampEpoch - objectRecordEpoch) / (windowFrameSize * 1000); + + float previousWindowWeight = 1 - currentPercentageWeight; + + log.info("CurrentWindowTimestamp is {} and objectRecordTimeStamp is {}", + currentWindowRecordTimestamp, objectCurrentRecordWindowTimestamp); + + log.info("PERCENTAGE IS {} and {} -- {}, {}", + previousWindowWeight, currentPercentageWeight, slidingWindowCounter.getPreviousRecordCount(), currentObjectCount); + + long value = (long) Math.ceil(previousWindowWeight * slidingWindowCounter.getPreviousRecordCount()) + + currentObjectCount; + + log.info("Hence value is {}", value); + +// TODO : we don't kind a need of previousCount since we are using currentObjectCount as previousCount. +// So we don't need this formula, but still keeping it over here. +// long previousCount = slidingWindowCounter.getPreviousRecordCount(); +// long limit = (long) Math.ceil(previousCount * previousWindowWeight + currentObjectCount * currentPercentageWeight); + + return value > threshold; +// return ((long) Math.ceil(previousWindowWeight) * currentObjectCount) >= threshold; + } + + private void checkAndSetIfFirstRequest() { + if (slidingWindowCounter.getCurrentRecordCount() == 0) { + slidingWindowCounter.setCurrentRecordCount(1); + } + } + + private boolean isWindowExpired(LocalDateTime objectCurrentWindowTimestamp, LocalDateTime currentWindowTimestamp, long frameSize) { + return (currentWindowTimestamp.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli() - frameSize) >= + objectCurrentWindowTimestamp.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli(); + // currentTime - windowFrame > previousRecordedTimestamp. + } + + /* + public static void main(String[] args) { + LocalDateTime d1 = LocalDateTime.now().withHour(9).withMinute(39).withSecond(04).withNano(0); + LocalDateTime d2 = LocalDateTime.now().withHour(9).withMinute(38).withSecond(22).withNano(0); + System.out.println(d1); + System.out.println(d2); + isRateLimited(d1, d2, 4, 5, 30_000); + } + + public boolean isRequestAllowedV1(String ip) { + + LocalDateTime currentWindowTimestamp = LocalDateTime.now().withSecond(0).withNano(0); + LocalDateTime previousWindowTimestamp = currentWindowTimestamp.minusSeconds(slidingWindowCounter.getWindowFrameSize()); + + long currentRequestCount = 1; // for readability purpose. + + LocalDateTime objectPreviousWindowTimestamp = slidingWindowCounter.getPreviousWindowTimestamp(); + LocalDateTime objectCurrentWindowTimestamp = slidingWindowCounter.getCurrentWindowTimestamp(); + long objectPreviousCount = slidingWindowCounter.getPreviousCount(); + long objectCurrentCount = slidingWindowCounter.getCurrentCount(); + + if (objectPreviousWindowTimestamp == null) { + // initial case + slidingWindowCounter.setPreviousWindowTimestamp(previousWindowTimestamp); + slidingWindowCounter.setCurrentWindowTimestamp(currentWindowTimestamp); + slidingWindowCounter.setPreviousCount(0); + slidingWindowCounter.setCurrentCount(currentRequestCount); + + log.info("Initial Object {}", slidingWindowCounter); + + return true; + } + + // this will always occur due to milliseconds. and + // TODO : objectCurrentWindowTimestamp <= currentWindowTimestamp, "this is case condition" else below + // percentage will be calculated for each request. + if (!currentWindowTimestamp.isEqual(objectCurrentWindowTimestamp)) { + if (previousWindowTimestamp.isEqual(objectCurrentWindowTimestamp)) { + // you are at limit reached or greater! + slidingWindowCounter.setPreviousWindowTimestamp(previousWindowTimestamp); + slidingWindowCounter.setPreviousCount(objectCurrentCount); + } + // this else and else if are same, but I made it two so to learn about conditions. + else if (previousWindowTimestamp.isAfter(objectCurrentWindowTimestamp)) { + slidingWindowCounter.setPreviousCount(0); + slidingWindowCounter.setPreviousWindowTimestamp(previousWindowTimestamp); + } else { + slidingWindowCounter.setPreviousCount(0); + slidingWindowCounter.setPreviousWindowTimestamp(previousWindowTimestamp); + } + slidingWindowCounter.setCurrentCount(0); + slidingWindowCounter.setCurrentWindowTimestamp(currentWindowTimestamp); + } + + log.info("Sliding Window counter at {} is {}", currentWindowTimestamp, slidingWindowCounter); + + // this part will always run no matter what. + long request = findRequestUsingWindowWeight(currentWindowTimestamp, objectCurrentWindowTimestamp, objectPreviousCount, objectCurrentCount); + + if (request > slidingWindowCounter.getThreshold()) { + return false; + } + + slidingWindowCounter.setCurrentCount(slidingWindowCounter.getCurrentCount() + currentRequestCount); + return true; + } + + private Long findRequestUsingWindowWeight(LocalDateTime currentWindowTimestamp, LocalDateTime objectCurrentWindowTimestamp, long objectPreviousCount, long objectCurrentCount) { + long lowerBoundOfCurrentTimeStamp = Math.floorMod(objectCurrentWindowTimestamp.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli(), slidingWindowCounter.getWindowFrameSize() * 1000); + long midTimeStamp = currentWindowTimestamp.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli() - lowerBoundOfCurrentTimeStamp; + + float currentWindowWeight = Float.parseFloat(decimalFormat.format( + (float) (currentWindowTimestamp.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli() - midTimeStamp) / (slidingWindowCounter.getWindowFrameSize() * 1000) + )); + + float previousWindowWeight = 1 - currentWindowWeight; + + // agar abhi ka timestamp window ke currenttimestamp se match nhi karta, toh uss case mein currentWindowWeight*objectCurrentCount hamesha zero hoga + // and uska matlab hai ki hum previous ka hi weight nikal rhe hai, and usse comparison kar rhe hai. + + log.info("Current weight is {}, previous weight is {} and value of current is {} and previous is {}", + currentWindowWeight, previousWindowWeight, currentWindowWeight * objectCurrentCount, previousWindowWeight * objectPreviousCount); + + return (long) Math.ceil(currentWindowWeight * objectCurrentCount + previousWindowWeight * objectPreviousCount); + } + */ +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowLogService.java b/rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowLogService.java new file mode 100644 index 0000000..5f8fab9 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/service/SlidingWindowLogService.java @@ -0,0 +1,52 @@ +package com.learning.ratelimiter.service; + +import com.learning.ratelimiter.algorithm.SlidingWindowLog; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +import java.time.LocalDateTime; +import java.util.concurrent.ConcurrentLinkedDeque; + +//@Component +@Slf4j +public class SlidingWindowLogService { + +// @Autowired + private SlidingWindowLog slidingWindowLog; + + public boolean isRequestAllowed(String ip) { + LocalDateTime currentTimeStamp = LocalDateTime.now(); + int windowTime = slidingWindowLog.getWindowtime(); + + LocalDateTime minusSecondsWindowTime = currentTimeStamp.minusSeconds(windowTime); + + log.info("Need to check between {} and {}", minusSecondsWindowTime, currentTimeStamp); + + ConcurrentLinkedDeque slidingWindowList = slidingWindowLog.getSlidingWindowList(); + + log.info("Before performing sliding operation, window list is {}", slidingWindowList); + + while (!slidingWindowList.isEmpty()) { + SlidingWindowLog.SlidingWindow first = slidingWindowList.getFirst(); + boolean before = first.getLocalDateTime().isBefore(minusSecondsWindowTime); + if (!before) { + break; + } else { + slidingWindowList.removeFirst(); + } + } + + log.info("After performing sliding operation,{} and {} ==" + + " window list is {}", slidingWindowLog.getThreshold(), + slidingWindowList.size(), slidingWindowList); + + if (slidingWindowList.size() > slidingWindowLog.getThreshold()) { + return false; + } else { + slidingWindowList.addLast(new SlidingWindowLog.SlidingWindow(ip, currentTimeStamp)); + return true; + } + } + +} diff --git a/rate-limiter/src/main/java/com/learning/ratelimiter/service/TokenBucketService.java b/rate-limiter/src/main/java/com/learning/ratelimiter/service/TokenBucketService.java new file mode 100644 index 0000000..8809a19 --- /dev/null +++ b/rate-limiter/src/main/java/com/learning/ratelimiter/service/TokenBucketService.java @@ -0,0 +1,41 @@ +package com.learning.ratelimiter.service; + +import com.learning.ratelimiter.algorithm.TokenBucket; +import com.learning.ratelimiter.dto.Token; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.ConcurrentHashMap; + +@Component +@Slf4j +public class TokenBucketService { + +// @Autowired + TokenBucket tokenBucket; + + public Token getToken(String ip) { + /* + check if ip exist? + if exists then check for count of token. + Else + register this ip and insert one token in bucket. + */ + tokenBucket.registerIpBucket(ip); + ConcurrentHashMap> ipBasedTokenBucket = tokenBucket.getIpBasedTokenBucket(); + if (ipBasedTokenBucket.containsKey(ip)) { + BlockingQueue tokens = ipBasedTokenBucket.get(ip); + if (!tokens.isEmpty()) { + return tokens.poll(); + } else { + throw new RuntimeException("Please try again. No Tokens found for this IP, " + + "Rate Limit is reached! Dropping this request"); + } + } else { + // never happening case. + throw new RuntimeException("IP is not registered please check"); + } + } +} diff --git a/rate-limiter/src/main/resources/application.properties b/rate-limiter/src/main/resources/application.properties new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/rate-limiter/src/main/resources/application.properties @@ -0,0 +1 @@ + diff --git a/rate-limiter/src/test/java/com/learning/ratelimiter/RateLimiterApplicationTestsController.java b/rate-limiter/src/test/java/com/learning/ratelimiter/RateLimiterApplicationTestsController.java new file mode 100644 index 0000000..b2e6747 --- /dev/null +++ b/rate-limiter/src/test/java/com/learning/ratelimiter/RateLimiterApplicationTestsController.java @@ -0,0 +1,13 @@ +package com.learning.ratelimiter; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class RateLimiterApplicationTestsController { + + @Test + void contextLoads() { + } + +} From 0d7c43c19bb8375f637aed6d8625c7d22823ab93 Mon Sep 17 00:00:00 2001 From: GauravGuptaDeveloper Date: Tue, 30 Jan 2024 22:35:26 +0530 Subject: [PATCH 2/3] Readme added --- rate-limiter/readme.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 rate-limiter/readme.md diff --git a/rate-limiter/readme.md b/rate-limiter/readme.md new file mode 100644 index 0000000..741959d --- /dev/null +++ b/rate-limiter/readme.md @@ -0,0 +1,25 @@ +### Challenge 27 - Rate-Limiter + +This challenge corresponds to the Rate Limiter which is of the Coding Challenges series by John Crickett. + +### Description +The Rate Limiter is written in Java. The main purpose of this repository is to have understanding of how to build your own rate limiter, you will see that there are many @Bean annotation and filters and algorithm. + +### Build Jar +Clone the project and build the jar, Otherwise I have also added the jar also which can be used directly. Read the usage section. + +```` +./gradlew clean build +```` + +I would highly suggest to clone this project and play with this, and have understanding of rate limiter. + +### How to run it? + +Just simply remove the comment from @Bean annotation and @Component from Services and filter and you are good to go. +This can be improved, but again the main purpose is to learn about rate limiter. + +### Usage +Default port is 8080; + +If you want to use redis then please add redis in localhost or any other server and add the IP in main class. \ No newline at end of file From 56b72968a0f307029683f49564ee7864dc709667 Mon Sep 17 00:00:00 2001 From: Gaurav Gupta <40142723+GauravGuptaDeveloper@users.noreply.github.com> Date: Tue, 30 Jan 2024 22:53:01 +0530 Subject: [PATCH 3/3] Create README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9c24519 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +### Challenge 27 - Rate-Limiter + +This challenge corresponds to the Rate Limiter which is of the Coding Challenges series by John Crickett. + +### Description +The Rate Limiter is written in Java. The main purpose of this repository is to have understanding of how to build your own rate limiter, you will see that there are many @Bean annotation and filters and algorithm. + +### Build Jar +Clone the project and build the jar, Otherwise I have also added the jar also which can be used directly. Read the usage section. + +```` +./gradlew clean build +```` + +I would highly suggest to clone this project and play with this, and have understanding of rate limiter. + +### How to run it? + +Just simply remove the comment from @Bean annotation and @Component from Services and filter and you are good to go. +This can be improved, but again the main purpose is to learn about rate limiter. + +### Usage +Default port is 8080; + +If you want to use redis then please add redis in localhost or any other server and add the IP in main class.