feat: add logger service and error handler

[Hitesh-Kandpal]

Portal PR Checklist

Pre-requisites

• I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
• I have performed preliminary testing to ensure that any existing features are not impacted and any new features are working as expected.

PR Details

PR details have been updated as per the given format (see below)

• PR title adheres to the format specified in guidelines (e.g., feat: add admin login page)
• Description has been added
• Related changes have been added (optional)
• Screenshots have been added (optional)
• Pending actions have been added (optional)
• Any other additional notes have been added (optional)

Additional Information

• Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
• Assignee(s) and reviewer(s) have been added (optional)

---

Description:

Added a logger service and error handler

Related changes:

1. created a new folder for services and added logger and error handler
2. added a enum.ts file
3. did necessary changes in app.module.ts for error handler

Screenshots:

Pending actions:

N/A

Additional notes:

N/A

Summary by CodeRabbit

• New Features

  • Introduced a custom error handler to improve error management across the application.
  • Added a new logging service to enhance diagnostic capabilities by capturing detailed device and session information.

• Refactor

  • Updated the application module to integrate the new error handler.

• Tests

  • Added test suites for both the new error handler and logging services to ensure reliability.

• Documentation

  • Enumerated new log levels and severity types to aid in debugging and maintenance.

[coderabbitai]

Walkthrough

This update enhances error handling and logging capabilities in an Angular application. A custom error handler, MyErrorHandler, is introduced, along with a robust Logger service for detailed logging. New enums facilitate standardized log levels and severities, and accompanying tests ensure reliability.

Changes

File Path	Change Summary
.../app.module.ts	Added MyErrorHandler and updated providers to use it for error handling.
.../shared/enum.ts	Introduced enums LogLevel and LogSeverity for standardized logging.
.../shared/services/...error-handler.service*.ts	New custom error handler service and its test suite.
.../shared/services/logger.service*.ts	New Logger service and its test suite for detailed logging, including device info and HTTP POST support.

🐇💻✨
In the burrow of code, where the wires entwine,
A rabbit hopped forth, with a plan so divine.
To catch every error, log every deed,
With a flick of its paw, set the software to lead.
Cheers to the bits, where no bug can hide,
With a hop and a skip, in bytes we confide!

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9b690f9 and b8b317e.

Files selected for processing (6)

• apps/portal/src/app/app.module.ts (1 hunks)
• apps/portal/src/app/shared/enum.ts (1 hunks)
• apps/portal/src/app/shared/services/error-handler.service.spec.ts (1 hunks)
• apps/portal/src/app/shared/services/error-handler.service.ts (1 hunks)
• apps/portal/src/app/shared/services/logger.service.spec.ts (1 hunks)
• apps/portal/src/app/shared/services/logger.service.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• apps/portal/src/app/shared/enum.ts

Additional comments not posted (3)

apps/portal/src/app/shared/services/logger.service.spec.ts (1)

1-16: LGTM! Basic creation test for Logger service.

The test suite correctly initializes the Logger service and includes a basic test to ensure that the service is created successfully. This is a good starting point, but consider adding more comprehensive tests that cover the functionality of the Logger service, especially the log method.

apps/portal/src/app/shared/services/error-handler.service.spec.ts (1)

1-16: LGTM! Basic creation test for MyErrorHandler service.

The test suite correctly initializes the MyErrorHandler service and includes a basic test to ensure that the service is created successfully. Similar to the Logger service tests, consider expanding the test cases to cover the actual error handling functionality, particularly how it interacts with the Logger service.

apps/portal/src/app/app.module.ts (1)

1-11: Correct integration of MyErrorHandler in the Angular module.

The AppModule correctly imports and configures MyErrorHandler as the default error handler for the application. This ensures that all uncaught errors will be processed by MyErrorHandler, leveraging the custom logic defined within it.

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 3