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

Fix domain list generation within public suffix #1823

Merged
merged 2 commits into from
Feb 27, 2025

Conversation

dhaavi
Copy link
Member

@dhaavi dhaavi commented Feb 26, 2025

Summary by CodeRabbit

  • New Features

    • Enhanced domain name processing to improve accuracy and reliability.
  • Tests

    • Introduced comprehensive tests to validate the functionality of the domain processing logic across various scenarios.

@dhaavi dhaavi requested a review from stenya February 26, 2025 12:13
Copy link
Contributor

coderabbitai bot commented Feb 26, 2025

📝 Walkthrough

Walkthrough

The pull request refactors the splitDomain function to enhance how domain strings are processed. The updated logic now trims any trailing period, retrieves the public suffix along with an indicator specifying if it’s a real top-level domain, and splits the domain into labels based on that suffix. It also builds a list of domain components up to the public suffix with an added condition for non-TLD public suffixes. Additionally, a new test file is introduced to validate the behavior of the function across several domain scenarios.

Changes

File Change Summary
service/intel/entity.go Refactored splitDomain to trim trailing periods, retrieve the public suffix with a TLD indicator, split the domain into labels, and build a domain list with conditional handling for public suffixes.
service/intel/entity_test.go Added tests for splitDomain covering various scenarios including registered domains, subdomains, TLDs, and public suffix domains.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant F as splitDomain
    participant S as Suffix Checker

    C->>F: Call splitDomain(domainString)
    F->>F: Trim trailing period from domainString
    F->>S: Retrieve public suffix & TLD indicator
    S-->>F: Return public suffix and flag
    F->>F: Compare domain to suffix and split into labels
    F->>F: Build domain list (append suffix if non-TLD)
    F-->>C: Return processed domain list
Loading

📜 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 83292d7 and 76c352d.

📒 Files selected for processing (1)
  • service/intel/entity_test.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • service/intel/entity_test.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test & Build

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
service/intel/entity.go (1)

408-410: Use strings.Split for better readability.

While the current implementation with FieldsFunc works correctly, using strings.Split would make the code more straightforward and readable.

- labels := strings.FieldsFunc(d[:len(d)-len(suffix)], func(r rune) bool {
-   return r == '.'
- })
+ parts := strings.Split(d[:len(d)-len(suffix)-1], ".")
+ labels := parts
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fdca991 and 83292d7.

📒 Files selected for processing (2)
  • service/intel/entity.go (1 hunks)
  • service/intel/entity_test.go (1 hunks)
🧰 Additional context used
🪛 golangci-lint (1.62.2)
service/intel/entity_test.go

26-26: Function TestSplitDomain missing the call to method parallel

(paralleltest)

🪛 GitHub Check: Linter
service/intel/entity_test.go

[failure] 26-26:
Function TestSplitDomain missing the call to method parallel

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test & Build
🔇 Additional comments (4)
service/intel/entity_test.go (1)

9-24: Test cases cover various domain patterns well.

The test cases effectively cover regular domains, subdomains, TLDs, and public suffix domains. Good job including trailing periods in the test cases to properly validate the function's handling of them.

service/intel/entity.go (3)

399-427: Improved domain splitting logic looks good.

The refactored splitDomain function now correctly:

  1. Handles trailing periods by trimming them first
  2. Properly identifies public suffixes and real TLDs
  3. Builds domain components more accurately
  4. Correctly handles non-TLD public suffixes by adding them to the list

The implementation fixes the domain list generation within public suffixes, which was the goal of this PR.


413-419: Efficient domain list generation.

The domain list generation logic is well-implemented with appropriate capacity pre-allocation and efficient string joining.


421-424: Good handling of non-TLD public suffixes.

Adding the public suffix to the list only when it's not a real TLD is a good approach to handle custom public suffixes like googleapis.com.

Comment on lines 26 to 31
func TestSplitDomain(t *testing.T) {
for _, testCase := range splitDomainTestCases {
splitted := splitDomain(testCase[0])
assert.Equal(t, testCase, splitted, "result must match")
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add t.Parallel() for better test performance.

Calling t.Parallel() at the beginning of your test function allows tests to run concurrently, which can significantly improve test execution time.

func TestSplitDomain(t *testing.T) {
+	t.Parallel()
	for _, testCase := range splitDomainTestCases {
		splitted := splitDomain(testCase[0])
		assert.Equal(t, testCase, splitted, "result must match")
	}
}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
func TestSplitDomain(t *testing.T) {
for _, testCase := range splitDomainTestCases {
splitted := splitDomain(testCase[0])
assert.Equal(t, testCase, splitted, "result must match")
}
}
func TestSplitDomain(t *testing.T) {
t.Parallel()
for _, testCase := range splitDomainTestCases {
splitted := splitDomain(testCase[0])
assert.Equal(t, testCase, splitted, "result must match")
}
}
🧰 Tools
🪛 golangci-lint (1.62.2)

26-26: Function TestSplitDomain missing the call to method parallel

(paralleltest)

🪛 GitHub Check: Linter

[failure] 26-26:
Function TestSplitDomain missing the call to method parallel

@dhaavi
Copy link
Member Author

dhaavi commented Feb 26, 2025

CI linter failed internally.

Copy link
Contributor

@stenya stenya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dhaavi dhaavi merged commit 7373b88 into develop Feb 27, 2025
4 of 6 checks passed
@dhaavi dhaavi deleted the fix/public-suffix-domain-list branch February 27, 2025 11:10
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.

2 participants