Development: Fix content-type of /.well-known/assetlinks.json

[FelberMartin]

Checklist

General

• I chose a title conforming to the naming conventions for pull requests.

Motivation and Context

This is a follow up to #9584, as the problem with deep links in the android app persists.

Description

I fixed the content type and allowed the google scrappers to access the URL.

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

Code Review

• Code Review 1
• Code Review 2

Summary by CodeRabbit

• New Features

  • Updated response type for the Android asset links endpoint to application/json for improved clarity.
  • Allowed web crawlers to access the .well-known directory in the robots.txt file.

• Bug Fixes

  • Ensured that existing disallow directives in robots.txt remain intact, maintaining proper access restrictions.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to two files. In the AndroidAppSiteAssociationResource.java, the getAndroidAssetLinks method's @GetMapping annotation is updated to specify that the response type is application/json. This enhances the clarity of the endpoint's expected response. Additionally, the robots.txt file is updated to allow web crawlers access to the .well-known directory, while existing restrictions on other paths remain unchanged.

Changes

File Path	Change Summary
src/main/java/de/tum/cit/aet/artemis/communication/web/AndroidAppSiteAssociationResource.java	Updated @GetMapping annotation in getAndroidAssetLinks method to include produces = "application/json".
src/main/webapp/robots.txt	Added Allow: /.well-known/ directive to permit access to the .well-known directory for web crawlers.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    Client->>Server: GET /assetlinks.json
    Server->>Server: Validate androidAppPackage and sha256CertFingerprints
    alt Valid
        Server-->>Client: 200 OK with AndroidAssetLinksEntry list
    else Invalid
        Server-->>Client: 404 Not Found
    end

Loading

---

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

🧹 Outside diff range and nitpick comments (2)

src/main/webapp/robots.txt (1)

12-12: LGTM! Consider adding a comment for clarity.

The addition of Allow: /.well-known/ is correct and necessary for Android App Links verification. This will enable Google's crawler to access the assetlinks.json file while maintaining restrictions on sensitive paths.

Consider adding a comment above the Allow directive to document its purpose:

 Disallow: /v3/api-docs/
+# Allow Google Digital Asset Links crawler to verify Android App Links
 Allow: /.well-known/

src/main/java/de/tum/cit/aet/artemis/communication/web/AndroidAppSiteAssociationResource.java (1)

Line range hint 40-46: Consider enhancing debug logging for troubleshooting.

The current debug message could be more informative for troubleshooting deep link issues.

-            log.debug("Android Assetlinks information is not configured!");
+            log.debug("Android Assetlinks validation failed: package='{}', fingerprint length={}", 
+                androidAppPackage, 
+                sha256CertFingerprints != null ? sha256CertFingerprints.length() : 0);

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 998d6c0 and 6c48a1a.

📒 Files selected for processing (2)

• src/main/java/de/tum/cit/aet/artemis/communication/web/AndroidAppSiteAssociationResource.java (1 hunks)
• src/main/webapp/robots.txt (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/main/java/de/tum/cit/aet/artemis/communication/web/AndroidAppSiteAssociationResource.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/communication/web/AndroidAppSiteAssociationResource.java (1)

40-40: LGTM! Correct content-type specification for Digital Asset Links.

The addition of produces = "application/json" is crucial for proper Android app verification. This ensures the response has the correct Content-Type header, which is required by Google's Digital Asset Links protocol for app-website association verification.