GreptimeTeam / greptimedb

An open-source, cloud-native, distributed time-series database with PromQL/SQL/Python supported. Available on GreptimeCloud.
https://greptime.com/
Apache License 2.0
3.96k stars 282 forks source link

refactor: use rwlock for modifiable session data #4232

Closed sunng87 closed 16 hours ago

sunng87 commented 6 days ago

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Follow up for #4218 . Need a rebase after #4218 merged.

Some of the properties, like schema and timezone, are modifiable within a session.

Our original design is to generate a read-only QueryContext, then pass it with all the execution process path. This works well before we have statements that modify some of the session data, like SET time_zone and USE.

After that, we introduce a new method called update_session to give back modified properties to session, after query execution. See https://github.com/GreptimeTeam/greptimedb/blob/b739c9fd10ba486726f6ee30d260792081eafd2f/src/servers/src/mysql/handler.rs#L107 . The implementation of update_session has to check each modifiable field and update the session. This is because ArcSwap data structure is not clonable. So we cannot share reference between the parent Session and the child QueryContext.

This main point of this patch is to change those modifiable fields from ArcSwap to Arc<RwLock> so that we can share it between parent and child. Note that because Session is associated with a signle connection, so actually there is no race condition with reading and updating those modifiable fields.

This patch also include a feature flag fix for orc-rust to exclude it datafusion dependency.

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 6 days ago

Walkthrough

The recent changes involve refining the PermissionChecker trait and numerous other components by requiring direct UserInfoRef instead of Option<UserInfoRef>. This update streamlines user handling across various modules. Additionally, the change introduces RwLock for managing concurrent mutable access to session fields like catalog, schema, user_info, and timezone. These alterations aim to improve code clarity, concurrency, and overall performance.

Changes

Files/Groups Change Summaries
src/auth/src/permission.rs Modified PermissionChecker trait to require UserInfoRef instead of Option<UserInfoRef>.
src/auth/tests/mod.rs Updated check_permission in DummyPermissionChecker to accept UserInfoRef.
src/common/datasource/Cargo.toml Added async feature to the orc-rust dependency.
src/common/function/src/.../database.rs Changed current_schema to current_schema_raw in QueryContextBuilder instantiation.
src/operator/src/expr_factory.rs and src/operator/src/... Replaced timezone with timezone_raw in QueryContextBuilder instantiation.
src/pipeline/src/manager/table.rs, src/query/src/plan.rs Modified query_ctx and test_extract_full_table_names to use current_schema_raw in QueryContextBuilder.
src/query/src/optimizer/type_conversion.rs Updated parameter in string_to_timestamp_ms function call to reference self.query_ctx.timezone().
src/query/src/sql.rs, src/servers/src/http/authorize.rs Changed timezone to timezone_raw and updated method calls and user handling logic.
src/servers/src/export_metrics.rs, src/servers/src/... Modified current_schema to current_schema_raw.
src/session/src/context.rs and src/session/src/lib.rs Introduced RwLock to manage session fields like current_schema, current_user, and timezone, replacing ArcSwap usage for better concurrency handling.

Sequence Diagram(s)

Changes don't include a new feature or modifications to the control flow that necessitate a sequence diagram.

Poem

In the realm of rust and code, UserInfoRef now we hold, With the RwLock dance in place, Schemas and timezones join the race. A smoother flow, concurrency bright, Our sessions now dance with delight! πŸ‡βœ¨


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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 days ago

Codecov Report

Attention: Patch coverage is 89.74359% with 8 lines in your changes missing coverage. Please review.

Project coverage is 84.65%. Comparing base (11cf9c8) to head (841842a). Report is 9 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #4232 +/- ## ========================================== - Coverage 84.97% 84.65% -0.32% ========================================== Files 1054 1057 +3 Lines 187154 187495 +341 ========================================== - Hits 159037 158732 -305 - Misses 28117 28763 +646 ```