Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ufal/header value could have equals char #895

Merged
merged 2 commits into from
Mar 11, 2025

Conversation

milanmajchrak
Copy link
Collaborator

@milanmajchrak milanmajchrak commented Mar 11, 2025

Phases MP MM MB MR JM Total
ETA 0 0 0 0 0 0
Developing 0 0 0 0 0 0
Review 0 0 0 0 0 0
Total - - - - - 0
ETA est. 0
ETA cust. - - - - - 0

Problem description

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced the extraction of parameter values to prevent errors from unexpected input formats.
  • Tests
    • Updated test cases to ensure login parameters are correctly encoded during authentication redirects.

Copy link

coderabbitai bot commented Mar 11, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates two parts of the codebase. In the header parser, the initialise method now uses a limited split (split("=", 2)) to ensure that only two elements are returned, preventing errors when values contain additional equals signs. In the authentication tests, the formatted netid is wrapped in a call to URLEncoder.encode(...) using UTF-8 encoding so that the parameter is safely included in redirect URLs during authentication failure scenarios.

Changes

File(s) Summary
dspace-api/.../Headers.java Changed the initialise method to use split("=", 2), ensuring the key/value pair is correctly extracted even when the value contains extra "=" characters.
dspace-server-webapp/.../ClarinShibbolethLoginFilterIT.java Modified tests to wrap the formatted netid with URLEncoder.encode(...) (UTF-8) to ensure proper URL encoding in redirect URLs during authentication failures.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ClarinLoginFilter
    participant URLEncoder
    participant RedirectHandler

    Client->>ClarinLoginFilter: Send authentication request with netid
    ClarinLoginFilter->>URLEncoder: Format and encode netid
    URLEncoder-->>ClarinLoginFilter: Return encoded netid
    ClarinLoginFilter->>RedirectHandler: Build redirect URL with encoded netid
    RedirectHandler-->>Client: Return redirect response
Loading

Poem

Oh, how I hop through lines of code,
Splitting keys with a lighter load.
"=" signs dance in a clever split,
With encoded netid every bit fit.
A rabbit's cheer for change so neat,
Hopping along on paths so sweet!


📜 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 63e94b3 and 5ffb503.

📒 Files selected for processing (2)
  • dspace-api/src/main/java/org/dspace/authenticate/clarin/Headers.java (1 hunks)
  • dspace-server-webapp/src/test/java/org/dspace/app/rest/security/ClarinShibbolethLoginFilterIT.java (6 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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 generate docstrings to generate docstrings for 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.

@milanmajchrak milanmajchrak merged commit 0e29e10 into dtq-dev Mar 11, 2025
6 of 7 checks passed
milanmajchrak added a commit that referenced this pull request Mar 11, 2025
* Set limit when splitting key/value using `=`

* The IT should expect encoded netid in the URL
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