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

fix: explicitly set easylist url #248

Merged
merged 2 commits into from
Dec 11, 2024
Merged

fix: explicitly set easylist url #248

merged 2 commits into from
Dec 11, 2024

Conversation

amhsirak
Copy link
Member

@amhsirak amhsirak commented Dec 11, 2024

ref: #207, #126

Copy link

coderabbitai bot commented Dec 11, 2024

Walkthrough

The changes in this pull request involve modifications to the PlaywrightBlocker initialization within the Interpreter and RemoteBrowser classes. The initialization method has been updated to use an external EasyList for ad-blocking rules instead of a prebuilt list. Additionally, the getSelectors method in the Interpreter class has been revised to improve selector collection logic, ensuring unique selectors are returned. Error handling for the ad-blocker initialization remains unchanged, and minor formatting adjustments were made in the RemoteBrowser class.

Changes

File Path Change Summary
maxun-core/src/interpret.ts - Updated PlaywrightBlocker initialization from fromPrebuiltAdsAndTracking(fetch) to fromLists(fetch, ['https://easylist.to/easylist/easylist.txt']).
- Modified getSelectors method to return unique selectors using a Set.
server/src/browser-management/classes/RemoteBrowser.ts - Changed PlaywrightBlocker initialization from fromPrebuiltAdsAndTracking(fetch) to fromLists(fetch, ['https://easylist.to/easylist/easylist.txt']).
- Minor comments and formatting adjustments made.

Possibly related PRs

  • feat: extract behind login #229: The changes in this PR also modify the getSelectors method in the Interpreter class within maxun-core/src/interpret.ts, enhancing selector management, which is directly related to the changes made in the main PR.

Suggested labels

Type: Feature, Status: In Review

Poem

🐰 In the land of code where rabbits play,
New blockers hop in, keeping ads at bay.
With selectors unique, they gather with glee,
A cleaner web world, oh what joy to see!
So let’s celebrate this change today,
For a brighter browsing, hip-hip-hooray! 🎉


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@amhsirak amhsirak added the Type: Bug Something isn't working label Dec 11, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (3)
maxun-core/src/interpret.ts (3)

Line range hint 105-109: Enhance error handling in ad-blocker initialization.

The error handling should include the error message for better debugging.

     PlaywrightBlocker.fromLists(fetch, ['https://easylist.to/easylist/easylist.txt']).then(blocker => {
       this.blocker = blocker;
     }).catch(err => {
-      this.log(`Failed to initialize ad-blocker:`, Level.ERROR);
+      this.log(`Failed to initialize ad-blocker: ${err.message}`, Level.ERROR);
     })

Line range hint 146-164: Review the selector collection logic.

  1. The early return after finding the first set of selectors might miss important selectors from earlier actions.
  2. The commented-out old implementation should be removed.

Consider this implementation to collect all unique selectors:

   private getSelectors(workflow: Workflow): string[] {
     const selectorsSet = new Set<string>();
 
     if (workflow.length === 0) {
         return [];
     }
 
     for (let index = workflow.length - 1; index >= 0; index--) {
         const currentSelectors = workflow[index]?.where?.selectors;
 
         if (currentSelectors && currentSelectors.length > 0) {
-            currentSelectors.forEach((selector) => selectorsSet.add(selector));
-            return Array.from(selectorsSet);
+            currentSelectors.forEach((selector) => selectorsSet.add(selector));
         }
     }
 
-    return [];
+    return Array.from(selectorsSet);
   }

Line range hint 117-145: Remove commented code.

The old implementation of getSelectors should be removed as it's no longer needed.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 53e4292 and 44880cf.

📒 Files selected for processing (2)
  • maxun-core/src/interpret.ts (1 hunks)
  • server/src/browser-management/classes/RemoteBrowser.ts (1 hunks)

Comment on lines +183 to 186
const blocker = await PlaywrightBlocker.fromLists(fetch, ['https://easylist.to/easylist/easylist.txt']);
await blocker.enableBlockingInPage(this.currentPage);
this.client = await this.currentPage.context().newCDPSession(this.currentPage);
await blocker.disableBlockingInPage(this.currentPage);
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider improving the ad-blocker initialization.

  1. The EasyList URL should be configurable rather than hardcoded to allow for easy updates and maintenance.
  2. The blocker is enabled and immediately disabled in sequence, which seems unnecessary.

Consider these improvements:

-        const blocker = await PlaywrightBlocker.fromLists(fetch, ['https://easylist.to/easylist/easylist.txt']);
+        const EASYLIST_URL = process.env.EASYLIST_URL || 'https://easylist.to/easylist/easylist.txt';
+        try {
+            const blocker = await PlaywrightBlocker.fromLists(fetch, [EASYLIST_URL]);
+            await blocker.enableBlockingInPage(this.currentPage);
+        } catch (error) {
+            logger.log('error', `Failed to initialize ad-blocker: ${error.message}`);
+        }

Committable suggestion skipped: line range outside the PR's diff.

@amhsirak amhsirak merged commit a37414f into develop Dec 11, 2024
1 check passed
@amhsirak amhsirak deleted the docker-arm branch January 2, 2025 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant