feat(headless): store responses

[dwisiswant0]

Proposed changes

Close #6246

Checklist

• Pull request is created against the dev branch
• All checks passed (lint, unit/integration/regression tests etc.) with my changes
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Summary by CodeRabbit

• New Features
  • Added the ability to store raw response bodies when the response storage option is enabled, improving response data management for users.

[coderabbitai]

Walkthrough

The dumpResponse function in the headless protocol was updated to support storing headless responses when the StoreResponse option is enabled. Now, the function writes the raw response body to the specified output directory in addition to existing debug logging, ensuring headless responses are saved as required.

Changes

File(s)	Change Summary
pkg/protocols/headless/request.go	Enhanced dumpResponse to store headless responses when StoreResponse is enabled, reusing the message prefix for both logging and storage.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HeadlessRequest
    participant Output

    User->>HeadlessRequest: Initiate headless request
    HeadlessRequest->>HeadlessRequest: Process response
    alt StoreResponse enabled
        HeadlessRequest->>Output: WriteStoreDebugData (response body)
    end
    alt Debug or DebugResponse enabled
        HeadlessRequest->>User: Log highlighted debug message
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Save headless protocol requests and responses to the -store-resp-dir directory (#6246)	✅

Poem

A hop and a skip, a bug in the way,
Headless responses now have a place to stay!
With paws on the keyboard and ears held high,
I’ve taught the code to store and not just pass by.
In the burrow of bytes, where responses reside,
Every headless hop is now saved with pride!
🐇✨

---

📜 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 a4859df and 7270be8.

📒 Files selected for processing (1)

• pkg/protocols/headless/request.go (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

pkg/protocols/headless/request.go (2)

pkg/types/types.go (1)

• Options (30-452)

pkg/protocols/headless/engine/page.go (1)

• Options (49-53)

🔇 Additional comments (1)

pkg/protocols/headless/request.go (1)

226-235: Excellent implementation of response storage functionality!

The changes cleanly separate the concerns of debug logging and response storing while maintaining efficiency. The logic correctly:

1. Expands the condition to include StoreResponse alongside existing debug options
2. Constructs the message prefix once for reuse across both logging and storing
3. Uses highlighted response for debug logging and raw response body for storage
4. Handles all combinations of the three flags (Debug, DebugResponse, StoreResponse) appropriately

The implementation aligns perfectly with the PR objective to store headless responses when the StoreResponse option is enabled.

✨ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.