Run basic psalm step in CI (#1062)

simPod · web-flow · commit e46d7c4765c4 · 2022-01-31T12:16:30.000+01:00
diff --git a/.gitattributes b/.gitattributes
@@ -16,3 +16,5 @@ phpbench.json export-ignore
 phpstan.neon.dist export-ignore
 phpstan-baseline.neon export-ignore
 phpunit.xml.dist export-ignore
+psalm.xml.dist export-ignore
+psalm-baseline.xml export-ignore
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -34,3 +34,29 @@ jobs:
 
       - name: "Run a static analysis with phpstan/phpstan"
         run: "vendor/bin/phpstan --error-format=checkstyle | cs2pr"
+
+  static-analysis-psalm:
+    name: "Static Analysis with Psalm"
+    runs-on: "ubuntu-20.04"
+
+    strategy:
+      matrix:
+        php-version:
+          - "8.1"
+
+    steps:
+      - name: "Checkout code"
+        uses: "actions/checkout@v2"
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "none"
+          php-version: "${{ matrix.php-version }}"
+          tools: "cs2pr"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v2"
+
+      - name: "Run a static analysis with vimeo/psalm"
+        run: "vendor/bin/psalm --output-format=github --shepherd"
diff --git a/.gitignore b/.gitignore
@@ -3,5 +3,6 @@
 composer.lock
 composer.phar
 phpstan.neon
+psalm.xml
 vendor
 .idea
diff --git a/README.md b/README.md
@@ -3,6 +3,7 @@
 [![CI](https://github.com/webonyx/graphql-php/workflows/CI/badge.svg)](https://github.com/webonyx/graphql-php/actions?query=workflow:CI+branch:master)
 [![Coverage Status](https://codecov.io/gh/webonyx/graphql-php/branch/master/graph/badge.svg)](https://codecov.io/gh/webonyx/graphql-php/branch/master)
 [![Latest Stable Version](https://poser.pugx.org/webonyx/graphql-php/version)](https://packagist.org/packages/webonyx/graphql-php)
+[![Shepherd Type](https://shepherd.dev/github/webonyx/graphql-php/coverage.svg)](ttps://shepherd.dev/github/webonyx/graphql-php)
 
 This is a PHP implementation of the GraphQL [specification](https://github.com/graphql/graphql-spec)
 based on the [reference implementation in JavaScript](https://github.com/graphql/graphql-js).
diff --git a/composer.json b/composer.json
@@ -26,11 +26,13 @@
     "phpstan/phpstan-phpunit": "^1",
     "phpstan/phpstan-strict-rules": "^1",
     "phpunit/phpunit": "^9.5",
+    "psalm/plugin-phpunit": "^0.16.1",
     "psr/http-message": "^1",
     "react/promise": "^2",
     "symfony/polyfill-php81": "^1.23",
     "symfony/var-exporter": "^5.3",
-    "thecodingmachine/safe": "^1.3"
+    "thecodingmachine/safe": "^1.3",
+    "vimeo/psalm": "^4.19"
   },
   "suggest": {
     "psr/http-message": "To use standard GraphQL server",
@@ -50,6 +52,7 @@
   },
   "config": {
     "allow-plugins": {
+      "composer/package-versions-deprecated": true,
       "ergebnis/composer-normalize": true,
       "phpstan/extension-installer": true
     },
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<files psalm-version="4.19.0@a2ad69ae4f5ab1f7d225a8dc4e2ec2d9415ed599">
+  <file src="src/Language/Lexer.php">
+    <InvalidParamDefault occurrences="1">
+      <code>ParserOptions</code>
+    </InvalidParamDefault>
+    <InvalidTypeImport occurrences="1">
+      <code>ParserOptions from Parser</code>
+    </InvalidTypeImport>
+  </file>
+  <file src="src/Language/Parser.php">
+    <UndefinedDocblockClass occurrences="5">
+      <code>ParserOptions</code>
+      <code>ParserOptions</code>
+      <code>ParserOptions</code>
+      <code>ParserOptions</code>
+      <code>array{string, ParserOptions}</code>
+    </UndefinedDocblockClass>
+  </file>
+  <file src="src/Language/Visitor.php">
+    <EmptyArrayAccess occurrences="1">
+      <code>$path[count($path) - 1]</code>
+    </EmptyArrayAccess>
+  </file>
+  <file src="src/Type/Definition/FieldDefinition.php">
+    <UndefinedDocblockClass occurrences="5">
+      <code>$this-&gt;config</code>
+      <code>ComplexityFn|null</code>
+      <code>FieldDefinitionConfig</code>
+      <code>FieldsConfig</code>
+      <code>array</code>
+    </UndefinedDocblockClass>
+  </file>
+  <file src="src/Type/Definition/InterfaceType.php">
+    <InvalidTypeImport occurrences="1">
+      <code>FieldsConfig from FieldDefinition</code>
+    </InvalidTypeImport>
+  </file>
+  <file src="src/Type/Definition/UnresolvedFieldDefinition.php">
+    <InvalidTypeImport occurrences="1">
+      <code>UnnamedFieldDefinitionConfig from FieldDefinition</code>
+    </InvalidTypeImport>
+  </file>
+  <file src="src/Utils/ASTDefinitionBuilder.php">
+    <InvalidTypeImport occurrences="1">
+      <code>UnnamedFieldDefinitionConfig from FieldDefinition</code>
+    </InvalidTypeImport>
+  </file>
+  <file src="src/Utils/BuildClientSchema.php">
+    <InvalidTypeImport occurrences="1">
+      <code>UnnamedFieldDefinitionConfig from FieldDefinition</code>
+    </InvalidTypeImport>
+  </file>
+</files>
diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<psalm
+    totallyTyped="true"
+    errorLevel="7"
+    resolveFromConfigFile="true"
+    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"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+
+    <plugins>
+        <pluginClass class="Psalm\PhpUnitPlugin\Plugin" />
+    </plugins>
+</psalm>
diff --git a/src/Error/FormattedError.php b/src/Error/FormattedError.php
@@ -33,6 +33,8 @@
  * It converts PHP exceptions to [spec-compliant errors](https://facebook.github.io/graphql/#sec-Errors)
  * and provides tools for error debugging.
  *
+ * @see ExecutionResult
+ *
  * @phpstan-import-type SerializableError from ExecutionResult
  * @phpstan-import-type ErrorFormatter from ExecutionResult
  */
diff --git a/src/Error/Warning.php b/src/Error/Warning.php
@@ -14,6 +14,9 @@
  * Also, it is possible to override warning handler (which is **trigger_error()** by default).
  *
  * @phpstan-type WarningHandler callable(string $errorMessage, int $warningId, ?int $messageLevel): void
+ *
+ * @see https://github.com/vimeo/psalm/issues/7527
+ * @psalm-type WarningHandler callable(string, int, int|null): void
  */
 final class Warning
 {
diff --git a/src/Executor/ExecutionResult.php b/src/Executor/ExecutionResult.php
@@ -19,6 +19,8 @@
  * Could be converted to [spec-compliant](https://facebook.github.io/graphql/#sec-Response-Format)
  * serializable array using `toArray()`.
  *
+ * @see Throwable
+ *
  * @phpstan-type SerializableError array{
  *   message: string,
  *   locations?: array<int, array{line: int, column: int}>,
@@ -33,6 +35,9 @@
  * }
  * @phpstan-type ErrorFormatter callable(Throwable): SerializableError
  * @phpstan-type ErrorsHandler callable(array<Error> $errors, ErrorFormatter $formatter): SerializableErrors
+ *
+ * @see https://github.com/vimeo/psalm/issues/6928
+ * @psalm-type ErrorsHandler callable(Error[], ErrorFormatter): SerializableErrors
  */
 class ExecutionResult implements JsonSerializable
 {
diff --git a/src/Executor/Executor.php b/src/Executor/Executor.php
@@ -17,7 +17,13 @@
  * Implements the "Evaluating requests" section of the GraphQL specification.
  *
  * @phpstan-type FieldResolver callable(mixed, array<string, mixed>, mixed, ResolveInfo): mixed
+ *
+ * @see https://github.com/vimeo/psalm/issues/6928
+ * @psalm-type FieldResolver callable(mixed, array, mixed, ResolveInfo): mixed
  * @phpstan-type ImplementationFactory callable(PromiseAdapter, Schema, DocumentNode, mixed, mixed, array<mixed>, ?string, callable): ExecutorImplementation
+ *
+ * @see https://github.com/vimeo/psalm/issues/6928, https://github.com/vimeo/psalm/issues/7527
+ * @psalm-type ImplementationFactory callable(PromiseAdapter, Schema, DocumentNode, mixed, mixed, array, ?string, callable): ExecutorImplementation
  */
 class Executor
 {
diff --git a/src/Language/AST/NodeList.php b/src/Language/AST/NodeList.php
@@ -28,10 +28,12 @@ class NodeList implements ArrayAccess, IteratorAggregate, Countable
     private $nodes;
 
     /**
+     * @template TT of Node
+     *
      * @param array<Node|array<string, mixed>> $nodes
-     * @phpstan-param array<T|array<string, mixed>> $nodes
+     * @phpstan-param array<TT|array<string, mixed>> $nodes
      *
-     * @phpstan-return self<T>
+     * @phpstan-return self<TT>
      */
     public static function create(array $nodes): self
     {
diff --git a/src/Language/Visitor.php b/src/Language/Visitor.php
@@ -258,6 +258,7 @@ public static function visit(object $root, array $visitor, ?array $keyMap = null
                         : $parent->{$key}
                     )
                     : $newRoot;
+                /** @psalm-suppress ParadoxicalCondition We don't have `undefined` in php */
                 if (null === $node || $node === $UNDEFINED) {
                     continue;
                 }
diff --git a/src/Server/ServerConfig.php b/src/Server/ServerConfig.php
@@ -26,9 +26,11 @@
  *
  *     $server = new GraphQL\Server\StandardServer($config);
  *
+ * @see ExecutionResult
+ *
  * @phpstan-type PersistedQueryLoader callable(string $queryId, OperationParams $operation): (string|DocumentNode)
  * @phpstan-type RootValueResolver callable(OperationParams $operation, DocumentNode $doc, string $operationType): mixed
- * @phpstan-type ValidationRulesOption array<ValidationRule>|(callable(OperationParams $operation, DocumentNode $doc, string $operationType): array<ValidationRule>)|null
+ * @phpstan-type ValidationRulesOption array<ValidationRule>|null|callable(OperationParams $operation, DocumentNode $doc, string $operationType): array<ValidationRule>
  * @phpstan-import-type ErrorsHandler from ExecutionResult
  * @phpstan-import-type ErrorFormatter from ExecutionResult
  */
diff --git a/src/Type/Definition/EnumType.php b/src/Type/Definition/EnumType.php
@@ -7,6 +7,7 @@
 use GraphQL\Error\SerializationError;
 use GraphQL\Language\AST\EnumTypeDefinitionNode;
 use GraphQL\Language\AST\EnumTypeExtensionNode;
+use GraphQL\Language\AST\EnumValueDefinitionNode;
 use GraphQL\Language\AST\EnumValueNode;
 use GraphQL\Language\AST\Node;
 use GraphQL\Language\Printer;
@@ -18,6 +19,8 @@
 use function is_string;
 
 /**
+ * @see EnumValueDefinitionNode
+ *
  * @phpstan-type PartialEnumValueConfig array{
  *   name?: string,
  *   value?: mixed,
diff --git a/src/Type/Definition/FieldDefinition.php b/src/Type/Definition/FieldDefinition.php
@@ -13,6 +13,8 @@
 use function is_string;
 
 /**
+ * @see Executor
+ *
  * @phpstan-import-type FieldResolver from Executor
  * @phpstan-import-type ArgumentListConfig from Argument
  * @phpstan-type FieldType (Type&OutputType)|callable(): (Type&OutputType)
@@ -36,7 +38,7 @@
  *     astNode?: FieldDefinitionNode|null,
  *     complexity?: ComplexityFn|null
  * }
- * @phpstan-type FieldsConfig iterable<mixed>|(callable(): iterable<mixed>)
+ * @phpstan-type FieldsConfig iterable<mixed>|callable(): iterable<mixed>
  */
 /*
  * TODO check if newer versions of PHPStan can handle the full definition, it currently crashes when it is used
diff --git a/src/Type/SchemaConfig.php b/src/Type/SchemaConfig.php
@@ -24,8 +24,10 @@
  *
  *     $schema = new Schema($config);
  *
- * @phpstan-type TypeLoader callable(string $typeName): ((Type&NamedType)|null)
- * @phpstan-type Types array<Type&NamedType>|(callable(): array<Type&NamedType>)
+ * @see Type, NamedType
+ *
+ * @phpstan-type TypeLoader callable(string $typeName):((Type&NamedType)|null)
+ * @phpstan-type Types array<Type&NamedType>|callable():array<Type&NamedType>
  */
 class SchemaConfig
 {
diff --git a/src/Utils/ASTDefinitionBuilder.php b/src/Utils/ASTDefinitionBuilder.php
@@ -38,6 +38,8 @@
 use Throwable;
 
 /**
+ * @see FieldDefinition, InputObjectField
+ *
  * @phpstan-import-type UnnamedFieldDefinitionConfig from FieldDefinition
  * @phpstan-import-type InputObjectFieldConfig from InputObjectField
  * @phpstan-import-type UnnamedInputObjectFieldConfig from InputObjectField
diff --git a/src/Utils/SchemaPrinter.php b/src/Utils/SchemaPrinter.php
@@ -38,6 +38,7 @@
  * Prints the contents of a Schema in schema definition language.
  *
  * @phpstan-type Options array{}
+ * @psalm-type Options array<never, never>
  */
 class SchemaPrinter
 {
diff --git a/src/Validator/Rules/CustomValidationRule.php b/src/Validator/Rules/CustomValidationRule.php
@@ -7,7 +7,10 @@
 use GraphQL\Validator\ValidationContext;
 
 /**
- * @phpstan-type VisitorFn callable(ValidationContext): (array<string, callable(Node): VisitorOperation|mixed|null>|array<string, array<string, callable(Node): VisitorOperation|mixed|null>>)
+ * @see Node, VisitorOperation
+ *
+ * @phpstan-type VisitorFnResult array<string, callable(Node): VisitorOperation|mixed|null>|array<string, array<string, callable(Node): VisitorOperation|mixed|null>>
+ * @phpstan-type VisitorFn callable(ValidationContext):VisitorFnResult
  */
 class CustomValidationRule extends ValidationRule
 {
diff --git a/src/Validator/Rules/QuerySecurityRule.php b/src/Validator/Rules/QuerySecurityRule.php
@@ -8,6 +8,7 @@
 use GraphQL\Language\AST\FragmentSpreadNode;
 use GraphQL\Language\AST\InlineFragmentNode;
 use GraphQL\Language\AST\SelectionSetNode;
+use GraphQL\Language\Visitor;
 use GraphQL\Type\Definition\FieldDefinition;
 use GraphQL\Type\Definition\HasFieldsType;
 use GraphQL\Type\Definition\Type;
@@ -17,7 +18,9 @@
 use InvalidArgumentException;
 
 /**
- * @phpstan-import-type VisitorArray from ValidationRule
+ * @see Visitor, FieldDefinition
+ *
+ * @phpstan-import-type VisitorArray from Visitor
  * @phpstan-type ASTAndDefs ArrayObject<string, ArrayObject<int, array{FieldNode, FieldDefinition|null}>>
  */
 abstract class QuerySecurityRule extends ValidationRule

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,8 @@`
`33`	`33`	`* It converts PHP exceptions to [spec-compliant errors](https://facebook.github.io/graphql/#sec-Errors)`
`34`	`34`	`* and provides tools for error debugging.`
`35`	`35`	`*`
	`36`	`+ * @see ExecutionResult`
	`37`	`+ *`
`36`	`38`	`* @phpstan-import-type SerializableError from ExecutionResult`
`37`	`39`	`* @phpstan-import-type ErrorFormatter from ExecutionResult`
`38`	`40`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,9 @@`
`14`	`14`	`* Also, it is possible to override warning handler (which is trigger_error() by default).`
`15`	`15`	`*`
`16`	`16`	`* @phpstan-type WarningHandler callable(string $errorMessage, int $warningId, ?int $messageLevel): void`
	`17`	`+ *`
	`18`	`+ * @see https://github.com/vimeo/psalm/issues/7527`
	`19`	`+ * @psalm-type WarningHandler callable(string, int, int\|null): void`
`17`	`20`	`*/`
`18`	`21`	`final class Warning`
`19`	`22`	`{`