feat: optimize image size with multi-staged dockerfile

[Varun-Kolanu]

Description

• Updated Dockerfile to reduce the size of image formed for developer's convenience.
• For this, I have updated the previously defined single-staged dockerfile into multi-staged one.
• The image size originally was 1.53 GB and with the help of new dockerfile, it reduced to 1.28 GB (350 MB reduction!)

• The reason for the working of this implementation is:
  1. Stage 1 (Dependency stage) installs the required dependencies and store it in that layer
  2. In Stage 2 (Development environment), we copy just the node modules from the previous stage and copy the source code. This reduces much of image size because we are excluding the files not needed like .npm, caches etc., that were created during the dependency installation stage.
• I have also run the new docker image and everything is working well.

Related issue(s) Fixes #3223 This PR successfully fixes this issue doing the intended changes. I tried so much to further reduce the size of image but concluded (in my opinion) that this may be the optimal size for the development docker image.

Summary by CodeRabbit

• New Features

  • Introduced a multi-stage build process for improved Docker image optimization.
  • Enhanced dependency management by separating installation from the application build.

• Bug Fixes

  • None reported.

• Documentation

  • None reported.

[coderabbitai[bot]]

Walkthrough

The changes involve modifying the Dockerfile to implement a multi-stage build process. The first stage, named deps, installs dependencies using node:18-alpine, while the second stage, dev, copies the installed dependencies and application files to set up the development environment. This restructuring aims to optimize the Docker image size and build speed by separating dependency installation from the application build.

Changes

File	Change Summary
Dockerfile	Introduced a multi-stage build with deps for dependencies and dev for application setup.

Assessment against linked issues

Objective	Addressed	Explanation
Implement multi-stage Dockerfile to reduce image size and build time (3223)	✅

🐇 In a world of code so bright,
A multi-stage build takes flight.
Dependencies fetched, oh what a sight,
Docker images now feel just right!
With each new change, we hop with glee,
Optimized builds, as happy as can be! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 029ea19bfe37c18dc9f0198c46368a58c2dabc5f and 79c67ea74aba6d007268419ad22bda1e0185e82b.

📒 Files selected for processing (1)

• Dockerfile (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• Dockerfile

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[netlify[bot]]

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	79c67ea74aba6d007268419ad22bda1e0185e82b
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/672311f706837e00084d40eb
😎 Deploy Preview	https://deploy-preview-3313--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[asyncapi-bot]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	45
🟢 Accessibility	98
🟢 Best practices	92
🟢 SEO	100
🔴 PWA	33

Lighthouse ran on https://deploy-preview-3313--asyncapi-website.netlify.app/

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 49.14%. Comparing base (983c80e) to head (79c67ea). Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3313   +/-   ##
=======================================
  Coverage   49.14%   49.14%           
=======================================
  Files          21       21           
  Lines         647      647           
=======================================
  Hits          318      318           
  Misses        329      329           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[anshgoyalevil]

Using docker as a dev container orchestrator requires the npm cache to speed up node_module downloads in case they purge the previous ones

[akshatnema]

@Varun-Kolanu I think @anshgoyalevil has a valid point. Moreover, we don't see any need to optimize the image since it's not a big issue for any developer. Thanks for creating the PR, but we won't be merging this PR.