Chore: Refactor Config Module #87

Killg0d · 2024-12-27T09:38:59Z

Description

This PR refactors the Config module of the boilerplate to improve its readability, maintainability, and functionality. It removes the existing service manager and introduces enhancements inspired by the MERN boilerplate.

Changes

Removed the existing service manager.
Integrated pyaml for reading .yml configuration files.
Refactored ConfigService to closely align with the structure and functionality of the MERN boilerplate.

Custom Environment Variables

Some deployment scenarios require secrets and settings to be configured via environment variables instead of hardcoding them in the codebase. The custom-environment-variables.yml file introduces a YAML-based approach for mapping environment variables into your configuration.

To enable custom environment variables, create a configuration file at config/custom-environment-variables.yml, mapping environment variable names to your configuration structure. Example:

web_app_host: "WEB_APP_HOST"  

inspectlet:  
  key: "INSPECTLET_KEY"  

papertrail:  
  host: "PAPERTRAIL_HOST"  
  port:  
    __name: "PAPERTRAIL_PORT"  
    __format: "number"

This example checks for the environment variables WEB_APP_HOST and INSPECTLET_KEY to override corresponding config values. The PAPERTRAIL_PORT variable is parsed using the specified __format type (number in this case).

Available __format types:

boolean
number

Precedence: Custom environment variables override all other configuration files, including default.yml and {app_env}.yml.

Database Schema Changes

N/A

Tests

Automated Tests

All automated test cases passed.

Manual Test Cases

User Creation

Verified document generation when creating a user using both username/password and phone number/OTP.

Login

Verified login functionality using username credentials.
Verified login functionality using phone number and OTP.

OTP Errors

Invalid OTP: Raised HTTP error 400 (code: OTP_ERR_01, "invalid otp").
Expired OTP: Raised HTTP error 400 (code: OTP_ERR_02, "expired otp").

Account Errors

Incorrect email during login: Raised HTTP error 404 (code: ACCOUNT_ERR_02, "account not found").
Incorrect password during login: Raised HTTP error 403 (code: ACCOUNT_ERR_02, "invalid password").
Incorrect email during password reset: Raised HTTP error 404 (code: ACCOUNT_ERR_02, "account not found").
Existing email during signup: Raised HTTP error 409 (code: ACCOUNT_ERR_01, "account already exists").

config/development.ini

src/apps/backend/modules/access_token/access_token_service.py

src/apps/backend/modules/config/config_service.py

govind-io · 2025-01-06T04:57:20Z

The current Config service does not seems to be similar as the one that we are using in mern-boilerplate We should expose just two methods from this class getValue and hasValue both of these functions should be type safe using generic types.

e.g:

def get_value(key: str, expected_type: Type[T]) -> T:
       # actual function logic here

# example usage
ConfigUtil.get_value("string_key", str)
ConfigUtil.get_value("integer_key", int)

src/apps/backend/modules/config/config_service.py

src/apps/backend/modules/access_token/access_token_service.py

removed unused settings and config_manager modified config_service to be the class that handles configuration modified all instances of config_manager to use config_service

- Overridden optionxform in ConfigParser to preserve the case of keys - Ensured environment variables are matched with original case from .ini files

fix: improved file readablity

…arity

refactor: created a config file which simulates node-config refactor: modified config_service to extend config so that it reflects mern-boilerplate

…lues function to improve code smell

config/custom-environment-variables.yml

config/default.yml

jjalan · 2025-01-30T06:08:00Z

src/apps/backend/modules/config/config.py

+import yaml
+
+
+def get_parent_directory(directory: str, levels: int) -> Path:


Avoid creating methods outside class

jjalan · 2025-01-30T06:08:11Z

src/apps/backend/modules/config/config.py

+
+class Config:
+    config_dict: dict[str, Any]
+    config_path: Path = get_parent_directory(__file__, 6) / "config"


Avoid magic numbers like 6 which are not readable.

jjalan · 2025-01-30T06:08:57Z

src/apps/backend/modules/config/config.py

+    return parent_dir
+
+
+class Config:


If this is not supposed to be file consumed by other modules directly, this should live inside internals folder

jjalan · 2025-01-30T06:09:36Z

src/apps/backend/modules/config/config_service.py

+        value = Config.get(key)
+        if value is None:
+            raise MissingKeyError(missing_key=key, error_code=ErrorCode.MISSING_KEY)
+        return value  # type: ignore


Why do we have this?

How are we enforcing type safety? For example if some asked for bool but found a string, that should throw.

jjalan · 2025-01-30T06:11:02Z

src/apps/backend/modules/config/config.py

+        return yaml_content
+
+    @staticmethod
+    def load_config() -> None:


If this is the only public method, move to top of the class.

Mark all internal methods to start with _

Consider improving readability of the code overall from code organization, naming and others

jalan-technologies-sonarqube · 2025-01-30T13:23:31Z

Analysis Details

0 Issues

0 Bugs
0 Vulnerabilities
0 Code Smells

Coverage and Duplications

No coverage information (0.00% Estimated after merge)
0.00% Duplicated Code (0.50% Estimated after merge)

Project ID: jalantechnologies_rflask-boilerplate

View in SonarQube

github-actions · 2025-01-30T13:24:46Z

Deployment (frm-boilerplate) is available at - https://f55a0c2629bdc00.preview.platform.jalantechnologies.com

github-actions · 2025-01-30T13:25:46Z

Package	Line Rate	Health
src.apps.backend	97%	✔
src.apps.backend.bin	70%	➖
src.apps.backend.modules	100%	✔
src.apps.backend.modules.access_token	99%	✔
src.apps.backend.modules.access_token.rest_api	100%	✔
src.apps.backend.modules.account	99%	✔
src.apps.backend.modules.account.internal	98%	✔
src.apps.backend.modules.account.internal.store	97%	✔
src.apps.backend.modules.account.rest_api	100%	✔
src.apps.backend.modules.application	93%	✔
src.apps.backend.modules.common	89%	✔
src.apps.backend.modules.communication	81%	✔
src.apps.backend.modules.communication.internals	48%	❌
src.apps.backend.modules.config	100%	✔
src.apps.backend.modules.config.internals	89%	✔
src.apps.backend.modules.error	85%	✔
src.apps.backend.modules.logger	86%	✔
src.apps.backend.modules.logger.internal	79%	➖
src.apps.backend.modules.otp	100%	✔
src.apps.backend.modules.otp.internal	91%	✔
src.apps.backend.modules.otp.internal.store	97%	✔
src.apps.backend.modules.password_reset_token	100%	✔
src.apps.backend.modules.password_reset_token.internal	97%	✔
src.apps.backend.modules.password_reset_token.internal.store	100%	✔
src.apps.backend.modules.password_reset_token.rest_api	100%	✔
tests	100%	✔
tests.modules	100%	✔
tests.modules.access_token	99%	✔
tests.modules.account	100%	✔
tests.modules.common	90%	✔
tests.modules.config	100%	✔
tests.modules.password_reset_token	100%	✔
Summary	93% (1688 / 1818)	✔

Minimum allowed line rate is 60%

jjalan · 2025-01-31T03:15:24Z

src/apps/backend/modules/config/config_service.py


+T = TypeVar('T')


Is it possible to bound the values of T?

jjalan · 2025-01-31T03:15:36Z

src/apps/backend/modules/config/config_service.py

-    def has_key(key: str) -> bool:
-        return key in ConfigManager.config
+    @classmethod
+    def get_value(cls,key: str) -> T:


Nit: add space after ,

jjalan · 2025-01-31T03:16:54Z