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

[iOS] - Replace NOTREACHED_IN_MIGRATION for iOS #26224

Merged
merged 2 commits into from
Oct 25, 2024

Conversation

Brandon-T
Copy link
Contributor

  • Replace NOTREACHED_IN_MIGRATION for iOS. Replaced with CHECK, DCHECK, [[no_return]] where necessary.

Resolves brave/brave-browser#41886

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:

@Brandon-T Brandon-T added CI/skip-android Do not run CI builds for Android CI/skip-macos-x64 Do not run CI builds for macOS x64 CI/skip-windows-x64 Do not run CI builds for Windows x64 unused-CI/skip-linux-x64 Do not run CI builds for Linux x64 CI/skip-macos-arm64 Do not run CI builds for macOS arm64 CI/skip-teamcity Do not run builds in TeamCity labels Oct 25, 2024
@Brandon-T Brandon-T self-assigned this Oct 25, 2024
@Brandon-T Brandon-T requested a review from a team as a code owner October 25, 2024 14:10
@@ -49,7 +49,7 @@ - (instancetype)initWithNode:(const bookmarks::BookmarkNode*)node
void BookmarkModelListener::BookmarkModelBeingDeleted() {
// This is an inconsistent state in the application lifecycle. The bookmark
// model shouldn't disappear.
NOTREACHED_IN_MIGRATION();
CHECK(false);
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't it just become NOTREACHED()?

Copy link
Collaborator

@cdesouza-chromium cdesouza-chromium left a comment

Choose a reason for hiding this comment

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

Hey Brandon, I think we will need to review the guidance to correct this PR[1]. NOTREACHED is now [[noreturn]] and so you should assume that a failed CHECK/DCHECK won't return, so we shouldn't have code after it for the failure path. A few examples on the guidance of "bad" code are like this:

// Bad:
//
// Do not handle `DCHECK()` failures. Use `CHECK()` instead and omit the
// conditional below.
DCHECK(foo);  // Use CHECK() instead and omit conditional below.
if (!foo) {
  ...
}

// Bad:
//
// Use CHECK(bar); instead.
if (!bar) {
  NOTREACHED();
}

We shouldn't be doing CHECK(FALSE) as that should be NOTREACHED. A CHECK is a NOTREACHED with a conditional in a way.

[1] https://chromium.googlesource.com/chromium/src/+/main/styleguide/c++/checks.md

@Brandon-T
Copy link
Contributor Author

Brandon-T commented Oct 25, 2024

NOTREACHED

Fixed.

However, chromium doesn't seem to be doing the same: https://source.chromium.org/chromium/chromium/src/+/main:chrome/browser/bookmarks/bookmark_html_writer.cc;l=338?q=BookmarkCodec::kTypeFolder&ss=chromium%2Fchromium%2Fsrc

They have:

if (!url_string) {
    NOTREACHED_IN_MIGRATION();
    return false;
}

instead of:

CHECK(url_string);

@cdesouza-chromium
Copy link
Collaborator

NOTREACHED

Chromium doesn't seem to be doing the same: https://source.chromium.org/chromium/chromium/src/+/main:chrome/browser/bookmarks/bookmark_html_writer.cc;l=338?q=BookmarkCodec::kTypeFolder&ss=chromium%2Fchromium%2Fsrc

They have:

if (!url_string) {
    NOTREACHED_IN_MIGRATION();
    return false;
}

instead of:

CHECK(url_string);

Please read the document.

Copy link
Collaborator

@cdesouza-chromium cdesouza-chromium left a comment

Choose a reason for hiding this comment

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

Thanks Brandon for that. Looks good.

@Brandon-T Brandon-T merged commit 9a7a73b into master Oct 25, 2024
17 checks passed
@Brandon-T Brandon-T deleted the bugfix/NOT_REACHED_IOS branch October 25, 2024 21:48
@github-actions github-actions bot added this to the 1.73.x - Nightly milestone Oct 25, 2024
@brave-builds
Copy link
Collaborator

Released in v1.73.51

@bsclifton bsclifton modified the milestones: 1.73.x - Nightly, 1.74.x - Nightly Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/skip-android Do not run CI builds for Android CI/skip-macos-arm64 Do not run CI builds for macOS arm64 CI/skip-macos-x64 Do not run CI builds for macOS x64 CI/skip-teamcity Do not run builds in TeamCity CI/skip-windows-x64 Do not run CI builds for Windows x64 unused-CI/skip-linux-x64 Do not run CI builds for Linux x64
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[iOS] - Replace NOTREACHED_IN_MIGRATION in iOS
6 participants