4 Commits

Author SHA1 Message Date
Arik Jones
9341a51d09 fix multi-file output 2024-12-06 17:02:31 -06:00
Arik Jones
9e9ac903e4 remove maxdepth from tests 2024-12-06 15:19:12 -06:00
Arik Jones
645626f763 remove maxdepth from tests 2024-12-06 15:17:33 -06:00
tnypxl
02e39baf38 flatten scrape config to 'sites:'
* flatten scrape config to 'sites:'. Update unit tests and readme.
* remove check for file_extensions configuration. 
* show progress indication after 5 seconds.
* add documentation to functions
* fix: remove MaxDepth and link extraction functionality
* fix: Remove MaxDepth references from cmd/web.go
2024-10-14 16:09:58 -05:00
6 changed files with 203 additions and 140 deletions

View File

@@ -33,7 +33,7 @@ var webCmd = &cobra.Command{
func init() { func init() {
webCmd.Flags().StringSliceVarP(&urls, "urls", "u", []string{}, "URLs of the webpages to scrape (comma-separated)") webCmd.Flags().StringSliceVarP(&urls, "urls", "u", []string{}, "URLs of the webpages to scrape (comma-separated)")
webCmd.Flags().StringVarP(&outputType, "output", "o", "single", "Output type: 'single' for one file, 'separate' for multiple files") webCmd.Flags().StringVarP(&outputType, "output", "o", "", "Output type: 'single' for one file, 'separate' for multiple files")
webCmd.Flags().StringVar(&includeSelector, "css", "", "CSS selector to extract specific content") webCmd.Flags().StringVar(&includeSelector, "css", "", "CSS selector to extract specific content")
webCmd.Flags().StringSliceVar(&excludeSelectors, "exclude", []string{}, "CSS selectors to exclude from the extracted content (comma-separated)") webCmd.Flags().StringSliceVar(&excludeSelectors, "exclude", []string{}, "CSS selectors to exclude from the extracted content (comma-separated)")
} }
@@ -58,7 +58,6 @@ func runWeb(cmd *cobra.Command, args []string) error {
ExcludeSelectors: site.ExcludeSelectors, ExcludeSelectors: site.ExcludeSelectors,
AllowedPaths: site.AllowedPaths, AllowedPaths: site.AllowedPaths,
ExcludePaths: site.ExcludePaths, ExcludePaths: site.ExcludePaths,
OutputAlias: site.OutputAlias,
PathOverrides: convertPathOverrides(site.PathOverrides), PathOverrides: convertPathOverrides(site.PathOverrides),
} }
logger.Printf("Site %d configuration: BaseURL=%s, CSSLocator=%s, AllowedPaths=%v", logger.Printf("Site %d configuration: BaseURL=%s, CSSLocator=%s, AllowedPaths=%v",
@@ -132,7 +131,7 @@ func runWeb(cmd *cobra.Command, args []string) error {
} }
}() }()
scrapedContent, err := scraper.ScrapeSites(scraperConfig) err := scraper.ScrapeSites(scraperConfig)
done <- true done <- true
fmt.Println() // New line after progress indicator fmt.Println() // New line after progress indicator
@@ -140,15 +139,9 @@ func runWeb(cmd *cobra.Command, args []string) error {
logger.Printf("Error occurred during scraping: %v", err) logger.Printf("Error occurred during scraping: %v", err)
return fmt.Errorf("error scraping content: %v", err) return fmt.Errorf("error scraping content: %v", err)
} }
logger.Printf("Scraping completed. Total content scraped: %d", len(scrapedContent)) logger.Println("Scraping completed")
if outputType == "single" { return nil
logger.Println("Writing content to a single file")
return writeSingleFile(scrapedContent)
} else {
logger.Println("Writing content to multiple files")
return writeMultipleFiles(scrapedContent)
}
} }
func writeSingleFile(content map[string]string) error { func writeSingleFile(content map[string]string) error {

View File

@@ -2,7 +2,7 @@ package cmd
import ( import (
"testing" "testing"
"strings"
"github.com/tnypxl/rollup/internal/config" "github.com/tnypxl/rollup/internal/config"
) )
@@ -67,9 +67,9 @@ func TestSanitizeFilename(t *testing.T) {
func TestGetFilenameFromContent(t *testing.T) { func TestGetFilenameFromContent(t *testing.T) {
tests := []struct { tests := []struct {
content string content string
url string url string
expected string expected string
expectErr bool expectErr bool
}{ }{
{"<title>Test Page</title>", "http://example.com", "Test_Page.rollup.md", false}, {"<title>Test Page</title>", "http://example.com", "Test_Page.rollup.md", false},
@@ -102,53 +102,3 @@ func TestGetFilenameFromContent(t *testing.T) {
func mockExtractAndConvertContent(urlStr string) (string, error) { func mockExtractAndConvertContent(urlStr string) (string, error) {
return "Mocked content for " + urlStr, nil return "Mocked content for " + urlStr, nil
} }
func mockExtractLinks() ([]string, error) {
return []string{"http://example.com/link1", "http://example.com/link2"}, nil
}
func TestScrapeURL(t *testing.T) {
// Store the original functions
originalExtractAndConvertContent := testExtractAndConvertContent
originalExtractLinks := testExtractLinks
// Define mock functions
testExtractAndConvertContent = func(urlStr string) (string, error) {
return "Mocked content for " + urlStr, nil
}
testExtractLinks = func(urlStr string) ([]string, error) {
return []string{"http://example.com/link1", "http://example.com/link2"}, nil
}
// Defer the restoration of original functions
defer func() {
testExtractAndConvertContent = originalExtractAndConvertContent
testExtractLinks = originalExtractLinks
}()
tests := []struct {
url string
depth int
expectedCalls int
}{
{"http://example.com", 0, 1},
{"http://example.com", 1, 3},
{"http://example.com", 2, 3}, // Same as depth 1 because our mock only returns 2 links
}
for _, test := range tests {
visited := make(map[string]bool)
content, err := scrapeURL(test.url, test.depth, visited)
if err != nil {
t.Errorf("scrapeURL(%q, %d) returned error: %v", test.url, test.depth, err)
continue
}
if len(visited) != test.expectedCalls {
t.Errorf("scrapeURL(%q, %d) made %d calls, expected %d", test.url, test.depth, len(visited), test.expectedCalls)
}
expectedContent := "Mocked content for " + test.url
if !strings.Contains(content, expectedContent) {
t.Errorf("scrapeURL(%q, %d) content doesn't contain %q", test.url, test.depth, expectedContent)
}
}
}

View File

@@ -48,8 +48,8 @@ type SiteConfig struct {
// ExcludePaths lists paths that should not be scraped // ExcludePaths lists paths that should not be scraped
ExcludePaths []string `yaml:"exclude_paths"` ExcludePaths []string `yaml:"exclude_paths"`
// OutputAlias provides an alternative name for output files // FileNamePrefix provides the base name for output files
OutputAlias string `yaml:"output_alias"` FileNamePrefix string `yaml:"file_name_prefix"`
// PathOverrides allows for path-specific configurations // PathOverrides allows for path-specific configurations
PathOverrides []PathOverride `yaml:"path_overrides"` PathOverrides []PathOverride `yaml:"path_overrides"`

View File

@@ -27,7 +27,7 @@ sites:
- "/blog" - "/blog"
exclude_paths: exclude_paths:
- "/admin" - "/admin"
output_alias: "example" file_name_prefix: "example"
path_overrides: path_overrides:
- path: "/special" - path: "/special"
css_locator: ".special-content" css_locator: ".special-content"
@@ -69,10 +69,9 @@ burst_limit: 5
BaseURL: "https://example.com", BaseURL: "https://example.com",
CSSLocator: "main", CSSLocator: "main",
ExcludeSelectors: []string{".ads"}, ExcludeSelectors: []string{".ads"},
MaxDepth: 2,
AllowedPaths: []string{"/blog"}, AllowedPaths: []string{"/blog"},
ExcludePaths: []string{"/admin"}, ExcludePaths: []string{"/admin"},
OutputAlias: "example", FileNamePrefix: "example",
PathOverrides: []PathOverride{ PathOverrides: []PathOverride{
{ {
Path: "/special", Path: "/special",
@@ -103,7 +102,7 @@ func TestValidate(t *testing.T) {
config: Config{ config: Config{
FileExtensions: []string{".go"}, FileExtensions: []string{".go"},
Sites: []SiteConfig{ Sites: []SiteConfig{
{BaseURL: "https://example.com", MaxDepth: 2}, {BaseURL: "https://example.com"},
}, },
}, },
wantErr: false, wantErr: false,
@@ -141,7 +140,7 @@ func TestValidate(t *testing.T) {
name: "Negative max depth", name: "Negative max depth",
config: Config{ config: Config{
FileExtensions: []string{".go"}, FileExtensions: []string{".go"},
Sites: []SiteConfig{{BaseURL: "https://example.com", MaxDepth: -1}}, Sites: []SiteConfig{{BaseURL: "https://example.com"}},
}, },
wantErr: true, wantErr: true,
}, },

View File

@@ -8,6 +8,7 @@ import (
"math/rand" "math/rand"
"net/url" "net/url"
"os" "os"
"path/filepath"
"regexp" "regexp"
"strings" "strings"
"sync" "sync"
@@ -47,7 +48,7 @@ type SiteConfig struct {
ExcludeSelectors []string ExcludeSelectors []string
AllowedPaths []string AllowedPaths []string
ExcludePaths []string ExcludePaths []string
OutputAlias string FileNamePrefix string
PathOverrides []PathOverride PathOverrides []PathOverride
} }
@@ -58,16 +59,18 @@ type PathOverride struct {
ExcludeSelectors []string ExcludeSelectors []string
} }
func ScrapeSites(config Config) (map[string]string, error) { func ScrapeSites(config Config) error {
logger.Println("Starting ScrapeSites function - Verbose mode is active") logger.Println("Starting ScrapeSites function - Verbose mode is active")
results := make(chan struct { results := make(chan struct {
url string url string
content string content string
site SiteConfig // Add site config to track which site the content came from
err error err error
}) })
limiter := rate.NewLimiter(rate.Limit(config.Scrape.RequestsPerSecond), config.Scrape.BurstLimit) limiter := rate.NewLimiter(rate.Limit(config.Scrape.RequestsPerSecond), config.Scrape.BurstLimit)
logger.Printf("Rate limiter configured with %f requests per second and burst limit of %d\n", config.Scrape.RequestsPerSecond, config.Scrape.BurstLimit) logger.Printf("Rate limiter configured with %f requests per second and burst limit of %d\n",
config.Scrape.RequestsPerSecond, config.Scrape.BurstLimit)
var wg sync.WaitGroup var wg sync.WaitGroup
totalURLs := 0 totalURLs := 0
@@ -91,71 +94,73 @@ func ScrapeSites(config Config) (map[string]string, error) {
logger.Println("All goroutines completed, results channel closed") logger.Println("All goroutines completed, results channel closed")
}() }()
scrapedContent := make(map[string]string) // Use a map that includes site configuration
scrapedContent := make(map[string]struct {
content string
site SiteConfig
})
for result := range results { for result := range results {
if result.err != nil { if result.err != nil {
logger.Printf("Error scraping %s: %v\n", result.url, result.err) logger.Printf("Error scraping %s: %v\n", result.url, result.err)
continue continue
} }
logger.Printf("Successfully scraped content from %s (length: %d)\n", result.url, len(result.content)) logger.Printf("Successfully scraped content from %s (length: %d)\n",
scrapedContent[result.url] = result.content result.url, len(result.content))
scrapedContent[result.url] = struct {
content string
site SiteConfig
}{
content: result.content,
site: result.site,
}
} }
logger.Printf("Total URLs processed: %d\n", totalURLs) logger.Printf("Total URLs processed: %d\n", totalURLs)
logger.Printf("Successfully scraped content from %d URLs\n", len(scrapedContent)) logger.Printf("Successfully scraped content from %d URLs\n", len(scrapedContent))
return scrapedContent, nil return SaveToFiles(scrapedContent, config)
} }
func scrapeSingleURL(url string, site SiteConfig, results chan<- struct { func scrapeSingleURL(url string, site SiteConfig, results chan<- struct {
url string url string
content string content string
site SiteConfig
err error err error
}, limiter *rate.Limiter, }, limiter *rate.Limiter) {
) {
logger.Printf("Starting to scrape URL: %s\n", url) logger.Printf("Starting to scrape URL: %s\n", url)
// Wait for rate limiter before making the request
err := limiter.Wait(context.Background()) err := limiter.Wait(context.Background())
if err != nil { if err != nil {
logger.Printf("Rate limiter error for %s: %v\n", url, err)
results <- struct { results <- struct {
url string url string
content string content string
site SiteConfig
err error err error
}{url, "", fmt.Errorf("rate limiter error: %v", err)} }{url, "", site, fmt.Errorf("rate limiter error: %v", err)}
return return
} }
cssLocator, excludeSelectors := getOverrides(url, site) cssLocator, excludeSelectors := getOverrides(url, site)
logger.Printf("Using CSS locator for %s: %s\n", url, cssLocator)
logger.Printf("Exclude selectors for %s: %v\n", url, excludeSelectors)
content, err := scrapeURL(url, cssLocator, excludeSelectors) content, err := scrapeURL(url, cssLocator, excludeSelectors)
if err != nil { if err != nil {
logger.Printf("Error scraping %s: %v\n", url, err)
results <- struct { results <- struct {
url string url string
content string content string
site SiteConfig
err error err error
}{url, "", err} }{url, "", site, err}
return return
} }
if content == "" {
logger.Printf("Warning: Empty content scraped from %s\n", url)
} else {
logger.Printf("Successfully scraped content from %s (length: %d)\n", url, len(content))
}
results <- struct { results <- struct {
url string url string
content string content string
site SiteConfig
err error err error
}{url, content, nil} }{url, content, site, nil}
} }
func isAllowedURL(urlStr string, site SiteConfig) bool { func isAllowedURL(urlStr string, site SiteConfig) bool {
parsedURL, err := url.Parse(urlStr) parsedURL, err := url.Parse(urlStr)
if err != nil { if err != nil {
@@ -228,9 +233,14 @@ func getFilenameFromContent(content, url string) string {
} }
func sanitizeFilename(name string) string { func sanitizeFilename(name string) string {
// Remove any character that isn't alphanumeric, dash, or underscore // Replace all non-alphanumeric characters with dashes
reg, _ := regexp.Compile("[^a-zA-Z0-9-_]+") reg := regexp.MustCompile("[^a-zA-Z0-9]+")
return reg.ReplaceAllString(name, "_") name = reg.ReplaceAllString(name, "-")
// Remove any leading or trailing dashes
name = strings.Trim(name, "-")
// Collapse multiple consecutive dashes into one
reg = regexp.MustCompile("-+")
return reg.ReplaceAllString(name, "-")
} }
// URLConfig holds configuration for a single URL // URLConfig holds configuration for a single URL
@@ -238,7 +248,7 @@ type URLConfig struct {
URL string URL string
CSSLocator string CSSLocator string
ExcludeSelectors []string ExcludeSelectors []string
OutputAlias string FileNamePrefix string
} }
// SetupLogger initializes the logger based on the verbose flag // SetupLogger initializes the logger based on the verbose flag
@@ -266,7 +276,7 @@ func InitPlaywright() error {
return fmt.Errorf("could not start Playwright: %v", err) return fmt.Errorf("could not start Playwright: %v", err)
} }
userAgent := "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" userAgent := "Mozilla/5.0 (Linux; Android 15; Pixel 9 Build/AP3A.241105.008) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.6723.106 Mobile Safari/537.36 OPX/2.5"
browser, err = pw.Chromium.Launch(playwright.BrowserTypeLaunchOptions{ browser, err = pw.Chromium.Launch(playwright.BrowserTypeLaunchOptions{
Args: []string{fmt.Sprintf("--user-agent=%s", userAgent)}, Args: []string{fmt.Sprintf("--user-agent=%s", userAgent)},
@@ -299,6 +309,119 @@ func CloseBrowser() {
ClosePlaywright() ClosePlaywright()
} }
// SaveToFiles writes the scraped content to files based on output type
func SaveToFiles(content map[string]struct {
content string
site SiteConfig
}, config Config) error {
if config.OutputType == "" {
config.OutputType = "separate" // default to separate files if not specified
}
switch config.OutputType {
case "single":
if err := os.MkdirAll("output", 0755); err != nil {
return fmt.Errorf("failed to create output directory: %v", err)
}
var combined strings.Builder
for url, data := range content {
combined.WriteString(fmt.Sprintf("## %s\n\n", url))
combined.WriteString(data.content)
combined.WriteString("\n\n")
}
return os.WriteFile(filepath.Join("output", "combined.md"), []byte(combined.String()), 0644)
case "separate":
if err := os.MkdirAll("output", 0755); err != nil {
return fmt.Errorf("failed to create output directory: %v", err)
}
// Group content by site and path
contentBySitePath := make(map[string]map[string]string)
for urlStr, data := range content {
parsedURL, err := url.Parse(urlStr)
if err != nil {
logger.Printf("Warning: Could not parse URL %s: %v", urlStr, err)
continue
}
// Find matching allowed path for this URL
var matchingPath string
for _, path := range data.site.AllowedPaths {
if strings.HasPrefix(parsedURL.Path, path) {
matchingPath = path
break
}
}
if matchingPath == "" {
logger.Printf("Warning: No matching allowed path for URL %s", urlStr)
continue
}
siteKey := fmt.Sprintf("%s-%s", data.site.BaseURL, data.site.FileNamePrefix)
if contentBySitePath[siteKey] == nil {
contentBySitePath[siteKey] = make(map[string]string)
}
// Combine all content for the same path
if existing, exists := contentBySitePath[siteKey][matchingPath]; exists {
contentBySitePath[siteKey][matchingPath] = existing + "\n\n" + data.content
} else {
contentBySitePath[siteKey][matchingPath] = data.content
}
}
// Write files for each site and path
for siteKey, pathContent := range contentBySitePath {
for path, content := range pathContent {
parts := strings.SplitN(siteKey, "-", 2) // Split only on first hyphen
prefix := parts[1] // Get the FileNamePrefix part
if prefix == "" {
prefix = "doc" // default prefix if none specified
}
normalizedPath := NormalizePathForFilename(path)
if normalizedPath == "" {
normalizedPath = "index"
}
filename := filepath.Join("output", fmt.Sprintf("%s-%s.md",
prefix, normalizedPath))
// Ensure we don't have empty files
if strings.TrimSpace(content) == "" {
logger.Printf("Skipping empty content for path %s", path)
continue
}
if err := os.WriteFile(filename, []byte(content), 0644); err != nil {
return fmt.Errorf("failed to write file %s: %v", filename, err)
}
logger.Printf("Wrote content to %s", filename)
}
}
return nil
default:
return fmt.Errorf("unsupported output type: %s", config.OutputType)
}
}
// NormalizePathForFilename converts a URL path into a valid filename component
func NormalizePathForFilename(urlPath string) string {
// Remove leading/trailing slashes
path := strings.Trim(urlPath, "/")
// Replace all non-alphanumeric characters with dashes
reg := regexp.MustCompile("[^a-zA-Z0-9]+")
path = reg.ReplaceAllString(path, "-")
// Remove any leading or trailing dashes
path = strings.Trim(path, "-")
// Collapse multiple consecutive dashes into one
reg = regexp.MustCompile("-+")
path = reg.ReplaceAllString(path, "-")
return path
}
// FetchWebpageContent retrieves the content of a webpage using Playwright // FetchWebpageContent retrieves the content of a webpage using Playwright
func FetchWebpageContent(urlStr string) (string, error) { func FetchWebpageContent(urlStr string) (string, error) {
logger.Printf("Fetching webpage content for URL: %s\n", urlStr) logger.Printf("Fetching webpage content for URL: %s\n", urlStr)
@@ -337,7 +460,7 @@ func FetchWebpageContent(urlStr string) (string, error) {
} }
logger.Println("Waiting for body element") logger.Println("Waiting for body element")
bodyElement := page.Locator("body") bodyElement := page.Locator("body")
err = bodyElement.WaitFor(playwright.LocatorWaitForOptions{ err = bodyElement.WaitFor(playwright.LocatorWaitForOptions{
State: playwright.WaitForSelectorStateVisible, State: playwright.WaitForSelectorStateVisible,
@@ -443,8 +566,7 @@ func scrollPage(page playwright.Page) error {
previousHeight = currentHeight previousHeight = currentHeight
// Wait for a while before scrolling again // Wait for a while before scrolling again
} }
logger.Println("Scrolling back to top") logger.Println("Scrolling back to top")
@@ -458,7 +580,6 @@ func scrollPage(page playwright.Page) error {
return nil return nil
} }
// ExtractContentWithCSS extracts content from HTML using a CSS selector // ExtractContentWithCSS extracts content from HTML using a CSS selector
func ExtractContentWithCSS(content, includeSelector string, excludeSelectors []string) (string, error) { func ExtractContentWithCSS(content, includeSelector string, excludeSelectors []string) (string, error) {
logger.Printf("Extracting content with CSS selector: %s\n", includeSelector) logger.Printf("Extracting content with CSS selector: %s\n", includeSelector)

View File

@@ -3,8 +3,8 @@ package scraper
import ( import (
"io" "io"
"log" "log"
"net/http" // "net/http"
"net/http/httptest" // "net/http/httptest"
"reflect" "reflect"
"strings" "strings"
"testing" "testing"
@@ -143,39 +143,39 @@ This is a **test** paragraph.
} }
} }
func TestExtractLinks(t *testing.T) { // func TestExtractLinks(t *testing.T) {
// Initialize Playwright before running the test // // Initialize Playwright before running the test
if err := InitPlaywright(); err != nil { // if err := InitPlaywright(); err != nil {
t.Fatalf("Failed to initialize Playwright: %v", err) // t.Fatalf("Failed to initialize Playwright: %v", err)
} // }
defer ClosePlaywright() // defer ClosePlaywright()
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { // server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/html") // w.Header().Set("Content-Type", "text/html")
w.Write([]byte(` // w.Write([]byte(`
<html> // <html>
<body> // <body>
<a href="https://example.com/page1">Page 1</a> // <a href="https://example.com/page1">Page 1</a>
<a href="https://example.com/page2">Page 2</a> // <a href="https://example.com/page2">Page 2</a>
<a href="https://othersite.com">Other Site</a> // <a href="https://othersite.com">Other Site</a>
</body> // </body>
</html> // </html>
`)) // `))
})) // }))
defer server.Close() // defer server.Close()
links, err := ExtractLinks(server.URL) // links, err := ExtractLinks(server.URL)
if err != nil { // if err != nil {
t.Fatalf("ExtractLinks() returned error: %v", err) // t.Fatalf("ExtractLinks() returned error: %v", err)
} // }
expectedLinks := []string{ // expectedLinks := []string{
"https://example.com/page1", // "https://example.com/page1",
"https://example.com/page2", // "https://example.com/page2",
"https://othersite.com", // "https://othersite.com",
} // }
if !reflect.DeepEqual(links, expectedLinks) { // if !reflect.DeepEqual(links, expectedLinks) {
t.Errorf("ExtractLinks() = %v, want %v", links, expectedLinks) // t.Errorf("ExtractLinks() = %v, want %v", links, expectedLinks)
} // }
} // }