Merge pull request #29 from binafy/feature-ajax-request

[1.x] Add `Ajax` mode condition for visit monitoring

Author: milwad-dev

README.md

@@ -19,6 +19,7 @@
         - [Delete Visit Monitoring Records By Specific Days](#delete-visit-monitoring-records-by-specific-days)
         - [Turn ON-OFF](#turn-on-off)
         - [Views](#visit-monitoring-views)
+        - [Ajax Requests](#ajax-requests)
     - [Action Monitoring](#action-monitoring)
         - [Views](#action-monitoring-views)
     - [Authentication Monitoring](#authentication-monitoring)
@@ -289,6 +290,26 @@ Laravel-User-Monitoring also has an amazing views that you can use it very easy,
 
 ![Visit Monitoring Preview](/art/visits-monitoring/preview.png "Visit Monitoring")
 
+<a name="ajax-requests"></a>
+### Ajax Requests
+
+Maybe you may disable record visits for `Ajax` requests, you can use config to disable it:
+
+```php
+ 'visit_monitoring' => [
+        ...
+
+        /*
+         * If you want to disable visit monitoring in Ajax mode, set it to false.
+         */
+        'ajax_requests' => true,
+
+        ...
+    ],
+```
+
+When set to false, Ajax requests will not be recorded.
+
 <a name="action-monitoring"></a>
 ## Action Monitoring
 

config/user-monitoring.php

@@ -51,10 +51,15 @@
         'table' => 'visits_monitoring',
 
         /*
-         * If you want to disable visit monitoring, you can change it to false.
+         * If you want to disable visit monitoring, set it to false.
          */
         'turn_on' => true,
 
+        /*
+         * If you want to disable visit monitoring in Ajax mode, set it to false.
+         */
+        'ajax_requests' => true,
+
         /*
          * You can specify pages not to be monitored.
          */

src/Middlewares/VisitMonitoringMiddleware.php

@@ -4,24 +4,22 @@
 
 use Closure;
 use Illuminate\Http\Request;
-use Illuminate\Http\Response;
 use Illuminate\Support\Facades\DB;
 use Jenssegers\Agent\Agent;
 
 class VisitMonitoringMiddleware
 {
     /**
-     * Handle.
-     *
-     * @param  Request $request
-     * @param  Closure $next
-     * @return Response
+     * Handle monitor visiting.
      */
-    public function handle(Request $request, Closure $next)
+    public function handle(Request $request, Closure $next): mixed
     {
         if (config('user-monitoring.visit_monitoring.turn_on', false) === false) {
             return $next($request);
         }
+        if (config('user-monitoring.visit_monitoring.ajax_requests', false) === false && $request->ajax()) {
+            return $next($request);
+        }
 
         $agent = new Agent();
         $guard = config('user-monitoring.user.guard', 'web');
@@ -46,12 +44,8 @@ public function handle(Request $request, Closure $next)
 
     /**
      * Check request page are exists in expect pages.
-     *
-     * @param  string $page
-     * @param  array $exceptPages
-     * @return bool
      */
-    private function checkIsExceptPages(string $page, array $exceptPages)
+    private function checkIsExceptPages(string $page, array $exceptPages): bool
     {
         return collect($exceptPages)->contains($page);
     }

tests/Feature/VisitMonitoringTest.php

@@ -59,6 +59,26 @@
     assertDatabaseMissing(config('user-monitoring.visit_monitoring.table'), ['page' => url('/')]);
 });
 
+// Ajax
+
+test('visit monitoring store ajax requests', function () {
+    get('/', ['X-Requested-With' => 'XMLHttpRequest']);
+
+    // DB Assertions
+    assertDatabaseCount(config('user-monitoring.visit_monitoring.table'), 1);
+    assertDatabaseHas(config('user-monitoring.visit_monitoring.table'), ['created_at' => now()]);
+});
+
+test('visit monitoring skip store when ajax mode is off for ajax requests', function () {
+    config()->set('user-monitoring.visit_monitoring.ajax_requests', false);
+
+    get('/', ['X-Requested-With' => 'XMLHttpRequest']);
+
+    // DB Assertions
+    assertDatabaseCount(config('user-monitoring.visit_monitoring.table'), 0);
+    assertDatabaseMissing(config('user-monitoring.visit_monitoring.table'), ['page' => 'http:\/\/localhost']);
+});
+
 /**
  * Create user.
  *