Skip to content
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

[pull] main from openfga:main #8

Merged
merged 1 commit into from
Feb 26, 2025
Merged

[pull] main from openfga:main #8

merged 1 commit into from
Feb 26, 2025

Conversation

pull[bot]
Copy link

@pull pull bot commented Feb 26, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Bug Fixes:

  • Fixes an issue where certain recursive tuple-to-userset (TTU) cases were not being evaluated correctly when the enable-check-optimizations flag was enabled.

@pull pull bot added the ⤵️ pull label Feb 26, 2025
@pull pull bot merged commit 56bb7c0 into Stars1233:main Feb 26, 2025
Copy link

sourcery-ai bot commented Feb 26, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new version of the recursive TTU fast path algorithm (recursiveTTUFastPathV2) to correctly handle more complex authorization models. It also refactors the object provider implementations to improve code clarity and channel handling to prevent goroutine leaks. Additionally, the pull request includes new test cases and updates dependencies.

Sequence diagram for recursiveTTUFastPathV2

sequenceDiagram
    participant LC as LocalChecker
    participant TS as TypeSystem
    participant OP as recursiveTTUObjectProvider
    participant RF as recursiveFastPath

    LC->TS: RecursiveTTUCanFastPathV2(objectType, relation, userType, rewrite)
    TS-->LC: true
    LC->OP: newRecursiveTTUObjectProvider(typesys, rewrite)
    LC->RF: recursiveFastPath(ctx, req, rightIter, mapping, objectProvider)
    RF->OP: Begin(ctx, req)
    OP-->RF: chan usersetMessage
    RF->OP: End()
Loading

Sequence diagram for constructLeftChannels

sequenceDiagram
    participant LC as LocalChecker
    participant constructLeftChannels
    participant TS as TypeSystem
    participant FP as fastPathRewrite

    LC->constructLeftChannels: constructLeftChannels(ctx, req, possibleParents, relationFunc)
    loop for each parentType in possibleParents
      constructLeftChannels->TS: GetRelation(parentType.GetType(), relationFunc(parentType))
      TS-->constructLeftChannels: rel, err
      constructLeftChannels->FP: fastPathRewrite(ctx, r, rel.GetRewrite())
      FP-->constructLeftChannels: leftChan, err
    end
    constructLeftChannels-->LC: leftChans, err
Loading

Sequence diagram for fanInIteratorChannels

sequenceDiagram
    participant LC as LocalChecker
    participant fanInIteratorChannels

    LC->fanInIteratorChannels: fanInIteratorChannels(ctx, chans)
    alt limit == 0
      fanInIteratorChannels->LC: close(out)
    else limit > 0
      loop for each c in chans
        fanInIteratorChannels->fanInIteratorChannels: pool.Go(func(ctx context.Context) error)
      end
    end
    fanInIteratorChannels-->LC: out
Loading

Updated class diagram for object providers

classDiagram
    class objectProvider {
        End()
        Begin(ctx Context, req ResolveCheckRequest) chan usersetMessage
    }

    class recursiveObjectProvider {
        mapper storage.TupleMapper
        ts *typesystem.TypeSystem
        ds storage.RelationshipTupleReader
        End()
        Begin(ctx Context, req ResolveCheckRequest) chan usersetMessage
    }

    class recursiveTTUObjectProvider {
        ts *typesystem.TypeSystem
        tuplesetRelation string
        computedRelation string
        pool *pool.ContextPool
        End()
        Begin(ctx Context, req ResolveCheckRequest) chan usersetMessage
    }

    objectProvider <|-- recursiveObjectProvider : implements
    objectProvider <|-- recursiveTTUObjectProvider : implements

    note for recursiveObjectProvider "Replaces simpleRecursiveObjectProvider"
    note for recursiveTTUObjectProvider "Replaces complexRecursiveTTUObjectProvider"
Loading

File-Level Changes

Change Details Files
Refactors the object provider implementations to improve code clarity and remove unnecessary error checks.
  • Renames simpleRecursiveObjectProvider to recursiveObjectProvider.
  • Removes error checks for nil TypeSystem and RelationshipTupleReader in newRecursiveObjectProvider.
  • Removes error checks for nil requests in recursiveObjectProvider.Begin.
  • Renames complexRecursiveTTUObjectProvider to recursiveTTUObjectProvider.
  • Removes error checks for nil TypeSystem and Userset in newRecursiveTTUObjectProvider.
  • Removes error checks for nil requests in recursiveTTUObjectProvider.Begin.
internal/graph/object_providers.go
internal/graph/object_providers_test.go
Implements a new version of the recursive TTU fast path algorithm (recursiveTTUFastPathV2) to correctly handle more complex authorization models.
  • Introduces recursiveTTUFastPathV2 to replace recursiveTTUFastPathUnionAlgebraicOperations.
  • Updates checkTTU to use recursiveTTUFastPathV2 when RecursiveTTUCanFastPathV2 returns true.
  • Removes recursiveTTUFastPathUnionAlgebraicOperations.
  • Implements RecursiveTTUCanFastPathV2 to determine if the fast path can be applied.
  • Adds new test cases for recursiveTTUFastPathV2 covering various scenarios, including complex models and resolution depth limits.
  • Removes TestRecursiveTTUFastPathUnionAlgebraicOperations.
internal/graph/check_fast_path.go
internal/graph/check_fast_path_test.go
internal/graph/check.go
pkg/typesystem/typesystem.go
Improves channel handling in fastPathRewrite and object providers to prevent goroutine leaks.
  • Introduces drainIteratorChannel to ensure all iterators are stopped when a channel is closed.
  • Uses drainIteratorChannel in fastPathRewrite and object providers to prevent goroutine leaks.
  • Removes the need to manually drain channels in some test cases.
internal/graph/check_fast_path.go
internal/graph/object_providers.go
Updates dependencies.
  • Updates github.com/openfga/language/pkg/go from v0.2.0-beta.2.0.20250121233318-0eae96a39570 to v0.2.0-beta.2.0.20250220223040-ed0cfba54336.
go.mod
go.sum
Adds a changelog entry to document the fix for recursive TTU evaluation.
  • Adds a changelog entry to document the fix for recursive TTU evaluation.
CHANGELOG.md
Removes the use of expectedOutcomes in TestBreadthFirstRecursiveMatch and replaces it with a single boolean expected.
  • Removes the use of expectedOutcomes in TestBreadthFirstRecursiveMatch.
  • Replaces expectedOutcomes with a single boolean expected.
internal/graph/check_fast_path_test.go

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

gitstream-cm bot commented Feb 26, 2025

🚨 gitStream Monthly Automation Limit Reached 🚨

Your organization has exceeded the number of pull requests allowed for automation with gitStream.
Monthly PRs automated: 2296/250

To continue automating your PR workflows and unlock additional features, please contact LinearB.

Copy link

coderabbitai bot commented Feb 26, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
  • @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.

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.

1 participant