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

✨ OPENID: Added option to create users on login #4421

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

lelemm
Copy link
Contributor

@lelemm lelemm commented Feb 20, 2025

After feedback, some users using self hosted openid provider wants to be able to create users on login.
Added the variable ACTUAL_USER_CREATION_MODE that can be manual or login.
If set to login it will create user at the first login of that user. The created user will be a BASIC user.
The default behavior is the manual

@actual-github-bot actual-github-bot bot changed the title ✨Added option to create users on login (openid) [WIP] ✨Added option to create users on login (openid) Feb 20, 2025
@lelemm lelemm changed the title [WIP] ✨Added option to create users on login (openid) [WIP] ✨OPENID: Added option to create users on login Feb 20, 2025
Copy link

netlify bot commented Feb 20, 2025

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 18ebf83
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/67bbe3348a03d1000897e652
😎 Deploy Preview https://deploy-preview-4421.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@lelemm lelemm changed the title [WIP] ✨OPENID: Added option to create users on login ✨OPENID: Added option to create users on login Feb 20, 2025
Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

Walkthrough

The changes introduce modifications to user authentication and configuration management within the application. The loginWithOpenIdFinalize function now identifies users using userInfo.sub instead of userInfo.name. User creation conditions have been expanded; a new user is created if there are no existing users or if the configuration specifies a ‘login’ mode. The role assigned to a new user is determined by the count of existing users, with the first user receiving an ‘ADMIN’ role and subsequent users receiving a ‘BASIC’ role. Error handling has been refined to provide specific messages for user existence and OpenID grant failures. Additionally, an optional userCreationMode property has been added to the configuration interface, allowing values of 'manual' or 'login'. This property is also reflected in the final configuration, which can be set based on an environment variable if defined.

Suggested labels

sparkles: Merged

Suggested reviewers

  • matt-fidd

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8565417 and 18ebf83.

📒 Files selected for processing (1)
  • packages/sync-server/src/load-config.js (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/sync-server/src/load-config.js
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: test
  • GitHub Check: build (macos-latest)
  • GitHub Check: build (windows-latest)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Analyze
  • GitHub Check: Wait for Netlify build to finish
  • GitHub Check: Build Docker image (alpine)
  • GitHub Check: Build Docker image (ubuntu)

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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

🧹 Nitpick comments (1)
packages/sync-server/src/accounts/openid.js (1)

223-223: Consider enforcing unique user_name constraint
The insertion query looks correct. For added data integrity, consider placing a unique constraint on user_name in the database. This will prevent duplicates if any transaction concurrency occurs.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd4b891 and fe162a4.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4421.md is excluded by !**/*.md
📒 Files selected for processing (3)
  • packages/sync-server/src/accounts/openid.js (3 hunks)
  • packages/sync-server/src/config-types.ts (1 hunks)
  • packages/sync-server/src/load-config.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build Docker image (alpine)
🔇 Additional comments (6)
packages/sync-server/src/accounts/openid.js (4)

196-197: Ensure final fallback sub remains stable
Using userInfo.sub as the ultimate fallback is typically correct for a unique, provider-specific ID. However, please verify with your OpenID provider that sub remains stable across sessions for the same user to avoid unexpected account duplication.


209-212: Good application of userCreationMode
This condition cleanly handles the new userCreationMode logic, allowing automatic user creation upon login. No issues found.


228-229: Logical assignment for owner and role
Correctly assigns the first user as ADMIN and subsequent users as BASIC. This logic appears consistent with the new workflow.


233-237: Verify edge cases in file transfer
Transferring files from a user with an empty user_name is logical for migrating previously password-created data. However, confirm that no other users share an empty user_name to avoid unintended file transfers.

packages/sync-server/src/config-types.ts (1)

43-43: New userCreationMode property
The optional userCreationMode?: 'manual' | 'login'; property is well-defined and expands configuration possibilities.

packages/sync-server/src/load-config.js (1)

224-226: Environment-based override for userCreationMode
Nicely allows userCreationMode to be configured via an environment variable, enabling flexible deployment setups.

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: 2

🧹 Nitpick comments (1)
packages/sync-server/src/load-config.js (1)

229-241: Add debug logging for userCreationMode.

For consistency with other configuration properties, consider adding debug logging for the new userCreationMode setting.

 debug(`using login method ${finalConfig.loginMethod}`);
 debug(`using trusted proxies ${finalConfig.trustedProxies.join(', ')}`);
+debug(`using user creation mode ${finalConfig.userCreationMode}`);
 debug(
   `using trusted auth proxies ${
     finalConfig.trustedAuthProxies?.join(', ') ?? 'same as trusted proxies'
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fe162a4 and 46b5bae.

📒 Files selected for processing (1)
  • packages/sync-server/src/load-config.js (2 hunks)
🧰 Additional context used
🪛 ESLint
packages/sync-server/src/load-config.js

[error] 91-91: Insert ,

(prettier/prettier)

🪛 GitHub Check: lint
packages/sync-server/src/load-config.js

[failure] 91-91:
Insert ,

🪛 GitHub Actions: Test
packages/sync-server/src/load-config.js

[error] 91-91: Prettier formatting check failed: Insert ,.

⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: build (macos-latest)
  • GitHub Check: build (windows-latest)
  • GitHub Check: Wait for Netlify build to finish
  • GitHub Check: Analyze
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Build Docker image (alpine)
  • GitHub Check: Build Docker image (ubuntu)

@lelemm lelemm requested a review from matt-fidd February 25, 2025 03:25
@lelemm lelemm changed the title ✨OPENID: Added option to create users on login ✨ OPENID: Added option to create users on login Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants