From 29f200110245443454fd4358ed8c71ff8607fdd7 Mon Sep 17 00:00:00 2001
From: Bob Van Landuyt <bob@gitlab.com>
Date: Tue, 2 May 2017 12:36:58 +0200
Subject: [PATCH] Update comments

---
 app/validators/dynamic_path_validator.rb      | 23 +++++++++++++++----
 .../rename_reserved_paths_migration/v1.rb     |  8 +++++++
 2 files changed, 26 insertions(+), 5 deletions(-)

diff --git a/app/validators/dynamic_path_validator.rb b/app/validators/dynamic_path_validator.rb
index ba142ea06a6..7a14aed0c3e 100644
--- a/app/validators/dynamic_path_validator.rb
+++ b/app/validators/dynamic_path_validator.rb
@@ -61,15 +61,28 @@ class DynamicPathValidator < ActiveModel::EachValidator
     users
   ].freeze
 
-  # All project routes with wildcard argument must be listed here.
-  # Otherwise it can lead to routing issues when route considered as project name.
+  # This list should contain all words following `/*namespace_id/:project_id` in
+  # routes that contain a second wildcard.
   #
   # Example:
-  #  /group/project/tree/deploy_keys
+  #   /*namespace_id/:project_id/badges/*ref/build
   #
-  #  without tree as reserved name routing can match 'group/project' as group name,
-  #  'tree' as project name and 'deploy_keys' as route.
+  # If `badges` was allowed as a project/group name, we would not be able to access the
+  # `badges` route for those projects:
   #
+  # Consider a namespace with path `foo/bar` and a project called `badges`.
+  # The route to the build badge would then be `/foo/bar/badges/badges/master/build.svg`
+  #
+  # When accessing this path the route would be matched to the `badges` path
+  # with the following params:
+  #   - namespace_id: `foo`
+  #   - project_id: `bar`
+  #   - ref: `badges/master`
+  #
+  # Failing to find the project, this would result in a 404.
+  #
+  # By rejecting `badges` the router can _count_ on the fact that `badges` will
+  # be preceded by the `namespace/project`.
   WILDCARD_ROUTES = %w[
     badges
     blame
diff --git a/lib/gitlab/database/rename_reserved_paths_migration/v1.rb b/lib/gitlab/database/rename_reserved_paths_migration/v1.rb
index 1966f5c1cec..89530082cd2 100644
--- a/lib/gitlab/database/rename_reserved_paths_migration/v1.rb
+++ b/lib/gitlab/database/rename_reserved_paths_migration/v1.rb
@@ -1,3 +1,11 @@
+# This module can be included in migrations to make it easier to rename paths
+# of `Namespace` & `Project` models certain paths would become `reserved`.
+#
+# If the way things are stored on the filesystem related to namespaces and
+# projects ever changes. Don't update this module, or anything nested in `V1`,
+# since it needs to keep functioning for all migrations using it using the state
+# that the data is in at the time. Instead, create a `V2` module that implements
+# the new way of reserving paths.
 module Gitlab
   module Database
     module RenameReservedPathsMigration