Tublian / tos-oms-webmvc

vFunction pilot project
0 stars 0 forks source link

Ideal Issue Template #12

Open tublian-ai-engineer opened 1 month ago

tublian-ai-engineer commented 1 month ago

Issue Description

A clear and concise description. Make sure to include any relevant background information or reasons why the issue needs to be addressed.

List of Tasks

Breaking down the issue into smaller, manageable tasks for the agent. This reduces ambiguity and use domain terms.

Files/Modules that are Affected

Exact files or modules potentially affected by the issue. Points agents to the right direction.

Architecture Tips:

Providing architectural guidelines ensures that the agent's solutions align with the overall system design.

Things Not to Do

Outlining actions to avoid helps prevent common pitfalls and mistakes. Mention any dependencies on other systems or constraints

Example: changes are only required for service module. Do not change anything in the controller.

Expected Outcomes or Acceptance Criteria:

Defining what success looks like can help the agent verify that the tasks have been completed correctly including non-functional requirements.

tublian-ai-engineer commented 1 month ago

Enhance Logging for Failed Login Attempts in AuthService

Issue Description

The logging mechanism in the authentication service is not capturing failed login attempts accurately. This is causing issues with tracking potential security breaches. The log entries for failed attempts are missing critical information, such as the timestamp and the user's IP address.

List of Tasks

Investigate the logging logic in the AuthService module. Add missing details (timestamp and IP address) to failed login logs. Ensure the changes are backward compatible with existing log parsing tools.

Files/Modules that are Affected

AuthService.java LoggingUtility.java

Architecture Tips

Follow the centralized logging system's format. Use the logging interface, not direct calls, to maintain consistency.

Things Not to Do

Do not change the log structure for successful login attempts. Avoid modifying anything related to the authentication flow in the controller.

Expected Outcomes or Acceptance Criteria

Failed login attempts should now log the timestamp and user IP address correctly. Logs should maintain the format compatible with existing monitoring tools. Performance should not degrade, and the change should be fully tested with at least 5000 failed login attempts.

tublian-ai-engineer commented 1 month ago

Correct Email Subject Formatting for New User Registrations

Issue Description

The email notification service for new user registrations is sending emails without the proper subject formatting. The subject line is missing the user's name and the timestamp of registration, leading to confusion in tracking.

List of Tasks

Review and update the subject formatting logic in the NotificationService. Add user's name and registration timestamp to the email subject. Write unit tests to cover different cases (e.g., different time zones).

Files/Modules that are Affected

NotificationService.java EmailTemplateHandler.java

Architecture Tips

Ensure subject formatting follows the email template guidelines already in place. Use the common utility functions for time and date formatting.

Things Not to Do

Do not modify formatting for any other emails. This change only related to New registrations Avoid making any changes to the user registration flow.

Expected Outcomes or Acceptance Criteria

The email subject should include the correct user's name and registration timestamp. Unit tests should cover scenarios for different locales. Emails should pass all current validation and anti-spam checks.