UFAL/Filename encoding encodes the fileName with the rest of the URL

[milanmajchrak]

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

Check the issue.

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of filenames with spaces and query parameters in URLs to ensure filenames are correctly encoded and query parameters are preserved.

[coderabbitai]

Walkthrough

The parse method in BitstreamUrlSerializer was updated to correctly handle URLs with query parameters, ensuring that only the filename segment is percent-encoded and that query parameters remain intact. A new test case was added to verify this behavior, focusing on filenames with spaces and the preservation of query parameters.

Changes

File(s)	Change Summary
src/app/core/url-serializer/bitstream-url-serializer.ts	Updated parse method to split URL at '?', encode only the filename, and preserve query parameters.
src/app/core/url-serializer/bitstream-url-serializer.spec.ts	Added a test to verify correct filename encoding and query parameter preservation in /bitstream/ URLs.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant BitstreamUrlSerializer
    participant DefaultUrlSerializer

    Client->>BitstreamUrlSerializer: parse(url)
    BitstreamUrlSerializer->>BitstreamUrlSerializer: Split url at '?'
    BitstreamUrlSerializer->>BitstreamUrlSerializer: Encode filename segment
    BitstreamUrlSerializer->>BitstreamUrlSerializer: Reconstruct url with encoded filename + original query
    BitstreamUrlSerializer->>DefaultUrlSerializer: parse(reconstructed url)
    DefaultUrlSerializer-->>BitstreamUrlSerializer: UrlTree
    BitstreamUrlSerializer-->>Client: UrlTree

Loading

Possibly related PRs

• UFAL/Copy bitstream encoding name #851: Introduced the initial implementation of the parse method in BitstreamUrlSerializer and related tests, which this PR directly extends to handle query parameters.

Poem

🐇
A filename with spaces, a query in tow,
The serializer works, encoding just so.
Spaces to %20, the query kept neat,
URLs now parsed, a technical feat!
Hopping through code, I nibble with glee—
Another bug fixed, from confusion set free!

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

yarn install v1.22.22
[1/4] Resolving packages...
(node:20740) [DEP0169] DeprecationWarning: url.parse() behavior is not standardized and prone to errors that have security implications. Use the WHATWG URL API instead. CVEs are not issued for url.parse() vulnerabilities.
(Use node --trace-deprecation ... to show where the warning was created)
[2/4] Fetching packages...
error [email protected]: The engine "node" is incompatible with this module. Expected version "^14 || ^16 || ^17 || ^18 || ^19". Got "24.1.0"
error Found incompatible module.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

---

📜 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 adf59d5 and c680347.

📒 Files selected for processing (2)

• src/app/core/url-serializer/bitstream-url-serializer.spec.ts (1 hunks)
• src/app/core/url-serializer/bitstream-url-serializer.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/app/core/url-serializer/bitstream-url-serializer.ts (1)

src/app/shared/clarin-shared-util.ts (1)

• encodeRFC3986URIComponent (96-102)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: tests (16.x)
• GitHub Check: tests (18.x)
• GitHub Check: dspace-angular / docker-build (linux/amd64, ubuntu-latest, true)

🔇 Additional comments (5)

src/app/core/url-serializer/bitstream-url-serializer.ts (4)

15-16: LGTM: Proper separation of path and query components.

The destructuring assignment correctly splits the URL at the first '?' character, which is the standard separator between path and query string in URLs. The split('?') method only splits on the first occurrence, which is the correct behavior for URL parsing.

---

19-19: LGTM: Correctly processes only the path component.

This change ensures that only the path portion is split for filename processing, preventing query parameters from being included in the filename encoding logic.

---

21-21: LGTM: Proper filename reconstruction with forward slashes.

The change from joining with commas to joining with forward slashes is correct for file path reconstruction. This properly handles nested directory structures in filenames within the bitstream URL path.

---

24-28: LGTM: Clean path reconstruction and query string handling.

The implementation correctly:

• Uses spread syntax for clean array concatenation
• Reconstructs the path with the encoded filename
• Properly handles both cases (with and without query parameters) using a ternary operator
• Preserves the original query string without modification

src/app/core/url-serializer/bitstream-url-serializer.spec.ts (1)

44-53: LGTM: Comprehensive test for the query parameter fix.

This test case effectively validates the core fix by:

• Testing a filename with spaces that requires encoding (some file.pdf → some%20file.pdf)
• Including query parameters that should be preserved unchanged
• Verifying the complete round-trip parsing and serialization process
• Following the established testing pattern in the file

The test adequately covers the main use case that was problematic before the fix.

✨ 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

• 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.
  • 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.

[Copilot]

Pull Request Overview

This PR addresses improper URL encoding for filenames within bitstream URLs, ensuring that filenames with spaces and query parameters are correctly handled.

• Separates the URL's path and query string
• Encodes the filename with improved reconstruction of the URL
• Adds tests verifying the expected behavior

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
src/app/core/url-serializer/bitstream-url-serializer.ts	Updates URL parsing to separate the query string and properly encode the filename
src/app/core/url-serializer/bitstream-url-serializer.spec.ts	Adds tests ensuring filenames with spaces and query parameters are encoded correctly

Comments suppressed due to low confidence (2)

src/app/core/url-serializer/bitstream-url-serializer.ts:19

• [nitpick] Consider renaming 'parts' to 'pathSegments' to improve clarity about its contents.

const parts = path.split('/');

src/app/core/url-serializer/bitstream-url-serializer.ts:20

• [nitpick] Consider adding a brief comment to clarify the expected value of 'this.FILENAME_INDEX' for improved maintainability.

if (parts.length > this.FILENAME_INDEX) {