Skip to content

upgrade of viper and mapstructure libraries #507

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.

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

creativeprojects
Copy link
Owner

@creativeprojects creativeprojects commented May 19, 2025

Upgrading the viper library comes with a new fork of mapstructure

Copy link

coderabbitai bot commented May 19, 2025

Walkthrough

The changes update the configuration system to use the github.com/go-viper/mapstructure/v2 package instead of github.com/mitchellh/mapstructure, and introduce explicit support for HCL encoding by registering an HCL codec with Viper. Dependency versions are updated accordingly, and unused indirect dependencies are removed.

Changes

File(s) Change Summary
config/config.go Switched to mapstructure/v2, registered HCL codec, and created a codec registry for Viper initialisation.
config/config_mixins.go
config/config_v1.go
config/profile.go
Updated import to use github.com/go-viper/mapstructure/v2 instead of github.com/mitchellh/mapstructure.
go.mod Updated dependencies: replaced mapstructure with mapstructure/v2, added encoding/hcl, upgraded Viper, and removed several indirect dependencies.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Config
    participant Viper
    participant CodecRegistry
    participant HCLCodec

    Caller->>Config: newConfig(format)
    Config->>CodecRegistry: Create registry
    Config->>HCLCodec: Register HCL codec in registry
    Config->>Viper: Initialise with key delimiter and codec registry
    Viper-->>Config: Viper instance ready (with HCL support)
    Config-->>Caller: Return Config instance
Loading

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between b3d9d7c and cdb0c02.

📒 Files selected for processing (1)
  • config/config.go (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • config/config.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (go)
✨ 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
🪧 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 81a6e45 and b3d9d7c.

⛔ Files ignored due to path filters (1)
  • go.sum is excluded by !**/*.sum
📒 Files selected for processing (5)
  • config/config.go (2 hunks)
  • config/config_mixins.go (1 hunks)
  • config/config_v1.go (1 hunks)
  • config/profile.go (1 hunks)
  • go.mod (1 hunks)
🧰 Additional context used
🪛 golangci-lint (1.64.8)
config/config.go

66-66: Error return value of codecRegistry.RegisterCodec is not checked

(errcheck)

🪛 GitHub Check: Build and test (1.24, macos-latest)
config/config.go

[failure] 66-66:
Error return value of codecRegistry.RegisterCodec is not checked (errcheck)

🪛 GitHub Check: Build and test (1.24, ubuntu-latest)
config/config.go

[failure] 66-66:
Error return value of codecRegistry.RegisterCodec is not checked (errcheck)

🪛 GitHub Actions: Build
config/config.go

[error] 66-66: golangci-lint: Error return value of codecRegistry.RegisterCodec is not checked (errcheck)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (go)
🔇 Additional comments (7)
config/profile.go (1)

20-20: Library migration looks good.

The dependency migration from github.com/mitchellh/mapstructure to github.com/go-viper/mapstructure/v2 is the right approach. This is part of the overall improvement to use the more actively maintained fork of mapstructure.

config/config_v1.go (1)

10-10: Library update looks correct.

This import change aligns with the overall migration to the go-viper maintained fork of mapstructure.

config/config_mixins.go (1)

11-11: Import update is consistent with project changes.

The import path update maintains consistency across the codebase in migrating to the go-viper fork.

go.mod (2)

13-14: Good dependency updates.

Adding github.com/go-viper/encoding/hcl and upgrading to github.com/go-viper/mapstructure/v2 are appropriate changes that align with the PR objectives.


25-25: Viper version update is necessary.

Upgrading to viper v1.20.1 is needed to properly support the new dependencies and ensure compatibility with the codec registry changes.

config/config.go (2)

23-24: Library migration looks good.

The import changes properly introduce the HCL codec support and upgrade to the newer mapstructure package.


73-76: Viper initialization looks good with the codec registry.

The viper initialization properly sets up the codec registry through options. This enables HCL codec support which was the main objective of the PR.

@creativeprojects
Copy link
Owner Author

creativeprojects commented May 19, 2025

@jkellerer do you remember why we created this test?
https://github.com/creativeprojects/resticprofile/actions/runs/15122540965/job/42507994888?pr=507#step:6:2194

The viper library started their own fork ofmapstructure and fixed some issues with it.
This is technically a breaking change, but I'm not sure if anyone would rely on this strange behaviour?

@creativeprojects creativeprojects changed the title upgrade viper upgrade of viper and mapstructure libraries May 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant