Skip to content

CORS Configuration for AMRIT API Services - #221

Merged
vishwab1 merged 11 commits into
developfrom
corsCheck
Jun 17, 2025
Merged

CORS Configuration for AMRIT API Services#221
vishwab1 merged 11 commits into
developfrom
corsCheck

Conversation

@vishwab1

@vishwab1 vishwab1 commented Jun 13, 2025

Copy link
Copy Markdown
Member

📋 Description

JIRA ID: AMM-1427

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 centralized configuration for cross-origin resource sharing (CORS), allowing customization of permitted origins and HTTP methods for all endpoints.
  • Refactor

    • Removed individual CORS annotations from all controllers to streamline and unify CORS management across the application.
    • Updated request filtering to dynamically apply CORS headers based on allowed origins configuration.
    • Adjusted filter registration order to prioritize CORS handling.
    • Enhanced JSON serialization for file management with improved formatting and null handling.
  • Bug Fixes

    • Ensured HTTP OPTIONS requests are handled correctly for CORS preflight, improving compatibility with cross-origin requests.

@coderabbitai

coderabbitai Bot commented Jun 13, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

This change centralizes CORS (Cross-Origin Resource Sharing) configuration by introducing a global CORS configuration class and removing all @CrossOrigin annotations from controller classes and methods. New CORS-related properties are added to configuration files, and the JWT filter is updated to allow HTTP OPTIONS requests to pass through without authentication checks.

Changes

Files/Groups Change Summary
src/main/environment/common_ci.properties, common_example.properties Added cors.allowed-origins property for CORS configuration.
src/main/java/com/iemr/common/config/CorsConfig.java Introduced new CorsConfig class implementing global CORS settings via WebMvcConfigurer.
All controller classes under src/main/java/com/iemr/common/controller/** Removed all @CrossOrigin annotations and related imports from controller classes and methods.
src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java Updated constructor to accept allowed origins; added logic to allow OPTIONS requests without JWT validation; minor log formatting fix.
src/main/java/com/iemr/common/utils/FilterConfig.java Injected cors.allowed-origins property and passed it to JwtUserIdValidationFilter constructor; set filter order explicitly.
src/main/java/com/iemr/common/data/kmfilemanager/KMFileManager.java Made some fields transient; rewrote toString() to use Gson with specific serialization settings.
src/main/java/com/iemr/common/controller/IEMRAdminController.java Removed @CrossOrigin annotations; changed service ID source in createUserMapping method.

Sequence Diagram(s)

sequenceDiagram
    participant Browser
    participant SpringApp
    participant CorsConfig
    participant JwtFilter
    participant Controller

    Browser->>SpringApp: OPTIONS /api/endpoint (preflight)
    SpringApp->>CorsConfig: Apply global CORS config
    CorsConfig-->>SpringApp: Set CORS headers
    SpringApp->>JwtFilter: Pass request
    JwtFilter-->>SpringApp: Allow OPTIONS, skip auth
    SpringApp-->>Browser: Respond with CORS headers

    Browser->>SpringApp: Actual request (GET/POST/...)
    SpringApp->>CorsConfig: Apply global CORS config
    CorsConfig-->>SpringApp: Set CORS headers
    SpringApp->>JwtFilter: Pass request
    JwtFilter->>SpringApp: Validate JWT
    SpringApp->>Controller: Handle request
    Controller-->>SpringApp: Return response
    SpringApp-->>Browser: Respond with data + CORS headers
Loading

Suggested reviewers

  • ravishanigarapu

Poem

In fields of code where rabbits hop,
CORS once grew in every crop.
Now one garden, neat and wide,
Keeps cross-origin rules inside.
OPTIONS requests may freely roam,
While controllers rest at home.
🥕 Cheers to tidy change, well done!


📜 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 c41c21f and 091249e.

📒 Files selected for processing (4)
  • src/main/java/com/iemr/common/controller/users/IEMRAdminController.java (1 hunks)
  • src/main/java/com/iemr/common/data/kmfilemanager/KMFileManager.java (1 hunks)
  • src/main/java/com/iemr/common/notification/agent/UserNotificationMappingController.java (0 hunks)
  • src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java (4 hunks)
💤 Files with no reviewable changes (1)
  • src/main/java/com/iemr/common/notification/agent/UserNotificationMappingController.java
✅ Files skipped from review due to trivial changes (1)
  • src/main/java/com/iemr/common/data/kmfilemanager/KMFileManager.java
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java
  • src/main/java/com/iemr/common/controller/users/IEMRAdminController.java
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Build
  • GitHub Check: Analyze (java)
  • GitHub Check: Package-test
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (2)
src/main/environment/common_example.properties (1)

205-206: Wildcard port pattern may not match as intended

http://localhost:* is accepted by Spring’s allowedOriginPatterns, but many developers expect “any port” to be expressed as http://localhost:[*]. Consider clarifying in a comment or documentation to avoid confusion.

src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java (1)

95-95: Minor log typo

"Common-API incoming userAget : ""Common-API incoming userAgent : "
Small, but fixing avoids noisy grep searches.

-logger.info("Common-API incoming userAget : " + userAgent);
+logger.info("Common-API incoming userAgent : " + userAgent);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d140c98 and 15ce2b0.

📒 Files selected for processing (45)
  • src/main/environment/common_ci.properties (1 hunks)
  • src/main/environment/common_example.properties (1 hunks)
  • src/main/java/com/iemr/common/config/CorsConfig.java (1 hunks)
  • src/main/java/com/iemr/common/controller/abdmfacility/AbdmFacilityController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/beneficiary/BeneficiaryRegistrationController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/brd/BRDIntegrationController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/callhandling/CallController.java (1 hunks)
  • src/main/java/com/iemr/common/controller/carestream/CareStreamCreateOrderController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/covid/CovidVaccinationController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/cti/ComputerTelephonyIntegrationController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/customization/CustomizationController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/directory/DirectoryController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/door_to_door_app/DoorToDoorAppController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/eausadha/EAusadhaController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/email/EmailController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/esanjeevani/ESanjeevaniController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/everwell/callhandle/EverwellCallController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/everwellTest/EverwellController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/feedback/FeedbackController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/helpline104history/Helpline104BeneficiaryHistoryController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/honeywell/HoneywellController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/institute/InstituteController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/kmfilemanager/KMFileManagerController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/language/LanguageController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/location/LocationController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/lonic/LonicController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/lungassessment/LungAssessmentController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/mctshistory/OutboundHistoryController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/nhmdashboard/NationalHealthMissionDashboardController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/notification/NotificationController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/otp/OTPGateway.java (0 hunks)
  • src/main/java/com/iemr/common/controller/questionconfig/QuestionTypeController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/questionconfig/QuestionnaireController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/report/CustomerRelationshipReports.java (0 hunks)
  • src/main/java/com/iemr/common/controller/scheme/SchemeController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/secondaryReport/CustomerRelationshipSecondaryReports.java (0 hunks)
  • src/main/java/com/iemr/common/controller/services/CategoryController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/services/CommonController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/sms/SMSController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/snomedct/SnomedController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/uptsu/UPTechnicalSupportController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/users/EmployeeSignatureController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/users/IEMRAdminController.java (0 hunks)
  • src/main/java/com/iemr/common/controller/version/VersionController.java (0 hunks)
  • src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java (2 hunks)
💤 Files with no reviewable changes (40)
  • src/main/java/com/iemr/common/controller/questionconfig/QuestionTypeController.java
  • src/main/java/com/iemr/common/controller/mctshistory/OutboundHistoryController.java
  • src/main/java/com/iemr/common/controller/services/CategoryController.java
  • src/main/java/com/iemr/common/controller/language/LanguageController.java
  • src/main/java/com/iemr/common/controller/questionconfig/QuestionnaireController.java
  • src/main/java/com/iemr/common/controller/helpline104history/Helpline104BeneficiaryHistoryController.java
  • src/main/java/com/iemr/common/controller/snomedct/SnomedController.java
  • src/main/java/com/iemr/common/controller/uptsu/UPTechnicalSupportController.java
  • src/main/java/com/iemr/common/controller/lonic/LonicController.java
  • src/main/java/com/iemr/common/controller/kmfilemanager/KMFileManagerController.java
  • src/main/java/com/iemr/common/controller/eausadha/EAusadhaController.java
  • src/main/java/com/iemr/common/controller/lungassessment/LungAssessmentController.java
  • src/main/java/com/iemr/common/controller/location/LocationController.java
  • src/main/java/com/iemr/common/controller/abdmfacility/AbdmFacilityController.java
  • src/main/java/com/iemr/common/controller/esanjeevani/ESanjeevaniController.java
  • src/main/java/com/iemr/common/controller/secondaryReport/CustomerRelationshipSecondaryReports.java
  • src/main/java/com/iemr/common/controller/email/EmailController.java
  • src/main/java/com/iemr/common/controller/version/VersionController.java
  • src/main/java/com/iemr/common/controller/services/CommonController.java
  • src/main/java/com/iemr/common/controller/door_to_door_app/DoorToDoorAppController.java
  • src/main/java/com/iemr/common/controller/feedback/FeedbackController.java
  • src/main/java/com/iemr/common/controller/brd/BRDIntegrationController.java
  • src/main/java/com/iemr/common/controller/scheme/SchemeController.java
  • src/main/java/com/iemr/common/controller/users/IEMRAdminController.java
  • src/main/java/com/iemr/common/controller/nhmdashboard/NationalHealthMissionDashboardController.java
  • src/main/java/com/iemr/common/controller/everwellTest/EverwellController.java
  • src/main/java/com/iemr/common/controller/report/CustomerRelationshipReports.java
  • src/main/java/com/iemr/common/controller/directory/DirectoryController.java
  • src/main/java/com/iemr/common/controller/users/EmployeeSignatureController.java
  • src/main/java/com/iemr/common/controller/carestream/CareStreamCreateOrderController.java
  • src/main/java/com/iemr/common/controller/institute/InstituteController.java
  • src/main/java/com/iemr/common/controller/cti/ComputerTelephonyIntegrationController.java
  • src/main/java/com/iemr/common/controller/sms/SMSController.java
  • src/main/java/com/iemr/common/controller/everwell/callhandle/EverwellCallController.java
  • src/main/java/com/iemr/common/controller/otp/OTPGateway.java
  • src/main/java/com/iemr/common/controller/covid/CovidVaccinationController.java
  • src/main/java/com/iemr/common/controller/honeywell/HoneywellController.java
  • src/main/java/com/iemr/common/controller/notification/NotificationController.java
  • src/main/java/com/iemr/common/controller/customization/CustomizationController.java
  • src/main/java/com/iemr/common/controller/beneficiary/BeneficiaryRegistrationController.java
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: style-check / checkstyle
  • GitHub Check: Build
  • GitHub Check: Analyze (java)
  • GitHub Check: Package-test
🔇 Additional comments (2)
src/main/environment/common_ci.properties (1)

181-182: Property placeholder added – verify runtime substitution

The placeholder @CORS_ALLOWED_ORIGINS@ relies on external substitution (CI/helm). Make sure the deployment pipeline always populates this value; an empty string will break CorsConfig->.allowedOriginPatterns() and effectively block every origin.

src/main/java/com/iemr/common/controller/callhandling/CallController.java (1)

501-504: Unchanged logic flagged as modified – no action needed

The line appears only re-formatted; functional behavior is identical.

Comment thread src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java
Comment thread src/main/java/com/iemr/common/config/CorsConfig.java
@vishwab1

Copy link
Copy Markdown
Member Author

Success:
image

@vishwab1
vishwab1 requested review from drtechie and vanitha1822 June 13, 2025 05:28

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Nitpick comments (3)
src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java (3)

41-48: Expose full CORS header set & cache pre-flight response

Access-Control-Max-Age and Access-Control-Expose-Headers are missing.
Without them browsers will re-issue pre-flights on every request and some
non-simple headers won’t be available to JS.

 response.setHeader("Access-Control-Allow-Credentials", "true");
+response.setHeader("Access-Control-Expose-Headers",
+                   "Authorization, Jwttoken, Location");
+response.setHeader("Access-Control-Max-Age", "3600");

Optional but recommended for better UX and reduced latency.


109-109: Typo in log message – userAget

-logger.info("Common-API incoming userAget : " + userAgent);
+logger.info("Common-API incoming userAgent : " + userAgent);

Minor, but helps when grepping logs.


127-136: isOriginAllowed does per-request regex compilation – cache patterns once

Splitting and transforming the pattern list on every request is avoidable GC
pressure. Pre-compile in the constructor:

-private final String allowedOrigins;
+private final List<Pattern> allowedOriginPatterns;

 // constructor
-this.allowedOrigins = allowedOrigins;
+this.allowedOriginPatterns = Arrays.stream(allowedOrigins.split(","))
+        .map(String::trim)
+        .map(p -> Pattern.compile(
+              p.replace(".", "\\.").replace("*", ".*")))
+        .collect(Collectors.toList());

Then isOriginAllowed simply iterates over the compiled list.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89c5602 and a048e52.

📒 Files selected for processing (2)
  • src/main/java/com/iemr/common/utils/FilterConfig.java (1 hunks)
  • src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Package-test
  • GitHub Check: Analyze (java)
  • GitHub Check: Build
🔇 Additional comments (1)
src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java (1)

49-53: OPTIONS branch should still invoke filterChain

Returning immediately prevents later filters (e.g., logging, metrics) and Spring
MVC from writing additional headers. Safer pattern:

-    response.setStatus(HttpServletResponse.SC_OK);
-    return;
+    response.setStatus(HttpServletResponse.SC_OK);
+    filterChain.doFilter(servletRequest, servletResponse);
+    return;

Keeps the fast-exit behaviour while preserving the normal filter pipeline.

Comment thread src/main/java/com/iemr/common/utils/FilterConfig.java
Comment thread src/main/java/com/iemr/common/utils/FilterConfig.java
Comment thread src/main/java/com/iemr/common/utils/JwtUserIdValidationFilter.java
drtechie
drtechie previously approved these changes Jun 13, 2025

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (2)
src/main/java/com/iemr/common/utils/FilterConfig.java (2)

12-14: Property still crashes the app if missing – previously flagged
Lack of a default value means the application will not start if cors.allowed-origins is absent in an environment. This was pointed out in an earlier review; the risk remains unchanged.


15-25: ⚠️ Potential issue

Filter now registered twice & runs before built-in CorsFilter
JwtUserIdValidationFilter is still annotated with @Component and manually registered here, so two instances are created.
By moving the registration bean to Ordered.HIGHEST_PRECEDENCE, it will now execute before Spring Boot’s auto-configured CorsFilter (which uses the same order). The final ordering between the two highest-precedence filters is undefined, which can:

• cause the JWT filter to run twice
• lead to CORS headers being written twice or overridden
• make OPTIONS requests bypass the built-in CORS handling altogether

Consider either

-@Component               // inside JwtUserIdValidationFilter
+// remove @Component – managed via FilterRegistrationBean only
...
-registrationBean.setOrder(Ordered.HIGHEST_PRECEDENCE);
+registrationBean.setOrder(Ordered.HIGHEST_PRECEDENCE + 1); // run immediately after CorsFilter

or drop the explicit registration and rely on component scanning to avoid duplication.

🧹 Nitpick comments (1)
src/main/java/com/iemr/common/utils/FilterConfig.java (1)

20-22: Pass a parsed collection instead of a raw comma-separated string
allowedOrigins is injected as a single String; the filter must parse it every request. Parsing once at config time and passing a Set<String> (or List<String>) would avoid repeated split operations and make intent clearer.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4594d05 and 9431d26.

📒 Files selected for processing (1)
  • src/main/java/com/iemr/common/utils/FilterConfig.java (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Package-test
  • GitHub Check: Analyze (java)
  • GitHub Check: Build

Comment thread src/main/environment/common_ci.properties Outdated
Comment thread src/main/java/com/iemr/common/controller/users/IEMRAdminController.java Outdated
@sonarqubecloud

Copy link
Copy Markdown

@vishwab1
vishwab1 merged commit 6c71e50 into develop Jun 17, 2025
7 checks passed
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.

3 participants