Skip to content

fix(snaplet): add snaplet target DB var to SNAPSHOT_PATHs #25

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

Merged
merged 3 commits into from
Jun 4, 2025

Conversation

oycyc
Copy link
Contributor

@oycyc oycyc commented Jun 3, 2025

Follow up to a previous PR #13 where support for SNAPLET_TARGET_DB_NAME was added, where there are use cases when using the same Taskfile commands, but for different DB connections and DB names.

The SNAPSHOT_PATH where the snapshots are stored, did not have the SNAPLET_TARGET_DB_NAME identifier. This PR adds that.

This is needed because if storing multiple DB snapshots, all snapshots are stored in the same directory of the .SNAPSHOT_ENV

Summary by CodeRabbit

  • Chores
    • Updated snapshot storage paths to include the database name for improved organization when downloading or restoring snapshots.

@oycyc oycyc requested a review from a team as a code owner June 3, 2025 19:20
Copy link

coderabbitai bot commented Jun 3, 2025

Walkthrough

This change modifies the snapshot path construction in several tasks within lib/snaplet/Taskfile.yaml. The SNAPSHOT_PATH variable is updated to include the SNAPLET_TARGET_DB_NAME as an additional directory level before the environment and snapshot name. This adjustment affects the download, restore, and restore:noprompt tasks, ensuring that all snapshot-related operations now reference the updated path structure. The download task also adds SNAPLET_TARGET_DB_NAME as a required variable. No changes are made to the actual commands or error handling logic.

Possibly related PRs

Suggested reviewers

  • Gowiem

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.

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: 0

🧹 Nitpick comments (3)
lib/snaplet/Taskfile.yaml (3)

121-121: Update download command to use new path
The aws s3 cp command now correctly references the DB-specific path. For safety, consider quoting both the source URI and destination path ("{{...}}") to guard against special characters or spaces.


133-133: Require SNAPLET_TARGET_DB_NAME for restores
Good addition of the DB name requirement. Optionally, you could also require SNAPSHOT_ENV here to ensure the environment is explicit and avoid default fallbacks.


145-145: Include database identifier in restore:noprompt path
Consistent override for non-prompt restores. Similar to download, consider quoting SNAPSHOT_PATH to align with the quoted declaration in the download task.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 10973ca and 02aac7d.

📒 Files selected for processing (1)
  • lib/snaplet/Taskfile.yaml (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.yaml`: You are well-versed in writing and reviewing YAML configurations for the Task tool (https://taskfile.dev/). Provide recommendations for clarity, maintainability, and a...

**/*.yaml: You are well-versed in writing and reviewing YAML configurations for the Task tool (https://taskfile.dev/).
Provide recommendations for clarity, maintainability, and adherence to Taskfile best practices, including usage of variables, environment blocks, and includes.
These configurations may also contain embedded Bash scripts or commands.
Demonstrate bash scripting best practices such as error handling, secure variable expansions, and clear documentation.

  • lib/snaplet/Taskfile.yaml
🔇 Additional comments (2)
lib/snaplet/Taskfile.yaml (2)

114-114: Include database identifier in download snapshot path
Great update to scope downloads per target DB by overriding SNAPSHOT_PATH with {{.SNAPLET_TARGET_DB_NAME}}.


130-130: Include database identifier in restore path
Overriding SNAPSHOT_PATH to include the DB name correctly isolates restores per database.

- printf "\n\n⬇ Snapshot downloaded to {{.SNAPSHOT_PATH}}\n\n"

restore:
desc: Restores the given RESTORE_SNAPSHOT to the SNAPLET_TARGET_DATABASE_URL database.
silent: true
env:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

SNAPLET_TARGET_DATABASE_URL is not used in the actual command. Snaplet reads this from the environment, so if we are passing this in as a Taskfile variable input argument, it has to be set as environment variable.

@oycyc oycyc merged commit f5e70c6 into main Jun 4, 2025
2 checks passed
@oycyc oycyc deleted the fix/snapshot_target_db branch June 4, 2025 03:20
oycyc pushed a commit that referenced this pull request Jun 6, 2025
🤖 I have created a release *beep* *boop*
---


##
[0.4.0](v0.3.1...v0.4.0)
(2025-06-04)


### Features

* add commands to download cursor rules
([#20](#20))
([de411c2](de411c2))
* small solutions for running task os:sync-all
([#23](#23))
([0b2ddc3](0b2ddc3))


### Bug Fixes

* **snaplet:** add snaplet target DB var to SNAPSHOT_PATHs
([#25](#25))
([f5e70c6](f5e70c6))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

2 participants