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

feat(docker): add initialize-onchain to copy files to docker volume #8

Merged
merged 1 commit into from
Nov 14, 2024

Conversation

tuky191
Copy link
Contributor

@tuky191 tuky191 commented Nov 8, 2024

Description

Fix Permission Denied Error for sui move test Execution
Resolved a "permission denied" issue occurring during sui move test by updating the Docker build process. Instead of directly mounting the project folder, files are now copied to a Docker volume, preventing permission changes that impacted local development.

Fixes

#7

Summary by CodeRabbit

  • New Features

    • Introduced a new service, initialize-onchain, to enhance data management during startup.
    • Added a new volume named onchain for improved service functionality.
  • Improvements

    • Modified the publish-package service to utilize the new onchain volume, streamlining the process.

@tuky191 tuky191 requested a review from pb-at-talus November 8, 2024 18:40
@tuky191 tuky191 linked an issue Nov 8, 2024 that may be closed by this pull request
Copy link

coderabbitai bot commented Nov 8, 2024

Walkthrough

The changes introduce a new service called initialize-onchain in the docker/sui/compose.yaml file, which utilizes the alpine:latest image to copy files from a specified source directory to a data directory upon startup. This service is configured with specific volume mappings and a restart policy. Additionally, the existing publish-package service has been updated to use a defined volume instead of a relative path, and the new service is set as a dependency for publish-package. A new volume named onchain is also declared for use by both services.

Changes

File Change Summary
docker/sui/compose.yaml - Added new service initialize-onchain using alpine:latest image.
- Configured to copy files from /source to /data with specific volumes.
- Modified publish-package to use the onchain volume instead of a path.
- Set initialize-onchain as a dependency for publish-package.
- Declared new volume onchain for both services.

Poem

🐰 In the land of code where changes bloom,
A new service hops, dispelling the gloom.
With volumes and paths all tidy and neat,
The publish-package now can’t be beat!
So let’s cheer for the updates, both fresh and bright,
In our Docker world, everything feels right! 🌼


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

@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

📥 Commits

Reviewing files that changed from the base of the PR and between 75b199c and 9fd4ebd.

📒 Files selected for processing (1)
  • docker/sui/compose.yaml (3 hunks)
🔇 Additional comments (3)
docker/sui/compose.yaml (3)

74-74: LGTM! Changes address permission issues effectively.

The modifications correctly:

  1. Use a named volume instead of direct mounting
  2. Ensure proper initialization sequence through service dependency

Also applies to: 80-81


241-241: LGTM! Volume declaration is appropriate.

The simple volume declaration is sufficient for this use case and follows the same pattern as other volumes in the file.


22-30: Verify development workflow impact.

While this solution fixes the permission issues, it introduces a one-way file synchronization that developers should be aware of:

  1. Changes in the local onchain directory will require container restart to be reflected in the volume
  2. Changes made inside the container won't persist in the local directory

Consider documenting these behaviors in the repository's developer guide.

Let's verify the file synchronization behavior:

Also applies to: 74-74, 80-81

✅ Verification successful

Development workflow impact is minimal and well-handled

The one-way file synchronization design is appropriate for this use case:

  1. The onchain directory is only used for package publishing, not active development
  2. Write operations only occur during package deployment via publish_package.sh
  3. No development workflows require two-way sync, as verified in the test scripts and documentation

The current implementation correctly handles the intended workflow where source files are copied into the container for deployment purposes only.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if there are any write operations to the onchain directory
# that might need two-way sync

# Look for potential write operations in the codebase
rg -g '!docker' -l 'onchain.*write|onchain.*create|onchain.*save' .

# Check for any shell scripts that might modify onchain files
fd -e sh -x grep -l 'onchain' {}

Length of output: 181


Script:

#!/bin/bash
# Let's check the content of these files to understand the write operations
echo "=== README.md mentions of onchain ==="
rg "onchain.*write|onchain.*create|onchain.*save" README.md

echo -e "\n=== oneclick-test.sh onchain operations ==="
cat e2e_tests/oneclick-test.sh

echo -e "\n=== publish_package.sh onchain operations ==="
cat docker/sui/bin/publish_package.sh

# Let's also check if there are any development instructions or documentation
echo -e "\n=== Development related content in README ==="
rg -A 5 -B 5 "develop|setup|install" README.md

Length of output: 6244

docker/sui/compose.yaml Show resolved Hide resolved
@tuky191 tuky191 merged commit 036e2f9 into main Nov 14, 2024
5 checks passed
@tuky191 tuky191 deleted the 7-build-nexus-package-in-volume branch November 14, 2024 12:31
@tuky191 tuky191 restored the 7-build-nexus-package-in-volume branch November 14, 2024 12:31
@tuky191 tuky191 deleted the 7-build-nexus-package-in-volume branch November 14, 2024 12:31
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.

build nexus package in volume
2 participants