Skip to content

Version issue #480

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

Merged
merged 1 commit into from
Apr 15, 2025
Merged

Version issue #480

merged 1 commit into from
Apr 15, 2025

Conversation

samad-yar-khan
Copy link
Contributor

@samad-yar-khan samad-yar-khan commented Jul 10, 2024

Linked Issue(s)

closes #478

Acceptance Criteria fulfillment

  • Display the current Docker version prominently within the application interface.
  • Ensure the Docker version information is updated in real-time or at regular intervals.
  • Include a CTA button or link that guides users to update their Docker version if an update is available.

Proposed changes (including videos or screenshots)

  • Updated version API to send docker version
  • Updated sidebar to show docker build darte

Further comments

Summary by CodeRabbit

  • New Features

    • Added display of the current Docker image build date at the bottom of the sidebar for improved build transparency.
  • Enhancements

    • API responses now include the current Docker image build date, providing more detailed version information to users.

@samad-yar-khan
Copy link
Contributor Author

@amoghjalan can you please see if this works and suggest changes

@middlewarehq middlewarehq deleted a comment from amoghjalan Aug 26, 2024
Copy link

coderabbitai bot commented Apr 15, 2025

Walkthrough

The changes introduce a new field, current_docker_image_build_date, to the backend API response and the corresponding frontend type definitions. The frontend sidebar UI is updated to display the build date of the currently running Docker image, formatted for readability. State selection and date formatting logic are added to the sidebar component to retrieve and present this information. No existing logic is removed, and no breaking changes are made to public interfaces. The update is additive, focusing on exposing and displaying Docker build metadata to users.

Changes

File(s) Change Summary
web-server/pages/api/internal/version.ts Added current_docker_image_build_date to API response type and logic to populate it from environment variables.
web-server/src/types/resources.ts Added current_docker_image_build_date property to ImageStatusApiResponse type.
web-server/src/layouts/ExtendedSidebarLayout/Sidebar/index.tsx Enhanced Sidebar UI to display formatted Docker image build date using Redux state and date-fns formatting.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Display the current Docker version prominently within the application interface (#478)
Ensure the Docker version information is updated in real-time or at regular intervals (#478) No evidence of polling or subscription to updates; unclear if sidebar info auto-updates.
Include a CTA button or link for updating Docker version if update is available (#478) No CTA or update link/button is present in the sidebar changes.

Poem

A sidebar shines with Docker's date,
Now users see the build—how great!
With every glance, the truth is clear,
The version's birth is posted here.
But oh! No button yet to press—
For updates, still, we must guess.
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this 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.

@jayantbh jayantbh merged commit 8a545c0 into main Apr 15, 2025
3 of 4 checks passed
@jayantbh jayantbh deleted the version-issue branch April 15, 2025 15:29
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
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7cba8f1 and f59b9a2.

📒 Files selected for processing (3)
  • web-server/pages/api/internal/version.ts (2 hunks)
  • web-server/src/layouts/ExtendedSidebarLayout/Sidebar/index.tsx (3 hunks)
  • web-server/src/types/resources.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
web-server/src/layouts/ExtendedSidebarLayout/Sidebar/index.tsx (1)
cli/source/store/index.ts (1)
  • useSelector (28-28)
🔇 Additional comments (6)
web-server/src/types/resources.ts (1)

1023-1023: Type definition added correctly.

The new field current_docker_image_build_date of type DateString has been appropriately added to the ImageStatusApiResponse type. This aligns with the PR objective to expose Docker version information in the UI.

web-server/pages/api/internal/version.ts (2)

26-26: Type definition extended correctly.

Adding the current_docker_image_build_date field to the CheckNewVersionResponse type properly supports the new feature requirement.


146-147: API response properly updated to include Docker build date.

The response now includes both the latest remote Docker image build date and the current local Docker image build date, which properly addresses the PR objective.

web-server/src/layouts/ExtendedSidebarLayout/Sidebar/index.tsx (3)

10-10: Import added to support date formatting.

The format function from date-fns is appropriately imported to format the build date for display.


13-17: Required component and hook imports added.

All necessary components and hooks are correctly imported to support the new UI functionality.


89-93: Build date UI element added correctly.

The build date is now prominently displayed at the bottom of the sidebar using appropriate components for layout and styling.

Comment on lines +68 to +73
const imageStatus = useSelector((s) => s.app.latestImageStatus);

const formattedDate = format(
new Date(imageStatus.current_docker_image_build_date),
'dd MMM yyyy HH:mm:ss'
);
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add error handling for potential missing date.

The current implementation assumes that imageStatus.current_docker_image_build_date will always be available, which might cause runtime errors if the API data is still loading or if there's an error.

Consider adding a fallback or conditional check:

- const formattedDate = format(
-   new Date(imageStatus.current_docker_image_build_date),
-   'dd MMM yyyy HH:mm:ss'
- );
+ const formattedDate = imageStatus?.current_docker_image_build_date
+   ? format(new Date(imageStatus.current_docker_image_build_date), 'dd MMM yyyy HH:mm:ss')
+   : 'Unknown build date';
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const imageStatus = useSelector((s) => s.app.latestImageStatus);
const formattedDate = format(
new Date(imageStatus.current_docker_image_build_date),
'dd MMM yyyy HH:mm:ss'
);
const imageStatus = useSelector((s) => s.app.latestImageStatus);
const formattedDate = imageStatus?.current_docker_image_build_date
? format(new Date(imageStatus.current_docker_image_build_date), 'dd MMM yyyy HH:mm:ss')
: 'Unknown build date';

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.

Add docker version details on the sidebar
4 participants