Add Danger rule for EE/CE templates60475-add-ce-ee-vue-template-danger-check

This commit adds a rule to Danger that warns the developer when their MR
includes changes to a CE .vue file that has a counterpart in the
EE repo or vice-versa.

2 files changed, 64 insertions, 0 deletions

diff --git a/Dangerfile b/Dangerfile
index 3e8cb456003..9e3a08949b0 100644
--- a/Dangerfile
+++ b/Dangerfile
@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 danger.import_plugin('danger/plugins/helper.rb')
 
 unless helper.release_automation?
@@ -16,4 +17,5 @@ unless helper.release_automation?
   danger.import_dangerfile(path: 'danger/roulette')
   danger.import_dangerfile(path: 'danger/single_codebase')
   danger.import_dangerfile(path: 'danger/gitlab_ui_wg')
+  danger.import_dangerfile(path: 'danger/ce_ee_vue_templates')
 end
diff --git a/danger/ce_ee_vue_templates/Dangerfile b/danger/ce_ee_vue_templates/Dangerfile
new file mode 100644
index 00000000000..7ed9f8c9b0c
--- /dev/null
+++ b/danger/ce_ee_vue_templates/Dangerfile
@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+# rubocop:disable Gitlab/HTTParty
+require 'cgi'
+
+def get_vue_files_with_ce_and_ee_versions(files)
+  files.select do |file|
+    if file.end_with?('.vue')
+      counterpart_path = if file.start_with?('ee/')
+                           file.sub('ee/', '')
+                         else
+                           "ee/#{file}"
+                         end
+
+      escaped_path = CGI.escape(counterpart_path)
+      api_endpoint = "https://gitlab.com/api/v4/projects/gitlab-org%2Fgitlab-ee/repository/files/#{escaped_path}?ref=master"
+      response = HTTParty.get(api_endpoint)
+      response.code != 404
+    else
+      false
+    end
+  end
+end
+
+vue_candidates = get_vue_files_with_ce_and_ee_versions(helper.all_changed_files)
+
+return if vue_candidates.empty?
+
+message 'This merge request includes changes to Vue files that have both CE and EE versions.'
+
+markdown(<<~MARKDOWN)
+  ## Vue `<template>` in CE and EE
+
+  Some Vue files in CE have a counterpart in EE.
+  (For example, `path/to/file.vue` and `ee/path/to/file.vue`.)
+
+  When run in the context of CE, the `<template>` of the CE Vue file is used.
+  When run in the context of EE, the `<template>` of the EE Vue file is used.
+
+  It's easy to accidentally make a change to a CE `<template>` that _should_
+  appear in both CE and EE without making the change in both places.
+  When this happens, the change only takes effect in CE.
+
+  The following Vue files were changed as part of this merge request that
+  include both a CE and EE version of the file:
+
+  * #{vue_candidates.map { |path| "`#{path}`" }.join("\n* ")}
+
+  If you made a change to the `<template>` of any of these Vue files that
+  should be visible in both CE and EE, please ensure you have made your
+  change to both versions of the file.
+
+  ### A better alternative
+
+  An even _better_ alternative is to refactor this component to only use
+  a single template for both CE and EE.  More info on this approach here:
+  https://docs.gitlab.com/ee/development/ee_features.html#template-tag
+
+  ### This will all go away soon
+
+  Thankfully, this soon won't be an issue as we are moving to a
+  single codebase: https://gitlab.com/groups/gitlab-org/-/epics/802
+MARKDOWN