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

[ads] [[nodiscard]] code health #27710

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

[ads] [[nodiscard]] code health #27710

wants to merge 1 commit into from

Conversation

tmancey
Copy link
Collaborator

@tmancey tmancey commented Feb 18, 2025

Resolves brave/brave-browser#44062

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:

@tmancey tmancey self-assigned this Feb 18, 2025
@tmancey tmancey requested a review from a team as a code owner February 18, 2025 15:48
Copy link
Contributor

[puLL-Merge] - brave/brave-core@27710

Description

This PR adds the [[nodiscard]] attribute to boolean return functions across the Brave Ads codebase. The [[nodiscard]] attribute indicates that the return value of a function should not be discarded, helping to prevent bugs where important boolean results are accidentally ignored. This is a code quality improvement that helps enforce better error handling and value checking.

Changes

Changes

  • Added [[nodiscard]] attribute to boolean return functions in multiple files, organized by component:
  1. browser/ui/views/brave_ads/:

    • Modified color_util.h
    • Added attribute to RgbStringToSkColor
  2. components/brave_ads/browser/:

    • Modified multiple files including reminder_util.h
    • Added attribute to functions like IsReminder
  3. components/brave_ads/core/internal/:

    • Modified multiple utility and helper files
    • Added attribute to functions like DoesRespectCap, IsInitialized, IsEmpty
    • Added to permission rules, condition matchers, and targeting functions
  4. components/brave_ads/core/public/:

    • Modified interface files
    • Added attribute to public API functions returning booleans
sequenceDiagram
    participant Compiler as C++ Compiler
    participant Code as Brave Ads Code
    participant Dev as Developer
    
    Dev->>Code: Adds [[nodiscard]] to boolean functions
    Code->>Compiler: Compilation
    Compiler->>Dev: Warning if bool result ignored
    Note over Compiler,Dev: Helps prevent accidental error ignoring
    Dev->>Code: Must handle all boolean returns
    Note over Code,Dev: Improves code quality
Loading

Security Hotspots

None - This is a type system enhancement that doesn't affect runtime behavior.

@tmancey tmancey marked this pull request as draft February 18, 2025 16:17
@tmancey tmancey marked this pull request as ready for review February 18, 2025 16:59
@tmancey tmancey marked this pull request as draft February 18, 2025 17:29
Copy link
Contributor

Chromium major version is behind target branch (133.0.6943.98 vs 134.0.6998.15). Please rebase.

@github-actions github-actions bot added the chromium-version-mismatch The Chromium version on the PR branch does not match the version on the target branch label Feb 18, 2025
@github-actions github-actions bot removed the chromium-version-mismatch The Chromium version on the PR branch does not match the version on the target branch label Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ads] [[nodiscard]] code health
1 participant