add getMessage, deleteMessage

Author: simonLeary42

resources/autoload.php

@@ -32,6 +32,7 @@
 require_once __DIR__ . "/lib/exceptions/EnsureException.php";
 require_once __DIR__ . "/lib/exceptions/EncodingUnknownException.php";
 require_once __DIR__ . "/lib/exceptions/EncodingConversionException.php";
+require_once __DIR__ . "/lib/exceptions/UnityHTTPDMessageNotFoundException.php";
 
 require_once __DIR__ . "/config.php";
 require __DIR__ . "/init.php";

resources/lib/UnityHTTPD.php

@@ -4,6 +4,7 @@
 
 use UnityWebPortal\lib\exceptions\NoDieException;
 use UnityWebPortal\lib\exceptions\ArrayKeyException;
+use UnityWebPortal\lib\exceptions\UnityHTTPDMessageNotFoundException;
 use RuntimeException;
 
 enum UnityHTTPDMessageLevel: string
@@ -323,8 +324,49 @@ public static function getMessages()
         return $_SESSION["messages"];
     }
 
-    public static function clearMessages()
-    {
-        $_SESSION["messages"] = [];
+    private static function getMessageIndex(
+        UnityHTTPDMessageLevel $level,
+        string $title_regex,
+        string $body_regex,
+    ) {
+        $messages = self::getMessages();
+        $error_msg = sprintf(
+            "message(level='%s' title_regex='%s' body_regex='%s'), not found. found messages: %s",
+            $level->value,
+            $title_regex,
+            $body_regex,
+            jsonEncode($messages),
+        );
+        foreach ($messages as $i => $message) {
+            if (
+                preg_match($title_regex, $message[0]) &&
+                preg_match($body_regex, $message[1]) &&
+                $level == $message[2]
+            ) {
+                return $i;
+            }
+        }
+        throw new UnityHTTPDMessageNotFoundException($error_msg);
+    }
+
+    /* returns the 1st message that matches criteria or throws UnityHTTPDMessageNotFoundException */
+    public static function getMessage(
+        UnityHTTPDMessageLevel $level,
+        string $title_regex,
+        string $body_regex,
+    ) {
+        $index = self::getMessageIndex($level, $title_regex, $body_regex);
+        return $_SESSION["messages"][$index];
+    }
+
+    /* deletes the 1st message that matches criteria or throws UnityHTTPDMessageNotFoundException */
+    public static function deleteMessage(
+        UnityHTTPDMessageLevel $level,
+        string $title_regex,
+        string $body_regex,
+    ) {
+        $index = self::getMessageIndex($level, $title_regex, $body_regex);
+        unset($_SESSION["messages"][$index]);
+        $_SESSION["messages"] = array_values($_SESSION["messages"]);
     }
 }

resources/lib/exceptions/UnityHTTPDMessageNotFoundException

@@ -0,0 +1,5 @@
+<?php
+
+namespace UnityWebPortal\lib\exceptions;
+
+class UnityHTTPDMessageNotFoundException extends \Exception {}

test/functional/PIMemberRequestTest.php

@@ -47,8 +47,7 @@ public function testRequestMembership()
             $this->assertFalse($SQL->requestExists($uid, $gid));
             UnityHTTPD::clearMessages();
             $this->requestMembership("asdlkjasldkj");
-            assertMessageExists(
-                $this,
+            UnityHTTPD::getMessage(
                 UnityHTTPDMessageLevel::ERROR,
                 "/.*/",
                 "/^This PI doesn't exist$/",

test/phpunit-bootstrap.php

@@ -23,6 +23,7 @@
 require_once __DIR__ . "/../resources/lib/exceptions/EnsureException.php";
 require_once __DIR__ . "/../resources/lib/exceptions/EncodingUnknownException.php";
 require_once __DIR__ . "/../resources/lib/exceptions/EncodingConversionException.php";
+require_once __DIR__ . "/../resources/lib/exceptions/UnityHTTPDMessageNotFoundException.php";
 
 use UnityWebPortal\lib\UnityGroup;
 use UnityWebPortal\lib\UnityHTTPD;
@@ -322,29 +323,3 @@ function getAdminUser()
 {
     return ["[email protected]", "foo", "bar", "[email protected]"];
 }
-
-function assertMessageExists(
-    TestCase $test_case,
-    UnityHTTPDMessageLevel $level,
-    string $title_regex,
-    string $body_regex,
-) {
-    $messages = UnityHTTPD::getMessages();
-    $error_msg = sprintf(
-        "message(level='%s' title_regex='%s' body_regex='%s'), not found. found messages: %s",
-        $level->value,
-        $title_regex,
-        $body_regex,
-        jsonEncode($messages),
-    );
-    $messages_with_title = array_filter($messages, fn($x) => preg_match($title_regex, $x[0]));
-    $messages_with_title_and_body = array_filter(
-        $messages_with_title,
-        fn($x) => preg_match($body_regex, $x[1]),
-    );
-    $messages_with_title_and_body_and_level = array_filter(
-        $messages_with_title_and_body,
-        fn($x) => $x[2] == $level,
-    );
-    $test_case->assertNotEmpty($messages_with_title_and_body_and_level, $error_msg);
-}