Skip to content

Conversation

SauravBizbRolly
Copy link

@SauravBizbRolly SauravBizbRolly commented Jul 4, 2025

📋 Description

JIRA ID:

Please provide a summary of the change and the motivation behind it. Include relevant context and details.


✅ Type of Change

  • 🐞 Bug fix (non-breaking change which resolves an issue)
  • New feature (non-breaking change which adds functionality)
  • 🔥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 🛠 Refactor (change that is neither a fix nor a new feature)
  • ⚙️ Config change (configuration file or build script updates)
  • 📚 Documentation (updates to docs or readme)
  • 🧪 Tests (adding new or updating existing tests)
  • 🎨 UI/UX (changes that affect the user interface)
  • 🚀 Performance (improves performance)
  • 🧹 Chore (miscellaneous changes that don't modify src or test files)

ℹ️ Additional Information

Please describe how the changes were tested, and include any relevant screenshots, logs, or other information that provides additional context.

Summary by CodeRabbit

  • New Features

    • Introduced beneficiary consent endpoints for OTP-based consent workflows.
    • Added dynamic form management with modules and form types.
    • Integrated Firebase Cloud Messaging for notifications, including user token management.
    • Added new data models and DTOs for beneficiary consent, dynamic forms, notifications, and user tokens.
  • Configuration

    • Added Firebase, SMS, email, scheduler, and various external service configurations to properties files.
  • Bug Fixes

    • Improved error handling and logging for identity and OTP-related services.
  • Refactor

    • Updated JWT utility methods and simplified token validation logic.
    • Adjusted controller and service logic for enhanced maintainability.
  • Style

    • Minor formatting and logging improvements across several files.

Copy link
Contributor

coderabbitai bot commented Jul 4, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This change introduces Firebase Cloud Messaging integration, dynamic form entities and controllers, OTP handling for beneficiary consent, and user token management. It adds new DTOs, entities, repositories, services, and controllers, updates configuration files, and refactors JWT utility and beneficiary identity handling. Additional logging and error handling improvements are included.

Changes

File(s) Change Summary
pom.xml Added Firebase Admin SDK dependency.
src/main/environment/common_ci.properties
src/main/environment/common_docker.properties
src/main/resources/application.properties
Added Firebase and other service configuration properties.
src/main/java/com/iemr/common/config/firebase/FirebaseMessagingConfig.java New config class for FirebaseMessaging bean setup.
src/main/java/com/iemr/common/controller/firebaseNotification/FirebaseNotificationController.java New REST controller for Firebase notification endpoints.
src/main/java/com/iemr/common/service/firebaseNotification/FirebaseNotificationService.java New service for sending notifications, updating, and retrieving Firebase tokens.
src/main/java/com/iemr/common/model/notification/NotificationMessage.java
src/main/java/com/iemr/common/model/notification/UserToken.java
New model classes for notification message and user token.
src/main/java/com/iemr/common/data/userToken/UserTokenData.java New JPA entity for user token storage.
src/main/java/com/iemr/common/repo/userToken/UserTokenRepo.java New Spring Data repository for user token entity.
src/main/java/com/iemr/common/controller/beneficiaryConsent/BeneficiaryConsentController.java New REST controller for beneficiary consent OTP operations.
src/main/java/com/iemr/common/data/beneficiaryConsent/BeneficiaryConsentRequest.java New DTO for beneficiary consent OTP requests.
src/main/java/com/iemr/common/service/beneficiaryOTPHandler/BeneficiaryOTPHandler.java
src/main/java/com/iemr/common/service/beneficiaryOTPHandler/BeneficiaryOTPHandlerImpl.java
New interface and implementation for OTP send/validate/resend logic.
src/main/java/com/iemr/common/controller/dynamicForm/DynamicFormController.java New REST controller for dynamic form and module creation.
src/main/java/com/iemr/common/data/dynamic_from/FormEntity.java
src/main/java/com/iemr/common/data/dynamic_from/ModuleEntity.java
New JPA entities for dynamic forms and modules.
src/main/java/com/iemr/common/dto/dynamicForm/FormFieldDTO.java
src/main/java/com/iemr/common/dto/dynamicForm/FormTypeEntityDTO.java
src/main/java/com/iemr/common/dto/dynamicForm/ModuleEntityDTO.java
New DTOs for dynamic form field, form type, and module.
src/main/java/com/iemr/common/repository/dynamic_form/FormTypeRepository.java
src/main/java/com/iemr/common/repository/dynamic_form/ModuleRepository.java
New Spring Data repositories for dynamic form entities.
src/main/java/com/iemr/common/service/dynamicForm/FormTypeService.java
src/main/java/com/iemr/common/service/dynamicForm/ModuleService.java
New services for dynamic form and module operations.
src/main/java/com/iemr/common/dto/identity/CommonIdentityDTO.java
src/main/java/com/iemr/common/model/beneficiary/BeneficiaryModel.java
Added isConsent field to identity and beneficiary models.
src/main/java/com/iemr/common/controller/otp/OTPGateway.java Enhanced logging and OTP response check logic.
src/main/java/com/iemr/common/controller/users/IEMRAdminController.java Changed JWT user ID extraction method.
src/main/java/com/iemr/common/service/beneficiary/IdentityBeneficiaryServiceImpl.java Improved error handling and logging in identity response.
src/main/java/com/iemr/common/service/beneficiary/RegisterBenificiaryServiceImpl.java Set isConsent field on identity DTO from model.
src/main/java/com/iemr/common/utils/JwtUtil.java Refactored token validation; removed denylist; changed user ID extraction logic.
src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java
src/main/java/com/iemr/common/service/notification/NotificationService.java
Minor formatting changes (blank lines, no functional change).
src/main/java/com/iemr/common/CommonApplication.java Added Firebase-related imports (no logic change).

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant BeneficiaryConsentController
  participant BeneficiaryOTPHandlerImpl
  participant SMSGateway
  participant Cache

  Client->>BeneficiaryConsentController: POST /beneficiaryConsent/sendConsent
  BeneficiaryConsentController->>BeneficiaryOTPHandlerImpl: sendOTP(request)
  BeneficiaryOTPHandlerImpl->>Cache: Store OTP (encrypted)
  BeneficiaryOTPHandlerImpl->>SMSGateway: Send OTP SMS
  BeneficiaryOTPHandlerImpl-->>BeneficiaryConsentController: OTP send result
  BeneficiaryConsentController-->>Client: Response

  Client->>BeneficiaryConsentController: POST /beneficiaryConsent/validateConsent
  BeneficiaryConsentController->>BeneficiaryOTPHandlerImpl: validateOTP(request)
  BeneficiaryOTPHandlerImpl->>Cache: Retrieve OTP (encrypted)
  BeneficiaryOTPHandlerImpl-->>BeneficiaryConsentController: Validation result
  BeneficiaryConsentController-->>Client: Response
Loading
sequenceDiagram
  participant Client
  participant FirebaseNotificationController
  participant FirebaseNotificationService
  participant FirebaseMessaging

  Client->>FirebaseNotificationController: POST /firebaseNotification/sendNotification
  FirebaseNotificationController->>FirebaseNotificationService: sendNotification(message)
  FirebaseNotificationService->>FirebaseMessaging: send(message)
  FirebaseMessaging-->>FirebaseNotificationService: Send result
  FirebaseNotificationService-->>FirebaseNotificationController: Result
  FirebaseNotificationController-->>Client: Response
Loading
sequenceDiagram
  participant Client
  participant DynamicFormController
  participant ModuleService
  participant FormTypeService
  participant ModuleRepository
  participant FormTypeRepository

  Client->>DynamicFormController: POST /masterFrom/modules
  DynamicFormController->>ModuleService: save(moduleDTO)
  ModuleService->>ModuleRepository: save(moduleEntity)
  ModuleRepository-->>ModuleService: moduleEntity
  ModuleService-->>DynamicFormController: moduleEntity
  DynamicFormController-->>Client: moduleEntity

  Client->>DynamicFormController: POST /masterFrom/modules/{id}/form-types
  DynamicFormController->>FormTypeService: createFormType(moduleId, formTypeDTO)
  FormTypeService->>ModuleRepository: findById(moduleId)
  ModuleRepository-->>FormTypeService: moduleEntity
  FormTypeService->>FormTypeRepository: save(formEntity)
  FormTypeRepository-->>FormTypeService: formEntity
  FormTypeService-->>DynamicFormController: formEntity
  DynamicFormController-->>Client: formEntity
Loading

Possibly related PRs

  • PSMRI/Common-API#227: Adds Firebase Admin SDK, Firebase config, and notification integration—directly related to Firebase features in this PR.
  • PSMRI/Common-API#248: Similar Firebase integration, config, and controller/service additions as this PR.
  • PSMRI/Common-API#234: Introduces Firebase Admin SDK, configuration, and messaging setup, overlapping with this PR.

Suggested labels

enhancement

Suggested reviewers

  • ravishanigarapu
  • drtechie

Poem

A rabbit hopped through fields of code,
Bringing Firebase news to the common abode.
OTPs now bounce, dynamic forms bloom,
Notifications fly—no more digital gloom!
With tokens and beans, and DTOs too,
This patch is a meadow of features anew.
🐇✨


📜 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 46195c5 and c935f37.

📒 Files selected for processing (35)
  • pom.xml (1 hunks)
  • src/main/environment/common_ci.properties (1 hunks)
  • src/main/environment/common_docker.properties (1 hunks)
  • src/main/java/com/iemr/common/CommonApplication.java (3 hunks)
  • src/main/java/com/iemr/common/config/firebase/FirebaseMessagingConfig.java (1 hunks)
  • src/main/java/com/iemr/common/controller/beneficiaryConsent/BeneficiaryConsentController.java (1 hunks)
  • src/main/java/com/iemr/common/controller/dynamicForm/DynamicFormController.java (1 hunks)
  • src/main/java/com/iemr/common/controller/firebaseNotification/FirebaseNotificationController.java (1 hunks)
  • src/main/java/com/iemr/common/controller/otp/OTPGateway.java (2 hunks)
  • src/main/java/com/iemr/common/controller/users/IEMRAdminController.java (1 hunks)
  • src/main/java/com/iemr/common/data/beneficiaryConsent/BeneficiaryConsentRequest.java (1 hunks)
  • src/main/java/com/iemr/common/data/dynamic_from/FormEntity.java (1 hunks)
  • src/main/java/com/iemr/common/data/dynamic_from/ModuleEntity.java (1 hunks)
  • src/main/java/com/iemr/common/data/userToken/UserTokenData.java (1 hunks)
  • src/main/java/com/iemr/common/dto/dynamicForm/FormFieldDTO.java (1 hunks)
  • src/main/java/com/iemr/common/dto/dynamicForm/FormTypeEntityDTO.java (1 hunks)
  • src/main/java/com/iemr/common/dto/dynamicForm/ModuleEntityDTO.java (1 hunks)
  • src/main/java/com/iemr/common/dto/identity/CommonIdentityDTO.java (1 hunks)
  • src/main/java/com/iemr/common/model/beneficiary/BeneficiaryModel.java (2 hunks)
  • src/main/java/com/iemr/common/model/notification/NotificationMessage.java (1 hunks)
  • src/main/java/com/iemr/common/model/notification/UserToken.java (1 hunks)
  • src/main/java/com/iemr/common/repo/userToken/UserTokenRepo.java (1 hunks)
  • src/main/java/com/iemr/common/repository/dynamic_form/FormTypeRepository.java (1 hunks)
  • src/main/java/com/iemr/common/repository/dynamic_form/ModuleRepository.java (1 hunks)
  • src/main/java/com/iemr/common/service/beneficiary/IdentityBeneficiaryServiceImpl.java (3 hunks)
  • src/main/java/com/iemr/common/service/beneficiary/RegisterBenificiaryServiceImpl.java (2 hunks)
  • src/main/java/com/iemr/common/service/beneficiaryOTPHandler/BeneficiaryOTPHandler.java (1 hunks)
  • src/main/java/com/iemr/common/service/beneficiaryOTPHandler/BeneficiaryOTPHandlerImpl.java (1 hunks)
  • src/main/java/com/iemr/common/service/dynamicForm/FormTypeService.java (1 hunks)
  • src/main/java/com/iemr/common/service/dynamicForm/ModuleService.java (1 hunks)
  • src/main/java/com/iemr/common/service/firebaseNotification/FirebaseNotificationService.java (1 hunks)
  • src/main/java/com/iemr/common/service/notification/NotificationService.java (1 hunks)
  • src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java (1 hunks)
  • src/main/java/com/iemr/common/utils/JwtUtil.java (1 hunks)
  • src/main/resources/application.properties (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@SauravBizbRolly SauravBizbRolly changed the base branch from develop to 3.3.0 July 4, 2025 11:16
@SauravBizbRolly SauravBizbRolly merged commit 4e52aa8 into PSMRI:3.3.0 Jul 4, 2025
4 checks passed
Copy link

sonarqubecloud bot commented Jul 4, 2025

Quality Gate Failed Quality Gate failed

Failed conditions
E Security Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

@coderabbitai coderabbitai bot mentioned this pull request Aug 28, 2025
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant