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

fix(subject-filter): handle wildcard and exclusion logic correctly #1695

Merged
merged 1 commit into from
Oct 16, 2024

Conversation

tolgaOzen
Copy link
Member

@tolgaOzen tolgaOzen commented Oct 16, 2024

Summary by CodeRabbit

  • New Features

    • Introduced new API endpoints for managing permissions and lookups.
    • Added support for additional arguments in requests.
  • Enhancements

    • Improved API documentation with detailed descriptions and structured responses.
    • Enhanced validation for request messages to ensure robust handling.
  • Bug Fixes

    • Updated response schemas to include new fields and improve clarity.
  • Refactor

    • Streamlined permission filtering logic and improved method signatures for clarity.

Copy link

coderabbitai bot commented Oct 16, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces extensive updates to the API documentation and underlying functionality of the Permify API. Key changes include the addition of new parameters and endpoints, modifications to existing endpoints, updates to response schemas, and enhancements to validation logic. Additionally, several structural changes were made to the LookupEngine, SubjectFilter, and DataReader components, improving their operational clarity and efficiency. The overall modifications aim to enhance the API's capabilities for managing permissions and data.

Changes

Files Change Summary
docs/api-reference/apidocs.swagger.json, docs/api-reference/openapiv2/apidocs.swagger.json - Added arguments field in LookupSubjectBody.
- Introduced new endpoints: /v1/tenants/{tenant_id}/permissions/lookup-entity-stream, /v1/tenants/{tenant_id}/permissions/lookup-subject, /v1/tenants/{tenant_id}/permissions/subject-permission.
- Updated response schemas and security definitions.
internal/engines/lookup.go, internal/engines/massSubjectFilter.go, internal/engines/subjectFilter.go, internal/engines/utils.go - Updated LookupSubject to use IdResponse structure.
- Removed MassSubjectFilter.
- Renamed SchemaBasedSubjectFilter to SubjectFilter and updated related methods.
- Introduced new helper functions for ID management.
internal/storage/decorators/circuitBreaker/dataReader.go, internal/storage/decorators/singleflight/dataReader.go, internal/storage/memory/dataReader.go, internal/storage/postgres/dataReader.go, internal/storage/storage.go - Updated QueryUniqueSubjectReferences method to include excluded []string parameter for filtering.
- Maintained overall structure of DataReader.
pkg/pb/base/v1/service.pb.validate.go, proto/base/v1/service.proto - Enhanced validation for PermissionLookupSubjectRequest with new arguments field.
- Updated field numbers for page_size and continuous_token due to the addition of arguments.

Possibly related PRs

  • feat: update API requests and client-side calls with improved formatting #1488: The changes in this PR involve updates to the API documentation in apidocs.swagger.json, which includes modifications to the page_size parameter and other formatting corrections. This is related to the main PR as both involve updates to the API documentation, specifically in the same apidocs.swagger.json files.

🐰 In the meadow where changes bloom,
New endpoints sprout, dispelling gloom.
Arguments added, clarity shines,
With filters and schemas, all aligns.
Permissions dance in a structured way,
Hooray for the updates, hip-hip-hooray! 🌼


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

@tolgaOzen tolgaOzen merged commit 5dc383c into master Oct 16, 2024
9 of 11 checks passed
@tolgaOzen tolgaOzen deleted the fix/subject-filter-wildcard-exclusion-logic branch October 16, 2024 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant