Nerimity / nerimity-server

GNU General Public License v3.0
37 stars 15 forks source link

Role based channel permissions #22

Closed SupertigerDev closed 20 hours ago

SupertigerDev commented 20 hours ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 20 hours ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

This pull request introduces several changes primarily focused on managing server channel permissions within the nerimity-server project. Key modifications include downgrading the tsup dependency, adding a new ServerChannelPermissions table in the database schema, and updating various service and middleware files to enhance permission handling. New functions for managing permissions are added, and existing functions are updated to reflect changes in the permissions model, including adjustments to how permissions are validated and cached.

Changes

File Change Summary
package.json Downgraded tsup dependency from "^8.3.5" to "8.3.0".
prisma/migrations/20241115134792_add_server_channel_permissions_table/migration.sql Added ServerChannelPermissions table with columns and foreign key constraints; dropped permissions column from Channel table.
prisma/migrations/20241127134025_toggle_private_channel_permission/migration.sql Updated ServerChannelPermissions table to toggle private channel permission using bitwise operations.
prisma/schema.prisma Updated Server and ServerRole models to include channelPermissions; added new ServerChannelPermissions model; updated Channel model to include permissions.
src/cache/CacheKeys.ts Added SERVER_CHANNEL_PERMISSION_KEY_HASH function for generating cache keys for channel permissions.
src/cache/ChannelCache.ts Updated ServerChannelCache interface to include canBePublic; added functions for managing server channel member permissions and updated cache deletion logic.
src/common/Bitwise.ts Removed PRIVATE_CHANNEL entry; added PUBLIC_CHANNEL entry with updated properties.
src/common/ClientEventNames.ts Added SERVER_CHANNEL_PERMISSIONS_UPDATED constant for event handling.
src/emits/Server.ts Added emitServerChannelPermissionsUpdated function; updated permission handling in emitServerJoined.
src/middleware/channelPermissions.ts Added optional invert property to Options interface for conditional permission checks.
src/middleware/channelVerification.ts Simplified code formatting and improved clarity in channel type checks.
src/routes/channels/channelMessageCreate.ts Updated validation logic for message creation, particularly for channel types and user permissions.
src/routes/servers/Router.ts Integrated serverChannelPermissionUpdate function into ServersRouter.
src/routes/servers/serverChannelPermissionsUpdate.ts Introduced new route handler for updating channel permissions with validation and error handling.
src/routes/servers/serverChannelUpdate.ts Removed permissions field from request body validation and interface.
src/services/Channel.ts Added updateServerChannelPermissions function; modified permissions structure in createServerChannel.
src/services/Message.ts Refined optional parameter handling in getMessagesByChannelId; streamlined createMessage function.
src/services/Server.ts Enhanced handling of server members and roles; updated permissions structure in createServer.
src/services/ServerMember.ts Improved role update logic to clear permissions cache upon role changes.
src/services/ServerRole.ts Streamlined role update and deletion processes for permissions management.
src/socket/events/onAuthenticate.ts Refactored handleAuthenticate function for improved user permissions and channel access handling.

Possibly related PRs

🐰 "In channels where permissions play,
We hop and skip, come what may.
With roles and rights now finely tuned,
Our server's harmony is festooned.
From private to public, we leap with glee,
In the world of code, we're wild and free!" 🐇✨

[!WARNING]

Rate limit exceeded

@SupertigerDev has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 16 seconds before requesting another review.

⌛ How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
🚦 How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://docs.coderabbit.ai/faq) for further information.
📥 Commits Reviewing files that changed from the base of the PR and between 67fe600e7902318992e5c99e1e381d601f738b96 and 71d6cbb57556d6aa6edc24436ebe3efbdae9718a.

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 67fe600e7902318992e5c99e1e381d601f738b96 and 71d6cbb57556d6aa6edc24436ebe3efbdae9718a.
📒 Files selected for processing (1) * `src/socket/events/onAuthenticate.ts` (2 hunks)

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.