fix(headless): Variables are now available into headless template

[alban-stourbe-wmx]

Proposed changes

Modify variables merge maps in headless requests to avoid loss of information (such as metadata, variables, constants, etc.). Sometimes, the headless template has no template context. But we need to keep information about variables.

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

• Refactor
  • Improved how variable maps are merged during request execution for more consistent variable handling.
  • Minor formatting update for improved code readability.

[coderabbitai]

Walkthrough

This change updates how variable maps are merged within the ExecuteWithResults method in the headless protocol request logic. It alters which maps are merged at different stages and includes a minor formatting adjustment for a deferred function call in another method. No changes were made to exported declarations.

Changes

File(s)	Change Summary
pkg/protocols/headless/request.go	Adjusted variable map merging logic in ExecuteWithResults and reformatted a deferred function.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Request as HeadlessRequest
    participant Options
    participant TemplateCtx

    Caller->>Request: ExecuteWithResults(input)
    alt HasTemplateCtx(input.MetaInput) is true
        Request->>TemplateCtx: Get variables
        Request->>Request: Merge vars + templateCtxVars
    else
        Request->>Request: Use vars only
    end
    Request->>Request: Evaluate variablesMap
    Request->>Request: Merge vars + metadata + optionVars + variablesMap + constants
    Request-->>Caller: Return results

Loading

Possibly related PRs

• Ensure Headless protocol accesses flow protocol variables #6003: Both PRs modify the merging logic of variable maps within the ExecuteWithResults method in pkg/protocols/headless/request.go, focusing on how vars, metadata, optionVars, and template context variables are combined and used.

Poem

In the warren of code, a merge was redone,
Variables shuffled—now fewer, then more,
With maps combined neatly, the logic moves on,
And rabbits rejoice on the protocol floor.
One hop for each context,
And a carrot for each fix—
Code harmony restored, in a handful of ticks! 🥕

---

📜 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 84a76b3 and 49a005b.

📒 Files selected for processing (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Tests (ubuntu-latest)
• GitHub Check: Tests (macOS-latest)
• GitHub Check: Tests (windows-latest)

🔇 Additional comments (2)

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

57-61: Variable merging logic correctly addresses the issue.

The changes improve variable availability in headless templates by:

1. Line 57: Simplifying the initial merge to only combine vars with template context variables, preserving metadata and optionVars for later use.

2. Line 61: Ensuring all variable sources (vars, metadata, optionVars, variablesMap, constants) are merged after proper evaluation, preventing variable loss when template context is missing.

This approach aligns perfectly with the PR objective to ensure variables remain accessible within headless templates.

---

122-123: Minor formatting improvement.

The defer statement has been reformatted to a more concise single-line anonymous function, improving code readability without affecting functionality.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • 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.

[alban-stourbe-wmx]

fix: #6300