fiber icon indicating copy to clipboard operation
fiber copied to clipboard

πŸ› fix: Subdomains offset handling

Open gaby opened this issue 7 months ago β€’ 2 comments

Summary

  • handle negative subdomain offsets gracefully
  • handle ports in domains
  • update docs
  • add more test cases

gaby avatar May 31 '25 16:05 gaby

Walkthrough

The logic of the Subdomains method in DefaultCtx was updated to return an empty slice when the offset is negative or exceeds the number of subdomain parts. The method now uses Hostname() to exclude ports before splitting. Tests were expanded to cover various offset values, including zero, negative, and offsets larger than the subdomain count, as well as hosts with ports. Documentation was revised to clarify behavior and provide detailed examples.

Changes

File(s) Change Summary
ctx.go Rewrote Subdomains method to return empty slice for negative or excessive offsets; use Hostname() to exclude ports.
ctx_test.go Refactored Test_Ctx_Subdomains to table-driven tests covering multiple offset scenarios, including edge cases and hosts with ports.
docs/api/ctx.md Updated Subdomains method documentation to clarify offset behavior with detailed table and corrected examples; minor edits to Download method docs.

Sequence Diagram(s)

sequenceDiagram
    participant Test
    participant DefaultCtx

    Test->>DefaultCtx: Subdomains(offset)
    alt offset < 0 or offset β‰₯ subdomain count
        DefaultCtx-->>Test: []
    else if offset == 0
        DefaultCtx-->>Test: all subdomain parts
    else
        DefaultCtx-->>Test: subdomain parts excluding last offset labels
    end

Suggested labels

πŸ“’ Documentation

Suggested reviewers

  • ReneWerner87
  • sixcolors
  • efectn

Poem

πŸ‡
When offsets fall below the line,
Empty slices now align.
Ports trimmed off, the dots divide,
Subdomains clear, no place to hide.
Tests hop in with cases brightβ€”
Code refined, all running right! πŸ₯•


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[bot] avatar May 31 '25 16:05 coderabbitai[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.84%. Comparing base (9409e4f) to head (3081184). Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3495      +/-   ##
==========================================
- Coverage   83.87%   83.84%   -0.04%     
==========================================
  Files         120      120              
  Lines       12272    12278       +6     
==========================================
+ Hits        10293    10294       +1     
- Misses       1555     1559       +4     
- Partials      424      425       +1     
Flag Coverage Ξ”
unittests 83.84% <100.00%> (-0.04%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar May 31 '25 16:05 codecov[bot]

@gaby check markdown lint

ReneWerner87 avatar Jun 04 '25 06:06 ReneWerner87