add max users env var and register check #274
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @tavdog, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a new feature that allows administrators to set a maximum limit on the number of users who can register on the system. This is achieved by introducing a configurable environment variable and integrating a check into the user registration process, ensuring that no new users can sign up once the defined limit is met. This enhances system control and resource management.
Highlights
- User Management: Implemented a new
MAX_USERSconfiguration option to control the maximum number of registered users allowed on the system. - Configuration: The
MAX_USERSlimit is now configurable via an environment variable. If not explicitly set, it defaults to 100 users. - Registration Flow: Added a pre-registration check that prevents new user sign-ups if the
MAX_USERSlimit has been reached. Users attempting to register beyond the limit will be redirected to the login page with an informative message.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a feature to limit the number of registered users via the MAX_USERS environment variable. There's a critical issue that could cause the application to crash during registration if the environment variable is not set. Additionally, there's a significant performance concern with how the current number of users is calculated, which could impact scalability. I've also included a few suggestions to improve configuration robustness and code consistency.
tronbyt_server/auth.py
Outdated
| @@ -25,6 +25,14 @@ | |||
|
|
|||
| @bp.route("/register", methods=("GET", "POST")) | |||
| def register() -> ResponseReturnValue: | |||
| # Check if max users limit is reached | |||
| max_users = int(current_app.config.get("MAX_USERS")) # default to something big | |||
There was a problem hiding this comment.
This line can cause a ValueError if MAX_USERS is set to an empty string in the environment. To make this more robust, you can provide a default value to fall back on if the config value is empty.
max_users = int(current_app.config.get("MAX_USERS") or 100)| # Check if max users limit is reached | ||
| max_users = int(current_app.config.get("MAX_USERS")) # default to something big | ||
| if max_users > 0: | ||
| users_count = len(db.get_all_users()) |
There was a problem hiding this comment.
Calling db.get_all_users() and then len() on the result can be very inefficient, especially if the number of users grows. This function fetches all user data from the database and deserializes it, just to get the count. A more efficient approach would be to get the count directly from the database using a COUNT(*) query.
users_count = db.get_user_count()
docker-compose.dev.yaml
Outdated
| @@ -18,3 +18,4 @@ services: | |||
| - SYSTEM_APPS_REPO | |||
| - PRODUCTION=0 | |||
| - LOG_LEVEL=DEBUG | |||
| - MAX_USERS | |||
There was a problem hiding this comment.
It's good practice to provide a default value for environment variables in docker-compose.yaml to ensure the service starts correctly even if the variable is not set in the host environment.
MAX_USERS=${MAX_USERS:-100}
tronbyt_server/__init__.py
Outdated
| @@ -221,6 +221,7 @@ def create_app(test_config: Optional[Dict[str, Any]] = None) -> Flask: | |||
| PRODUCTION=os.getenv("PRODUCTION", "1"), | |||
| DB_FILE="users/usersdb.sqlite", | |||
| LANGUAGES=["en", "de"], | |||
| MAX_USERS=os.getenv("MAX_USERS", 100), | |||
There was a problem hiding this comment.
To maintain type consistency for the MAX_USERS configuration value, it's better to provide the default value as a string as well. This avoids having a configuration value that is sometimes an integer and sometimes a string.
| MAX_USERS=os.getenv("MAX_USERS", 100), | |
| MAX_USERS=os.getenv("MAX_USERS", "100") |
tronbyt_server/__init__.py
Outdated
| @@ -241,6 +242,7 @@ | |||
| USERS_DIR="tests/users", | |||
| DATA_DIR=os.getenv("DATA_DIR", "data"), | |||
| PRODUCTION="0", | |||
| MAX_USERS=os.getenv("MAX_USERS", 100), | |||
There was a problem hiding this comment.
Similar to the production configuration, the default value for MAX_USERS here should be a string to ensure type consistency.
MAX_USERS=os.getenv("MAX_USERS", "100")
fixes #273