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

Added header to bookmarks panel #20211

Merged
merged 2 commits into from
Sep 22, 2023
Merged

Added header to bookmarks panel #20211

merged 2 commits into from
Sep 22, 2023

Conversation

simonhong
Copy link
Member

@simonhong simonhong commented Sep 19, 2023

fix brave/brave-browser#32952

Bookmarks panel's header includes icon, title and button for loading bookmarks manager.

BraveBookmarksSidePanelCoordinator gives bookmaks panel's contents view and that contents view
has our header view and upstream web view.

image

image

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 lint, 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:

  1. Toggle bookmarks panel and check header is shown.
  2. Click button in the header and check bookmarks manager is loaded in a tab

@simonhong simonhong self-assigned this Sep 19, 2023
@github-actions github-actions bot added the potential-layer-violation-fixes This PR touches a BUILD.gn file with check_includes=false label Sep 19, 2023
@simonhong simonhong force-pushed the bookmark_panel_header branch from 3c6ab32 to ceb3140 Compare September 19, 2023 05:15
@simonhong simonhong linked an issue Sep 19, 2023 that may be closed by this pull request
Base automatically changed from reading_list_panel_header to master September 19, 2023 22:40
@simonhong simonhong marked this pull request as ready for review September 19, 2023 22:41
@simonhong simonhong requested review from a team as code owners September 19, 2023 22:41
ui::ImageModel::FromVectorIcon(omnibox::kStarIcon, ui::kColorIcon),
base::BindRepeating(
&BraveBookmarksSidePanelCoordinator::CreateBookmarksPanelView,
base::Unretained(this))));
Copy link
Contributor

Choose a reason for hiding this comment

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

reported by reviewdog 🐶
[semgrep] base::Unretained is most of the time unrequited, and a weak reference is better suited for secure coding.
Consider swapping Unretained for a weak reference.
base::Unretained usage may be acceptable when a callback owner is guaranteed
to be destroyed with the object base::Unretained is pointing to, for example:

- PrefChangeRegistrar
- base::*Timer
- mojo::Receiver
- any other class member destroyed when the class is deallocated


Source: https://github.com/brave/security-action/blob/main/assets/semgrep_rules/client/chromium-uaf.yaml


Cc @thypon @goodov @iefremov

Copy link
Member Author

Choose a reason for hiding this comment

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

This BraveBookmarksSidePanelCoordinator and global_registry_ is per browser object. Both life cycle is tied with Browser object. So, both are destroyed together when Browser object is deleted. So, I think using Unretained() here would not cause any issue. Also all upstream coordinator uses this pattern.

// this class.
auto* button = AddChildView(std::make_unique<views::ImageButton>(
base::BindRepeating(&BookmarksSidePanelHeaderView::OnButtonPressed,
base::Unretained(this), browser)));
Copy link
Contributor

Choose a reason for hiding this comment

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

reported by reviewdog 🐶
[semgrep] base::Unretained is most of the time unrequited, and a weak reference is better suited for secure coding.
Consider swapping Unretained for a weak reference.
base::Unretained usage may be acceptable when a callback owner is guaranteed
to be destroyed with the object base::Unretained is pointing to, for example:

- PrefChangeRegistrar
- base::*Timer
- mojo::Receiver
- any other class member destroyed when the class is deallocated


Source: https://github.com/brave/security-action/blob/main/assets/semgrep_rules/client/chromium-uaf.yaml


Cc @thypon @goodov @iefremov

Copy link
Member Author

Choose a reason for hiding this comment

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

// Safe to use Unretained(this) here as |button| will be destroyed before
// this class.

Copy link
Contributor

@sangwoo108 sangwoo108 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Copy link
Contributor

@sangwoo108 sangwoo108 left a comment

Choose a reason for hiding this comment

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

Still LGTM

fix brave/brave-browser#32952

Bookmarks panel's header includes icon, title and button for loading
bookmarks manager.
@simonhong simonhong force-pushed the bookmark_panel_header branch from 78ca02d to 70255d1 Compare September 20, 2023 23:09
Copy link
Member

@goodov goodov left a comment

Choose a reason for hiding this comment

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

chromium_src lgtm

Copy link
Collaborator

@mkarolin mkarolin left a comment

Choose a reason for hiding this comment

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

strings++

@simonhong simonhong merged commit 4a53732 into master Sep 22, 2023
6 checks passed
@simonhong simonhong deleted the bookmark_panel_header branch September 22, 2023 16:06
@github-actions github-actions bot added this to the 1.60.x - Nightly milestone Sep 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-security-review potential-layer-violation-fixes This PR touches a BUILD.gn file with check_includes=false
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add title to Bookmarks side panel
6 participants