Development: Add CORS allowed-origin-patterns

[janthoXO]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) and too complex database calls.
• I strictly followed the principle of data economy for all database calls.
• I strictly followed the server coding and design guidelines.
• I documented the Java code using JavaDoc style.

Description

Fixes CORS so that configured allowed-origin-patterns are also accepted.
Furthermore adds the VSCode plugin origins to the CORS in application.yml

Steps for Testing

only Config changes so code reviews are appreciated

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Test Coverage

Screenshots

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Enhanced CORS filter configuration to support a broader range of allowed origins and patterns for API endpoints.

• Bug Fixes

  • Improved logic for registering the CORS filter to ensure proper handling of origin patterns.

@coderabbitai pause

[coderabbitai]

Walkthrough

The changes in the pull request focus on updating the CORS filter configuration in the WebConfigurer.java file. The method corsFilter() now includes an additional condition that checks if either config.getAllowedOrigins() or config.getAllowedOriginPatterns() is not empty. This enhancement broadens the criteria for CORS filter registration while not altering method signatures, class declarations, or public entities.

Changes

File	Change Summary
src/main/java/de/tum/cit/aet/artemis/core/config/WebConfigurer.java	Modified the corsFilter() method to include an additional condition for CORS filter registration, checking both allowed origins and allowed origin patterns.

Possibly related PRs

• Adjust cors config for VSCode Plugin #8784: The changes in this PR also modify the CORS filter configuration in WebConfigurer.java to include checks for both config.getAllowedOrigins() and config.getAllowedOriginPatterns(), directly relating to the updates made in the main PR.

Suggested reviewers

• SimonEntholzer
• florian-glombik
• krusche

---

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>, please review it.
  • 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 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 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 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 or @coderabbitai title anywhere in the PR title to generate the title automatically.

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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between b7a816e and 1ee4259.

⛔ Files ignored due to path filters (1)

• src/main/resources/config/application.yml is excluded by !**/*.yml

📒 Files selected for processing (1)

• src/main/java/de/tum/cit/aet/artemis/core/config/WebConfigurer.java (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/main/java/de/tum/cit/aet/artemis/core/config/WebConfigurer.java (1)

Pattern src/main/java/**/*.java: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports

[iyannsch]

Code LGTM, we should maybe test if the App etc are still able to fetch all their data

[janthoXO]

Code LGTM, we should maybe test if the App etc are still able to fetch all their data

yes that would be good. currently cors is disabled on production and testservers. so we need the cors adjustment on the test servers first

[SimonEntholzer]

Code lgtm. How could I test this locally?

[janthoXO]

Code lgtm. How could I test this locally?

its hard to test. basically you would need a second website with a different URL that makes requests to the server. and then you would set the allowed-origin-patterns in the application.yml

you could open up just any website and then in the inspect console do a fetch(localhost:8080/api/..., {method: POST}) and see if it throws an error. and if you then add the website in the application.yml as a pattern it should not throw an error anymore
or a curl like this curl -v --request OPTIONS 'http://localhost:8080/api/...' -H 'Origin: http://some.origin.here' -H 'Access-Control-Request-Method: GET'

[magaupp]

Code LGTM

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range comments (1)

src/main/java/de/tum/cit/aet/artemis/core/config/WebConfigurer.java (1)

Line range hint 121-126: LGTM! Consider extracting the condition for improved readability.

The changes effectively extend the CORS filter registration to include allowedOriginPatterns, which aligns with the PR objectives. The implementation adheres to the single responsibility principle and maintains simplicity. The use of CollectionUtils.isEmpty() is a good practice for null-safe empty checks.

To further improve code readability and adhere to the "small_methods" principle mentioned in the coding guidelines, consider extracting the condition into a separate method:

 @Bean
 public CorsFilter corsFilter() {
     UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
     CorsConfiguration config = jHipsterProperties.getCors();
-    if (!CollectionUtils.isEmpty(config.getAllowedOrigins()) || !CollectionUtils.isEmpty(config.getAllowedOriginPatterns())) {
+    if (shouldRegisterCorsFilter(config)) {
         log.debug("Registering CORS filter");
         source.registerCorsConfiguration("/api/**", config);
         source.registerCorsConfiguration("/management/**", config);
         source.registerCorsConfiguration("/v3/api-docs", config);
     }
     return new CorsFilter(source);
 }

+private boolean shouldRegisterCorsFilter(CorsConfiguration config) {
+    return !CollectionUtils.isEmpty(config.getAllowedOrigins()) || !CollectionUtils.isEmpty(config.getAllowedOriginPatterns());
+}

This refactoring improves readability while maintaining the functionality and adhering to the coding guidelines.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 6f99488 and a2e9e84.

📒 Files selected for processing (1)

• src/main/java/de/tum/cit/aet/artemis/core/config/WebConfigurer.java (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/main/java/de/tum/cit/aet/artemis/core/config/WebConfigurer.java (1)

Pattern src/main/java/**/*.java: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports

🔇 Additional comments (1)

src/main/java/de/tum/cit/aet/artemis/core/config/WebConfigurer.java (1)

27-27: LGTM! Appropriate import added for CollectionUtils.

The addition of import org.springframework.util.CollectionUtils; is correct and necessary for using the CollectionUtils.isEmpty() method in the corsFilter() method. This aligns with the coding guidelines to use appropriate utility classes.

[iyannsch]

Code LGTM as long as the origins are authentic

[magaupp]

Code LGTM

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

[SimonEntholzer]

lgtm

[eceeeren]

Code LGTM