Skip to content

fix: browser pool circular dependency #536

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

Merged
merged 9 commits into from
Apr 21, 2025
Merged

fix: browser pool circular dependency #536

merged 9 commits into from
Apr 21, 2025

Conversation

amhsirak
Copy link
Member

@amhsirak amhsirak commented Apr 12, 2025

closes #533

Summary by CodeRabbit

Summary by CodeRabbit

  • Refactor
    • Enhanced browser session handling and workflow management by introducing an additional identifier parameter to improve internal resource coordination.
  • Chores
    • Updated container build configuration by removing an unused directory from the image.

Copy link

coderabbitai bot commented Apr 12, 2025

Walkthrough

This change removes the copying of the maxun-core directory from the Docker image build in two Dockerfiles. In addition, the RemoteBrowser class and its usage in the controller have been updated to require an additional poolId parameter. The WorkflowGenerator class now accepts and utilizes this poolId, with corresponding adjustments in its event handling logic. These modifications refactor how browser instances are managed and remove an outdated dependency on the maxun-core directory in Docker builds.

Changes

Files Change Summary
Dockerfile, server/Dockerfile Removed the COPY maxun-core ./maxun-core instruction, excluding the maxun-core directory from the Docker image.
server/src/browser-management/classes/RemoteBrowser.ts, server/src/browser-management/controller.ts Updated the RemoteBrowser constructor to include a new poolId parameter; modified constructor calls in controller functions accordingly.
server/src/workflow-management/classes/Generator.ts Modified WorkflowGenerator constructor to accept and store poolId, and updated the decision event handler to use poolId instead of a browser pool lookup.

Sequence Diagram(s)

sequenceDiagram
    participant C as Controller
    participant RB as RemoteBrowser
    participant WG as WorkflowGenerator
    participant S as Socket

    C->>RB: new RemoteBrowser(socket, userId, poolId)
    RB->>WG: new WorkflowGenerator(socket, poolId)
    WG->>WG: Store poolId & listen for "decision" events
    WG->>S: Process decision using poolId
Loading

Poem

I’m a rabbit leaping through the code,
Happy steps where new parameters explode.
No more circles trapping my hop,
With poolId in place, the bugs all stop.
A joyful nibble on changes so bright,
Celebrating progress from morning 'til night! 🐰🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between f533faf and 8e60df7.

📒 Files selected for processing (5)
  • Dockerfile (0 hunks)
  • server/Dockerfile (0 hunks)
  • server/src/browser-management/classes/RemoteBrowser.ts (1 hunks)
  • server/src/browser-management/controller.ts (2 hunks)
  • server/src/workflow-management/classes/Generator.ts (2 hunks)
💤 Files with no reviewable changes (2)
  • Dockerfile
  • server/Dockerfile

🪧 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 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.

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: 0

🧹 Nitpick comments (1)
server/src/workflow-management/classes/Generator.ts (1)

153-170: Changed decision event handler to use poolId

The event handler now checks for this.poolId rather than attempting to access a browser instance through a global pool reference. The previous code that caused the circular dependency is still present but commented out, which maintains the history and context of the change.

Consider removing the commented-out code once you've verified the changes work as expected. While it's helpful during development and debugging, it may create confusion for future maintainers.

if (this.poolId) {
-  // const activeBrowser = browserPool.getRemoteBrowser(id);
-  // const currentPage = activeBrowser?.getCurrentPage();
  if (!decision) {
    switch (actionType) {
      case 'customAction':
        // pair.where.selectors = [this.generatedData.lastUsedSelector];
        pair.where.selectors = pair.where.selectors.filter(
          (selector: string) => selector !== this.generatedData.lastUsedSelector
        );
        break;
      default: break;
    }
  }
-  // if (currentPage) {
-  //   await this.addPairToWorkflowAndNotifyClient(pair, currentPage);
-  // }
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f533faf and 8e60df7.

📒 Files selected for processing (5)
  • Dockerfile (0 hunks)
  • server/Dockerfile (0 hunks)
  • server/src/browser-management/classes/RemoteBrowser.ts (1 hunks)
  • server/src/browser-management/controller.ts (2 hunks)
  • server/src/workflow-management/classes/Generator.ts (2 hunks)
💤 Files with no reviewable changes (2)
  • Dockerfile
  • server/Dockerfile
🧰 Additional context used
🧬 Code Graph Analysis (2)
server/src/browser-management/classes/RemoteBrowser.ts (2)
server/src/workflow-management/classes/Interpreter.ts (1)
  • WorkflowInterpreter (59-357)
server/src/workflow-management/classes/Generator.ts (1)
  • WorkflowGenerator (54-1210)
server/src/browser-management/controller.ts (1)
server/src/browser-management/classes/RemoteBrowser.ts (1)
  • RemoteBrowser (51-904)
🔇 Additional comments (5)
server/src/browser-management/classes/RemoteBrowser.ts (1)

121-125: Constructor updated to include poolId parameter

The constructor now accepts an additional poolId parameter which is properly passed to the WorkflowGenerator. This change resolves the circular dependency issue mentioned in the PR objectives by providing the pool identifier directly to the generator instead of having the generator access it through a global reference.

server/src/workflow-management/classes/Generator.ts (2)

72-72: Added poolId property to WorkflowGenerator

A new private property has been added to store the pool ID. This is appropriate for maintaining the state passed from the constructor.


80-82: Updated constructor to accept poolId parameter

The constructor now accepts and stores the poolId parameter, which is consistent with the changes made in the RemoteBrowser class. This is the right approach for breaking the circular dependency.

server/src/browser-management/controller.ts (2)

35-35: Updated RemoteBrowser instantiation to include pool ID

The RemoteBrowser instantiation now includes the id parameter, which corresponds to the poolId parameter in the RemoteBrowser constructor. This change is consistent with the updated constructor signature.


65-65: Updated RemoteBrowser instantiation in createRemoteBrowserForRun

The RemoteBrowser instantiation in the createRemoteBrowserForRun function now includes the id parameter, maintaining consistency with the constructor changes. This ensures that all browser instances are properly initialized with their pool ID.

@amhsirak amhsirak added Type: Bug Something isn't working Type: Refactor Issues/PRs related to refactoring codebase labels Apr 15, 2025
@amhsirak amhsirak merged commit 68df9ff into develop Apr 21, 2025
1 check passed
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 Type: Refactor Issues/PRs related to refactoring codebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: circular dependency in browser pool
1 participant