Southclaws / storyden

With a fresh new take on traditional bulletin board forum software, Storyden is a modern, secure and extensible platform for building communities.
https://www.storyden.org/
Mozilla Public License 2.0
93 stars 11 forks source link

Rework authentication flows #296

Closed Southclaws closed 3 days ago

Southclaws commented 1 week ago

Adds the ability for instance owners to control auth flows for members. Enable/disable email based auth etc.

General refactor to auth provider code, simplifying from the mess it once was.

Redesign auth flow frontend, ensure all cases are covered including handle+password, email+password, phone and OAuth2 providers.

vercel[bot] commented 1 week ago

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
storyden βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Nov 18, 2024 4:58pm
1 Skipped Deployment | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **storyden-homepage** | ⬜️ Ignored ([Inspect](https://vercel.com/southclaws-projects/storyden-homepage/2ZdoPJyj1chKFzvmkaisegBPhDZ3)) | [Visit Preview](https://storyden-homepage-git-rework-auth-flows-southclaws-projects.vercel.app) | | Nov 18, 2024 4:58pm |
coderabbitai[bot] commented 1 week ago

[!CAUTION]

Review failed

The pull request is closed.

πŸ“ Walkthrough
πŸ“ Walkthrough ## Walkthrough This pull request introduces extensive changes to the authentication system, including the addition of new types, methods, and error handling mechanisms to support various authentication modes (email, phone, username). Key updates include the introduction of `TokenType`, `Service`, and `Mode` enums, modifications to database interactions, and enhancements to the email management system. The changes also streamline the control flow for authentication processes, allowing for better management of user accounts and email addresses, while ensuring compatibility with the newly defined structures and error handling strategies. ## Changes | File Path | Change Summary | |-----------|----------------| | app/resources/account/authentication/authentication_enum_gen.go | Added `Mode`, `Service`, and `TokenType` enums with associated methods for handling authentication modes, services, and token types. | | app/resources/account/authentication/db.go | Updated `Create`, `LookupByIdentifier`, and `Delete` methods to incorporate `tokenType`. Removed `LookupByHandle`, replaced with `LookupByTokenType`. | | app/resources/account/authentication/dto.go | Removed `Service` type; added `Type` field of type `TokenType` in `Authentication` struct. | | app/resources/account/authentication/mode.go | Introduced a new file defining authentication modes as an enum. | | app/resources/account/email/email.go | Updated `EmailRepo` to `Repository`, enhancing email management with error handling and new methods. | | app/resources/seed/account.go | Updated authentication service references to use defined constants. | | app/resources/settings/defaults.go | Added `AuthenticationMode` field to `DefaultSettings`. | | app/resources/settings/settings.go | Added `AuthenticationMode` field to `Settings` struct. | | app/services/account/account_auth/account_auth.go | Modified `Manager` struct to streamline dependency management for authentication services. | | app/services/authentication/provider.go | Enhanced `Provider` and `OAuthProvider` interfaces with new methods for service and token retrieval. | | app/services/authentication/provider/email_only/email_only.go | Implemented email-only authentication provider with registration and login methods. | | app/services/authentication/provider/password/password.go | Updated password provider methods to enhance error handling and functionality. | | app/transports/http/bindings/auth_email.go | Updated methods for email signup and signin to use new provider methods. | | web/src/api/openapi-schema/authMode.ts | Introduced a new TypeScript file defining `AuthMode` type for authentication modes. | | web/src/api/openapi-schema/authProviderListOKResponse.ts | Added `mode` property of type `AuthMode` to `AuthProviderListOKResponse`. | | web/src/screens/auth/LoginScreen/LoginEmail/LoginEmailForm.tsx | Introduced a new form component for email login functionality. | | web/src/screens/auth/RegisterScreen/RegisterEmail/RegisterEmailForm.tsx | Introduced a new form component for email registration functionality. | | internal/ent/authentication.go | Modified `Authentication` struct to include new fields for token type and account authentication. | | internal/ent/email.go | Removed `AuthenticationRecordID` field and related methods from `Email` struct. | | internal/ent/migrate/schema.go | Updated schema for the authentications table to include new columns and indices. | ## Possibly related issues - **Southclaws/storyden#229**: The changes in this PR address the need for a reworked authentication flow by introducing support for multiple authentication methods (email, phone, username) and enhancing the management of these methods, aligning with the issue's objectives. > πŸ‡ In the meadow, where bunnies play, > New auth modes hop in, brightening the day! > With tokens and services, all set to go, > Email and phone, come join the show! > So let’s celebrate this leap, oh so grand, > A fluffy new world, all perfectly planned! πŸ‡

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.