Skip to content

Fixes #1632#1668

Open
hk2166 wants to merge 1 commit into
hiero-ledger:mainfrom
hk2166:Improved_comments_on_Windows-specific
Open

Fixes #1632#1668
hk2166 wants to merge 1 commit into
hiero-ledger:mainfrom
hk2166:Improved_comments_on_Windows-specific

Conversation

@hk2166

@hk2166 hk2166 commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Description:
Improve documentation for Windows-specific header include ordering to prevent macro collisions.

  • Update vague comments explaining the Windows build workaround with detailed explanations.
  • Clarify that <windows.h> macros (e.g. GetMessage) collide with protobuf-generated identifiers if it is included before the proto headers.
  • Modify comments in AccountId.cc, FeeEstimateQuery.cc, BaseNode.h, and TckServer.cc.

Related issue(s):

Fixes #1632

Notes for reviewer:
The changes are strictly limited to updating comments for better context and clarity. No actual code behavior, #include directives, or logic was altered, so the builds will continue functioning on all platforms as expected.

Summary by CodeRabbit

Release Notes

  • Chores
    • Updated internal code documentation and include ordering comments for improved developer clarity. No user-facing changes or functionality updates.

@hk2166 hk2166 requested review from a team as code owners June 1, 2026 10:01
@hk2166 hk2166 requested a review from rwalworth June 1, 2026 10:01
@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@hk2166, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 55 minutes and 17 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3432d83c-8fff-4e9c-a157-821659ebaf44

📥 Commits

Reviewing files that changed from the base of the PR and between d172d93 and 7a5a45d.

📒 Files selected for processing (4)
  • src/sdk/main/include/impl/BaseNode.h
  • src/sdk/main/src/AccountId.cc
  • src/sdk/main/src/FeeEstimateQuery.cc
  • src/tck/src/TckServer.cc
📝 Walkthrough

Walkthrough

This PR updates include-ordering comments in four files across the SDK and TCK to clarify that protobuf-generated headers (e.g., services/basic_types.pb.h) must be included before any header that pulls in <windows.h> to prevent Windows macro collisions with generated identifiers.

Changes

Include-ordering documentation

Layer / File(s) Summary
Clarify Windows header include-ordering requirements
src/sdk/main/include/impl/BaseNode.h, src/sdk/main/src/AccountId.cc, src/sdk/main/src/FeeEstimateQuery.cc, src/tck/src/TckServer.cc
Comments in all four files are updated to explicitly document the requirement that protobuf-generated headers must be included before headers that introduce <windows.h> macros, preventing collisions with generated identifiers such as GetMessage.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

  • hiero-ledger/hiero-sdk-cpp#1632: This PR directly addresses the include-ordering comment clarifications requested in that issue by updating the identical four files with the same explanatory documentation.

Poem

🐰 Windows macros clash with proto's finest art,
So headers dance in order, each in their part—
The comment now sings clear: which comes first, you see?
A hop, a skip, and no collision spree! 🌟

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Fixes #1632' is too vague and does not summarize the actual change. While it references an issue, it provides no meaningful information about what the PR accomplishes. Revise the title to clearly describe the change, such as 'Improve comments on Windows-specific include-ordering workarounds' or 'Clarify Windows macro collision documentation in include comments'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

Review ran into problems

🔥 Problems

Stopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a @coderabbit review after the pipeline has finished.


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.

@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown

Hey @hk2166 👋 thanks for the PR!
I'm your friendly PR Helper Bot 🤖 and I'll be riding shotgun on this one, keeping track of your PR's status to help you get it approved and merged.

This comment updates automatically as you push changes -- think of it as your PR's live scoreboard!
Here's the latest:


PR Checks

DCO Sign-off -- All commits have valid sign-offs. Nice work!


GPG Signature -- All commits have verified GPG signatures. Locked and loaded!


Merge Conflicts -- No merge conflicts detected. Smooth sailing!


Issue Link -- Linked to #1632 (assigned to you).


🎉 All checks passed! Your PR is ready for review. Great job!

@github-actions github-actions Bot added the status: needs revision The pull request requires changes from the author before it can be reviewed or merged label Jun 1, 2026
@hk2166 hk2166 changed the title Fixes #1632 - Improve comments on Windows-specific include-ordering workarounds Fixes #1632 Jun 1, 2026
@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown

Caution

Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted.

Error details
{}

Signed-off-by: hk2166 <9610hemant@gmail.com>
@hk2166 hk2166 force-pushed the Improved_comments_on_Windows-specific branch from d172d93 to 7a5a45d Compare June 1, 2026 10:04
@github-actions github-actions Bot added status: needs review The pull request is ready for maintainer review and removed status: needs revision The pull request requires changes from the author before it can be reviewed or merged labels Jun 1, 2026
@hk2166

hk2166 commented Jun 1, 2026

Copy link
Copy Markdown
Contributor Author

@rwalworth I have made changes to the mentioned files
Can you review the changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: needs review The pull request is ready for maintainer review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Good First Issue]: Improve comments on Windows-specific include-ordering workarounds

1 participant