feat: improve pagination and scraping logic

[RohitR311]

This PR focuses on improving the pagination logic and core scraping logic of Maxun.

Summary by CodeRabbit

• Bug Fixes
  • Enhanced data collection reliability in paginated views. If additional content fails to load after several attempts, the system now automatically retrieves available data from the current page. This improvement minimizes interruptions and ensures you receive comprehensive results even when encountering loading challenges.

[coderabbitai]

Walkthrough

The change modifies the handlePagination method within the Interpreter class by adding a call to scrapeCurrentPage() when pagination has failed after the maximum number of retries. This ensures that even if pagination is unsuccessful, the data on the current page is still scraped and returned. No alterations were made to the exported or public entities.

Changes

File(s)	Summary
maxun-core/src/interpret.ts	Added call to scrapeCurrentPage() in handlePagination to scrape the current page on pagination failure.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Interpreter
    participant Scraper

    Caller->>Interpreter: call handlePagination()
    alt Pagination Successful
        Interpreter-->>Caller: return paginated results
    else Pagination Fails & Max Retries Reached
        Interpreter->>Scraper: scrapeCurrentPage()
        Scraper-->>Interpreter: return scraped data
        Interpreter-->>Caller: return accumulated results
    end

Loading

Possibly related PRs

• feat: add check for selector visibility, revert domcontentloaded to networkidle state #257: Enhances error handling in the Interpreter class by addressing pagination failure scenarios.
• fix: remove url creation and click race condition #365: Introduces modifications in the handlePagination method, similar to the new call to scrapeCurrentPage().
• feat: click next improvements #482: Focuses on improving the pagination logic within the Interpreter, aligning with the changes made in this PR.

Suggested reviewers

• amhsirak

Poem

I'm a rabbit hopping through the code,
Found a bug where errors once strode.
With a skip and a jump, I added a scrape,
So no data is ever lost, my mate.
Hooray for clean paths and a bug-free road!
🐰💻

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2211173 and 2938150.

📒 Files selected for processing (1)

• maxun-core/src/interpret.ts (1 hunks)

🔇 Additional comments (1)

maxun-core/src/interpret.ts (1)

820-820: Good improvement to error handling!

Adding scrapeCurrentPage() call when pagination fails ensures that data from the current page is still collected before returning, preventing potential data loss even when navigation to the next page isn't successful.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.