Skip to content
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

fix: create temp folder with looser perms #8670

Merged
merged 1 commit into from
Sep 4, 2024

Conversation

PaddyMc
Copy link
Collaborator

@PaddyMc PaddyMc commented Sep 4, 2024

What is the purpose of the change

During the testnet upgrade multiple node runners failed to upgrade their nodes as there was an issue when creating a new folder to populated command, this PR leverages the go os.MkdirTemp() function to initialise the folder with looser perms and in the /tmp folder, allowing it to be created and deleted by all system users.

See

How to test

  • cd /
  • osmosisd <= this won't work on the v26.0.0-rc3 branch

Copy link
Contributor

coderabbitai bot commented Sep 4, 2024

Walkthrough

The changes involve modifying the NewRootCmd function in the cmd/osmosisd/cmd/root.go file to improve temporary directory management. The previous method of generating a temporary directory name using rand.Int() has been replaced with a new tempDir() function that utilizes os.MkdirTemp(). This new function includes error handling and ensures the temporary directory is cleaned up after use.

Changes

Files Change Summary
cmd/osmosisd/cmd/root.go Modified NewRootCmd function logic to use tempDir() for creating temporary directories; added tempDir() function for improved error handling and resource management.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant TempDir

    User->>CLI: Initialize Command
    CLI->>TempDir: Call tempDir()
    TempDir->>TempDir: Create temporary directory
    TempDir-->>CLI: Return directory path
    CLI->>CLI: Continue with command execution
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 362a01b and 95b00a5.

Files selected for processing (1)
  • cmd/osmosisd/cmd/root.go (3 hunks)
Additional comments not posted (3)
cmd/osmosisd/cmd/root.go (3)

480-488: LGTM!

The new tempDir function looks good:

  • It creates a unique temporary directory using os.MkdirTemp, which is an improvement over generating just a name.
  • It handles errors appropriately by falling back to the default directory if creation fails.
  • It ensures proper cleanup by deferring the removal of the temporary directory.

Nice work!


357-357: LGTM!

The changes to NewRootCmd look good:

  • It now uses the new tempDir function to create a unique temporary directory that is properly cleaned up.
  • It passes the temporary directory to NewOsmosisApp allowing it to be used by the app.

The changes integrate the new tempDir function appropriately.


Line range hint 1479-1483: LGTM!

The changes to initRootCmd look good:

  • It now calls genAutoCompleteCmd to generate auto-complete commands, which will improve the CLI user experience by providing command completion.
  • It also calls autoCliOpts to generate auto-CLI options based on the app modules and enhances the root command with them. This further improves the CLI with module-specific options.

Great additions to enhance the CLI!


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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.

@PaddyMc PaddyMc added V:state/compatible/no_backport State machine compatible PR, depends on prior breaks V:state/compatible/backport State machine compatible PR, should be backported A:backport/v26.x backport patches to v26.x branch A:no-changelog and removed V:state/compatible/no_backport State machine compatible PR, depends on prior breaks labels Sep 4, 2024
@PaddyMc PaddyMc merged commit 1bdcf05 into main Sep 4, 2024
1 check passed
@PaddyMc PaddyMc deleted the fix/create-temp-folder-with-lose-permissions branch September 4, 2024 16:15
mergify bot pushed a commit that referenced this pull request Sep 4, 2024
PaddyMc added a commit that referenced this pull request Sep 4, 2024
(cherry picked from commit 1bdcf05)

Co-authored-by: PaddyMc <[email protected]>
@ValarDragon
Copy link
Member

ValarDragon commented Sep 4, 2024

Interesting, wasn't aware we even created folders outside of .osmosisd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:backport/v26.x backport patches to v26.x branch A:no-changelog V:state/compatible/backport State machine compatible PR, should be backported
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants