Deprecate UrlGenerator::supports() and UrlGenerator::getRouteDebugMessage()

NW for deprecation test and docs update

+++ b/core/lib/Drupal/Core/Routing/UrlGenerator.php
@@ -429,10 +429,28 @@ protected function getRoute($name) {
+   * @internal
...
+  private function getRouteStringIdentifier($name, array $parameters = []) {
+    if (is_scalar($name)) {
+      return $name;
...
+      return 'Route with pattern ' . $name->getPath();
...
+    return serialize($name);

needs @return in docblock

Filed CR https://www.drupal.org/node/3172303 and updated patch with ref

Also updated other 2 places where unused methods implemented

As this methods undocumented now

- removed usage in testing code
- deprecated in remaining bubblable generator

This issue is being reviewed by the kind folks in Slack, #needs-review-queue-initiative. We are working to keep the size of Needs Review queue [2700+ issues] to around 400 (1 month or less), following Review a patch or merge request as a guide.

At this time we will need a D10 patch and the deprecation to be 10.1 please

updated for 10.1/11.0

fix indent for deprecation

Close! Appears to be a CI issue.

As I see the $parameters argument is not used and looking how $name argument is passed I set it type to expected string|\Symfony\Component\Routing\Route

+   * @deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Use
+   *   the route name instead.

Think that's the last little bit and I'm good to mark it!

Addressed #22, thanks!

Thanks!

one hunk context fix via #2574981: Fix grammar ("an URL" should be "a URL") and consistent use of URL (not "url" / "Url") in documentation only, part 1

-index bd3268d86d..b70af426fe 100644
+index b796efea45..eec14d17f9 100644
 --- a/core/tests/Drupal/Tests/Core/Routing/UrlGeneratorTest.php
 +++ b/core/tests/Drupal/Tests/Core/Routing/UrlGeneratorTest.php
 @@ -451,6 +451,18 @@ public function testBaseURLGeneration() {
@@ -187,5 +187,5 @@
 +  }
 +
    /**
-    * Tests that the 'scheme' route requirement is respected during url
+    * Tests that the 'scheme' route requirement is respected during URL
     * generation.

Moving back thanks for the reroll!

Unrelated failure

1. Nice to get this cleaned up!

2. +++ b/core/lib/Drupal/Core/Render/MetadataBubblingUrlGenerator.php
   @@ -110,16 +110,42 @@ public function generateFromRoute($name, $parameters = [], $options = [], $colle
   +    @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Only string route names are supported. See https://www.drupal.org/node/3172303', E_USER_DEPRECATED);
        return $this->urlGenerator->supports($name);
   ...
   +    @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use the route name instead. See https://www.drupal.org/node/3172303', E_USER_DEPRECATED);
        return $this->urlGenerator->getRouteDebugMessage($name, $parameters);
   

   I always find this a bit tricky - given the urlGenerator method triggers a deprecation is adding the deprecation here necessary. Sure to the docs - but doubling up on every deprecation message can be noisy. Not sure.

3. +++ b/core/lib/Drupal/Core/Routing/UrlGenerator.php
   @@ -429,17 +429,17 @@ protected function getRoute($name) {
   -  public function getRouteDebugMessage($name, array $parameters = []) {
   +  private function getRouteStringIdentifier($name) {
   

   Let's add return and parameter typehinting.

4. +++ b/core/modules/help/tests/modules/help_test/src/SupernovaGenerator.php
   @@ -45,18 +45,4 @@ public function generateFromRoute($name, $parameters = [], $options = [], $colle
   -  /**
   -   * {@inheritdoc}
   -   */
   -  public function supports($name) {
   -    throw new \Exception();
   -  }
   -
   -  /**
   -   * {@inheritdoc}
   -   */
   -  public function getRouteDebugMessage($name, array $parameters = []) {
   -    throw new \Exception();
   -  }
   

   Given this is test code I think this is fine.

Fix #30.2 and about 1) - I see no usage so no reason to throttle warnings

+++ b/core/lib/Drupal/Core/Routing/UrlGenerator.php
@@ -429,17 +429,17 @@ protected function getRoute($name) {
-  public function getRouteDebugMessage($name, array $parameters = []) {
+  private function getRouteStringIdentifier($name): string {

@@ -451,4 +451,45 @@ public function getRouteDebugMessage($name, array $parameters = []) {
+  public function getRouteDebugMessage($name, array $parameters = []) {
+    @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use the route name instead. See https://www.drupal.org/node/3172303', E_USER_DEPRECATED);
+    return $this->getRouteStringIdentifier($name);
+  }

string|SymfonyRoute $name can typehint the param too.

But that also means we should leave the implementation of the old getRouteDebugMessage() alone - which is normally for the best anyway.

I think new private method will be removed in #3151019: Only allow route names, deprecate support for route objects in UrlGenerator methods

I mean getRouteStringIdentifier() is a full copy of getRouteDebugMessage() (which we can't type hint except doc-block as existing) so I copied code and added todo with link

updated IS

Points for #32 addressed

Committed d532f6f and pushed to 10.1.x. Thanks!

diff --git a/core/tests/Drupal/Tests/Core/Routing/UrlGeneratorTest.php b/core/tests/Drupal/Tests/Core/Routing/UrlGeneratorTest.php
index eec14d17f92..54d169f76ae 100644
--- a/core/tests/Drupal/Tests/Core/Routing/UrlGeneratorTest.php
+++ b/core/tests/Drupal/Tests/Core/Routing/UrlGeneratorTest.php
@@ -458,9 +458,9 @@ public function testBaseURLGeneration() {
    */
   public function testDeprecatedMethods() {
     $this->expectDeprecation('Drupal\Core\Routing\UrlGenerator::getRouteDebugMessage() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use the route name instead. See https://www.drupal.org/node/3172303');
-    $this->generator->getRouteDebugMessage('test');
+    $this->assertSame('test', $this->generator->getRouteDebugMessage('test'));
     $this->expectDeprecation('Drupal\Core\Routing\UrlGenerator::supports() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Only string route names are supported. See https://www.drupal.org/node/3172303');
-    $this->generator->supports('test');
+    $this->assertTrue($this->generator->supports('test'));
   }
 
   /**

Added test coverage of the deprecated method return value.

Thank you! The last deprecation of route objects unblocked #3151019-31: Only allow route names, deprecate support for route objects in UrlGenerator methods

I published the change record.