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] Remove tab storage on all tab content scripts #27162

Merged
merged 1 commit into from
Jan 10, 2025

Conversation

kylehickinson
Copy link
Collaborator

This change prepares for using the Chromium web embedder by removing weak storage of Tab objects passed in when creating classes confomring to TabContentScript which better matches JavaScriptFeature and its requirements.

This doesn't change how any underlying JavaScript functions or logic of the message handlers

Resolves brave/brave-browser#43184

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:

@kylehickinson kylehickinson 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 CI/skip-macos-arm64 Do not run CI builds for macOS arm64 CI/skip-teamcity Do not run builds in TeamCity labels Jan 8, 2025
@kylehickinson kylehickinson self-assigned this Jan 8, 2025
@kylehickinson kylehickinson requested a review from a team as a code owner January 8, 2025 20:59
@@ -227,10 +227,6 @@ public class BrowserViewController: UIViewController {
// allow us to re-trigger the `URLRequest` if the user requests a file to be downloaded.
var pendingRequests = [String: URLRequest]()

// This is set when the user taps "Download Link" from the context menu. We then force a
// download of the next request through the `WKNavigationDelegate` that matches this web view.
weak var pendingDownloadWebView: WKWebView?
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This was never set so I removed it

@kylehickinson kylehickinson force-pushed the ios-tab-content-script branch from e74ed87 to d1b8724 Compare January 10, 2025 14:40
Copy link
Contributor

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

Description

This PR significantly refactors the TabContentScript protocol and its implementations. The main changes involve removing the tab property from individual script handlers and instead passing the Tab instance as a parameter to the receivedScriptMessage method. This change promotes better encapsulation and reduces tight coupling between the script handlers and the Tab class.

Possible Issues

  1. The refactoring might introduce subtle bugs if any script handlers were relying on maintaining state between messages using the tab property.
  2. Some script handlers may need additional refactoring to handle the new method signature correctly.

Security Hotspots

No significant security issues are introduced by this change. However, careful testing should be done to ensure that all script handlers are correctly handling the new method signature, especially in security-sensitive areas like the wallet and authentication handlers.

Changes

Changes

  1. TabContentScript.swift:

    • Updated the userContentController method to tab(_:receivedScriptMessage:replyHandler:).
    • Removed the tab property from the protocol.
  2. Various script handlers (e.g., BlockedDomainScriptHandler, HTTPBlockedScriptHandler, etc.):

    • Removed tab property.
    • Updated method signature to match the new protocol.
    • Refactored internal methods to accept tab as a parameter where necessary.
  3. Tab.swift:

    • Updated TabContentScriptManager to pass the Tab instance to script handlers.
  4. BrowserViewController.swift:

    • Updated script handler initializations to remove tab parameter where it's no longer needed.
  5. Test files:

    • Updated to reflect the new method signatures and initialization patterns.
sequenceDiagram
    participant BVC as BrowserViewController
    participant Tab
    participant TSM as TabScriptManager
    participant SH as ScriptHandler

    BVC->>Tab: Creates Tab
    Tab->>TSM: Creates TabScriptManager
    BVC->>Tab: Adds ScriptHandlers
    Tab->>TSM: Registers ScriptHandlers
    Note over Tab,TSM: ScriptHandlers no longer hold reference to Tab
    WKWebView->>TSM: Receives script message
    TSM->>SH: Calls tab(_:receivedScriptMessage:replyHandler:)
    SH->>Tab: Interacts with Tab as needed
    SH->>TSM: Returns result
    TSM->>WKWebView: Sends reply
Loading

This change prepares for using the Chromium web embedder by removing weak storage of `Tab` objects passed in when creating classes confomring to `TabContentScript` which better matches `JavaScriptFeature` and its requirements
@kylehickinson kylehickinson force-pushed the ios-tab-content-script branch from d1b8724 to 8690a3c Compare January 10, 2025 17:28
@kylehickinson kylehickinson merged commit dbb1a68 into master Jan 10, 2025
18 checks passed
@kylehickinson kylehickinson deleted the ios-tab-content-script branch January 10, 2025 19:09
@github-actions github-actions bot added this to the 1.76.x - Nightly milestone Jan 10, 2025
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 puLL-Merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Prepare JavaScript message handlers for support using the Chromium web embedder
5 participants