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

refactor: avoid unfavorable tar -> untar in container image #8439

Merged
merged 4 commits into from May 14, 2024

Conversation

salim-b
Copy link
Contributor

@salim-b salim-b commented May 9, 2024

Change Summary

Before this change, the NocoDB app code was GZIP-compressed to a tar archive during container image generation and extracted again on the first run of the app. This is unfavorable for a containerized app since the extraction is repeated on every container restart (unless /usr/src/appEntry lives on persistent storage), which delays startup. Besides, adding a tar archive in the container image to be extracted at run-time actually increases the storage requirements for the app at run-time.

This change removes the compression and decompression steps and instead directly copies the app code as-is. It is a prerequisite for #8347.

Additionally, some ShellCheck suggestions were applied to make the start scripts more robust / POSIX-compliant.

Change type

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Test/ Verification

Untested.

Copy link
Contributor

coderabbitai bot commented May 9, 2024

Walkthrough

Walkthrough

The updates across various Dockerfiles and shell scripts primarily focus on streamlining operations by changing the way built code is handled—shifting from packaging into a tarball to direct copying. Additionally, there's an enhancement in the handling of environment variables and conditional checks, particularly around directory creation and AWS credentials. These changes aim to improve clarity and efficiency in the code deployment and execution process.

Changes

Files Change Summary
packages/nocodb/Dockerfile, packages/nocodb/Dockerfile.local, packages/nocodb/litestream/Dockerfile Updated to copy built code directly to /usr/src/appEntry/ instead of packaging into app.tar.gz. Comments adjusted for clarity.
packages/nocodb/docker/start-litestream.sh, packages/nocodb/docker/start-local.sh, packages/nocodb/docker/start.sh Enhanced variable handling and conditional checks. Simplified directory creation logic and removed unnecessary file checks. Adjusted command executions for better variable quoting.

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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 5be970b and aca35b5.
Files selected for processing (6)
  • packages/nocodb/Dockerfile (2 hunks)
  • packages/nocodb/Dockerfile.local (2 hunks)
  • packages/nocodb/docker/start-litestream.sh (2 hunks)
  • packages/nocodb/docker/start-local.sh (1 hunks)
  • packages/nocodb/docker/start.sh (1 hunks)
  • packages/nocodb/litestream/Dockerfile (2 hunks)
Files skipped from review due to trivial changes (5)
  • packages/nocodb/Dockerfile
  • packages/nocodb/Dockerfile.local
  • packages/nocodb/docker/start-local.sh
  • packages/nocodb/docker/start.sh
  • packages/nocodb/litestream/Dockerfile
Additional comments not posted (3)
packages/nocodb/docker/start-litestream.sh (3)

5-6: LGTM! The directory creation logic is robust and correctly handles potential spaces in directory names.


Line range hint 9-18: LGTM! The AWS credential checks are comprehensive, and the file handling logic is secure and robust.


18-23: LGTM! The litestream commands are correctly quoted, and running the replication in the background is a good practice for performance optimization.

Comment on lines 52 to 53
# Copy production code & main entry file
COPY --from=builder /usr/src/appEntry/ /usr/src/appEntry/
Copy link
Member

@pranavxc pranavxc May 9, 2024

Choose a reason for hiding this comment

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

We have to copy build and node_modules to /usr/src/app/ and L#31 can be removed.

Here we can add

COPY --from=builder /usr/src/app/ /usr/src/app/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah sorry, I mixed up /usr/src/app/ and /usr/src/appEntry/ 🙈. Should be fine now.

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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between aca35b5 and e2967a2.
Files selected for processing (3)
  • packages/nocodb/Dockerfile (2 hunks)
  • packages/nocodb/Dockerfile.local (2 hunks)
  • packages/nocodb/litestream/Dockerfile (2 hunks)
Files skipped from review as they are similar to previous changes (3)
  • packages/nocodb/Dockerfile
  • packages/nocodb/Dockerfile.local
  • packages/nocodb/litestream/Dockerfile

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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between e2967a2 and dae8bc0.
Files selected for processing (2)
  • packages/nocodb/Dockerfile (2 hunks)
  • packages/nocodb/Dockerfile.local (2 hunks)
Files skipped from review as they are similar to previous changes (2)
  • packages/nocodb/Dockerfile
  • packages/nocodb/Dockerfile.local

@mertmit mertmit merged commit 373ba0d into nocodb:develop May 14, 2024
21 of 23 checks passed
@salim-b salim-b deleted the no-tar branch May 14, 2024 09:43
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.

None yet

3 participants