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 crawler skipping downloading components #87

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

BrandonClapp
Copy link

@BrandonClapp BrandonClapp commented Nov 17, 2024

Fixes #86

There are a couple of issues here

  1. The path is currently derived from the URL, which means that we get incorrect downstream paths like ./output/components/htmlhttps://tailwindui.com/components/application-ui/navigation/navbars when passing this path const.
  2. The downloader is skipping components because it's not parsing the correct segment of the URL. [4] instead of [2] here is what we need to parse the correct segment.

Summary by CodeRabbit

  • New Features

    • Improved accuracy in local path generation based on component URLs.
    • Enhanced component identification from URLs for better filtering.
  • Bug Fixes

    • Corrected the extraction of component names from URLs to align with the intended structure.

Copy link

codesandbox bot commented Nov 17, 2024

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link

coderabbitai bot commented Nov 17, 2024

Walkthrough

The changes in this pull request primarily focus on the processComponent function and the main execution block of the index.mjs script. Modifications include the adjustment of the path variable to accurately derive the local output path by removing the rootUrl from the url. Additionally, the extraction of the component variable from the URL has been corrected to access the fifth segment instead of the third, ensuring proper parsing of the component name. These adjustments enhance the accuracy of local path generation and component identification.

Changes

File Change Summary
index.mjs Modified processComponent to correctly derive local output path and updated the URL parsing logic to access the fifth segment for component extraction.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Script
    participant URL

    User->>Script: Execute script
    Script->>URL: Retrieve URL
    URL-->>Script: Provide URL
    Script->>Script: Process URL
    Script->>Script: Derive local path
    Script->>Script: Extract component name
    Script-->>User: Output results
Loading

🐇 "In the code where paths align,
A rabbit hops with joy divine.
From URLs, we now extract,
The components, clear and intact.
With every change, we leap and bound,
In code's embrace, new paths are found!" 🐇


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

@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

🧹 Outside diff range and nitpick comments (1)
index.mjs (1)

243-246: Consider using URL API for more robust path handling

While the current fix addresses the immediate path issue, consider using the URL API for more robust path handling:

- // Remove the rootUrl from the url to get the local path
- const localOutput = url.replace('https://tailwindui.com', '')
- const path = `${localOutput}/${filename}`
+ const urlObj = new URL(url)
+ const localOutput = urlObj.pathname
+ const path = _path.join(localOutput, filename)

This approach would:

  1. Handle URL encoding/decoding automatically
  2. Use the existing rootUrl constant instead of hardcoding
  3. Use proper path joining for cross-platform compatibility
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3fd4ff1 and 4e48dc0.

📒 Files selected for processing (1)
  • index.mjs (2 hunks)

Comment on lines +445 to +447
// Example URL: https://tailwindui.com/components/application-ui/navigation/navbars
// Parse out "application-ui" | "marketing" | "ecommerce" from the URL to ensure we only download the components we want
const component = url.split('/')[4]
Copy link

@coderabbitai coderabbitai bot Nov 17, 2024

Choose a reason for hiding this comment

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

💡 Codebase verification

⚠️ The URL parsing index is incorrect and needs to be fixed

The current implementation uses index [4] to extract the component type from URLs like "https://tailwindui.com/components/application-ui/navigation/navbars", but this is incorrect:

0: "https:"
1: ""
2: "tailwindui.com"
3: "components"
4: "application-ui"  // Current implementation uses this

The code should be using index [3] since "components" is at index [3], not the component type. This contradicts the comment's intention to extract "application-ui", "marketing", or "ecommerce".

🔗 Analysis chain

LGTM! Verify component filtering across all URL patterns

The fix correctly extracts the component type from the URL structure. The added comment clearly documents the expected URL format.

Let's verify that all component URLs in the codebase follow this structure:


Let me verify the URL patterns more thoroughly by checking the actual code context where these URLs are used.


Let me check the actual implementation to verify if the index [4] is correct for the URL structure.


Let me fix the regex and try again.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify URL patterns for component extraction
# Expected format: /components/<component-type>/...

# Search for all component URLs in the codebase
rg -o '/components/[^"'\'')\s]+' | while read -r url; do
  # Extract and verify the component type (should be application-ui, marketing, or ecommerce)
  component_type=$(echo "$url" | cut -d'/' -f3)
  echo "URL: $url"
  echo "Component type: $component_type"
  case "$component_type" in
    "application-ui"|"marketing"|"ecommerce")
      echo "✓ Valid component type"
      ;;
    *)
      echo "⚠ Unexpected component type"
      ;;
  esac
  echo "---"
done

Length of output: 473


Script:

#!/bin/bash
# Get more context around the URL patterns
rg -B 3 -A 3 "components/[^\"'\s)]+" 

Length of output: 538


Script:

#!/bin/bash
# Get the full URL validation and parsing logic
rg -B 5 -A 10 "url\.split\('\/'\)\[4\]"

Length of output: 150


Script:

#!/bin/bash
# Get the full URL validation and parsing logic
rg -B 5 -A 10 'split.*\[4\]'

Length of output: 855

Copy link

Choose a reason for hiding this comment

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

AI suggestion is wrong.

Copy link

Choose a reason for hiding this comment

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

@andyw8, thank you for pointing that out. I apologize for the mistake in my previous suggestion. I'll make sure to verify the URL parsing logic more carefully in future reviews.


✏️ Learnings added
Learnt from: andyw8
PR: kiliman/tailwindui-crawler#87
File: index.mjs:445-447
Timestamp: 2024-12-01T16:54:57.688Z
Learning: In `index.mjs`, when parsing component URLs like `https://tailwindui.com/components/application-ui/navigation/navbars`, the correct index to extract the component type (e.g., "application-ui", "marketing", "ecommerce") from `url.split('/')` is `[4]`.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

@andyw8
Copy link

andyw8 commented Dec 1, 2024

Thanks for looking into this. I tried out your branch and noticed an issue with the preview directory:

Screenshot 2024-12-01 at 1 14 40 PM

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.

Components not crawling
2 participants