feat: support phpstan (#62)

* feat: support phpstan

Author: godruoyi

.github/workflows/static-analysis.yml

@@ -0,0 +1,41 @@
+name: static analysis
+
+on:
+  push:
+    branches:
+      - master
+      - '*.x'
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    runs-on: ubuntu-22.04
+
+    strategy:
+      fail-fast: true
+
+    name: Static Analysis
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          tools: composer:v2
+          coverage: none
+
+      - name: Install dependencies
+        uses: nick-fields/retry@v2
+        with:
+          timeout_minutes: 10
+          max_attempts: 3
+          command: composer update --prefer-stable --prefer-dist --no-interaction --no-progress
+
+      - name: Execute type checking
+        run: vendor/bin/phpstan

composer.json

@@ -23,7 +23,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^10",
-        "laravel/pint": "^1.10"
+        "laravel/pint": "^1.10",
+        "phpstan/phpstan": "^1.10"
     },
     "autoload-dev": {
         "psr-4": {
@@ -38,5 +39,10 @@
     "scripts": {
         "test": "vendor/bin/phpunit",
         "pint": "vendor/bin/pint"
+    },
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     }
 }

phpstan.neon.dist

@@ -0,0 +1,5 @@
+parameters:
+  paths:
+    - src
+
+  level: 9

src/FileLockResolver.php

@@ -68,6 +68,10 @@ protected function getSequence(string $filePath, int $currentTime): int
         try {
             $f = @fopen($filePath, static::FileOpenMode);
 
+            if (! $f) {
+                throw new SnowflakeException(sprintf('can not open this file %s', $filePath));
+            }
+
             // we always use exclusive lock to avoid the problem of concurrent access.
             // so we don't need to check the return value of flock.
             flock($f, static::FlockLockOperation);
@@ -97,7 +101,7 @@ protected function getSequence(string $filePath, int $currentTime): int
     /**
      * Unlock and close file.
      *
-     * @param  resource  $f
+     * @param  resource|false|null  $f
      */
     protected function unlock($f): void
     {
@@ -108,7 +112,9 @@ protected function unlock($f): void
     }
 
     /**
+     * @param  array<int, int>  $contents
      * @param  resource  $f
+     * @return bool
      */
     public function updateContents(array $contents, $f): bool
     {
@@ -119,6 +125,9 @@ public function updateContents(array $contents, $f): bool
     /**
      * Increment sequence with specify time. if current time is not set in the lock file
      * set it to 1, otherwise increment it.
+     *
+     * @param  array<int, int>  $contents
+     * @return array<int, int>
      */
     public function incrementSequenceWithSpecifyTime(array $contents, int $currentTime): array
     {
@@ -129,6 +138,9 @@ public function incrementSequenceWithSpecifyTime(array $contents, int $currentTi
 
     /**
      * Clean the old content, we only save the data generated within 10 minutes.
+     *
+     * @param  array<int, int>  $contents
+     * @return array<int, int>
      */
     public function cleanOldSequences(array $contents): array
     {
@@ -148,6 +160,10 @@ public function cleanAllLocksFile(): void
     {
         $files = glob($this->lockFileDir.'/*');
 
+        if (! $files) {
+            return;
+        }
+
         foreach ($files as $file) {
             if (is_file($file) && preg_match('/snowflake-(\d+)\.lock$/', $file)) {
                 unlink($file);
@@ -159,6 +175,7 @@ public function cleanAllLocksFile(): void
      * Get resource contents, If the contents are invalid json, return null.
      *
      * @param  resource  $f
+     * @return array<int, int>|null
      */
     public function getContents($f): ?array
     {

src/LaravelSequenceResolver.php

@@ -24,18 +24,20 @@ class LaravelSequenceResolver implements SequenceResolver
     /**
      * Init resolve instance, must be connected.
      */
-    public function __construct(protected Repository $cache)
+    public function __construct(protected Repository $cache) // @phpstan-ignore-line
     {
     }
 
     public function sequence(int $currentTime): int
     {
         $key = $this->prefix.$currentTime;
 
+        // @phpstan-ignore-next-line
         if ($this->cache->add($key, 1, 10)) {
             return 0;
         }
 
+        // @phpstan-ignore-next-line
         return $this->cache->increment($key, 1);
     }
 

src/RedisSequenceResolver.php

@@ -48,7 +48,7 @@ public function sequence(int $currentTime): int
 LUA;
 
         // 10 seconds
-        return $this->redis->eval($lua, [$this->prefix.$currentTime, '0', '10'], 1);
+        return $this->redis->eval($lua, [$this->prefix.$currentTime, '0', '10'], 1) | 0;
     }
 
     /**

src/Snowflake.php

@@ -38,8 +38,10 @@ class Snowflake
 
     /**
      * The Sequence Resolver instance.
+     *
+     * @var Closure|SequenceResolver|null
      */
-    protected null|Closure|SequenceResolver $sequence = null;
+    protected SequenceResolver|null|Closure $sequence = null;
 
     /**
      * The start timestamp.
@@ -87,6 +89,8 @@ public function id(): string
 
     /**
      * Parse snowflake id.
+     *
+     * @return array<string, float|int|string>
      */
     public function parseId(string $id, bool $transform = false): array
     {
@@ -154,7 +158,7 @@ public function getStartTimeStamp(): float|int
     /**
      * Set Sequence Resolver.
      */
-    public function setSequenceResolver(callable|SequenceResolver $sequence): self
+    public function setSequenceResolver(Closure|SequenceResolver $sequence): self
     {
         $this->sequence = $sequence;
 
@@ -180,7 +184,7 @@ public function getDefaultSequenceResolver(): SequenceResolver
     /**
      * Call resolver.
      */
-    protected function callResolver(mixed $currentTime): int
+    protected function callResolver(int $currentTime): int
     {
         $resolver = $this->getSequenceResolver();
 

src/Sonyflake.php

@@ -82,8 +82,10 @@ public function setStartTimeStamp(int $millisecond): self
 
     /**
      * Parse snowflake id.
+     *
+     * @return array<string, float|int|string>
      */
-    public function parseId(string $id, $transform = false): array
+    public function parseId(string $id, bool $transform = false): array
     {
         $id = decbin((int) $id);
         $length = self::MAX_SEQUENCE_LENGTH + self::MAX_MACHINEID_LENGTH;