fix: only pass engine version header when inside a task

[ericallam]

This will allow migrating to the v4 SDK in your application backend before deploying v4 to trigger, and everything will just work

Summary by CodeRabbit

• Refactor
  • Streamlined communication logic so that additional processing details are now included only during specific task operations, ensuring smoother, more targeted interactions.
  • Improved internal guidance to clarify this context-sensitive behavior.

[changeset-bot]

⚠️ No Changeset found

Latest commit: dafe35a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update the header management in the ApiClient class. The "x-trigger-engine-version": "V2" header is no longer added unconditionally. Instead, it is now conditionally included only when the operation is running inside a task context. A comment has been added to clarify this behavior, which adjusts the control flow of header assignment.

Changes

File(s)	Summary
packages/core/.../apiClient/index.ts	Removed the unconditional inclusion of the "x-trigger-engine-version": "V2" header; now conditionally added when inside a task; added a clarifying comment on this behavior.

Sequence Diagram(s)

sequenceDiagram
    participant AC as ApiClient
    participant TC as Task Context
    participant S as Server

    AC->>AC: Prepare HTTP request headers
    alt Inside task context?
        AC->>AC: Add "x-trigger-engine-version" header
    else Not inside task
        AC->>AC: Do not add "x-trigger-engine-version"
    end
    AC->>S: Send request with headers

Loading

Possibly related PRs

• v4 engine version selection logic updated #1866: This PR also deals with engine version header handling, involving the conditional logic around setting "x-trigger-engine-version": "V2".

Suggested reviewers

• nicktrn
• matt-aitken

Poem

In a field of code so vast,
I hop along with headers cast.
A task, a check, a conditional cheer,
"x-trigger" joins only when it's clear.
🐰 Cheers to changes, swift and bright,
Hopping code rhythms into the night!
🌟

---

📜 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 dcacc3a and dafe35a.

📒 Files selected for processing (1)

• packages/core/src/v3/apiClient/index.ts (1 hunks)

✨ 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.
  • 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.