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

Move UserType to OC.Users.Core #15926

Merged
merged 1 commit into from
May 1, 2024
Merged

Move UserType to OC.Users.Core #15926

merged 1 commit into from
May 1, 2024

Conversation

hishamco
Copy link
Member

@hishamco hishamco commented Apr 30, 2024

PR #15389 introduced a module-to-module reference which we denied from the beginning, and tonight @sebastienros mentioned this during the meeting

/cc @hyzx86

Summary by CodeRabbit

  • Refactor

    • Removed an unnecessary project reference to enhance module independence.
  • New Features

    • Introduced a new GraphQL UserType class to represent user information more comprehensively, including custom user settings.

Copy link
Contributor

coderabbitai bot commented Apr 30, 2024

Walkthrough

Walkthrough

The recent changes in the OrchardCore project involve adjustments in project dependencies and the introduction of new functionalities in the GraphQL API. Specifically, a dependency on OrchardCore.Users was removed from OrchardCore.ContentFields, while OrchardCore.Users.Core now references OrchardCore.ContentManagement.GraphQL. Additionally, a new UserType class was introduced to enhance the GraphQL schema with user-related information, initializing custom user settings based on registered content types with the stereotype "CustomUserSettings."

Changes

File Path Change Summary
.../ContentFields/OrchardCore.ContentFields.csproj Removed project reference to OrchardCore.Users.csproj
.../Users.Core/GraphQL/UserType.cs Introduced UserType class for GraphQL user information, including fields for user ID, username, email, and phone number, and initialization of custom user settings based on content types with stereotype "CustomUserSettings"
.../Users.Core/OrchardCore.Users.Core.csproj Added project reference to OrchardCore.ContentManagement.GraphQL.csproj

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 7e25b3e and 1190fdf.
Files selected for processing (2)
  • src/OrchardCore.Modules/OrchardCore.ContentFields/OrchardCore.ContentFields.csproj (1 hunks)
  • src/OrchardCore/OrchardCore.Users.Core/OrchardCore.Users.Core.csproj (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • src/OrchardCore.Modules/OrchardCore.ContentFields/OrchardCore.ContentFields.csproj
  • src/OrchardCore/OrchardCore.Users.Core/OrchardCore.Users.Core.csproj

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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Out of diff range and nitpick comments (1)
src/OrchardCore/OrchardCore.Users.Core/GraphQL/UserType.cs (1)

10-53: Ensure proper documentation for public class and methods.

The UserType class and its public methods (UserType constructor and Initialize) should have XML documentation comments to improve code maintainability and provide clear API documentation for developers.

@hishamco
Copy link
Member Author

hishamco commented May 1, 2024

@hyzx86 do you have comments here or shall we merge?

Copy link
Contributor

@hyzx86 hyzx86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks! 😊

@hishamco hishamco merged commit 8ff9ee5 into main May 1, 2024
6 checks passed
@hishamco hishamco deleted the hishamco/users-graph-ql branch May 1, 2024 05:36
MikeAlhayek pushed a commit that referenced this pull request May 2, 2024
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.

2 participants