A platform for community discussion. Free, open, simple.
UX: Name the failing repository in GitHub setting validation errors (#41738)
Régis Hanol7fdfa88e1181
diff --git a/plugins/discourse-github/app/lib/github_badges_repo_setting_validator.rb b/plugins/discourse-github/app/lib/github_badges_repo_setting_validator.rbindex 3f479638983..cf0133bc166 100644--- a/plugins/discourse-github/app/lib/github_badges_repo_setting_validator.rb+++ b/plugins/discourse-github/app/lib/github_badges_repo_setting_validator.rb@@ -7,15 +7,21 @@ class GithubBadgesRepoSettingValidatordef valid_value?(val)return true if val.blank?- val- .split("|")- .all? do |repo|- repo.match?(DiscourseGithubPlugin::GithubRepo::VALID_URL_BASED_REPO_REGEX) ||- repo.match?(DiscourseGithubPlugin::GithubRepo::VALID_USER_BASED_REPO_REGEX)- end+ @invalid_repo =+ val+ .split("|")+ .find do |repo|+ !repo.match?(DiscourseGithubPlugin::GithubRepo::VALID_URL_BASED_REPO_REGEX) &&+ !repo.match?(DiscourseGithubPlugin::GithubRepo::VALID_USER_BASED_REPO_REGEX)+ end+ @invalid_repo.nil?enddef error_message- I18n.t("site_settings.errors.invalid_badge_repo")+ if @invalid_repo.present?+ I18n.t("site_settings.errors.invalid_badge_repo_value", repo: @invalid_repo)+ else+ I18n.t("site_settings.errors.invalid_badge_repo")+ endendenddiff --git a/plugins/discourse-github/app/lib/github_linkback_access_token_setting_validator.rb b/plugins/discourse-github/app/lib/github_linkback_access_token_setting_validator.rbindex 471c1778a43..f9e5b3c566e 100644--- a/plugins/discourse-github/app/lib/github_linkback_access_token_setting_validator.rb+++ b/plugins/discourse-github/app/lib/github_linkback_access_token_setting_validator.rb@@ -9,14 +9,22 @@ class GithubLinkbackAccessTokenSettingValidatorreturn true if val.blank?client = Discourse::GithubApi.new(val)DiscourseGithubPlugin::GithubRepo.repos.each do |repo|+ @failing_repo = repo.nameclient.get("/repos/#{repo.name}/branches")endtrue- rescue Discourse::GithubApi::Unauthorized+ rescue Discourse::GithubApi::Unauthorized, Discourse::GithubApi::NotFoundfalseenddef error_message- I18n.t("site_settings.errors.invalid_github_linkback_access_token")+ if @failing_repo.present?+ I18n.t(+ "site_settings.errors.invalid_github_linkback_access_token_for_repo",+ repo: @failing_repo,+ )+ else+ I18n.t("site_settings.errors.invalid_github_linkback_access_token")+ endendenddiff --git a/plugins/discourse-github/config/locales/server.en.yml b/plugins/discourse-github/config/locales/server.en.ymlindex d397d3e582f..5597592c213 100644--- a/plugins/discourse-github/config/locales/server.en.yml+++ b/plugins/discourse-github/config/locales/server.en.yml@@ -16,7 +16,9 @@ en:errors:invalid_badge_repo: "You must provide a GitHub URL or the repository name in the format github_user/repository_name"+ invalid_badge_repo_value: "'%{repo}' is not a valid GitHub URL or repository name. Use the format github_user/repository_name."invalid_github_linkback_access_token: "You must provide a valid GitHub linkback access token which has access to the badge repositories you have provided."+ invalid_github_linkback_access_token_for_repo: "The GitHub linkback access token could not access the '%{repo}' repository. Make sure the token is valid and that the repository name is correct and accessible."github_linkback:commit_template: |diff --git a/plugins/discourse-github/spec/lib/github_badges_repo_setting_validator_spec.rb b/plugins/discourse-github/spec/lib/github_badges_repo_setting_validator_spec.rbindex 13c5dfd0567..1563083dcf6 100644--- a/plugins/discourse-github/spec/lib/github_badges_repo_setting_validator_spec.rb+++ b/plugins/discourse-github/spec/lib/github_badges_repo_setting_validator_spec.rb@@ -46,4 +46,19 @@ describe GithubBadgesRepoSettingValidator doendendend++ describe "#error_message" do+ it "returns the generic message when no specific repo failed" do+ expect(validator.error_message).to eq(I18n.t("site_settings.errors.invalid_badge_repo"))+ end++ it "names the first invalid repo in a list" do+ value = "discourse/discourse-github|https://github.com/discourse/discourse/|bad-dog|nope"++ expect(validator.valid_value?(value)).to eq(false)+ expect(validator.error_message).to eq(+ I18n.t("site_settings.errors.invalid_badge_repo_value", repo: "bad-dog"),+ )+ end+ endenddiff --git a/plugins/discourse-github/spec/lib/github_linkback_access_token_setting_validator_spec.rb b/plugins/discourse-github/spec/lib/github_linkback_access_token_setting_validator_spec.rbindex 30a28b331b7..64a98ec1a97 100644--- a/plugins/discourse-github/spec/lib/github_linkback_access_token_setting_validator_spec.rb+++ b/plugins/discourse-github/spec/lib/github_linkback_access_token_setting_validator_spec.rb@@ -21,6 +21,19 @@ describe GithubLinkbackAccessTokenSettingValidator doendend+ context "when a repo is missing or private (404)" do+ before do+ setup_repos+ stub_request(:get, "https://api.github.com/repos/discourse/discourse/branches").to_return(+ status: 404,+ )+ end++ it "should fail" do+ expect(validator.valid_value?(value)).to eq(false)+ end+ end+context "when the token is accepted" doit "should pass, without repos defined" doexpect(validator.valid_value?(value)).to eq(true)@@ -42,8 +55,48 @@ describe GithubLinkbackAccessTokenSettingValidator doendend- def setup_repos- SiteSetting.github_badges_repos = "discourse/discourse"+ describe "#error_message" do+ it "returns the generic message when no specific repo failed" do+ expect(validator.error_message).to eq(+ I18n.t("site_settings.errors.invalid_github_linkback_access_token"),+ )+ end++ it "names the failing repo when access is unauthorized (401)" do+ setup_repos("discourse/discourse|acme/private-repo|foo/bar")+ stub_branches("discourse/discourse", status: 200)+ stub_branches("acme/private-repo", status: 401)++ expect(validator.valid_value?(value)).to eq(false)+ expect(validator.error_message).to eq(+ I18n.t(+ "site_settings.errors.invalid_github_linkback_access_token_for_repo",+ repo: "acme/private-repo",+ ),+ )+ end++ it "names the failing repo when it is missing or private (404)" do+ setup_repos("discourse/discourse|acme/typo-repo")+ stub_branches("discourse/discourse", status: 200)+ stub_branches("acme/typo-repo", status: 404)++ expect(validator.valid_value?(value)).to eq(false)+ expect(validator.error_message).to eq(+ I18n.t(+ "site_settings.errors.invalid_github_linkback_access_token_for_repo",+ repo: "acme/typo-repo",+ ),+ )+ end+ end++ def setup_repos(repos = "discourse/discourse")+ SiteSetting.github_badges_repos = reposDiscourseGithubPlugin::GithubRepo.reposend++ def stub_branches(repo, status:)+ stub_request(:get, "https://api.github.com/repos/#{repo}/branches").to_return(status:)+ endend