Skip to content

Handle YAML tag in migration properly #381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
May 28, 2025
Merged

Handle YAML tag in migration properly #381

merged 1 commit into from
May 28, 2025

Conversation

frenck
Copy link
Member

@frenck frenck commented May 28, 2025 •
edited by coderabbitai bot
Loading

Proposed Changes

We need special handling for the YAML !env_var tag in yq.
Cleaned stuff up a little, and added some more logs.

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of configuration updates for authentication tokens and HTTP URL, ensuring correct formatting and environment variable usage.
    • Enhanced reliability by streamlining checks for required configuration fields.

@frenck frenck added the bugfix Inconsistencies or issues which will cause a problem for users or implementors. label May 28, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 28, 2025 •
edited
Loading

Walkthrough

The script for initializing AppDaemon has been updated to streamline configuration checks and updates. Redundant existence checks for certain configuration keys have been removed, and the process for injecting environment variables and updating URLs has been simplified for directness and clarity.

Changes

File(s) Change Summary
appdaemon/rootfs/etc/s6-overlay/s6-rc.d/init-appdaemon/run Simplified logic for checking and updating .appdaemon.plugins.HASS fields and .http.url values.

Poem

A hop and a skip, the script’s now more neat,
No double-checks—just logic, direct and fleet.
URLs are swapped with a flick of the paw,
Tokens injected with YAML’s raw.
In the burrow of code, things run with less fuss,
Streamlined and simple—just right for us!
🐇✨

📜 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 0ba2c5f and 35b7611.

📒 Files selected for processing (1)
  • appdaemon/rootfs/etc/s6-overlay/s6-rc.d/init-appdaemon/run (1 hunks)
🔇 Additional comments (4)
appdaemon/rootfs/etc/s6-overlay/s6-rc.d/init-appdaemon/run (4)

23-24: LGTM: Proper existence checks for authentication fields.

The use of yq with has() to check for the existence of token and ha_key fields is the correct approach and handles cases where the parent path might not exist.

26-32: Excellent improvement: Proper YAML tag handling for environment variables.

This change addresses the main objective of properly handling the !env_var YAML tag. The use of tag="!env_var" in the yq command ensures the YAML tag is preserved correctly, which is crucial for AppDaemon to recognize this as an environment variable reference.

The logic correctly adds authentication only when both token and ha_key are missing, preventing overwriting of existing configurations.

35-40: Good simplification: Streamlined URL update logic.

The removal of the redundant existence check for .http.url simplifies the code while maintaining the same functional behavior. If the URL doesn't exist, yq e '.http.url' will return null which won't match the comparison string, so no update will occur - this is the desired behavior.

23-40:

❓ Verification inconclusive

Verify yq version compatibility for tag syntax.

The tag="!env_var" syntax used in line 30 is critical for proper YAML tag handling. Please ensure this syntax is compatible with the version of yq installed in the container environment.

🏁 Script executed:

#!/bin/bash
# Description: Check yq version and verify tag syntax support
# Expected: yq version that supports the tag="..." syntax

# Check yq version
yq --version

# Test the tag syntax with a simple example
echo 'test: value' | yq e '.test tag="!env_var"' -

Length of output: 253

#!/bin/bash
# Locate Dockerfile(s) and inspect for yq installation/version pinning
set -e

# Find all Dockerfile variants
dockerfiles=$(fd -t f -I 'Dockerfile*' . || true)
if [ -z "$dockerfiles" ]; then
  echo "No Dockerfile found in the repo."
  exit 0
fi

for df in $dockerfiles; do
  echo "=== Inspecting $df ==="
  grep -n "yq" "$df" || echo "  ⚠️ No 'yq' reference in $df"
done

Verify yq installation and tag syntax support

The tag="!env_var" filter on line 30 requires Mike Farah’s yq v4+ (the Go implementation) to be present in the container and support inline tag assignments. Please confirm that:

  • yq is installed in your add-on image (e.g. via apk add yq or equivalent).
  • yq --version reports a 4.x release.
  • The installed yq supports the tag="!..." syntax.

You may also guard this script with an early check:

if ! command -v yq >/dev/null; then
  bashio::log.error "Missing yq (v4+)—required for YAML tag handling."
  exit 1
fi

If your Dockerfile or build pipeline doesn’t yet install yq v4+, please add it to ensure the tag operation succeeds.

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
🪧 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.

@frenck frenck merged commit cd2d0cc into main May 28, 2025
20 checks passed
@frenck frenck deleted the frenck-2025-0302 branch May 28, 2025 09:29
@coderabbitai coderabbitai bot mentioned this pull request May 28, 2025
Merged
@github-actions github-actions bot locked and limited conversation to collaborators May 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
bugfix Inconsistencies or issues which will cause a problem for users or implementors.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@frenck