Merge pull request #3406 from thekesolutions/dis_1653

DIS-1653: Add spellcheckMaxCollationTries to system_variables

Author: mdnoble73

code/web/release_notes/25.12.00.MD

@@ -216,6 +216,10 @@
 ### Indexing Updates
 - Add SolrCloud support by using the Schema API instead of downloading the schema file. (DIS-1569) (*TC*)
 
+#### New Settings
+- System Administration > System Variables > Spellcheck Max Collation Tries (DIS-1653) (*TC*)
+  - New setting to limit the number of tries for spellcheck collation to improve performance on large datasets.
+
 ## This release includes code contributions from
 ### ByWater Solutions
 - Leo Stoyanov (LS)

code/web/sys/DBMaintenance/version_updates/25.12.00.php

@@ -182,7 +182,17 @@ function getUpdates25_12_00(): array {
 					genericArtCode TINYTEXT
 				) ENGINE = InnoDB",
 			]
-		]
+		],
+
+		// Tomas Cohen Arazi - Theke Solutions
+		'configurable_solr_spellcheck_collation' => [
+			'title' => 'SolR - Spellcheck Collation max tries',
+			'description' => 'Make SolR spellcheck.maxCollationTries configurable',
+			'sql' => [
+				"ALTER TABLE system_variables ADD COLUMN spellcheckMaxCollationTries int(11) DEFAULT 25 AFTER solrQueryTimeout;"
+			],
+		],
+
 		//other
 
 	];

code/web/sys/SolrConnector/Solr.php

@@ -1332,6 +1332,10 @@ function search($query, $handler = null, $filter = null, $start = 0, $limit = 20
 
 		// Enable Spell Checking
 		if ($spell != '') {
+			require_once ROOT_DIR . '/sys/SystemVariables.php';
+			$systemVariables = SystemVariables::getSystemVariables();
+			$maxCollationTries = ($systemVariables && $systemVariables->spellcheckMaxCollationTries > 0) ? $systemVariables->spellcheckMaxCollationTries : 25;
+
 			$options['spellcheck'] = 'true';
 			$options['spellcheck.q'] = $spell;
 //			if ($dictionary != null) {
@@ -1347,7 +1351,7 @@ function search($query, $handler = null, $filter = null, $start = 0, $limit = 20
 			$options['spellcheck.collateParam.mm'] = '100%';
 			$options['spellcheck.maxCollations'] = 5;
 			$options['spellcheck.collateExtendedResults'] = 'true';
-			$options['spellcheck.maxCollationTries'] = 25;
+			$options['spellcheck.maxCollationTries'] = $maxCollationTries;
 			$options['spellcheck.accuracy'] = .5;
 		}
 

code/web/sys/SystemVariables.php

@@ -32,6 +32,7 @@ class SystemVariables extends DataObject {
 	public $libraryToUseForPayments;
 	public $solrConnectTimeout;
 	public $solrQueryTimeout;
+	public $spellcheckMaxCollationTries;
 	public $catalogStatus;
 	public $offlineMessage;
 	public $appScheme;
@@ -303,6 +304,16 @@ static function getObjectStructure(string $context = ''): array {
 				'default' => 10,
 				'min' => 1,
 			],
+			'spellcheckMaxCollationTries' => [
+				'property' => 'spellcheckMaxCollationTries',
+				'type' => 'integer',
+				'label' => 'Spellcheck Max Collation Tries',
+				'description' => 'Maximum number of collation attempts for spellcheck queries (lower values improve performance)',
+				'required' => true,
+				'default' => 25,
+				'min' => 1,
+				'max' => 50,
+			],
 			'catalogStatus' => [
 				'property' => 'catalogStatus',
 				'type' => 'enum',