test(internal): add test case for linked schema entrance validation

[tolgaOzen]

Summary by CodeRabbit

Release Notes for Permify v1.2.7

• Documentation

  • Updated API documentation version to v1.2.7
  • Refreshed Swagger and OpenAPI specifications

• Improvements

  • Simplified pagination logic in entity filtering
  • Enhanced permission propagation across entities

• Testing

  • Added new test cases for complex entity relationship scenarios
  • Verified permission inheritance and attribute-based access control

• Maintenance

  • Incremented internal version number

[coderabbitai]

Walkthrough

This pull request primarily involves updating the version number from "v1.2.6" to "v1.2.7" across multiple files in the Permify project. The changes include updating version strings in API documentation files (Swagger JSON), the internal version constant, and the OpenAPI proto specification. Additionally, the PR introduces new test cases for entity filter and linked schema functionality, with a focus on permission propagation across entities.

Changes

File	Change Summary
docs/api-reference/apidocs.swagger.json	Version updated from "v1.2.6" to "v1.2.7"
docs/api-reference/openapiv2/apidocs.swagger.json	Version updated from "v1.2.6" to "v1.2.7"
internal/engines/entityFilter.go	Simplified pagination logic in attributeEntrance method
internal/engines/lookup_test.go	Added new entity filter schema for "Propagation Across Entities" test
internal/info.go	Version constant updated from "v1.2.6" to "v1.2.7"
internal/schema/linkedSchema_test.go	Added new test case (Case 23) for linked schema permissions
proto/base/v1/openapi.proto	Version updated from "v1.2.6" to "v1.2.7"

Sequence Diagram

sequenceDiagram
    participant User
    participant EntityFilter
    participant Entities
    
    User->>EntityFilter: Request entities with pagination
    EntityFilter->>Entities: Apply cursor pagination
    Entities-->>EntityFilter: Return paginated results
    EntityFilter-->>User: Provide paginated entity list

Loading

Possibly related PRs

• feat: update version to v1.2.6 in multiple API reference files. #1910: Version number update in API documentation files
• fix(internal): fix comparison condition for entity entrance type. #1924: Modifications to attributeEntrance method in entityFilter.go

Poem

🐰 Hop, hop, version's on the rise,
From v1.2.6 to v1.2.7's surprise!
Swagger docs and protos gleam,
A rabbit's update, smooth as a dream
Version bumped with coding might! 🚀

---

📜 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 c910e05 and f616e1a.

⛔ Files ignored due to path filters (1)

• pkg/pb/base/v1/openapi.pb.go is excluded by !**/*.pb.go

📒 Files selected for processing (7)

• docs/api-reference/apidocs.swagger.json (1 hunks)
• docs/api-reference/openapiv2/apidocs.swagger.json (1 hunks)
• internal/engines/entityFilter.go (1 hunks)
• internal/engines/lookup_test.go (1 hunks)
• internal/info.go (1 hunks)
• internal/schema/linkedSchema_test.go (1 hunks)
• proto/base/v1/openapi.proto (1 hunks)

✅ Files skipped from review due to trivial changes (4)

• internal/info.go
• proto/base/v1/openapi.proto
• docs/api-reference/apidocs.swagger.json
• docs/api-reference/openapiv2/apidocs.swagger.json

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Test with Coverage

🔇 Additional comments (3)

internal/engines/entityFilter.go (1)

163-163: LGTM! Consistent pagination approach.

The change simplifies pagination by always using cursor-based pagination with "entity_id" sorting, making it consistent with other methods in the file.

internal/schema/linkedSchema_test.go (1)

1185-1251: LGTM! Well-structured test case for permission propagation.

The new test case thoroughly validates the LinkedEntrances functionality by testing:

• Permission propagation across multiple entities (aaa -> bbb -> ccc)
• Both relation-based (role__admin) and attribute-based (attr__is_public) permissions
• Complex permission combinations using logical operators

internal/engines/lookup_test.go (1)

3063-3204: LGTM! Comprehensive test coverage for permission propagation.

The new test case effectively validates the end-to-end permission evaluation by:

• Testing the same entity hierarchy (aaa -> bbb -> ccc) as the linked schema test
• Verifying both direct permissions and inherited permissions
• Including attribute-based conditions in the permission chain

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.