MSI 100%, Fix typo, Remove .gitkeep, Add functions to "use" (#36)

yiisoft · Jun 30, 2023 · de79472 · de79472
1 parent 5a23c43
commit de79472
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 8 deletions.
diff --git a/src/.gitkeep b/src/.gitkeep
diff --git a/src/TrustedHostsNetworkResolver.php b/src/TrustedHostsNetworkResolver.php
@@ -17,6 +17,12 @@
 use Yiisoft\Validator\Rule\Ip;
 use Yiisoft\Validator\ValidatorInterface;
 
+use function count;
+use function in_array;
+use function is_array;
+use function is_callable;
+use function is_string;
+
 /**
  * Scans the entire connection chain and resolves the data from forwarded headers taking into account trusted IPs.
  * Additionally, all items' structure is thoroughly validated because headers' data can't be trusted. The following data
@@ -399,9 +405,9 @@ private function assertNonEmpty(string|array $value, string $name, bool $inRunti
             return;
         }
 
-        $expeptionClassName = $inRuntime ? RuntimeException::class : InvalidArgumentException::class;
+        $exceptionClassName = $inRuntime ? RuntimeException::class : InvalidArgumentException::class;
 
-        throw new $expeptionClassName("$name can't be empty.");
+        throw new $exceptionClassName("$name can't be empty.");
     }
 
     /**
@@ -421,9 +427,9 @@ private function assertExactKeysForArray(
 
         $allowedKeysStr = implode('", "', $allowedKeys);
         $message = "Invalid array keys for $name. The allowed and required keys are: \"$allowedKeysStr\".";
-        $expeptionClassName = $inRuntime ? RuntimeException::class : InvalidArgumentException::class;
+        $exceptionClassName = $inRuntime ? RuntimeException::class : InvalidArgumentException::class;
 
-        throw new $expeptionClassName($message);
+        throw new $exceptionClassName($message);
     }
 
     /**
@@ -436,9 +442,9 @@ private function assertIsNonEmptyString(mixed $value, string $name, bool $inRunt
             return;
         }
 
-        $expeptionClassName = $inRuntime ? RuntimeException::class : InvalidArgumentException::class;
+        $exceptionClassName = $inRuntime ? RuntimeException::class : InvalidArgumentException::class;
 
-        throw new $expeptionClassName("$name must be non-empty string.");
+        throw new $exceptionClassName("$name must be non-empty string.");
     }
 
     /**
@@ -455,9 +461,9 @@ private function assertIsAllowedProtocol(mixed $value, string $name, bool $inRun
 
         $allowedProtocolsStr = implode('", "', self::ALLOWED_PROTOCOLS);
         $message = "$name must be a valid protocol. Allowed values are: \"$allowedProtocolsStr\" (case-sensitive).";
-        $expeptionClassName = $inRuntime ? RuntimeException::class : InvalidArgumentException::class;
+        $exceptionClassName = $inRuntime ? RuntimeException::class : InvalidArgumentException::class;
 
-        throw new $expeptionClassName($message);
+        throw new $exceptionClassName($message);
     }
 
     private function handleNotTrusted(
@@ -521,6 +527,9 @@ private function normalizeHeaderName(string $headerName): string
      * @psalm-param non-empty-string $remoteAddr
      *
      * @psalm-return array{0: ForwardedHeaderGroup, 1: list<RawConnectionChainItem>}
+     *
+     * @throws InvalidConnectionChainItemException
+     * @throws RfcProxyParseException
      */
     private function getConnectionChainItems(string $remoteAddr, ServerRequestInterface $request): array
     {
@@ -609,6 +618,9 @@ private function getProtocolFromSeparateHeader(
      * @psalm-return list<RawConnectionChainItem>
      *
      * @link https://tools.ietf.org/html/rfc7239
+     *
+     * @throws RfcProxyParseException
+     * @throws InvalidConnectionChainItemException
      */
     private function parseProxiesFromRfcHeader(array $proxyItems): array
     {
@@ -701,6 +713,8 @@ private function parseProxiesFromRfcHeader(array $proxyItems): array
 
     /**
      * @psalm-return RawConnectionChainItem
+     *
+     * @throws InvalidConnectionChainItemException
      */
     private function getConnectionChainItem(
         ?string $ip = null,

diff --git a/tests/.gitkeep b/tests/.gitkeep
diff --git a/tests/TrustedHostsNetworkResolver/ConfigurationExceptionTest.php b/tests/TrustedHostsNetworkResolver/ConfigurationExceptionTest.php
@@ -125,6 +125,19 @@ public function dataWithForwardedHeaderGroupsException(): array
                 ],
                 'Header name for "host" must be non-empty string.',
             ],
+            'ip: value is empty string' => [
+                [
+                    TrustedHostsNetworkResolver::FORWARDED_HEADER_RFC,
+                    [
+                        'ip' => '',
+                        'protocol' => 'y-forwarded-proto',
+                        'host' => 'y-forwarded-host',
+                        'port' => 'y-forwarded-port',
+                    ],
+                    TrustedHostsNetworkResolver::FORWARDED_HEADER_GROUP_X_PREFIX,
+                ],
+                'Header name for "ip" must be non-empty string.',
+            ],
             'protocol: value is neither a string nor an array' => [
                 [
                     TrustedHostsNetworkResolver::FORWARDED_HEADER_RFC,
@@ -243,6 +256,22 @@ public function dataWithForwardedHeaderGroupsException(): array
                 ],
                 'Protocol header resolving must be specified either via an associative array or a callable.',
             ],
+            'protocol, array, resolving: name equal to exists function' => [
+                [
+                    TrustedHostsNetworkResolver::FORWARDED_HEADER_RFC,
+                    [
+                        'ip' => 'y-forwarded-for',
+                        'protocol' => [
+                            '\Yiisoft\ProxyMiddleware\Tests\TrustedHostsNetworkResolver\testCallableFunction',
+                            'test',
+                        ],
+                        'host' => 'y-forwarded-host',
+                        'port' => 'y-forwarded-port',
+                    ],
+                    TrustedHostsNetworkResolver::FORWARDED_HEADER_GROUP_X_PREFIX,
+                ],
+                'Protocol header resolving must be specified either via an associative array or a callable.',
+            ],
             'protocol, array, resolving: array, empty' => [
                 [
                     TrustedHostsNetworkResolver::FORWARDED_HEADER_RFC,
@@ -388,3 +417,7 @@ public function testWithConnectionChainItemsAttributeException(): void
         $middleware->withConnectionChainItemsAttribute('');
     }
 }
+
+function testCallableFunction(): void
+{
+}