Ratelimiting

api/pom.xml

@@ -25,6 +25,12 @@
             <version>${motech.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>com.github.vladimir-bukhtoyarov</groupId>
+            <artifactId>org.motechproject.com.github.vladimir-bukhtoyarov</artifactId>
+            <version>4.1.1-${external.dependency.release.tag.new}</version>
+        </dependency>
+
         <dependency>
             <groupId>org.motechproject.nms</groupId>
             <artifactId>region</artifactId>

api/src/main/resources/META-INF/motech/applicationContext.xml

@@ -11,6 +11,86 @@
 
     <mvc:annotation-driven />
 
+    <mvc:interceptors>
+        <mvc:interceptor>
+            <mvc:mapping path="/kilkari/user"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+                <constructor-arg type="java.lang.String" value="kilkari_user"></constructor-arg>
+                <constructor-arg type="int" value="100"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+        <mvc:interceptor>
+            <mvc:mapping path="/kilkari/inbox"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+                <constructor-arg type="java.lang.String" value="kilkari_inbox"></constructor-arg>
+                <constructor-arg type="int" value="100"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+        <mvc:interceptor>
+            <mvc:mapping path="/kilkari/subscription"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+                <constructor-arg type="java.lang.String" value="kilkari_subscription"></constructor-arg>
+                <constructor-arg type="int" value="200"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+        <mvc:interceptor>
+            <mvc:mapping path="/kilkari/inboxCallDetails"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+                <constructor-arg type="java.lang.String" value="kilkari_inboxCallDetails"></constructor-arg>
+                <constructor-arg type="int" value="100"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+        <mvc:interceptor>
+            <mvc:mapping path="/mobileacademy/user"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+                <constructor-arg type="java.lang.String" value="mobileacademy_user"></constructor-arg>
+                <constructor-arg type="int" value="100"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+        <mvc:interceptor>
+            <mvc:mapping path="/mobileacademy/sms/status/imi"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+                <constructor-arg type="java.lang.String" value="sms_status_imi"></constructor-arg>
+                <constructor-arg type="int" value="100"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+        <mvc:interceptor>
+            <mvc:mapping path="/mobileacademy/course"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+            <constructor-arg type="java.lang.String" value="mobileacademy_course"></constructor-arg>
+            <constructor-arg type="int" value="100"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+        <mvc:interceptor>
+            <mvc:mapping path="/mobileacademy/courseVersion"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+                <constructor-arg type="java.lang.String" value="mobileacademy_courseVersion"></constructor-arg>
+                <constructor-arg type="int" value="100"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+        <mvc:interceptor>
+            <mvc:mapping path="/mobileacademy/bookmarkWithScore"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+            <constructor-arg type="java.lang.String" value="mobileacademy_bookmarkWithScore"></constructor-arg>
+            <constructor-arg type="int" value="200"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+        <mvc:interceptor>
+            <mvc:mapping path="/mobileacademy/callDetails"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+                <constructor-arg type="java.lang.String" value="mobileacademy_callDetails"></constructor-arg>
+                <constructor-arg type="int" value="100"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+        <mvc:interceptor>
+            <mvc:mapping path="/mobileacademy/languageLocationCode"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+                <constructor-arg type="java.lang.String" value="mobileacademy_languageLocationCode"></constructor-arg>
+                <constructor-arg type="int" value="100"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+    </mvc:interceptors>
+
     <bean id="moduleRegistrationData" class="org.motechproject.osgi.web.ModuleRegistrationData">
         <constructor-arg name="moduleName" value="api" />
         <constructor-arg name="i18n">

imi/pom.xml

@@ -27,6 +27,12 @@
             <version>${motech.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>com.github.vladimir-bukhtoyarov</groupId>
+            <artifactId>org.motechproject.com.github.vladimir-bukhtoyarov</artifactId>
+            <version>4.1.1-${external.dependency.release.tag.new}</version>
+        </dependency>
+
 
         <!-- common properties -->
         <dependency>
@@ -55,6 +61,7 @@
             <version>3.1.0</version>
             <scope>provided</scope>
         </dependency>
+
     </dependencies>
 
     <repositories>
@@ -97,6 +104,7 @@
                             net.sf.cglib.reflect,
                             org.springframework.transaction,
                             org.motechproject.nms.kilkari.repository,
+                            org.motechproject.nms.kilkari.service,
                             org.motechproject.nms.region.service,
                             org.motechproject.nms.region.utils,
                             org.datanucleus.enhancement,

imi/src/main/java/org/motechproject/nms/imi/web/ImiController.java

@@ -212,7 +212,7 @@ public void notifyNewCdrFile(@RequestBody CdrFileNotificationRequest request) {
                     null
             ));
             alertService.create(fileName, "scpCdrFromRemote", error, AlertType.CRITICAL, AlertStatus.NEW, 0, null);
-            throw new IllegalArgumentException(e.getMessage(), e);
+            throw new IllegalArgumentException("Error copying CDR file", e);
         }
 
         // Copy the summary file from the IMI share (imi.remote_cdr_dir) into local cdr dir (imi.local_cdr_dir)
@@ -231,7 +231,7 @@ public void notifyNewCdrFile(@RequestBody CdrFileNotificationRequest request) {
                     null
             ));
             alertService.create(fileName, "scpCdrFromRemote", error, AlertType.CRITICAL, AlertStatus.NEW, 0, null);
-            throw new IllegalArgumentException(e.getMessage(), e);
+            throw new IllegalArgumentException("Error copying CSR file", e);
         }
 
         // Checks the CSR/CDR checksum, record count & csv, then sends an event to proceed to phase 2 of the

imi/src/main/resources/META-INF/motech/applicationContext.xml

@@ -10,7 +10,22 @@
     <context:component-scan base-package="org.motechproject.nms.imi" />
 
     <mvc:annotation-driven />
-
+    <mvc:interceptors>
+        <mvc:interceptor>
+            <mvc:mapping path="/obdFileProcessedStatusNotification"/>
+        <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+            <constructor-arg type="java.lang.String" value="obdFileProcessedStatusNotification"></constructor-arg>
+            <constructor-arg type="int" value="10"></constructor-arg>
+        </bean>
+        </mvc:interceptor>
+        <mvc:interceptor>
+            <mvc:mapping path="/cdrFileNotification"/>
+            <bean class="org.motechproject.nms.kilkari.service.RateLimitInterceptor">
+            <constructor-arg type="java.lang.String" value="cdrFileNotification"></constructor-arg>
+            <constructor-arg type="int" value="10"></constructor-arg>
+            </bean>
+        </mvc:interceptor>
+    </mvc:interceptors>
     <bean id="moduleRegistrationData" class="org.motechproject.osgi.web.ModuleRegistrationData">
         <constructor-arg name="moduleName" value="imi" />
         <constructor-arg name="i18n">

kilkari/pom.xml

@@ -60,6 +60,10 @@
             <artifactId>rejection-handler</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.github.vladimir-bukhtoyarov</groupId>
+            <artifactId>org.motechproject.com.github.vladimir-bukhtoyarov</artifactId>
+        </dependency>
 
     </dependencies>
 

kilkari/src/main/java/org/motechproject/nms/kilkari/service/RateLimitInterceptor.java

@@ -0,0 +1,87 @@
+package org.motechproject.nms.kilkari.service;
+
+import io.github.bucket4j.*;
+import org.springframework.web.servlet.HandlerInterceptor;
+import org.springframework.web.servlet.ModelAndView;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.time.Duration;
+import java.util.concurrent.TimeUnit;
+
+public class RateLimitInterceptor implements HandlerInterceptor {
+    //
+    private final Bucket bucket;
+    private final String url = "http://192.168.200.4:8080/NMSReportingSuite/nms/mail/emailAlert";
+    private final String api;
+    private final String USER_AGENT = "Mozilla/5.0";
+    private final int capacity;
+    private final String email = "[email protected]";
+
+    public RateLimitInterceptor(int capacity, String api) {
+        this.capacity = capacity;
+        Refill refill = Refill.intervally(capacity, Duration.ofMinutes(1));
+        Bandwidth limit = Bandwidth.classic(capacity, refill);
+        this.bucket = Bucket4j.builder().addLimit(limit).build();
+        this.api = api;
+    }
+
+    @Override
+    public boolean preHandle(HttpServletRequest request,
+                             HttpServletResponse response, Object handler) throws Exception {
+        System.out.println("Inside pre handle");
+        ConsumptionProbe probe = this.bucket.tryConsumeAndReturnRemaining(1);
+
+        if (probe.isConsumed()) {
+            long remTokens = probe.getRemainingTokens();
+            response.addHeader("X-Rate-Limit-Remaining",
+                    Long.toString(remTokens));
+            System.out.println("remaning tokens for this api for this min "+remTokens);
+            if(remTokens==(0.4*capacity)){
+                sendEmailAlert(remTokens, "warning", 60);
+                System.out.println("sendEmailAlert "+api + remTokens);
+            }
+            if(remTokens==(0.2*capacity)){
+                sendEmailAlert(remTokens, "critical", 80);
+            }
+            return true;
+        }
+
+        response.setStatus(429); // 429
+        response.addHeader("X-Rate-Limit-Retry-After-Milliseconds",
+                Long.toString(TimeUnit.NANOSECONDS.toMillis(probe.getNanosToWaitForRefill())));
+
+        return false;
+    }
+
+    @Override
+    public void postHandle(HttpServletRequest req, HttpServletResponse res,
+                           Object handler, ModelAndView model)  throws Exception {
+    }
+
+    // Called after rendering the view
+    @Override
+    public void afterCompletion(HttpServletRequest req, HttpServletResponse res,
+                                Object handler, Exception ex)  throws Exception {
+    }
+
+    public void sendEmailAlert(long remTokens, String status, long perc) throws Exception {
+        String finalUrl = url + "?api=" + api + "&capacity=" + remTokens + "&email=" + email + "&status=" + status
+                 + "&perc=" + perc;
+        URL obj = new URL(finalUrl);
+        HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+
+        // optional default is GET
+        con.setRequestMethod("GET");
+
+        //add request header
+        con.setRequestProperty("User-Agent", USER_AGENT);
+
+        int responseCode = con.getResponseCode();
+        System.out.println("\nSending 'GET' request to URL : " + finalUrl);
+        System.out.println("Response Code : " + responseCode);
+    }
+
+}

pom.xml

@@ -661,6 +661,11 @@
                     </exclusion>
                 </exclusions>
             </dependency>
+            <dependency>
+                <groupId>com.github.vladimir-bukhtoyarov</groupId>
+                <artifactId>org.motechproject.com.github.vladimir-bukhtoyarov</artifactId>
+                <version>4.1.1-${external.dependency.release.tag.new}</version>
+            </dependency>
             <dependency>
                 <groupId>org.motechproject</groupId>
                 <artifactId>motech-platform-osgi-extender-fragment</artifactId>