Skip to content

refactor: improve the Dockerfile of generator#1445

Merged
asyncapi-bot merged 6 commits into
asyncapi:masterfrom
Adi-204:improve-dockerfile
Mar 31, 2025
Merged

refactor: improve the Dockerfile of generator#1445
asyncapi-bot merged 6 commits into
asyncapi:masterfrom
Adi-204:improve-dockerfile

Conversation

@Adi-204

@Adi-204 Adi-204 commented Mar 26, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Description
Improve the Dockerfile of generator.

  1. Move ARG variable below Base image so that it is not out of scope.
  2. Merge RUN instruction with the consecutive ones.
  3. Remove the LegacyKeyValueFormat warning.

After building image and check version inside the container of build image

image

Related issue(s)
Fixes #1432

Summary by CodeRabbit

  • Chores
    • Improved the container build configuration by reformatting environment variable declarations for a more consistent style.
    • Consolidated installation steps by merging cache cleanup with package installation, enhancing build efficiency without impacting functionality.

@coderabbitai

coderabbitai Bot commented Mar 26, 2025 •
edited
Loading

Copy link
Copy Markdown

Walkthrough

The Dockerfile in the generator application has been updated. Changes include reformatting of environment variable declarations, repositioning the ARG ASYNCAPI_GENERATOR_VERSION declaration onto a new line, and combining the APK cache cleanup with the npm package installation into a single RUN command. These changes improve consistency in formatting and simplify the command structure without modifying core functionality.

Changes

File(s) Change Summary
apps/generator/Dockerfile Reformatted environment variable declarations; repositioned ARG ASYNCAPI_GENERATOR_VERSION onto a new line; merged RUN instructions to combine APK cache cleanup with npm installation.

Assessment against linked issues

Objective Addressed Explanation
Ensure ARG is declared below base image so it is not out of scope [#1432] ❌ ARG placement relative to the base image not modified.
Merge RUN instruction to combine APK cache cleanup with npm installation [#1432] ✅
Reformat environment variables to use key=value format to remove legacy warning [#1432] ✅

Suggested labels

ready-to-merge

Suggested reviewers

  • Florence-Njeri
  • asyncapi-bot-eve
  • derberg

Poem

I'm a happy rabbit, hopping through the code,
Tweaking Docker commands on a bouncy mode.
The cache is cleared and npm installs align,
With cleaner syntax now perfectly fine.
I twitch my nose and celebrate these changes in rhyme! 🐇

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35c71a7 and 9ecd86b.

📒 Files selected for processing (1)
  • apps/generator/Dockerfile (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/generator/Dockerfile
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Test generator as dependency with Node 20
  • GitHub Check: Test generator as dependency with Node 18
  • GitHub Check: Test NodeJS PR - windows-latest
🪧 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

coderabbitai[bot]
coderabbitai Bot reviewed Mar 26, 2025
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
apps/generator/Dockerfile (1)

15-18: Optimized RUN Command Consolidation and Cache Cleanup
Consolidating the multiple commands into a single RUN instruction is an efficient practice that reduces the number of image layers. However, please note that the command

rm -rf /var/lib/apt/lists/*

is typically used for Debian-based images and is unnecessary in an Alpine-based image (like the one used here). Although it is generally benign if the directory does not exist, removing it might improve clarity.

Consider applying the following diff if you agree:

-    rm -rf /var/lib/apt/lists/* && \
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 591741f and 1232584.

📒 Files selected for processing (1)
  • apps/generator/Dockerfile (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Test generator as dependency with Node 20
  • GitHub Check: Test generator as dependency with Node 18
  • GitHub Check: Test NodeJS PR - windows-latest
  • GitHub Check: Test NodeJS PR - macos-13
🔇 Additional comments (2)
apps/generator/Dockerfile (2)

3-3: ARG Declaration Placement Improvement
The ARG for ASYNCAPI_GENERATOR_VERSION is now placed immediately after the base image declaration. This correctly scopes the build argument for later usage in the Dockerfile.

8-9: Consistent ENV Variable Formatting
The ENV variables now use the = operator without extra spaces, which both enhances readability and resolves the legacy key-value format warning.

@Adi-204

Adi-204 commented Mar 26, 2025 •
edited
Loading

Copy link
Copy Markdown
Member Author

@derberg I will add --ignore-scripts as suggested here - https://sonarcloud.io/project/security_hotspots?id=asyncapi_generator&pullRequest=1445&issueStatuses=OPEN%2CCONFIRMED&sinceLeakPeriod=true&tab=how_to_fix
I am not 100% sure about coderabbit suggestion. should we proceed with that also.
wdyt? And why it is showing "ARG placement relative to the base image not modified." under Assessment against linked issues

@Adi-204

Adi-204 commented Mar 26, 2025 •
edited
Loading

Copy link
Copy Markdown
Member Author

I tried building the image after removing rm -rf /var/lib/apt/lists/* && \ and also add --ignore-scripts it work perfectly fine with correct generator version installed as shown below -

image

@changeset-bot

changeset-bot Bot commented Mar 26, 2025 •
edited
Loading

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: de7412f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Adi-204

Adi-204 commented Mar 27, 2025 •
edited
Loading

Copy link
Copy Markdown
Member Author

@derberg we have solved following SonarQube issues in this PR -

  1. https://sonarcloud.io/project/issues?open=AZFCmY8SYFR-KciwR6Ur&id=asyncapi_generator
  2. https://sonarcloud.io/project/issues?id=asyncapi_generator&open=AZB4sekEgviDxNeZYbKn
  3. https://sonarcloud.io/project/issues?id=asyncapi_generator&open=AZB4sekEgviDxNeZYbKo&tab=code

image

any more suggestions from your side? thanks : )

@sonarqubecloud

sonarqubecloud Bot commented Mar 31, 2025

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@derberg

derberg commented Mar 31, 2025

Copy link
Copy Markdown
Member

/rtm

@asyncapi-bot
asyncapi-bot merged commit c45bb17 into asyncapi:master Mar 31, 2025
This was referenced Apr 16, 2025
Merged
Merged
@coderabbitai coderabbitai Bot mentioned this pull request Dec 11, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments
@derberg derberg derberg approved these changes
@magicmatatjahu magicmatatjahu Awaiting requested review from magicmatatjahu magicmatatjahu is a code owner
@jonaslagoni jonaslagoni Awaiting requested review from jonaslagoni jonaslagoni is a code owner
@asyncapi-bot-eve asyncapi-bot-eve Awaiting requested review from asyncapi-bot-eve asyncapi-bot-eve is a code owner

Assignees

No one assigned

Labels

ready-to-merge

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Draft] Improvements in Docker file of generator

3 participants

@Adi-204 @derberg @asyncapi-bot