Skip to content

Conversation

@keivenchang
Copy link
Contributor

@keivenchang keivenchang commented Sep 17, 2025

Overview:

Minor formatting and output organization.

Details:

  • Revert the display order -- make Dynamo info (the most important part) show on the bottom of the screen, because the top part sometimes gets scrolled off.

Where should the reviewer start?

  • deploy/dynamo_check.py - review the formatting and organizational changes

CodeRabbit, don't bother reviewing.
[codenotreview]

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 17, 2025

Walkthrough

Reorders the addition of the Dynamo workspace info node in SystemInfo.init within deploy/dynamo_check.py, moving DynamoInfo(thorough_check=self.thorough_check) from an early position to after the terse/error-handling block. No public API changes; only tree construction order is adjusted.

Changes

Cohort / File(s) Summary
Dynamo check ordering
deploy/dynamo_check.py
Moved the append of DynamoInfo(thorough_check=self.thorough_check) from before to after terse/error-handling in SystemInfo.__init__. No signature or error-handling logic changes.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant C as Caller
  participant S as SystemInfo.__init__
  rect rgb(245,245,255)
  Note over S: Old flow (before)
  C->>S: construct SystemInfo(thorough_check)
  S->>S: add Environment/Python nodes
  S->>S: add DynamoInfo(thorough_check)
  S->>S: handle terse / error nodes
  end
Loading
sequenceDiagram
  autonumber
  participant C as Caller
  participant S as SystemInfo.__init__
  rect rgb(240,255,240)
  Note over S: New flow (after)
  C->>S: construct SystemInfo(thorough_check)
  S->>S: add Environment/Python nodes
  S->>S: handle terse / error nodes
  S->>S: add DynamoInfo(thorough_check)
  Note right of S: DynamoInfo moved later
  end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

I hop through logs with tidy cheer,
Shuffle the nodes, make order clear.
Dynamo waits—now placed just right,
After terse checks pass the light.
Ears up, whiskers twitch—no fuss, no fright,
A neat little hop in the system’s night. 🐇✨

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The PR title "chore: reorder dynamo_check.py output (very minor)" succinctly describes the primary change — reordering output in deploy/dynamo_check.py — and directly matches the changeset. It is concise, focused on the main change, and contains no misleading or unrelated information. The parenthetical "very minor" is optional but does not make the title unclear. Therefore it meets the repository's expectations for a clear, single-sentence summary.
Description Check ✅ Passed The PR description includes the required "Overview", "Details", and "Where should the reviewer start?" sections and clearly explains the formatting/output reordering and where to review the change. It omits the "Related Issues" section from the repository template and includes a non-actionable line ("CodeRabbit, don't bother reviewing.") that should be removed. Overall the description is mostly complete and provides sufficient context for reviewers.

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

🧹 Nitpick comments (2)
deploy/dynamo_check.py (2)

2253-2263: Tighten matching for Dynamo node in error-check helper.

Use an exact label match to avoid accidental substring hits if other top-level labels ever include “Dynamo”.

-def has_framework_errors(tree: NodeInfo) -> bool:
+def has_framework_errors(tree: NodeInfo) -> bool:
@@
-    for child in tree.children:
-        if child.label and "Dynamo" in child.label:
+    for child in tree.children:
+        if child.label == "Dynamo":
             # Find the Framework components node
             for dynamo_child in child.children:
                 if dynamo_child.label and "Framework components" in dynamo_child.label:
                     # Use the has_errors() method to check the entire subtree
                     return dynamo_child.has_errors()

304-318: Optional: update the nearby comment to reflect the new ordering.

The “Always show: OS, User, GPU, Framework, Dynamo” comment is true, but mentioning that Dynamo is intentionally appended last would help future maintainers.

-        # Collect and add all system information
-        # Always show: OS, User, GPU, Framework, Dynamo
+        # Collect and add all system information.
+        # Always show: OS, User, GPU, Framework, and append Dynamo last for readability.
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0373b89 and 788d6e0.

📒 Files selected for processing (1)
  • deploy/dynamo_check.py (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: keivenchang
PR: ai-dynamo/dynamo#3035
File: lib/runtime/src/metrics/prometheus_names.rs:49-53
Timestamp: 2025-09-16T00:26:37.072Z
Learning: keivenchang prefers consistency in metric naming standardization over strict adherence to Prometheus conventions about gauge vs counter suffixes. When standardizing metrics naming, prioritize consistency across the codebase rather than technical pedantry about individual metric type conventions.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build and Test - dynamo
🔇 Additional comments (1)
deploy/dynamo_check.py (1)

336-338: Reordering confirmed — Dynamo prints last in both modes.

Both outputs show "Dynamo" as the final section; the prior automated check failed because it expected leading tree glyphs (├─/└─) that the current output doesn't include. Use this simpler verification:

#!/bin/bash
set -euo pipefail
python deploy/dynamo_check.py | awk 'NF{last=$0} END{print last}' | grep -qx 'Dynamo' && echo "OK default" || echo "FAIL default"
python deploy/dynamo_check.py --terse | awk 'NF{last=$0} END{print last}' | grep -qx 'Dynamo' && echo "OK terse" || echo "FAIL terse"

@keivenchang keivenchang changed the title chore: update dynamo_check.py formatting and output organization chore: reorder dynamo_check.py output (very minor) Sep 17, 2025
@keivenchang keivenchang merged commit d05795f into main Sep 17, 2025
15 checks passed
@keivenchang keivenchang deleted the keivenchang/dynamo_check.py-reorder-outputs-tiny-change branch September 17, 2025 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants