fix: Fix the RootVersionChecker (#790)

theofidry · web-flow · commit c5be279ec7ba · 2022-12-22T21:20:49.000+01:00
diff --git a/.github/workflows/composer-root-version.yaml b/.github/workflows/composer-root-version.yaml
@@ -24,14 +24,25 @@ jobs:
                     php-version: "${{ matrix.php }}"
                     tools: composer
 
+            # https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#setting-an-environment-variable
+            -   name: Configure composer root version
+                run: |
+                    source .composer-root-version
+                    echo "COMPOSER_ROOT_VERSION=${COMPOSER_ROOT_VERSION}" >> $GITHUB_ENV
+
+            -   name: Install the Composer (root) dependencies
+                uses: ramsey/composer-install@v2
+
+            -   name: Ensure that the root dependencies are updated correctly
+                run: make vendor_install
+
             -   name: Install PHP-CS-Fixer
                 uses: ramsey/composer-install@v2
                 with:
                     working-directory: 'vendor-bin/php-cs-fixer'
-                    tools: composer
 
-            -   name: Ensures the makefile does not remake the PHP-CS-Fixer target
-                run: touch -c vendor-bin/php-cs-fixer/vendor/friendsofphp/php-cs-fixer/php-cs-fixer
+            -   name: Ensure that PHP-CS-Fixer dependencies are updated correctly
+                run: make install_php_cs_fixer
 
             -   name: Install the Composer dependencies
                 uses: ramsey/composer-install@v2
diff --git a/Makefile b/Makefile
@@ -545,6 +545,9 @@ vendor-bin/covers-validator/composer.lock: vendor-bin/covers-validator/composer.
 	@echo "$(@) is not up to date. You may want to run the following command:"
 	@echo "$$ composer bin covers-validator update --lock && touch -c $(@)"
 
+.PHONY: install_php_cs_fixer
+install_php_cs_fixer: $(PHP_CS_FIXER_BIN)
+
 $(PHP_CS_FIXER_BIN): vendor-bin/php-cs-fixer/vendor
 	touch -c $@
 vendor-bin/php-cs-fixer/vendor: vendor-bin/php-cs-fixer/composer.lock $(COMPOSER_BIN_PLUGIN_VENDOR)
diff --git a/composer-root-version-checker/src/Checker.php b/composer-root-version-checker/src/Checker.php
@@ -25,27 +25,31 @@ public static function check(): int
         $fetcher = new TagFetcher($logger);
 
         try {
-            $expectedComposerRootVersion = $fetcher->fetchLastTag();
+            $lastTag = $fetcher->fetchLastTag();
+        } catch (CouldNotParseTag $couldNotParseTag) {
+            $logger->notice(
+                sprintf(
+                    'Skipped: %s',
+                    $couldNotParseTag->getMessage(),
+                ),
+            );
+
+            // This is the GitHub API playing tricks on us... I could not find a way to reliably fix it so it is just better
+            // to avoid bailing out because of it for now.
+            return 0;
         } catch (RuntimeException $couldNotFetchTag) {
             if (false !== getenv('PHP_SCOPER_GITHUB_TOKEN') && false === getenv('GITHUB_TOKEN')) {
-                $logger->info('Skipped.');
+                $logger->info('Skipped: not GitHub token configured. Export the environment variable "PHP_SCOPER_GITHUB_TOKEN" or "GITHUB_TOKEN" to fix this.');
 
                 // Ignore this PR to avoid too many builds to fail untimely or locally due to API rate limits because the last
                 // release version could not be retrieved.
                 return 0;
             }
 
-            if (100 === $couldNotFetchTag->getCode()) {
-                $logger->info('Skipped.');
-
-                // This is the GitHub API playing tricks on us... I could not find a way to reliably fix it so it is just better
-                // to avoid bailing out because of it for now.
-                return 0;
-            }
-
             throw $couldNotFetchTag;
         }
 
+        $expectedComposerRootVersion = VersionCalculator::calculateDesiredVersion($lastTag);
         $currentRootVersion = RootVersionProvider::provideCurrentVersion();
 
         if ($expectedComposerRootVersion === $currentRootVersion) {
diff --git a/composer-root-version-checker/src/CouldNotParseTag.php b/composer-root-version-checker/src/CouldNotParseTag.php
@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the humbug/php-scoper package.
+ *
+ * Copyright (c) 2017 Théo FIDRY <theo.fidry@gmail.com>,
+ *                    Pádraic Brady <padraic.brady@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Humbug\PhpScoperComposerRootChecker;
+
+use RuntimeException;
+use function sprintf;
+use const PHP_EOL;
+
+final class CouldNotParseTag extends RuntimeException
+{
+    public static function noTagFound(
+        string $content
+    ): self {
+        return new self(
+            sprintf(
+                'No tag could be found in: "%s".',
+                $content,
+            ),
+        );
+    }
+
+    public static function noNameTagFound(
+        string $content
+    ): self {
+        return new self(
+            sprintf(
+                'No tag name could be found in:%s"%s".',
+                PHP_EOL,
+                $content,
+            ),
+        );
+    }
+
+    public static function withReason(
+        null|bool|int|float|string $tag,
+        string $reason
+    ): self {
+        return new self(
+            sprintf(
+                'Could not parse the tag "%s": %s',
+                $tag,
+                $reason,
+            ),
+        );
+    }
+}
diff --git a/composer-root-version-checker/src/Dumper.php b/composer-root-version-checker/src/Dumper.php
@@ -32,27 +32,32 @@ public static function dump(): void
         $fetcher = new TagFetcher($logger);
 
         try {
-            $composerRootVersion = $fetcher->fetchLastTag();
+            $lastTag = $fetcher->fetchLastTag();
+        } catch (CouldNotParseTag $couldNotParseTag) {
+            $logger->notice(
+                sprintf(
+                    'Skipped: %s',
+                    $couldNotParseTag->getMessage(),
+                ),
+            );
+
+            // This is the GitHub API playing tricks on us... I could not find a way to reliably fix it so it is just better
+            // to avoid bailing out because of it for now.
+            return;
         } catch (RuntimeException $couldNotFetchTag) {
-            if (false !== getenv('TRAVIS') && false === getenv('GITHUB_TOKEN')) {
-                $logger->info('Skipped.');
+            if (false !== getenv('PHP_SCOPER_GITHUB_TOKEN') && false === getenv('GITHUB_TOKEN')) {
+                $logger->info('Skipped: not GitHub token configured. Export the environment variable "PHP_SCOPER_GITHUB_TOKEN" or "GITHUB_TOKEN" to fix this.');
 
                 // Ignore this PR to avoid too many builds to fail untimely or locally due to API rate limits because the last
                 // release version could not be retrieved.
                 return;
             }
 
-            if (100 === $couldNotFetchTag->getCode()) {
-                $logger->info('Skipped.');
-
-                // This is the GitHub API playing tricks on us... I could not find a way to reliably fix it so it is just better
-                // to avoid bailing out because of it for now.
-                return;
-            }
-
             throw $couldNotFetchTag;
         }
 
+        $composerRootVersion = VersionCalculator::calculateDesiredVersion($lastTag);
+
         file_put_contents(
             self::COMPOSER_ROOT_VERSION_PATH,
             sprintf(
diff --git a/composer-root-version-checker/src/TagParser.php b/composer-root-version-checker/src/TagParser.php
@@ -14,61 +14,65 @@
 
 namespace Humbug\PhpScoperComposerRootChecker;
 
-use RuntimeException;
+use JsonException;
 use function current;
+use function get_debug_type;
 use function is_array;
 use function is_string;
 use function Safe\json_decode;
+use function Safe\json_encode;
 use function sprintf;
 use function trim;
+use const JSON_PRETTY_PRINT;
 
 final class TagParser
 {
     public static function parse(string $responseContent): string
     {
-        $decodedContent = json_decode(
-            $responseContent,
-            false,
-            512,
-            JSON_PRETTY_PRINT & JSON_THROW_ON_ERROR,
-        );
+        try {
+            $decodedContent = json_decode(
+                $responseContent,
+                false,
+                512,
+                JSON_PRETTY_PRINT & JSON_THROW_ON_ERROR,
+            );
+        } catch (JsonException) {
+            throw CouldNotParseTag::noTagFound($responseContent);
+        }
 
         if (!is_array($decodedContent)) {
-            throw new RuntimeException(
-                sprintf(
-                    'No tag name could be found in: %s',
-                    $responseContent,
-                ),
-                100,
-            );
+            throw CouldNotParseTag::noTagFound($responseContent);
         }
 
         $lastReleaseInfo = current($decodedContent);
 
         if (false === $lastReleaseInfo) {
-            throw new RuntimeException(
-                sprintf(
-                    'No tag name could be found in: %s',
-                    $responseContent,
-                ),
-                100,
-            );
+            throw CouldNotParseTag::noTagFound($responseContent);
+        }
+
+        if (!isset($lastReleaseInfo->name)) {
+            throw CouldNotParseTag::noNameTagFound(json_encode($lastReleaseInfo, JSON_PRETTY_PRINT));
         }
 
-        if (!($lastReleaseInfo->name) || !is_string($lastReleaseInfo->name)) {
-            throw new RuntimeException(
+        $tagName = $lastReleaseInfo->name;
+
+        if (!is_string($tagName)) {
+            throw CouldNotParseTag::withReason(
+                $tagName,
                 sprintf(
-                    'No tag name could be found in: %s',
-                    $responseContent,
+                    'Expected the tag to be a non-blank string, got "%s".',
+                    get_debug_type($tagName),
                 ),
-                100,
             );
         }
 
-        $lastRelease = trim($lastReleaseInfo->name);
+        $lastRelease = trim($tagName);
 
         if ('' === $lastRelease) {
-            throw new RuntimeException('Invalid tag name found.');
+            throw CouldNotParseTag::withReason(
+                $tagName,
+                'Expected the tag to be a non-blank string, got an empty string.',
+            );
         }
 
         return $lastRelease;
diff --git a/composer-root-version-checker/src/VersionCalculator.php b/composer-root-version-checker/src/VersionCalculator.php
@@ -14,17 +14,36 @@
 
 namespace Humbug\PhpScoperComposerRootChecker;
 
+use function str_contains;
+use function strtolower;
+
 final class VersionCalculator
 {
     public static function calculateDesiredVersion(string $tag): string
     {
         $tagParts = explode('.', $tag);
+        $desiredVersionParts = [];
+
+        foreach ($tagParts as $tagPart) {
+            $normalizedPart = strtolower($tagPart);
+
+            if (str_contains($normalizedPart, 'rc')
+                || str_contains($normalizedPart, 'alpha')
+                || str_contains($normalizedPart, 'beta')
+            ) {
+                $desiredVersionParts[] = '99';
+
+                return implode('.', $desiredVersionParts);
+            }
+
+            $desiredVersionParts[] = $tagPart;
+        }
 
-        array_pop($tagParts);
+        array_pop($desiredVersionParts);
 
-        $tagParts[] = '99';
+        $desiredVersionParts[] = '99';
 
-        return implode('.', $tagParts);
+        return implode('.', $desiredVersionParts);
     }
 
     private function __construct()
diff --git a/composer-root-version-checker/tests/TagParserTest.php b/composer-root-version-checker/tests/TagParserTest.php
diff --git a/composer-root-version-checker/tests/VersionCalculatorTest.php b/composer-root-version-checker/tests/VersionCalculatorTest.php
