Merge pull request #1679 from acelaya-forks/feature/deprecate-url-validation

Deprecated validateUrl option on short URL creation/edition

CHANGELOG.md

@@ -28,7 +28,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 * *Nothing*
 
 ### Deprecated
-* [#1676](https://github.com/shlinkio/shlink/issues/1676) Deprecated `GET /short-urls/shorten` endpoint. Use `POST /short-urls` to create short URLs instead
+* [#1676](https://github.com/shlinkio/shlink/issues/1676) Deprecated `GET /short-urls/shorten` endpoint. Use `POST /short-urls` to create short URLs instead.
+* [#1678](https://github.com/shlinkio/shlink/issues/1678) Deprecated `validateUrl` option on URL creation/edition.
 
 ### Removed
 * *Nothing*

docs/swagger/definitions/ShortUrlEdition.json

@@ -24,7 +24,8 @@
             "nullable": true
         },
         "validateUrl": {
-            "description": "Tells if the long URL (if provided) should or should not be validated as a reachable URL. If not provided, it will fall back to app-level config",
+            "deprecated": true,
+            "description": "**[DEPRECATED]** Tells if the long URL should or should not be validated as a reachable URL. Defaults to `false`",
             "type": "boolean"
         },
         "tags": {

docs/swagger/paths/v1_short-urls.json

@@ -314,10 +314,6 @@
                                     "shortCodeLength": {
                                         "description": "The length for generated short code. It has to be at least 4 and defaults to 5. It will be ignored when customSlug is provided",
                                         "type": "number"
-                                    },
-                                    "validateUrl": {
-                                        "description": "Tells if the long URL should or should not be validated as a reachable URL. If not provided, it will fall back to app-level config",
-                                        "type": "boolean"
                                     }
                                 }
                             }

module/CLI/src/Command/ShortUrl/CreateShortUrlCommand.php

@@ -103,7 +103,7 @@ class CreateShortUrlCommand extends Command
                 'validate-url',
                 null,
                 InputOption::VALUE_NONE,
-                'Forces the long URL to be validated, regardless what is globally configured.',
+                '[DEPRECATED] Makes the URL to be validated as publicly accessible.',
             )
             ->addOption(
                 'crawlable',

module/Core/src/ShortUrl/Helper/ShortUrlTitleResolutionHelper.php

@@ -14,6 +14,8 @@ class ShortUrlTitleResolutionHelper implements ShortUrlTitleResolutionHelperInte
     }
 
     /**
+     * @deprecated TODO Rename to processTitle once URL validation is removed with Shlink 4.0.0
+     *                  Move relevant logic from URL validator here.
      * @template T of TitleResolutionModelInterface
      * @param T $data
      * @return T

module/Core/src/ShortUrl/Helper/ShortUrlTitleResolutionHelperInterface.php

@@ -9,6 +9,7 @@ use Shlinkio\Shlink\Core\Exception\InvalidUrlException;
 interface ShortUrlTitleResolutionHelperInterface
 {
     /**
+     * @deprecated TODO Rename to processTitle once URL validation is removed with Shlink 4.0.0
      * @template T of TitleResolutionModelInterface
      * @param T $data
      * @return T

module/Core/src/ShortUrl/Helper/TitleResolutionModelInterface.php

@@ -10,6 +10,7 @@ interface TitleResolutionModelInterface
 
     public function getLongUrl(): string;
 
+    /** @deprecated */
     public function doValidateUrl(): bool;
 
     public function withResolvedTitle(string $title): static;

module/Core/src/ShortUrl/Model/ShortUrlCreation.php

@@ -33,6 +33,7 @@ final class ShortUrlCreation implements TitleResolutionModelInterface
         public readonly bool $findIfExists = false,
         public readonly ?string $domain = null,
         public readonly int $shortCodeLength = 5,
+        /** @deprecated  */
         public readonly bool $validateUrl = false,
         public readonly ?ApiKey $apiKey = null,
         public readonly array $tags = [],
@@ -131,6 +132,7 @@ final class ShortUrlCreation implements TitleResolutionModelInterface
         return $this->domain !== null;
     }
 
+    /** @deprecated  */
     public function doValidateUrl(): bool
     {
         return $this->validateUrl;

module/Core/src/ShortUrl/Model/ShortUrlEdition.php

@@ -38,6 +38,7 @@ final class ShortUrlEdition implements TitleResolutionModelInterface
         private readonly bool $titlePropWasProvided = false,
         public readonly ?string $title = null,
         public readonly bool $titleWasAutoResolved = false,
+        /** @deprecated */
         public readonly bool $validateUrl = false,
         private readonly bool $crawlablePropWasProvided = false,
         public readonly bool $crawlable = false,
@@ -154,6 +155,7 @@ final class ShortUrlEdition implements TitleResolutionModelInterface
         return $this->titleWasAutoResolved;
     }
 
+    /** @deprecated */
     public function doValidateUrl(): bool
     {
         return $this->validateUrl;

module/Core/src/ShortUrl/Model/Validation/ShortUrlInputFilter.php

@@ -32,6 +32,7 @@ class ShortUrlInputFilter extends InputFilter
     public const SHORT_CODE_LENGTH = 'shortCodeLength';
     public const LONG_URL = 'longUrl';
     public const DEVICE_LONG_URLS = 'deviceLongUrls';
+    /** @deprecated */
     public const VALIDATE_URL = 'validateUrl';
     public const API_KEY = 'apiKey';
     public const TAGS = 'tags';

module/Core/src/Util/UrlValidator.php

@@ -22,6 +22,7 @@ use function trim;
 
 use const Shlinkio\Shlink\TITLE_TAG_VALUE;
 
+/** @deprecated */
 class UrlValidator implements UrlValidatorInterface, RequestMethodInterface
 {
     private const MAX_REDIRECTS = 15;
@@ -33,6 +34,7 @@ class UrlValidator implements UrlValidatorInterface, RequestMethodInterface
     }
 
     /**
+     * @deprecated
      * @throws InvalidUrlException
      */
     public function validateUrl(string $url, bool $doValidate): void
@@ -44,6 +46,10 @@ class UrlValidator implements UrlValidatorInterface, RequestMethodInterface
         $this->validateUrlAndGetResponse($url);
     }
 
+    /**
+     * @deprecated
+     * @throws InvalidUrlException
+     */
     public function validateUrlWithTitle(string $url, bool $doValidate): ?string
     {
         if (! $doValidate && ! $this->options->autoResolveTitles) {

module/Core/src/Util/UrlValidatorInterface.php

@@ -6,14 +6,17 @@ namespace Shlinkio\Shlink\Core\Util;
 
 use Shlinkio\Shlink\Core\Exception\InvalidUrlException;
 
+/** @deprecated */
 interface UrlValidatorInterface
 {
     /**
+     * @deprecated
      * @throws InvalidUrlException
      */
     public function validateUrl(string $url, bool $doValidate): void;
 
     /**
+     * @deprecated
      * @throws InvalidUrlException
      */
     public function validateUrlWithTitle(string $url, bool $doValidate): ?string;