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: multiple temp directories on command executions #8726

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

harish551
Copy link

Closes: #8725

What is the purpose of the change

This pull request fix issue with temp directories and stops creating multiple temp directories
also gives panic if node is unable to create a temp directory instead of returning node default home directory which leads to erasing of entire node data

Copy link
Contributor

coderabbitai bot commented Sep 23, 2024

Walkthrough

The changes in the codebase introduce a new deferred function to ensure that the temporary application (tempApp) is closed properly and that the temporary directory is removed if it is not the default node home. The error handling for creating the temporary directory has been modified to panic on failure instead of reverting to the default node home, enhancing resource cleanup and error management.

Changes

Files Change Summary
cmd/osmosisd/cmd/root.go Introduced deferred function for closing tempApp and removing temporary directory; modified error handling for directory creation to panic on failure.

Assessment against linked issues

Objective Addressed Explanation
Prevent creation of multiple temp directories during command executions ( #8725)
Ensure that temporary directories are removed after execution ( #8725)
Avoid overwriting the default node home on temp directory creation failure ( #8725)

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>, 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 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
Contributor

@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

Outside diff range and nitpick comments (1)
cmd/osmosisd/cmd/root.go (1)

Line range hint 489-496: Approve changes with a suggestion for cleanup timing.

The modifications to the tempDir function improve isolation and error handling. However, the cleanup logic can be improved.

Consider moving the defer os.RemoveAll(dir) to the calling function. This ensures that the temporary directory is cleaned up after it has been used, rather than immediately after creation. Here's a suggested modification:

 func tempDir() string {
 	dir, err := os.MkdirTemp("", "osmosisd")
 	if err != nil {
 		panic(fmt.Sprintf("failed creating temp directory: %s", err.Error()))
 	}
-	defer os.RemoveAll(dir)
 
 	return dir
 }

Then, in the calling function (likely NewRootCmd), add:

tempDir := tempDir()
defer os.RemoveAll(tempDir)

This ensures that the temporary directory is removed after it has been used by the application.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 133d623 and b683bd2.

Files selected for processing (1)
  • cmd/osmosisd/cmd/root.go (2 hunks)

Comment on lines +359 to +366
defer func() {
if err := tempApp.Close(); err != nil {
panic(err)
}
if tempDir != osmosis.DefaultNodeHome {
os.RemoveAll(tempDir)
}
}()
Copy link
Contributor

Choose a reason for hiding this comment

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

Approve changes with a suggestion for improved error handling.

The addition of the deferred cleanup function is a good practice for resource management. It ensures that the temporary app is properly closed and the temporary directory is removed when necessary.

Consider improving the error handling in the deferred function. Instead of panicking, log the error. This allows the application to continue running even if there's an issue during cleanup. Here's a suggested modification:

 	defer func() {
 		if err := tempApp.Close(); err != nil {
-			panic(err)
+			logger.Error("failed to close temp app", "error", err)
 		}
 		if tempDir != osmosis.DefaultNodeHome {
-			os.RemoveAll(tempDir)
+			if err := os.RemoveAll(tempDir); err != nil {
+				logger.Error("failed to remove temp directory", "error", err)
+			}
 		}
 	}()

This change ensures that any errors during cleanup are logged but don't cause the application to panic, which could be disruptive in a production environment.

Committable suggestion was skipped due to low confidence.

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.

[Bug]: node is creating multiple temp directories command executions
1 participant