feat: bulk permission check api is added

[ucatbas]

• Added a new Bulk Permission Check API endpoint that accepts multiple permission checks in one call.
• Added integration tests

Summary by CodeRabbit

• New Features

  • Introduced a new API endpoint for bulk permission checks at /v1/tenants/{tenant_id}/permissions/bulk-check.
  • Added support for checking multiple permissions in a single request, improving efficiency for clients.

• Bug Fixes

  • Enhanced validation for permission check requests and responses, ensuring stricter adherence to defined constraints.

• Documentation

  • Updated API documentation with new endpoint details and usage examples for better clarity.

• Tests

  • Added new test cases for bulk permission checks across various integrations (Facebook Groups, Google Docs, Notion).
  • Introduced additional test cases for Github and Exclusion sample contexts, validating permissions against repository entities.

[coderabbitai[bot]]

Walkthrough

The changes introduce a new API endpoint /v1/tenants/{tenant_id}/permissions/bulk-check for performing bulk permission checks. This endpoint supports a POST request that allows clients to check multiple permissions in a single call. New schemas for request and response structures are defined, including BulkCheckBody, BulkPermissionCheckResponse, SinglePermissionCheck, and SinglePermissionCheckResponse. Additionally, new validation methods and test cases for bulk checks across various integrations have been added, enhancing the API's functionality and testing capabilities.

Changes

File Path	Change Summary
docs/api-reference/apidocs.swagger.json	Added new endpoint /v1/tenants/{tenant_id}/permissions/bulk-check for bulk permission checks with request body BulkCheckBody and response type BulkPermissionCheckResponse. Added definitions for SinglePermissionCheck and SinglePermissionCheckResponse.
docs/api-reference/openapiv2/apidocs.swagger.json	Similar changes as above, defining the new endpoint and its parameters, including the request and response schemas.
integration-test/usecases/facebook_groups_test.go	Added a test case "Facebook Groups Sample: Bulk Checks" to validate bulk permission checks.
integration-test/usecases/google_docs_test.go	Added a test case "Google Docs Sample: Bulk Checks" for bulk permission checks.
integration-test/usecases/notion_test.go	Added a test case "Notion Sample: Bulk Checks" for testing bulk permission checks.
internal/servers/permissionServer.go	Introduced BulkCheck method in PermissionServer to handle bulk permission checks and return results.
internal/engines/balancer/balancer.go	Added BulkCheck method to Balancer struct; currently unimplemented.
internal/engines/check.go	Added BulkCheck method to CheckEngine struct for performing permission checks on a set of entities.
internal/invoke/invoke.go	Added BulkCheck method to DirectInvoker struct for bulk permission checks.
internal/engines/cache/cache.go	Added BulkCheck method to CheckEngineWithCache struct; currently unimplemented.
internal/engines/bulk.go	Enhanced BulkChecker functionality with new types and methods for processing bulk checks.
internal/engines/lookup.go	Updated callback signatures in LookupEntity, LookupEntityStream, and LookupSubject methods to accept variadic parameters for improved clarity.
internal/storage/memory/schemaReader.go	Improved error handling in ReadEntityDefinition and ReadRuleDefinition methods for consistency.
integration-test/specific/health_test.go	Modified gRPC server connection string in health check test.
integration-test/usecases/usecase_test.go	Changed gRPC server connection string in test setup.
internal/engines/check_test.go	Added new test cases in Github Sample and Exclusion Sample contexts for bulk permission checks.

Possibly related PRs

• #1486: The changes in this PR focus on enhancing the testing framework related to garbage collection and permission checks, which aligns with the bulk permission check functionality introduced in the main PR.
• #1524: This PR includes modifications to the BulkChecker class, which is directly related to the bulk permission check functionality introduced in the main PR, enhancing the overall efficiency and readability of the code.

Suggested reviewers

• tolgaOzen

🐰 In a field of dreams so bright,
A new endpoint brings delight.
With bulk checks now in play,
Permissions verified in a single sway.
Hops of joy, we celebrate,
Efficiency is truly great! 🌟

---

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

[thisisnkc]

this is a good to have feature and it will be quite usefull