Skip to content

chore: Configure ProcessACL for async enumerable ACE collection #157

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 22, 2025
Merged

chore: Configure ProcessACL for async enumerable ACE collection #157

merged 1 commit into from
Jul 22, 2025

Conversation

definitelynotagoblin
Copy link
Contributor

@definitelynotagoblin definitelynotagoblin commented Jul 2, 2025 •
edited by coderabbitai bot
Loading

Description

Returning ProcessACL to return an IAsyncEnumerable for deferred collection processing as it had been before.
This may help resolves issues of memory spikes.
Additionally, moving the aggregate property doesanyacegrantownerrights from the parent domain object and attaching to the ACE instead as IsPermissionForOwnerRightsSid as this is more reflective of an ACE's properties than of the parent.

Motivation and Context

Investigating a large memory spike https://bloodhoundhq.slack.com/archives/C20NG2L87/p1751305729336129

How Has This Been Tested?

Local testing on ESC 10 lab

Screenshots (if appropriate):

Types of changes

  • Chore (a change that does not modify the application functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • Documentation updates are needed, and have been made accordingly.
  • I have added and/or updated tests to cover my changes.
  • All new and existing tests passed.
  • My changes include a database migration.

Summary by CodeRabbit

  • Refactor
    • Improved how access control list (ACL) results are processed for various object types, ensuring consistent evaluation of owner rights permissions.
  • Chores
    • Removed unused code dependencies for cleaner and more efficient maintenance.

@definitelynotagoblin definitelynotagoblin self-assigned this Jul 2, 2025
@definitelynotagoblin definitelynotagoblin added the enhancement New feature or request label Jul 2, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 2, 2025 •
edited
Loading

Walkthrough

The update refactors how ACL processing results are handled in object processing methods. Instead of deconstructing a returned tuple, the code now awaits an asynchronous enumerable, collects ACEs into an array, and computes boolean flags using predicates. Several unused using directives are also removed from the file.

Changes

File(s) Change Summary
src/Runtime/ObjectProcessors.cs Replaced tuple deconstruction of ACL processing with async enumerable collection and predicate-based flag computation; removed unused using directives.

Estimated code review effort

2 (~15 minutes)

Poem

In ObjectProcessors, tuples took flight,
Now async streams bring ACEs to light.
Booleans are checked with a predicate’s care,
Unused usings vanish into thin air.
With each refactor, the code feels bright—
A rabbit hops on, all permissions right! 🐇✨

📜 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 cda9597 and 60d8ec9.

📒 Files selected for processing (1)
  • src/Runtime/ObjectProcessors.cs (13 hunks)
🔇 Additional comments (14)
src/Runtime/ObjectProcessors.cs (14)

138-141: LGTM: ACL processing refactor correctly implemented

The refactoring properly converts from tuple deconstruction to IAsyncEnumerable processing with predicate-based boolean flag computation. The implementation correctly uses cancellation token and reuses the aces array for subsequent processing.

201-204: LGTM: Consistent ACL processing implementation

The changes follow the same correct pattern as other methods in the refactoring.

400-403: LGTM: ACL processing refactor applied consistently

The implementation maintains the same correct pattern across object types.

447-450: LGTM: Domain ACL processing correctly implemented

The refactoring is correctly applied to domain objects, appropriately omitting the Aces assignment which is consistent with domain object handling.

489-492: LGTM: GPO ACL processing correctly refactored

The implementation follows the established pattern correctly.

518-521: LGTM: OU ACL processing correctly implemented

The refactoring maintains consistency with other object processors.

568-571: LGTM: Container ACL processing correctly refactored

The implementation is consistent with the established refactoring pattern.

601-604: LGTM: RootCA ACL processing correctly implemented

The refactoring follows the established pattern correctly.

632-635: LGTM: AIACA ACL processing correctly refactored

The implementation maintains consistency with the refactoring pattern.

663-666: LGTM: EnterpriseCA ACL processing correctly implemented

The refactoring is applied consistently and correctly.

766-769: LGTM: NTAuthStore ACL processing correctly refactored

The implementation follows the established pattern correctly.

805-808: LGTM: CertTemplate ACL processing correctly implemented

The refactoring maintains the established pattern correctly.

837-840: LGTM: IssuancePolicy ACL processing correctly refactored

The final method correctly implements the established refactoring pattern.

1-861: Excellent refactoring: Consistent deferred processing implementation

This refactoring successfully addresses the memory spike issues by:

  1. Consistent pattern application: All ACL processing methods now follow the same pattern of awaiting IAsyncEnumerable, materializing to array, and computing boolean flags via predicates
  2. Deferred enumeration: ProcessACL now returns IAsyncEnumerable allowing for deferred processing until materialization is needed
  3. Property relocation: Boolean flags are now computed from ACE-level properties (IsPermissionForOwnerRightsSid, IsInheritedPermissionForOwnerRightsSid) rather than being aggregated in ProcessACL, improving separation of concerns

The materialization via ToArrayAsync() is necessary to perform the Any() predicate operations, which represents a good balance between memory efficiency and functional requirements.

✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

@definitelynotagoblin definitelynotagoblin marked this pull request as ready for review July 22, 2025 16:32
@definitelynotagoblin definitelynotagoblin merged commit 0adfb89 into 2.X Jul 22, 2025
2 checks passed
@definitelynotagoblin definitelynotagoblin deleted the enumerable-aces branch July 22, 2025 16:59
@github-actions github-actions bot locked and limited conversation to collaborators Jul 22, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ktstrader ktstrader ktstrader approved these changes

Assignees

@definitelynotagoblin definitelynotagoblin

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@definitelynotagoblin @ktstrader