Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove NOT_REACHED() call in brave_domains #26454

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nvonpentz
Copy link
Member

Resolves

Submitter Checklist:

  • I confirm that no security/privacy review is needed and no other type of reviews are needed, or that I have requested them
  • There is a ticket for my issue
  • Used Github auto-closing keywords in the PR description above
  • Wrote a good PR/commit description
  • Squashed any review feedback or "fixup" commits before merge, so that history is a record of what happened in the repo, not your PR
  • Added appropriate labels (QA/Yes or QA/No; release-notes/include or release-notes/exclude; OS/...) to the associated issue
  • Checked the PR locally:
    • npm run test -- brave_browser_tests, npm run test -- brave_unit_tests wiki
    • npm run presubmit wiki, npm run gn_check, npm run tslint
  • Ran git rebase master (if needed)

Reviewer Checklist:

  • A security review is not needed, or a link to one is included in the PR description
  • New files have MPL-2.0 license header
  • Adequate test coverage exists to prevent regressions
  • Major classes, functions and non-trivial code blocks are well-commented
  • Changes in component dependencies are properly reflected in gn
  • Code follows the style guide
  • Test plan is specified in PR before merging

After-merge Checklist:

Test Plan:

@@ -75,7 +75,7 @@ std::string ConvertEnvironmentToString(brave_domains::ServicesEnvironment env) {
return it->second;
}

NOTREACHED_IN_MIGRATION();
LOG(ERROR) << "Invalid ServicesEnvironment value: " << static_cast<int>(env);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be NOTREACHED actually. We own the enum, which is

enum ServicesEnvironment { DEV, STAGING, PROD };

I particularly think this function should be something like:

std::string ConvertEnvironmentToString(brave_domains::ServicesEnvironment env) {
 switch(env) {
    case ServicesEnvironment::DEV:
       return kBraveServicesSwitchValueDev;
    case ServicesEnvironment::STAGING:
       return kBraveServicesSwitchValueStaging;
    case ServicesEnvironment::PROD:
       return kBraveServicesSwitchValueProduction;  
 }
  NOTREACHED_NORETURN();
}

This way we don't get some hidden bug if a new key is added to brave_domains::ServicesEnvironment.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need to do it if you don't feel like, but ideally we should also change this enum from

enum ServicesEnvironment { DEV, STAGING, PROD };

to:

enum class ServicesEnvironment { kDev, kStaging, kProd };

So, if you feel like doing that too....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants