Merge pull request #718 from jaredhendrickson13/next_patch

v2.5.2 Fixes

Author: jaredhendrickson13

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Fields/FloatField.inc

@@ -144,8 +144,8 @@ class FloatField extends RESTAPI\Core\Field {
 
         # Otherwise, the internal value cannot be represented by this Field. Throw an error.
         throw new RESTAPI\Responses\ServerError(
-            message: "Cannot parse FloatField '$this->name' from internal because its internal value is not
-                    a numeric value. Consider changing this field to a StringField.",
+            message: "Cannot parse FloatField '$this->name' from internal because its internal value is not " .
+                'a numeric value. Consider changing this field to a StringField.',
             response_id: 'FLOAT_FIELD_WITH_NON_FLOAT_INTERNAL_VALUE',
         );
     }

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/SystemStatus.inc

@@ -116,7 +116,7 @@ class SystemStatus extends Model {
             allow_null: true,
             read_only: true,
             many: true,
-            delimiter: ', ',
+            delimiter: ' ',
             help_text: 'The CPU load averages. The first value represents the load average for the last minute, the ' .
                 'second value represents the load average for the last 5 minutes, and the third value represents the ' .
                 'load average for the last 15 minutes.',
@@ -181,7 +181,7 @@ class SystemStatus extends Model {
             'mds_mitigation' => get_single_sysctl('hw.mds_disable_state'),
             'temp_c' => $this->get_system_temp(),
             'temp_f' => $this->get_system_temp(as_fahrenheit: true),
-            'cpu_load_avg' => get_load_average(),
+            'cpu_load_avg' => $this->get_cpu_load_average(),
             'cpu_count' => get_single_sysctl('hw.ncpu'),
             'cpu_usage' => $this->get_cpu_usage(),
             'mbuf_usage' => $this->get_mbuf_usage(),
@@ -223,6 +223,24 @@ class SystemStatus extends Model {
         return $as_fahrenheit ? $temp * 1.8 + 32 : $temp;
     }
 
+    /**
+     * Obtains the CPU load average. This method is responsible for obtaining the raw load average string from pfSense
+     * and ensuring it is formatted correctly before the cpu_load_average field splits it into an array.
+     * @return string|null The CPU load average as a string or null if it could not be obtained.
+     */
+    private function get_cpu_load_average(): ?string {
+        # Obtain the load average using pfSense's get_load_average() function
+        $load_avg = get_load_average();
+
+        # The system language may affect the load average's delimiter (missing a comma in some languages)
+        # ensure values are only ever separated by a single space (no commas). #716
+        if (str_contains($load_avg, ', ')) {
+            $load_avg = str_replace(', ', ' ', $load_avg);
+        }
+
+        return $load_avg ?? null;
+    }
+
     /**
      * Determines approximate CPU usage using the last minute load average.
      * @return float|null The CPU usage as a whole percentage.

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Tests/APIModelsSystemStatusTestCase.inc

@@ -3,6 +3,7 @@
 namespace RESTAPI\Tests;
 
 use RESTAPI\Core\Command;
+use RESTAPI\Core\Model;
 use RESTAPI\Core\TestCase;
 use RESTAPI\Models\SystemStatus;
 
@@ -44,4 +45,33 @@ class APIModelsSystemStatusTestCase extends TestCase {
             (new Command(command: '/bin/kenv -q smbios.bios.reldate 2>/dev/null', trim_whitespace: true))->output,
         );
     }
+
+    /**
+     * Checks that the load average can can be read correctly despite the system's assign language. Normally,
+     * the load average format can change based on the systems assigned language and cause issues parsing the
+     * value into an array. This is a regression test for #716.
+     */
+    public function test_language_does_not_change_cpu_load_avg(): void {
+        # Change the language to German
+        Model::set_config('system/language', 'de_DE');
+        set_language();
+
+        # Ensure we can read the SystemStatus cpu_load_average without an error
+        $this->assert_does_not_throw(
+            callable: function () {
+                $system_status = new SystemStatus();
+                $this->assert_equals(count($system_status->cpu_load_avg->value), 3);
+            },
+        );
+
+        # Reset the language to English and check again
+        Model::set_config('system/language', 'en_US');
+        set_language();
+        $this->assert_does_not_throw(
+            callable: function () {
+                $system_status = new SystemStatus();
+                $this->assert_equals(count($system_status->cpu_load_avg->value), 3);
+            },
+        );
+    }
 }