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

Cosmetic filtering fixes #12038

Merged
merged 2 commits into from
Jan 28, 2022
Merged

Cosmetic filtering fixes #12038

merged 2 commits into from
Jan 28, 2022

Conversation

antonok-edm
Copy link
Collaborator

Resolves brave/brave-browser#20177
Resolves brave/brave-browser#20722

Submitter Checklist:

  • I confirm that no security/privacy review is needed, or that I have requested one
  • 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, npm run lint, 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:

See brave/brave-browser#20177 (comment)

@antonok-edm antonok-edm self-assigned this Jan 28, 2022
@github-actions github-actions bot added the CI/storybook-url Deploy storybook and provide a unique URL for each build label Jan 28, 2022
Copy link
Collaborator Author

@antonok-edm antonok-edm left a comment

Choose a reason for hiding this comment

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

Just a few comments with some additional context around what changed in this PR

};
})();)";

const char kStyleSelectorsInjectScript[] =
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've removed kForceHideSelectorsInjectScript and kStyleSelectorsInjectScript entirely. They were previously adding rules to window.content_cosmetic.cosmeticStyleSheet in order to keep track of the indices of rules, but this is no longer necessary as a result of using injectStylesheet with an id of 0. At that point, there is no special behavior in JS and we can construct the corresponding stylesheets directly in C++ instead.

Copy link
Member

Choose a reason for hiding this comment

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

cool refactor!

Comment on lines +191 to +193
web_frame->GetDocument().InsertStyleSheet(
blink::WebString::FromUTF8(stylesheet), style_sheet_key,
blink::WebDocument::kUserOrigin);
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

InsertStyleSheet with kUserOrigin provides the desired "injected stylesheet" behavior as if it were added by an extension, rather than "constructed stylesheet" from document.adoptedStyleSheets.

It also has the added bonus of being able to pass in a custom blink::WebString as an identifier for each stylesheet, allowing those sheets to be removed later by RemoveInsertedStyleSheet. There was previously a lot of JS code to manage this around the document.adoptedStyleSheets API.

InsertStyleSheet and RemoveInsertedStyleSheet are exposed directly to the JS cosmetic filtering script through injectStylesheet and uninjectStylesheet.

Comment on lines +2024 to +2025
R"(addElementsDynamically();
async function waitCSSSelector() {
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@brave-builds
Copy link
Collaborator

A Storybook has been deployed to preview UI for the latest push

json_selectors = "[]";
base::Value* force_hide_selectors_list =
resources_dict->FindListKey("force_hide_selectors");
if (force_hide_selectors_list->GetList().size() != 0) {
Copy link
Member

Choose a reason for hiding this comment

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

perhaps worth to check force_hide_selectors_list != nullptr in case we don't have that key.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

oops, good catch! I thought I had it but I guess not

if (force_hide_selectors_list &&
base::Value* force_hide_selectors_list =
resources_dict->FindListKey("force_hide_selectors");
if (force_hide_selectors &&
Copy link
Member

Choose a reason for hiding this comment

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

force_hide_selectors_list?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

🤦 yep...
updated

Copy link
Member

@SergeyZhukovsky SergeyZhukovsky left a comment

Choose a reason for hiding this comment

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

++

@brave-builds
Copy link
Collaborator

A Storybook has been deployed to preview UI for the latest push

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/storybook-url Deploy storybook and provide a unique URL for each build
Projects
None yet
3 participants