feat: make driver to be more flexible and have modularity

[andostronaut]

This is an automated pull request for branch feat/driver-modularity-folder

Summary by CodeRabbit

• New Features

  • Improved configuration management now validates your setup and clearly reports any issues with the URL.
  • Testing functionality has been updated to use Safari by default in sample scenarios, enhancing compatibility.
  • Detailed performance tracking and outcome reporting for test cases provide clearer insights.

• Refactor

  • Internal processes and parameter validation have been streamlined to deliver a more stable browser testing experience.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces multiple updates across configuration and driver components. The .gitignore file now omits drowser.json and restores ignoring of node_modules. The JSON file’s formatting is adjusted with a tab character. In the test example, the browser parameter is changed from 'chrome' to 'safari'. The old driver implementation is removed from src/driver.ts and replaced by new modular functions spread across several files. Import paths are updated accordingly to support the reorganized driver functionality, and minor formatting improvements have been made.

Changes

File(s)	Change Summary
.gitignore	Added entry for drowser.json and restored ignore entry for node_modules.
drowser.json	Modified whitespace before the "url" value from a single space to a tab character.
examples/basic.ts	Updated driver configuration from { browser: 'chrome' } to { browser: 'safari' }.
mod.ts	Updated import path for the driver from ./src/driver.ts to ./src/driver/index.ts.
src/driver.ts	Removed the old asynchronous driver function that executed browser tests.
src/driver/config.ts, src/driver/index.ts, src/driver/process.ts, src/driver/validate.ts	Introduced new driver functionality: - getConfig in config.ts to load and validate configuration. - A new asynchronous driver function in index.ts handling navigation, service cases processing, and reporting. - processServiceCase in process.ts to measure and log individual test case execution. - validateParams in validate.ts for browser parameter validation.
src/driver/export.ts	Updated import paths to reflect directory restructuring and simplified the concatenation in the exportGeneratedLog function.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant D as Driver (index.ts)
    participant G as getConfig (config.ts)
    participant V as validateParams (validate.ts)
    participant B as Builder
    participant S as ServiceCase (processServiceCase)
    participant L as Logger

    C->>D: Call driver({ browser })
    D->>G: getConfig()
    G-->>D: Return { url }
    D->>V: validateParams({ browser })
    V-->>D: Validation passed
    D->>B: Create Builder instance
    D->>B: Navigate to URL
    B-->>D: Navigation result
    loop For each service case
        D->>S: processServiceCase(serviceCase, builder, ...)
        S-->>D: Test result (time, status)
    end
    D->>L: exportGeneratedFiles()
    D->>B: Quit browser session
    D-->>C: Return test results

Loading

Poem

I'm a bunny, hopping with glee,
Code changes ripple like ripples in a sea,
Ignoring files and setting paths anew,
Browser switched and functions shining through,
With modular hops and logic so bright,
I nibble on bugs in the soft moonlight!
🐰💻 Hop, hop, hooray!

---

📜 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 2adcfcf and d8f6902.

📒 Files selected for processing (10)

• .gitignore (1 hunks)
• drowser.json (1 hunks)
• examples/basic.ts (1 hunks)
• mod.ts (1 hunks)
• src/driver.ts (0 hunks)
• src/driver/config.ts (1 hunks)
• src/driver/export.ts (3 hunks)
• src/driver/index.ts (1 hunks)
• src/driver/process.ts (1 hunks)
• src/driver/validate.ts (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @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.