From 9a0f174b66a77fa6ea44a976de2f3d649db6cbf2 Mon Sep 17 00:00:00 2001
From: Coleman Watts <coleman@civicrm.org>
Date: Wed, 18 Aug 2021 16:26:53 -0400
Subject: [PATCH] SearchKit - Allow random sorting

---
 Civi/Api4/Query/SqlFunctionRAND.php           | 32 +++++++++++++++++++
 .../crmSearchAdminDisplay.component.js        | 16 +++++++---
 .../crmSearchAdminDisplaySort.html            |  2 +-
 .../phpunit/api/v4/Action/SqlFunctionTest.php | 17 ++++++++++
 4 files changed, 62 insertions(+), 5 deletions(-)
 create mode 100644 Civi/Api4/Query/SqlFunctionRAND.php

diff --git a/Civi/Api4/Query/SqlFunctionRAND.php b/Civi/Api4/Query/SqlFunctionRAND.php
new file mode 100644
index 000000000000..1cb0cfeeb915
--- /dev/null
+++ b/Civi/Api4/Query/SqlFunctionRAND.php
@@ -0,0 +1,32 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+namespace Civi\Api4\Query;
+
+/**
+ * Sql function
+ */
+class SqlFunctionRAND extends SqlFunction {
+
+  protected static $category = self::CATEGORY_MATH;
+
+  protected static function params(): array {
+    return [];
+  }
+
+  /**
+   * @return string
+   */
+  public static function getTitle(): string {
+    return ts('Random Number');
+  }
+
+}
diff --git a/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplay.component.js b/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplay.component.js
index 7ea85b38884a..a5694f4c421f 100644
--- a/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplay.component.js
+++ b/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplay.component.js
@@ -251,10 +251,18 @@
           return _.findIndex(ctrl.display.settings.sort, [key]) >= 0;
         }
         return {
-          results: [{
-            text: ts('Columns'),
-            children: ctrl.crmSearchAdmin.getSelectFields(disabledIf)
-          }].concat(ctrl.crmSearchAdmin.getAllFields('', ['Field', 'Custom'], disabledIf))
+          results: [
+            {
+              text: ts('Random'),
+              icon: 'crm-i fa-random',
+              id: 'RAND()',
+              disabled: disabledIf('RAND()')
+            },
+            {
+              text: ts('Columns'),
+              children: ctrl.crmSearchAdmin.getSelectFields(disabledIf)
+            }
+          ].concat(ctrl.crmSearchAdmin.getAllFields('', ['Field', 'Custom'], disabledIf))
         };
       };
 
diff --git a/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplaySort.html b/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplaySort.html
index 4e548899aa97..a3a1cf737e23 100644
--- a/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplaySort.html
+++ b/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplaySort.html
@@ -1,7 +1,7 @@
 <div class="form-inline" ng-repeat="sort in $ctrl.display.settings.sort">
   <label for="crm-search-display-sort-{{$index}}">{{ $index ? ts('Also by') : ts('Sort by') }}</label>
   <input id="crm-search-display-sort-{{$index}}" class="form-control huge" ng-model="sort[0]" crm-ui-select="{data: $ctrl.parent.fieldsForSort}" />
-  <select class="form-control" ng-model="sort[1]">
+  <select class="form-control" ng-model="sort[1]" ng-show="sort[0] !== 'RAND()'">
     <option value="ASC">{{ ts('Ascending') }}</option>
     <option value="DESC">{{ ts('Descending') }}</option>
   </select>
diff --git a/tests/phpunit/api/v4/Action/SqlFunctionTest.php b/tests/phpunit/api/v4/Action/SqlFunctionTest.php
index 078b9eeaa82a..5cf7373770d8 100644
--- a/tests/phpunit/api/v4/Action/SqlFunctionTest.php
+++ b/tests/phpunit/api/v4/Action/SqlFunctionTest.php
@@ -199,4 +199,21 @@ public function testIncorrectNumberOfArguments() {
     }
   }
 
+  public function testRandFunction() {
+    $cid = Contact::create(FALSE)
+      ->addValue('first_name', 'hello')
+      ->execute()->first()['id'];
+
+    $result = Contact::get(FALSE)
+      ->addSelect('RAND() AS rand')
+      ->addOrderBy('RAND()')
+      ->setDebug(TRUE)
+      ->setLimit(1)
+      ->execute();
+
+    $this->assertStringContainsString('ORDER BY RAND()', $result->debug['sql'][0]);
+    $this->assertGreaterThanOrEqual(0, $result[0]['rand']);
+    $this->assertLessThan(1, $result[0]['rand']);
+  }
+
 }