Merge pull request #140 from tsmilan/issue-139

[#139] Add configurable request timeout

Author: brendanheywood

classes/esrequest.php

@@ -57,7 +57,8 @@ public function __construct($handler = false) {
         $this->signing = (isset($this->config->signing) ? (bool)$this->config->signing : false);
 
         $config = [
-            'connect_timeout' => intval($this->config->connecttimeout)
+            'timeout' => isset($this->config->timeout) ? intval($this->config->timeout) : 0,
+            'connect_timeout' => intval($this->config->connecttimeout),
         ];
 
         // Allow the caller to instantiate the Guzzle client with a custom handler.

classes/task/retry_errors_task.php

@@ -100,7 +100,6 @@ private function retry_single($errorid): array {
                 $successcount++;
             } else {
                 $errorcount++;
-                $error->mark_failed();
                 mtrace("Failed to retry error ID {$errorid}: {$result['message']}");
             }
 

lang/en/search_elastic.php

@@ -185,6 +185,8 @@
 $string['tikasendsize_help'] = 'Sending large files to Tika can cause out of memory issues. Therefore we limit it to a size in bytes.';
 $string['timecreated'] = 'Created';
 $string['timemodified'] = 'Timemodified';
+$string['timeout'] = 'Request timeout';
+$string['timeout_desc'] = 'Maximum time in seconds to wait for HTTP requests to complete. Defaults to 0 to wait indefinitely (the default behavior).';
 $string['type_indexing'] = 'Indexing';
 $string['type_tika'] = 'Tika';
 $string['usesimplequery'] = 'Use simple query';

settings.php

@@ -58,6 +58,9 @@
     $settings->add(new admin_setting_configtext('search_elastic/connecttimeout', get_string('connecttimeout', 'search_elastic'),
         get_string('connecttimeout_help', 'search_elastic'), 5, PARAM_INT));
 
+    $settings->add(new admin_setting_configtext('search_elastic/timeout', get_string('timeout', 'search_elastic'),
+        get_string('timeout_desc', 'search_elastic'), 0, PARAM_INT));
+
     $settings->add(new admin_setting_heading('signingsettings', get_string('signingsettings', 'search_elastic'), ''));
     $settings->add(new admin_setting_configcheckbox('search_elastic/signing', get_string('signing', 'search_elastic'),
         get_string ('signing_help', 'search_elastic'), 0));

tests/esrequest_test.php

@@ -429,4 +429,28 @@ public function test_proxy_get() {
         $this->assertEquals('bar=blerg', $request->getUri()->getQuery());
         $this->assertEquals($expected, $lastrequestoptions['proxy']);
     }
+
+    /**
+     * Test constructor applies configured timeout.
+     */
+    public function test_constructor_configured_timeout(): void {
+        $this->resetAfterTest();
+
+        // Mock config with timeout setting.
+        set_config('timeout', 60, 'search_elastic');
+        set_config('connecttimeout', 5, 'search_elastic');
+
+        $esrequest = new esrequest();
+
+        // Use reflection to access private client.
+        $reflection = new \ReflectionClass($esrequest);
+        $clientproperty = $reflection->getProperty('client');
+        $clientproperty->setAccessible(true);
+        $client = $clientproperty->getValue($esrequest);
+
+        // Assert configured timeout is applied.
+        $clientconfig = $client->getConfig();
+        $this->assertEquals(60, $clientconfig['timeout']);
+        $this->assertEquals(5, $clientconfig['connect_timeout']);
+    }
 }

tests/local/service/error_service_test.php

@@ -542,6 +542,43 @@ public function test_get_error_count_different_statuses($status): void {
         $this->assertEquals(0, $othercount);
     }
 
+    /**
+     * Test that extract_file_contents method handles timeout correctly.
+     */
+    public function test_extract_file_contents_handles_timeout(): void {
+        $this->resetAfterTest();
+
+        // Set up Tika configuration.
+        set_config('tikahostname', 'http://127.0.0.1', 'search_elastic');
+        set_config('tikaport', 9998, 'search_elastic');
+        set_config('tikasendsize', 512000000, 'search_elastic');
+        set_config('timeout', 5, 'search_elastic');
+        set_config('connecttimeout', 2, 'search_elastic');
+
+        // Create a test file.
+        $file = $this->create_test_file();
+
+        // Test with reflection since extract_file_contents is private.
+        $reflection = new \ReflectionClass('search_elastic\local\service\error_service');
+        $method = $reflection->getMethod('extract_file_contents');
+        $method->setAccessible(true);
+
+        // Test that request timeout is handled properly and not throw an exception.
+        $result = false;
+        $exceptionthrown = false;
+
+        try {
+            $result = $method->invoke(null, $file);
+            $this->assertdebuggingcalledcount(1);
+        } catch (\Exception $e) {
+            $exceptionthrown = true;
+        }
+
+        // Verify that timeout should be handled gracefully, and not crash the indexing task.
+        $this->assertFalse($exceptionthrown);
+        $this->assertFalse($result);
+    }
+
     public function tearDown(): void {
         parent::tearDown();
         if ($this->generator) {

version.php

@@ -24,7 +24,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2025062708;
+$plugin->version   = 2025080100;
 $plugin->release   = '4.2.6 (Build: 20250514)'; // Build same as version.
 $plugin->requires  = 2023042405;
 $plugin->component = 'search_elastic';