RouteNotFoundException when a module (previously added to shortcuts) disabled

I set out to automatically remove shortcut links to routes belonging to modules that are being uninstalled, but I don't know how to get a list of routes registered by any given module.

To advance this issue, here's a test that shows this bug. (setting to NR to run this test through the testbot, expecting a fail.)

Setting to major since uninstalling a module can break your entire site, and requires manually removing the shortcut link from the database to recover.

@kpv: thanks for the pointers!

Attached is a patch that should fix the original scope of this issue (uninstalling a module with routes for which one or more shortcut links exist no longer cause the site to break). However, this does not solve the full issue: routes can be added dynamically (for example through Views), and shortcut links pointing to those might still trigger an exception when the routes disappear (which is also why the router/shortcut-table solution outlined in #5.2 might not be the best approach).

For dynamic routes, I think we have no other option than to add a check to shorcut to ensure all links to be rendered point to a route that exists.

Setting to CNR to show that the patch fixes the "shortcut-breaks-on-module-uninstall"-issue, but this issue remains NW for the dynamic routes.

+++ b/core/modules/shortcut/shortcut.module
@@ -438,3 +440,26 @@ function shortcut_toolbar() {
+  // Fetch all routes declared in the modules being uninstalled.
+  $yamlDiscovery = new YamlDiscovery('routing', $module_directories);
+  $routes = $yamlDiscovery->getDefinitions();
+
+  // Remove shortcut links pointing to routes that belong to the modules being
+  // uninstalled.
+  if ($routes) {
+    $shortcuts = \Drupal::entityQuery('shortcut')->condition('route_name', array_keys($routes), 'IN')->execute();
+    entity_delete_multiple('shortcut', $shortcuts);
+  }

Mh, this really just works for static routes, not defined dynamically. An alternative implementation could be to fetch all the route names which are available and check with those

So .

This is absolutely a duplicate of an old issue, but I can't find it :(

Yeah I also remember that other one, but I thought it was already marked as fixed ...

In function shortcut_renderable_links() you may ensure that only available routes are listed. This does not remove items from disabled modules in database, but prevents errors.

function shortcut_renderable_links($shortcut_set = NULL) {
  // ...
  /** @var \Drupal\shortcut\ShortcutInterface[] $shortcuts  */
  $route_provider = \Drupal::service('router.route_provider');
  $shortcuts = \Drupal::entityManager()->getStorage('shortcut')->loadByProperties(array('shortcut_set' => $shortcut_set->id()));
  $all_cache_tags = array();
  foreach ($shortcuts as $shortcut) {
    // ensure route exists
    if ($route_provider->getRoutesByNames(array($shortcut->route_name->value))) {
      $links[] = array(
        'title' => $shortcut->label(),
        'href' => $shortcut->path->value,
      );
      $all_cache_tags[] = $shortcut->getCacheTag();
    }
  }
  // ...
  return $shortcut_links;
}

#2277753: Shortcuts should handle missing routes elegantly seems to have more momentum.