Merge pull request #36: Update metafiles and code style

roxblnfk · web-flow · commit bc04ee6b805b · 2025-01-10T00:08:20.000+04:00
diff --git a/.gitattributes b/.gitattributes
@@ -1,2 +1,10 @@
-/tests export-ignore
+* text=auto
+
+/.*      export-ignore
 /example export-ignore
+/tests   export-ignore
+/*.xml   export-ignore
+/*.yml   export-ignore
+/*.lock  export-ignore
+/*.dist  export-ignore
+/*.php   export-ignore
diff --git a/.github/workflows/cs-fix.yml b/.github/workflows/cs-fix.yml
@@ -0,0 +1,12 @@
+on:
+  push:
+    branches:
+      - '*'
+
+name: Fix Code Style
+
+jobs:
+  cs-fix:
+    permissions:
+      contents: write
+    uses: spiral/gh-actions/.github/workflows/cs-fix.yml@master
diff --git a/.gitignore b/.gitignore
@@ -1,11 +1,6 @@
-.idea/
-.env
+/runtime
+/vendor
+/.idea
+/.env
 composer.lock
-vendor/
-*.db
-clover.xml
 example/vendor/
-go.sum
-builds/
-.phpunit.result.cache
-.phpunit.cache/
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+require_once 'vendor/autoload.php';
+
+return \Spiral\CodeStyle\Builder::create()
+    ->include(__DIR__ . '/src')
+    ->include(__FILE__)
+    ->allowRisky(true)
+    ->build();
diff --git a/composer.json b/composer.json
@@ -51,6 +51,8 @@
         "jetbrains/phpstorm-attributes": "^1.0",
         "mockery/mockery": "^1.4",
         "phpunit/phpunit": "^10.0",
+        "spiral/code-style": "^2.2",
+        "spiral/dumper": "^3.3",
         "vimeo/psalm": ">=5.8"
     },
     "autoload": {
@@ -66,8 +68,11 @@
         }
     },
     "scripts": {
-        "tests": "phpunit",
-        "psalm": "psalm --no-cache"
+        "cs:diff": "php-cs-fixer fix --dry-run -v --diff --show-progress dots",
+        "cs:fix": "php-cs-fixer fix -v",
+        "psalm": "psalm",
+        "psalm:baseline": "psalm --set-baseline=psalm-baseline.xml",
+        "tests": "phpunit"
     },
     "config": {
         "sort-packages": true
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,19 +1,37 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false"
-         colors="true" processIsolation="false" stopOnFailure="false" stopOnError="false" stderr="true"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd" cacheDirectory=".phpunit.cache"
-         backupStaticProperties="false">
-    <coverage>
-        <include>
-            <directory>src</directory>
-        </include>
-    </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheResultFile="runtime/phpunit/result.cache"
+         backupGlobals="false"
+         colors="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         stopOnError="false"
+         stderr="true"
+         backupStaticProperties="false"
+>
     <testsuites>
         <testsuite name="Test Suite">
             <directory suffix="Test.php">tests</directory>
             <exclude>tests/generated</exclude>
         </testsuite>
     </testsuites>
+    <coverage>
+        <report>
+            <html outputDirectory="runtime/phpunit/coverage"/>
+            <text outputFile="runtime/phpunit/coverage.txt"/>
+            <clover outputFile="runtime/phpunit/logs/clover.xml"/>
+        </report>
+    </coverage>
+    <source>
+        <include>
+            <directory>src</directory>
+        </include>
+        <exclude>
+            <directory>tests</directory>
+        </exclude>
+    </source>
     <php>
         <!-- error_reporting = E_ALL ^ E_DEPRECATED -->
         <ini name="error_reporting" value="24575"/>
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<files psalm-version="dev-master@765dcbfe43002e52e4808b65561842784fe7bcc7"/>
diff --git a/psalm.xml b/psalm.xml
@@ -3,6 +3,7 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    errorBaseline="psalm-baseline.xml"
     errorLevel="1"
     hoistConstants="true"
     resolveFromConfigFile="true"
diff --git a/src/Context.php b/src/Context.php
@@ -16,8 +16,7 @@ final class Context implements ContextInterface, \IteratorAggregate, \Countable,
      */
     public function __construct(
         private array $values,
-    ) {
-    }
+    ) {}
 
     public function withValue(string $key, mixed $value): ContextInterface
     {
diff --git a/src/Internal/Json.php b/src/Internal/Json.php
@@ -33,6 +33,6 @@ public static function encode(mixed $payload): string
      */
     public static function decode(string $payload): array
     {
-        return (array)\json_decode($payload, true, self::DEFAULT_JSON_DEPTH, self::DEFAULT_JSON_FLAGS);
+        return (array) \json_decode($payload, true, self::DEFAULT_JSON_DEPTH, self::DEFAULT_JSON_FLAGS);
     }
 }
diff --git a/src/Invoker.php b/src/Invoker.php
@@ -12,7 +12,6 @@ final class Invoker implements InvokerInterface
     private const ERROR_METHOD_RETURN =
         'Method %s must return an object that instance of %s, ' .
         'but the result provides type of %s';
-
     private const ERROR_METHOD_IN_TYPE =
         'Method %s input type must be an instance of %s, ' .
         'but the input is type of %s';
diff --git a/src/Method.php b/src/Method.php
@@ -16,24 +16,18 @@ final class Method
     private const ERROR_PARAMS_COUNT =
         'The GRPC method %s can only contain 2 parameters (input and output), but ' .
         'signature contains an %d parameters';
-
     private const ERROR_PARAM_UNION_TYPE =
         'Parameter $%s of the GRPC method %s cannot be declared using union type';
-
     private const ERROR_PARAM_CONTEXT_TYPE =
         'The first parameter $%s of the GRPC method %s can only take an instance of %s';
-
     private const ERROR_PARAM_INPUT_TYPE =
         'The second (input) parameter $%s of the GRPC method %s can only take ' .
         'an instance of %s, but type %s is indicated';
-
     private const ERROR_RETURN_UNION_TYPE =
         'Return type of the GRPC method %s cannot be declared using union type';
-
     private const ERROR_RETURN_TYPE =
         'Return type of the GRPC method %s must return ' .
         'an instance of %s, but type %s is indicated';
-
     private const ERROR_INVALID_GRPC_METHOD = 'Method %s is not valid GRPC method.';
 
     /**
@@ -45,7 +39,44 @@ private function __construct(
         public readonly string $name,
         public readonly string $inputType,
         public readonly string $outputType,
-    ) {
+    ) {}
+
+    /**
+     * Returns true if method signature matches.
+     */
+    public static function match(\ReflectionMethod $method): bool
+    {
+        try {
+            self::assertMethodSignature($method);
+        } catch (\Throwable) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Creates a new {@see Method} object from a {@see \ReflectionMethod} object.
+     */
+    public static function parse(\ReflectionMethod $method): Method
+    {
+        try {
+            self::assertMethodSignature($method);
+        } catch (\Throwable $e) {
+            $message = \sprintf(self::ERROR_INVALID_GRPC_METHOD, $method->getName());
+            throw GRPCException::create($message, StatusCode::INTERNAL, $e);
+        }
+
+        [, $input] = $method->getParameters();
+
+        /** @var \ReflectionNamedType $inputType */
+        $inputType = $input->getType();
+
+        /** @var \ReflectionNamedType $returnType */
+        $returnType = $method->getReturnType();
+
+        /** @psalm-suppress ArgumentTypeCoercion */
+        return new self($method->getName(), $inputType->getName(), $returnType->getName());
     }
 
     /**
@@ -75,20 +106,6 @@ public function getOutputType(): string
         return $this->outputType;
     }
 
-    /**
-     * Returns true if method signature matches.
-     */
-    public static function match(\ReflectionMethod $method): bool
-    {
-        try {
-            self::assertMethodSignature($method);
-        } catch (\Throwable) {
-            return false;
-        }
-
-        return true;
-    }
-
     /**
      * @throws \ReflectionException
      */
@@ -231,28 +248,4 @@ private static function assertMethodSignature(\ReflectionMethod $method): void
         // The return type must be declared as a Google\Protobuf\Internal\Message class
         self::assertOutputReturnType($method);
     }
-
-    /**
-     * Creates a new {@see Method} object from a {@see \ReflectionMethod} object.
-     */
-    public static function parse(\ReflectionMethod $method): Method
-    {
-        try {
-            self::assertMethodSignature($method);
-        } catch (\Throwable $e) {
-            $message = \sprintf(self::ERROR_INVALID_GRPC_METHOD, $method->getName());
-            throw GRPCException::create($message, StatusCode::INTERNAL, $e);
-        }
-
-        [, $input] = $method->getParameters();
-
-        /** @var \ReflectionNamedType $inputType */
-        $inputType = $input->getType();
-
-        /** @var \ReflectionNamedType $returnType */
-        $returnType = $method->getReturnType();
-
-        /** @psalm-suppress ArgumentTypeCoercion */
-        return new self($method->getName(), $inputType->getName(), $returnType->getName());
-    }
 }
diff --git a/src/ResponseHeaders.php b/src/ResponseHeaders.php
@@ -39,7 +39,6 @@ public function set(string $key, string $value): void
 
     /**
      * @param THeaderKey $key
-     * @param string|null $default
      * @return THeaderValue|null
      */
     public function get(string $key, ?string $default = null): ?string
diff --git a/src/Server.php b/src/Server.php
@@ -39,8 +39,7 @@ final class Server
     public function __construct(
         private readonly InvokerInterface $invoker = new Invoker(),
         private readonly array $options = [],
-    ) {
-    }
+    ) {}
 
     /**
      * Register new GRPC service.
@@ -63,39 +62,6 @@ public function registerService(string $interface, ServiceInterface $service): v
         $this->services[$service->getName()] = $service;
     }
 
-    /**
-     * @param ContextResponse $data
-     * @return array{0: string, 1: string}
-     * @throws \JsonException
-     * @throws \Throwable
-     */
-    private function tick(string $body, array $data): array
-    {
-        $context = (new Context($data['context']))
-            ->withValue(ResponseHeaders::class, new ResponseHeaders());
-
-        $response = $this->invoke($data['service'], $data['method'], $context, $body);
-
-        /** @var ResponseHeaders|null $responseHeaders */
-        $responseHeaders = $context->getValue(ResponseHeaders::class);
-        $responseHeadersString = $responseHeaders ? $responseHeaders->packHeaders() : '{}';
-
-        return [$response, $responseHeadersString];
-    }
-
-    /**
-     * @psalm-suppress InaccessibleMethod
-     */
-    private function workerSend(WorkerInterface $worker, string $body, string $headers): void
-    {
-        $worker->respond(new Payload($body, $headers));
-    }
-
-    private function workerError(WorkerInterface $worker, string $message): void
-    {
-        $worker->error($message);
-    }
-
     /**
      * Serve GRPC over given RoadRunner worker.
      */
@@ -121,7 +87,7 @@ public function serve(?WorkerInterface $worker = null, ?callable $finalize = nul
             } catch (GRPCExceptionInterface $e) {
                 $this->workerGrpcError($worker, $e);
             } catch (\Throwable $e) {
-                $this->workerError($worker, $this->isDebugMode() ? (string)$e : $e->getMessage());
+                $this->workerError($worker, $this->isDebugMode() ? (string) $e : $e->getMessage());
             } finally {
                 if ($finalize !== null) {
                     isset($e) ? $finalize($e) : $finalize();
@@ -146,6 +112,39 @@ protected function invoke(string $service, string $method, ContextInterface $con
         return $this->services[$service]->invoke($method, $context, $body);
     }
 
+    /**
+     * @param ContextResponse $data
+     * @return array{0: string, 1: string}
+     * @throws \JsonException
+     * @throws \Throwable
+     */
+    private function tick(string $body, array $data): array
+    {
+        $context = (new Context($data['context']))
+            ->withValue(ResponseHeaders::class, new ResponseHeaders());
+
+        $response = $this->invoke($data['service'], $data['method'], $context, $body);
+
+        /** @var ResponseHeaders|null $responseHeaders */
+        $responseHeaders = $context->getValue(ResponseHeaders::class);
+        $responseHeadersString = $responseHeaders ? $responseHeaders->packHeaders() : '{}';
+
+        return [$response, $responseHeadersString];
+    }
+
+    /**
+     * @psalm-suppress InaccessibleMethod
+     */
+    private function workerSend(WorkerInterface $worker, string $body, string $headers): void
+    {
+        $worker->respond(new Payload($body, $headers));
+    }
+
+    private function workerError(WorkerInterface $worker, string $message): void
+    {
+        $worker->error($message);
+    }
+
     private function workerGrpcError(WorkerInterface $worker, GRPCExceptionInterface $e): void
     {
         $status = new Status([
diff --git a/src/ServiceInterface.php b/src/ServiceInterface.php
@@ -7,6 +7,4 @@
 /**
  * Indicates that given class expected to be GRPC service.
  */
-interface ServiceInterface
-{
-}
+interface ServiceInterface {}
diff --git a/tests/ContextTest.php b/tests/ContextTest.php
diff --git a/tests/InvalidInterface.php b/tests/InvalidInterface.php
diff --git a/tests/MethodTest.php b/tests/MethodTest.php
diff --git a/tests/ServerTest.php b/tests/ServerTest.php
diff --git a/tests/ServiceWrapperTest.php b/tests/ServiceWrapperTest.php
diff --git a/tests/Stub/TestService.php b/tests/Stub/TestService.php

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<?xml version="1.0" encoding="UTF-8"?>`
	`2`	`+<files psalm-version="dev-master@765dcbfe43002e52e4808b65561842784fe7bcc7"/>`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,7 @@ final class Context implements ContextInterface, \IteratorAggregate, \Countable,`
`16`	`16`	`*/`
`17`	`17`	`public function __construct(`
`18`	`18`	`private array $values,`
`19`		`- ) {`
`20`		`- }`
	`19`	`+ ) {}`
`21`	`20`
`22`	`21`	`public function withValue(string $key, mixed $value): ContextInterface`
`23`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,6 @@ public static function encode(mixed $payload): string`
`33`	`33`	`*/`
`34`	`34`	`public static function decode(string $payload): array`
`35`	`35`	`{`
`36`		`- return (array)\json_decode($payload, true, self::DEFAULT_JSON_DEPTH, self::DEFAULT_JSON_FLAGS);`
	`36`	`+ return (array) \json_decode($payload, true, self::DEFAULT_JSON_DEPTH, self::DEFAULT_JSON_FLAGS);`
`37`	`37`	`}`
`38`	`38`	`}`