24 Commits

Author SHA1 Message Date
333b9a366c fix: Resolve playwright function deprecations and io/ioutil function deprecations. 2024-09-24 15:13:36 -05:00
Arik Jones (aider)
1869dae89a docs: update configuration section in README.md 2024-09-22 18:36:17 -05:00
Arik Jones (aider)
d3ff7cb862 docs: Update README.md CLI flag documentation 2024-09-22 18:33:24 -05:00
Arik Jones (aider)
ea410e4abb feat: Update README.md to reflect recent changes in functionality 2024-09-22 18:31:06 -05:00
Arik Jones (aider)
7d8e25b1ad docs: Add CHANGELOG.md with v0.0.3 release notes 2024-09-22 18:20:25 -05:00
Arik Jones
691832e282 fix: Update expectation 2024-09-22 18:18:03 -05:00
Arik Jones (aider)
31e0fa5ea4 fix: Remove redeclaration of cfg variable in cmd/root.go 2024-09-22 17:07:57 -05:00
Arik Jones (aider)
71f63ddaa8 fix: resolve undefined config variable in cmd/files.go 2024-09-22 17:07:32 -05:00
Arik Jones (aider)
574800c241 fix: Update runRollup function to accept config parameter 2024-09-22 17:06:18 -05:00
Arik Jones (aider)
d5a94f5468 fix: remove indentation while preserving HTML structure in ExtractContentWithCSS 2024-09-22 17:00:16 -05:00
Arik Jones (aider)
59994c085c fix: improve file ignore logic and preserve newlines in extracted content 2024-09-22 16:58:53 -05:00
Arik Jones (aider)
396f092d50 fix: improve file ignore pattern matching for nested directories 2024-09-22 16:58:22 -05:00
Arik Jones (aider)
274ef7ea79 test: enhance and expand test coverage for file operations 2024-09-22 16:56:52 -05:00
Arik Jones
a55e8df02a refactor: improve error handling and variable naming in TestRunRollup 2024-09-22 16:56:51 -05:00
Arik Jones (aider)
364b185269 fix: resolve test failures in TestRunRollup, TestExtractContentWithCSS, and TestExtractLinks 2024-09-21 16:04:20 -05:00
Arik Jones (aider)
952c2dda02 refactor: update browser initialization in scraper tests 2024-09-21 16:01:51 -05:00
Arik Jones (aider)
de84d68b4c test: initialize browser before running ExtractLinks test 2024-09-21 16:01:08 -05:00
Arik Jones (aider)
e5d4c514a7 fix: resolve build errors in test files 2024-09-21 15:59:39 -05:00
Arik Jones (aider)
6ff44f81bb fix: resolve nil pointer dereference in ExtractContentWithCSS test 2024-09-21 15:59:08 -05:00
Arik Jones (aider)
2fd411ce65 test: add debugging info and fix reflect import 2024-09-21 15:57:05 -05:00
Arik Jones
73116e8d82 Fix logging and other issues from preventing scraping 2024-09-21 15:54:33 -05:00
5482621d99 fix: Use preferred fmt.Fprintf funcion 2024-09-20 13:48:28 -05:00
3788a08b00 fix: Remove unused args in getDefaultFilename(), use preferred fmt.Fprintf funcion 2024-09-20 13:47:52 -05:00
8ba54001ce cleanup: Ran go mod tidy to clear out an unused dep. 2024-09-20 13:41:51 -05:00
10 changed files with 451 additions and 320 deletions

View File

@@ -4,16 +4,18 @@ Rollup aggregates the contents of text-based files and webpages into a markdown
## Features ## Features
- File type filtering - File type filtering for targeted content aggregation
- Ignore patterns for excluding files - Ignore patterns for excluding specific files or directories
- Support for code-generated file detection - Support for code-generated file detection and exclusion
- Advanced web scraping functionality - Advanced web scraping functionality with depth control
- Verbose logging option for detailed output - Verbose logging option for detailed operation insights
- Exclusionary CSS selectors for web scraping - Exclusionary CSS selectors for precise web content extraction
- Support for multiple URLs in web scraping - Support for multiple URLs in web scraping operations
- Configurable output format for web scraping (single file or separate files) - Configurable output format for web scraping (single file or separate files)
- Configuration file support (YAML) - Flexible configuration file support (YAML)
- Generation of default configuration file - Automatic generation of default configuration file
- Custom output file naming
- Concurrent processing for improved performance
## Installation ## Installation
@@ -74,14 +76,27 @@ ignore:
code_generated: code_generated:
- **/generated/** - **/generated/**
scrape: scrape:
urls: sites:
- url: https://example.com - base_url: https://example.com
css_locator: .content css_locator: .content
exclude_selectors: exclude_selectors:
- .ads - .ads
- .navigation - .navigation
max_depth: 2
allowed_paths:
- /blog
- /docs
exclude_paths:
- /admin
output_alias: example output_alias: example
path_overrides:
- path: /special-page
css_locator: .special-content
exclude_selectors:
- .special-ads
output_type: single output_type: single
requests_per_second: 1.0
burst_limit: 3
``` ```
## Examples ## Examples
@@ -92,10 +107,10 @@ scrape:
rollup files rollup files
``` ```
2. Web scraping with multiple URLs: 2. Web scraping with multiple URLs and increased concurrency:
```bash ```bash
rollup web --urls=https://example.com,https://another-example.com rollup web --urls=https://example.com,https://another-example.com --concurrent=8
``` ```
3. Generate a default configuration file: 3. Generate a default configuration file:
@@ -104,15 +119,25 @@ scrape:
rollup generate rollup generate
``` ```
4. Use a custom configuration file: 4. Use a custom configuration file and specify output:
```bash ```bash
rollup files --config=my-config.yml rollup files --config=my-config.yml --output=project_summary.md
``` ```
5. Web scraping with separate output files: 5. Web scraping with separate output files and custom timeout:
```bash ```bash
rollup web --urls=https://example.com,https://another-example.com --output=separate rollup web --urls=https://example.com,https://another-example.com --output=separate --timeout=60
```
6. Rollup files with specific types and ignore patterns:
```bash
rollup files --types=.go,.md --ignore=vendor/**,*_test.go
```
7. Web scraping with depth and CSS selector:
```bash
rollup web --urls=https://example.com --depth=2 --css=.main-content
``` ```
## Contributing ## Contributing

View File

@@ -8,8 +8,11 @@ import (
"time" "time"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/tnypxl/rollup/internal/config"
) )
var cfg *config.Config
var ( var (
path string path string
fileTypes string fileTypes string
@@ -24,7 +27,7 @@ var filesCmd = &cobra.Command{
in a given project, current path or a custom path, to a single timestamped markdown file in a given project, current path or a custom path, to a single timestamped markdown file
whose name is <project-directory-name>-rollup-<timestamp>.md.`, whose name is <project-directory-name>-rollup-<timestamp>.md.`,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return runRollup() return runRollup(cfg)
}, },
} }
@@ -87,16 +90,23 @@ func isIgnored(filePath string, patterns []string) bool {
return true return true
} }
} else { } else {
matched, err := filepath.Match(pattern, filepath.Base(filePath)) // Check if the pattern matches the full path or any part of it
if err == nil && matched { if matched, _ := filepath.Match(pattern, filePath); matched {
return true return true
} }
pathParts := strings.Split(filePath, string(os.PathSeparator))
for i := range pathParts {
partialPath := filepath.Join(pathParts[:i+1]...)
if matched, _ := filepath.Match(pattern, partialPath); matched {
return true
}
}
} }
} }
return false return false
} }
func runRollup() error { func runRollup(cfg *config.Config) error {
// Use config if available, otherwise use command-line flags // Use config if available, otherwise use command-line flags
var types, codeGenList, ignoreList []string var types, codeGenList, ignoreList []string
if cfg != nil && len(cfg.FileTypes) > 0 { if cfg != nil && len(cfg.FileTypes) > 0 {

View File

@@ -21,6 +21,9 @@ func TestMatchGlob(t *testing.T) {
{"**/*.go", "dir/subdir/file.go", true}, {"**/*.go", "dir/subdir/file.go", true},
{"dir/*.go", "dir/file.go", true}, {"dir/*.go", "dir/file.go", true},
{"dir/*.go", "otherdir/file.go", false}, {"dir/*.go", "otherdir/file.go", false},
{"**/test_*.go", "internal/test_helper.go", true},
{"docs/**/*.md", "docs/api/endpoints.md", true},
{"docs/**/*.md", "src/docs/readme.md", false},
} }
for _, test := range tests { for _, test := range tests {
@@ -32,7 +35,7 @@ func TestMatchGlob(t *testing.T) {
} }
func TestIsCodeGenerated(t *testing.T) { func TestIsCodeGenerated(t *testing.T) {
patterns := []string{"generated_*.go", "**/auto_*.go"} patterns := []string{"generated_*.go", "**/auto_*.go", "**/*_gen.go"}
tests := []struct { tests := []struct {
path string path string
expected bool expected bool
@@ -41,6 +44,8 @@ func TestIsCodeGenerated(t *testing.T) {
{"normal_file.go", false}, {"normal_file.go", false},
{"subdir/auto_file.go", true}, {"subdir/auto_file.go", true},
{"subdir/normal_file.go", false}, {"subdir/normal_file.go", false},
{"pkg/models_gen.go", true},
{"pkg/handler.go", false},
} }
for _, test := range tests { for _, test := range tests {
@@ -52,7 +57,7 @@ func TestIsCodeGenerated(t *testing.T) {
} }
func TestIsIgnored(t *testing.T) { func TestIsIgnored(t *testing.T) {
patterns := []string{"*.tmp", "**/*.log"} patterns := []string{"*.tmp", "**/*.log", ".git/**", "vendor/**"}
tests := []struct { tests := []struct {
path string path string
expected bool expected bool
@@ -61,6 +66,10 @@ func TestIsIgnored(t *testing.T) {
{"file.go", false}, {"file.go", false},
{"subdir/file.log", true}, {"subdir/file.log", true},
{"subdir/file.txt", false}, {"subdir/file.txt", false},
{".git/config", true},
{"src/.git/config", false},
{"vendor/package/file.go", true},
{"internal/vendor/file.go", false},
} }
for _, test := range tests { for _, test := range tests {
@@ -81,49 +90,56 @@ func TestRunRollup(t *testing.T) {
// Create some test files // Create some test files
files := map[string]string{ files := map[string]string{
"file1.go": "package main\n\nfunc main() {}\n", "file1.go": "package main\n\nfunc main() {}\n",
"file2.txt": "This is a text file.\n", "file2.txt": "This is a text file.\n",
"subdir/file3.go": "package subdir\n\nfunc Func() {}\n", "subdir/file3.go": "package subdir\n\nfunc Func() {}\n",
"subdir/file4.json": "{\"key\": \"value\"}\n", "subdir/file4.json": "{\"key\": \"value\"}\n",
"generated_model.go": "// Code generated DO NOT EDIT.\n\npackage model\n",
"docs/api/readme.md": "# API Documentation\n",
".git/config": "[core]\n\trepositoryformatversion = 0\n",
"vendor/lib/helper.go": "package lib\n\nfunc Helper() {}\n",
} }
for name, content := range files { for name, content := range files {
path := filepath.Join(tempDir, name) path := filepath.Join(tempDir, name)
err := os.MkdirAll(filepath.Dir(path), 0755) if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
if err != nil {
t.Fatalf("Failed to create directory: %v", err) t.Fatalf("Failed to create directory: %v", err)
} }
err = os.WriteFile(path, []byte(content), 0644) if err := os.WriteFile(path, []byte(content), 0o644); err != nil {
if err != nil {
t.Fatalf("Failed to write file: %v", err) t.Fatalf("Failed to write file: %v", err)
} }
} }
// Set up test configuration // Set up test configuration
cfg = &config.Config{ cfg = &config.Config{
FileTypes: []string{"go", "txt"}, FileTypes: []string{"go", "txt", "md"},
Ignore: []string{"*.json"}, Ignore: []string{"*.json", ".git/**", "vendor/**"},
CodeGenerated: []string{}, CodeGenerated: []string{"generated_*.go"},
} }
path = tempDir
// Change working directory to the temp directory
originalWd, _ := os.Getwd()
os.Chdir(tempDir)
defer os.Chdir(originalWd)
// Run the rollup // Run the rollup
err = runRollup() if err := runRollup(cfg); err != nil {
if err != nil {
t.Fatalf("runRollup() failed: %v", err) t.Fatalf("runRollup() failed: %v", err)
} }
// Check if the output file was created // Check if the output file was created
outputFiles, err := filepath.Glob(filepath.Join(tempDir, "*.rollup.md")) outputFiles, err := filepath.Glob("*.rollup.md")
if err != nil { if err != nil {
t.Fatalf("Failed to glob output files: %v", err) t.Fatalf("Error globbing for output file: %v", err)
} }
if len(outputFiles) != 1 { if len(outputFiles) == 0 {
t.Fatalf("Expected 1 output file, got %d", len(outputFiles)) allFiles, _ := filepath.Glob("*")
t.Fatalf("No rollup.md file found. Files in directory: %v", allFiles)
} }
outputFile := outputFiles[0]
// Read the content of the output file // Read the content of the output file
content, err := os.ReadFile(outputFiles[0]) content, err := os.ReadFile(outputFile)
if err != nil { if err != nil {
t.Fatalf("Failed to read output file: %v", err) t.Fatalf("Failed to read output file: %v", err)
} }
@@ -133,6 +149,8 @@ func TestRunRollup(t *testing.T) {
"# File: file1.go", "# File: file1.go",
"# File: file2.txt", "# File: file2.txt",
"# File: subdir/file3.go", "# File: subdir/file3.go",
"# File: docs/api/readme.md",
"# File: generated_model.go (Code-generated, Read-only)",
} }
for _, expected := range expectedContent { for _, expected := range expectedContent {
if !strings.Contains(string(content), expected) { if !strings.Contains(string(content), expected) {
@@ -140,8 +158,15 @@ func TestRunRollup(t *testing.T) {
} }
} }
// Check if the ignored file is not included // Check if the ignored files are not included
if strings.Contains(string(content), "file4.json") { ignoredContent := []string{
t.Errorf("Output file contains ignored file: file4.json") "file4.json",
".git/config",
"vendor/lib/helper.go",
}
for _, ignored := range ignoredContent {
if strings.Contains(string(content), ignored) {
t.Errorf("Output file contains ignored file: %s", ignored)
}
} }
} }

View File

@@ -7,7 +7,6 @@ import (
var ( var (
configFile string configFile string
cfg *config.Config
verbose bool verbose bool
) )
@@ -19,10 +18,10 @@ Use subcommands to perform specific operations.`,
} }
func Execute(conf *config.Config) error { func Execute(conf *config.Config) error {
cfg = conf if conf == nil {
if cfg == nil { conf = &config.Config{} // Use an empty config if none is provided
cfg = &config.Config{} // Use an empty config if none is provided
} }
cfg = conf // Set the cfg variable in cmd/files.go
return rootCmd.Execute() return rootCmd.Execute()
} }

View File

@@ -2,7 +2,7 @@ package cmd
import ( import (
"fmt" "fmt"
"io/ioutil" "io"
"log" "log"
"net/url" "net/url"
"os" "os"
@@ -41,97 +41,97 @@ func init() {
} }
func runWeb(cmd *cobra.Command, args []string) error { func runWeb(cmd *cobra.Command, args []string) error {
scraper.SetupLogger(verbose) scraper.SetupLogger(verbose)
logger := log.New(os.Stdout, "WEB: ", log.LstdFlags) logger := log.New(os.Stdout, "WEB: ", log.LstdFlags)
if !verbose { if !verbose {
logger.SetOutput(ioutil.Discard) logger.SetOutput(io.Discard)
} }
logger.Printf("Starting web scraping process with verbose mode: %v", verbose) logger.Printf("Starting web scraping process with verbose mode: %v", verbose)
scraperConfig.Verbose = verbose scraperConfig.Verbose = verbose
var siteConfigs []scraper.SiteConfig var siteConfigs []scraper.SiteConfig
if len(cfg.Scrape.Sites) > 0 { if len(cfg.Scrape.Sites) > 0 {
logger.Printf("Using configuration from rollup.yml for %d sites", len(cfg.Scrape.Sites)) logger.Printf("Using configuration from rollup.yml for %d sites", len(cfg.Scrape.Sites))
siteConfigs = make([]scraper.SiteConfig, len(cfg.Scrape.Sites)) siteConfigs = make([]scraper.SiteConfig, len(cfg.Scrape.Sites))
for i, site := range cfg.Scrape.Sites { for i, site := range cfg.Scrape.Sites {
siteConfigs[i] = scraper.SiteConfig{ siteConfigs[i] = scraper.SiteConfig{
BaseURL: site.BaseURL, BaseURL: site.BaseURL,
CSSLocator: site.CSSLocator, CSSLocator: site.CSSLocator,
ExcludeSelectors: site.ExcludeSelectors, ExcludeSelectors: site.ExcludeSelectors,
MaxDepth: site.MaxDepth, MaxDepth: site.MaxDepth,
AllowedPaths: site.AllowedPaths, AllowedPaths: site.AllowedPaths,
ExcludePaths: site.ExcludePaths, ExcludePaths: site.ExcludePaths,
OutputAlias: site.OutputAlias, OutputAlias: site.OutputAlias,
PathOverrides: convertPathOverrides(site.PathOverrides), PathOverrides: convertPathOverrides(site.PathOverrides),
} }
logger.Printf("Site %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d, AllowedPaths=%v", logger.Printf("Site %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d, AllowedPaths=%v",
i+1, site.BaseURL, site.CSSLocator, site.MaxDepth, site.AllowedPaths) i+1, site.BaseURL, site.CSSLocator, site.MaxDepth, site.AllowedPaths)
} }
} else { } else {
logger.Printf("No sites defined in rollup.yml, falling back to URL-based configuration") logger.Printf("No sites defined in rollup.yml, falling back to URL-based configuration")
siteConfigs = make([]scraper.SiteConfig, len(urls)) siteConfigs = make([]scraper.SiteConfig, len(urls))
for i, u := range urls { for i, u := range urls {
siteConfigs[i] = scraper.SiteConfig{ siteConfigs[i] = scraper.SiteConfig{
BaseURL: u, BaseURL: u,
CSSLocator: includeSelector, CSSLocator: includeSelector,
ExcludeSelectors: excludeSelectors, ExcludeSelectors: excludeSelectors,
MaxDepth: depth, MaxDepth: depth,
} }
logger.Printf("URL %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d", logger.Printf("URL %d configuration: BaseURL=%s, CSSLocator=%s, MaxDepth=%d",
i+1, u, includeSelector, depth) i+1, u, includeSelector, depth)
} }
} }
if len(siteConfigs) == 0 { if len(siteConfigs) == 0 {
logger.Println("Error: No sites or URLs provided") logger.Println("Error: No sites or URLs provided")
return fmt.Errorf("no sites or URLs provided. Use --urls flag with comma-separated URLs or set 'scrape.sites' in the rollup.yml file") return fmt.Errorf("no sites or URLs provided. Use --urls flag with comma-separated URLs or set 'scrape.sites' in the rollup.yml file")
} }
// Set default values for rate limiting // Set default values for rate limiting
defaultRequestsPerSecond := 1.0 defaultRequestsPerSecond := 1.0
defaultBurstLimit := 3 defaultBurstLimit := 3
// Use default values if not set in the configuration // Use default values if not set in the configuration
requestsPerSecond := cfg.Scrape.RequestsPerSecond requestsPerSecond := cfg.Scrape.RequestsPerSecond
if requestsPerSecond == 0 { if requestsPerSecond == 0 {
requestsPerSecond = defaultRequestsPerSecond requestsPerSecond = defaultRequestsPerSecond
} }
burstLimit := cfg.Scrape.BurstLimit burstLimit := cfg.Scrape.BurstLimit
if burstLimit == 0 { if burstLimit == 0 {
burstLimit = defaultBurstLimit burstLimit = defaultBurstLimit
} }
scraperConfig := scraper.Config{ scraperConfig := scraper.Config{
Sites: siteConfigs, Sites: siteConfigs,
OutputType: outputType, OutputType: outputType,
Verbose: verbose, Verbose: verbose,
Scrape: scraper.ScrapeConfig{ Scrape: scraper.ScrapeConfig{
RequestsPerSecond: requestsPerSecond, RequestsPerSecond: requestsPerSecond,
BurstLimit: burstLimit, BurstLimit: burstLimit,
}, },
} }
logger.Printf("Scraper configuration: OutputType=%s, RequestsPerSecond=%f, BurstLimit=%d", logger.Printf("Scraper configuration: OutputType=%s, RequestsPerSecond=%f, BurstLimit=%d",
outputType, requestsPerSecond, burstLimit) outputType, requestsPerSecond, burstLimit)
logger.Println("Starting scraping process") logger.Println("Starting scraping process")
scrapedContent, err := scraper.ScrapeSites(scraperConfig) scrapedContent, err := scraper.ScrapeSites(scraperConfig)
if err != nil { if err != nil {
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.Printf("Scraping completed. Total content scraped: %d", len(scrapedContent))
if outputType == "single" { if outputType == "single" {
logger.Println("Writing content to a single file") logger.Println("Writing content to a single file")
return writeSingleFile(scrapedContent) return writeSingleFile(scrapedContent)
} else { } else {
logger.Println("Writing content to multiple files") logger.Println("Writing content to multiple files")
return writeMultipleFiles(scrapedContent) return writeMultipleFiles(scrapedContent)
} }
} }
func writeSingleFile(content map[string]string) error { func writeSingleFile(content map[string]string) error {
outputFile := generateDefaultFilename(urls) outputFile := generateDefaultFilename()
file, err := os.Create(outputFile) file, err := os.Create(outputFile)
if err != nil { if err != nil {
return fmt.Errorf("error creating output file: %v", err) return fmt.Errorf("error creating output file: %v", err)
@@ -139,7 +139,7 @@ func writeSingleFile(content map[string]string) error {
defer file.Close() defer file.Close()
for url, c := range content { for url, c := range content {
_, err = file.WriteString(fmt.Sprintf("# Content from %s\n\n%s\n\n---\n\n", url, c)) _, err = fmt.Fprintf(file, "# ::: Content from %s\n\n%s\n\n---\n\n", url, c)
if err != nil { if err != nil {
return fmt.Errorf("error writing content to file: %v", err) return fmt.Errorf("error writing content to file: %v", err)
} }
@@ -161,7 +161,7 @@ func writeMultipleFiles(content map[string]string) error {
return fmt.Errorf("error creating output file %s: %v", filename, err) return fmt.Errorf("error creating output file %s: %v", filename, err)
} }
_, err = file.WriteString(fmt.Sprintf("# Content from %s\n\n%s\n", url, c)) _, err = file.WriteString(fmt.Sprintf("# ::: Content from %s\n\n%s\n", url, c))
if err != nil { if err != nil {
file.Close() file.Close()
return fmt.Errorf("error writing content to file %s: %v", filename, err) return fmt.Errorf("error writing content to file %s: %v", filename, err)
@@ -174,7 +174,7 @@ func writeMultipleFiles(content map[string]string) error {
return nil return nil
} }
func generateDefaultFilename(urls []string) string { func generateDefaultFilename() string {
timestamp := time.Now().Format("20060102-150405") timestamp := time.Now().Format("20060102-150405")
return fmt.Sprintf("web-%s.rollup.md", timestamp) return fmt.Sprintf("web-%s.rollup.md", timestamp)
} }
@@ -215,8 +215,10 @@ func scrapeURL(urlStr string, depth int, visited map[string]bool) (string, error
return content, nil return content, nil
} }
var testExtractAndConvertContent = extractAndConvertContent var (
var testExtractLinks = scraper.ExtractLinks testExtractAndConvertContent = extractAndConvertContent
testExtractLinks = scraper.ExtractLinks
)
func extractAndConvertContent(urlStr string) (string, error) { func extractAndConvertContent(urlStr string) (string, error) {
content, err := scraper.FetchWebpageContent(urlStr) content, err := scraper.FetchWebpageContent(urlStr)
@@ -240,7 +242,7 @@ func extractAndConvertContent(urlStr string) (string, error) {
if err != nil { if err != nil {
return "", fmt.Errorf("error parsing URL: %v", err) return "", fmt.Errorf("error parsing URL: %v", err)
} }
header := fmt.Sprintf("# Content from %s\n\n", parsedURL.String()) header := fmt.Sprintf("# ::: Content from %s\n\n", parsedURL.String())
return header + markdown + "\n\n", nil return header + markdown + "\n\n", nil
} }
@@ -261,11 +263,11 @@ func getFilenameFromContent(content, urlStr string) (string, error) {
if err != nil { if err != nil {
return "", fmt.Errorf("invalid URL: %v", err) return "", fmt.Errorf("invalid URL: %v", err)
} }
if parsedURL.Host == "" { if parsedURL.Host == "" {
return "", fmt.Errorf("invalid URL: missing host") return "", fmt.Errorf("invalid URL: missing host")
} }
filename := parsedURL.Host filename := parsedURL.Host
if parsedURL.Path != "" && parsedURL.Path != "/" { if parsedURL.Path != "" && parsedURL.Path != "/" {
filename += strings.TrimSuffix(parsedURL.Path, "/") filename += strings.TrimSuffix(parsedURL.Path, "/")

View File

@@ -103,7 +103,7 @@ func mockExtractAndConvertContent(urlStr string) (string, error) {
return "Mocked content for " + urlStr, nil return "Mocked content for " + urlStr, nil
} }
func mockExtractLinks(urlStr string) ([]string, error) { func mockExtractLinks() ([]string, error) {
return []string{"http://example.com/link1", "http://example.com/link2"}, nil return []string{"http://example.com/link1", "http://example.com/link2"}, nil
} }

21
docs/CHANGELOG.md Normal file
View File

@@ -0,0 +1,21 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.0.3] - 2024-09-22
### Added
- Implemented web scraping functionality using Playwright
- Added support for CSS selectors to extract specific content
- Introduced rate limiting for web requests
- Created configuration options for scraping settings
### Changed
- Improved error handling and logging throughout the application
- Enhanced URL parsing and validation
### Fixed
- Resolved issues with concurrent scraping operations

View File

@@ -45,10 +45,10 @@ scrape:
} }
defer os.Remove(tmpfile.Name()) defer os.Remove(tmpfile.Name())
if _, err := tmpfile.Write(content); err != nil { if _, err = tmpfile.Write(content); err != nil {
t.Fatalf("Failed to write to temp file: %v", err) t.Fatalf("Failed to write to temp file: %v", err)
} }
if err := tmpfile.Close(); err != nil { if err = tmpfile.Close(); err != nil {
t.Fatalf("Failed to close temp file: %v", err) t.Fatalf("Failed to close temp file: %v", err)
} }

View File

@@ -1,21 +1,21 @@
package scraper package scraper
import ( import (
"context"
"fmt" "fmt"
"io/ioutil" "io"
"log" "log"
"math/rand" "math/rand"
"net/url" "net/url"
"os" "os"
"regexp" "regexp"
"strings" "strings"
"time"
"sync" "sync"
"context" "time"
md "github.com/JohannesKaufmann/html-to-markdown"
"github.com/PuerkitoBio/goquery" "github.com/PuerkitoBio/goquery"
"github.com/playwright-community/playwright-go" "github.com/playwright-community/playwright-go"
md "github.com/JohannesKaufmann/html-to-markdown"
"golang.org/x/time/rate" "golang.org/x/time/rate"
) )
@@ -60,208 +60,210 @@ type PathOverride struct {
} }
func ScrapeSites(config Config) (map[string]string, error) { func ScrapeSites(config Config) (map[string]string, 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
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
for _, site := range config.Sites { for _, site := range config.Sites {
logger.Printf("Processing site: %s\n", site.BaseURL) logger.Printf("Processing site: %s\n", site.BaseURL)
wg.Add(1) wg.Add(1)
go func(site SiteConfig) { go func(site SiteConfig) {
defer wg.Done() defer wg.Done()
for _, path := range site.AllowedPaths { for _, path := range site.AllowedPaths {
fullURL := site.BaseURL + path fullURL := site.BaseURL + path
totalURLs++ totalURLs++
logger.Printf("Queueing URL for scraping: %s\n", fullURL) logger.Printf("Queueing URL for scraping: %s\n", fullURL)
scrapeSingleURL(fullURL, site, config, results, limiter) scrapeSingleURL(fullURL, site, results, limiter)
} }
}(site) }(site)
} }
go func() { go func() {
wg.Wait() wg.Wait()
close(results) close(results)
logger.Println("All goroutines completed, results channel closed") logger.Println("All goroutines completed, results channel closed")
}() }()
scrapedContent := make(map[string]string) scrapedContent := make(map[string]string)
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", result.url, len(result.content))
scrapedContent[result.url] = result.content scrapedContent[result.url] = result.content
} }
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 scrapedContent, nil
} }
func scrapeSingleURL(url string, site SiteConfig, config Config, results chan<- struct { func scrapeSingleURL(url string, site SiteConfig, results chan<- struct {
url string url string
content string content string
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 // 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) logger.Printf("Rate limiter error for %s: %v\n", url, err)
results <- struct { results <- struct {
url string url string
content string content string
err error err error
}{url, "", fmt.Errorf("rate limiter error: %v", err)} }{url, "", 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("Using CSS locator for %s: %s\n", url, cssLocator)
logger.Printf("Exclude selectors for %s: %v\n", url, excludeSelectors) 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) logger.Printf("Error scraping %s: %v\n", url, err)
results <- struct { results <- struct {
url string url string
content string content string
err error err error
}{url, "", err} }{url, "", err}
return return
} }
if content == "" { if content == "" {
logger.Printf("Warning: Empty content scraped from %s\n", url) logger.Printf("Warning: Empty content scraped from %s\n", url)
} else { } else {
logger.Printf("Successfully scraped content from %s (length: %d)\n", url, len(content)) 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
err error err error
}{url, content, nil} }{url, content, nil}
} }
func scrapeSite(site SiteConfig, config Config, results chan<- struct { func scrapeSite(site SiteConfig, results chan<- struct {
url string url string
content string content string
err error err error
}, limiter *rate.Limiter) { }, limiter *rate.Limiter,
visited := make(map[string]bool) ) {
queue := []string{site.BaseURL} visited := make(map[string]bool)
queue := []string{site.BaseURL}
for len(queue) > 0 { for len(queue) > 0 {
url := queue[0] url := queue[0]
queue = queue[1:] queue = queue[1:]
if visited[url] { if visited[url] {
continue continue
} }
visited[url] = true visited[url] = true
if !isAllowedURL(url, site) { if !isAllowedURL(url, site) {
continue continue
} }
// Wait for rate limiter before making the request // Wait for rate limiter before making the request
err := limiter.Wait(context.Background()) err := limiter.Wait(context.Background())
if err != nil { if err != nil {
results <- struct { results <- struct {
url string url string
content string content string
err error err error
}{url, "", fmt.Errorf("rate limiter error: %v", err)} }{url, "", fmt.Errorf("rate limiter error: %v", err)}
continue continue
} }
cssLocator, excludeSelectors := getOverrides(url, site) cssLocator, excludeSelectors := getOverrides(url, site)
content, err := scrapeURL(url, cssLocator, excludeSelectors) content, err := scrapeURL(url, cssLocator, excludeSelectors)
results <- struct { results <- struct {
url string url string
content string content string
err error err error
}{url, content, err} }{url, content, err}
if len(visited) < site.MaxDepth { if len(visited) < site.MaxDepth {
links, _ := ExtractLinks(url) links, _ := ExtractLinks(url)
for _, link := range links { for _, link := range links {
if !visited[link] && isAllowedURL(link, site) { if !visited[link] && isAllowedURL(link, site) {
queue = append(queue, link) queue = append(queue, link)
} }
} }
} }
} }
} }
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 {
return false return false
} }
baseURL, _ := url.Parse(site.BaseURL) baseURL, _ := url.Parse(site.BaseURL)
if parsedURL.Host != baseURL.Host { if parsedURL.Host != baseURL.Host {
return false return false
} }
path := parsedURL.Path path := parsedURL.Path
for _, allowedPath := range site.AllowedPaths { for _, allowedPath := range site.AllowedPaths {
if strings.HasPrefix(path, allowedPath) { if strings.HasPrefix(path, allowedPath) {
for _, excludePath := range site.ExcludePaths { for _, excludePath := range site.ExcludePaths {
if strings.HasPrefix(path, excludePath) { if strings.HasPrefix(path, excludePath) {
return false return false
} }
} }
return true return true
} }
} }
return false return false
} }
func getOverrides(urlStr string, site SiteConfig) (string, []string) { func getOverrides(urlStr string, site SiteConfig) (string, []string) {
parsedURL, _ := url.Parse(urlStr) parsedURL, _ := url.Parse(urlStr)
path := parsedURL.Path path := parsedURL.Path
for _, override := range site.PathOverrides { for _, override := range site.PathOverrides {
if strings.HasPrefix(path, override.Path) { if strings.HasPrefix(path, override.Path) {
if override.CSSLocator != "" { if override.CSSLocator != "" {
return override.CSSLocator, override.ExcludeSelectors return override.CSSLocator, override.ExcludeSelectors
} }
return site.CSSLocator, override.ExcludeSelectors return site.CSSLocator, override.ExcludeSelectors
} }
} }
return site.CSSLocator, site.ExcludeSelectors return site.CSSLocator, site.ExcludeSelectors
} }
func scrapeURL(url, cssLocator string, excludeSelectors []string) (string, error) { func scrapeURL(url, cssLocator string, excludeSelectors []string) (string, error) {
content, err := FetchWebpageContent(url) content, err := FetchWebpageContent(url)
if err != nil { if err != nil {
return "", err return "", err
} }
if cssLocator != "" { if cssLocator != "" {
content, err = ExtractContentWithCSS(content, cssLocator, excludeSelectors) content, err = ExtractContentWithCSS(content, cssLocator, excludeSelectors)
if err != nil { if err != nil {
return "", err return "", err
} }
} }
return ProcessHTMLContent(content, Config{}) return ProcessHTMLContent(content, Config{})
} }
func getFilenameFromContent(content, url string) string { func getFilenameFromContent(content, url string) string {
@@ -296,7 +298,7 @@ func SetupLogger(verbose bool) {
if verbose { if verbose {
logger = log.New(os.Stdout, "SCRAPER: ", log.LstdFlags) logger = log.New(os.Stdout, "SCRAPER: ", log.LstdFlags)
} else { } else {
logger = log.New(ioutil.Discard, "", 0) logger = log.New(io.Discard, "", 0)
} }
} }
@@ -339,6 +341,16 @@ func ClosePlaywright() {
} }
} }
// InitBrowser initializes the browser
func InitBrowser() error {
return InitPlaywright()
}
// CloseBrowser closes the browser
func CloseBrowser() {
ClosePlaywright()
}
// 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)
@@ -377,7 +389,9 @@ func FetchWebpageContent(urlStr string) (string, error) {
} }
logger.Println("Waiting for body element") logger.Println("Waiting for body element")
_, err = page.WaitForSelector("body", playwright.PageWaitForSelectorOptions{
bodyElement := page.Locator("body")
err = bodyElement.WaitFor(playwright.LocatorWaitForOptions{
State: playwright.WaitForSelectorStateVisible, State: playwright.WaitForSelectorStateVisible,
}) })
if err != nil { if err != nil {
@@ -394,7 +408,7 @@ func FetchWebpageContent(urlStr string) (string, error) {
if content == "" { if content == "" {
logger.Println(" content is empty, falling back to body content") logger.Println(" content is empty, falling back to body content")
content, err = page.InnerHTML("body") content, err = bodyElement.InnerHTML()
if err != nil { if err != nil {
logger.Printf("Error getting body content: %v\n", err) logger.Printf("Error getting body content: %v\n", err)
return "", fmt.Errorf("could not get body content: %v", err) return "", fmt.Errorf("could not get body content: %v", err)
@@ -447,6 +461,8 @@ func scrollPage(page playwright.Page) error {
() => { () => {
window.scrollTo(0, document.body.scrollHeight); window.scrollTo(0, document.body.scrollHeight);
return document.body.scrollHeight; return document.body.scrollHeight;
// wait for 500 ms
new Promise(resolve => setTimeout(resolve, 500));
} }
` `
@@ -478,7 +494,9 @@ func scrollPage(page playwright.Page) error {
previousHeight = currentHeight previousHeight = currentHeight
page.WaitForTimeout(500) // Wait for a while before scrolling again
} }
logger.Println("Scrolling back to top") logger.Println("Scrolling back to top")
@@ -518,7 +536,9 @@ func ExtractLinks(urlStr string) ([]string, error) {
var result []string var result []string
for _, link := range links.([]interface{}) { for _, link := range links.([]interface{}) {
result = append(result, link.(string)) // Normalize URL by removing trailing slash
normalizedLink := strings.TrimRight(link.(string), "/")
result = append(result, normalizedLink)
} }
logger.Printf("Extracted %d links\n", len(result)) logger.Printf("Extracted %d links\n", len(result))
@@ -552,6 +572,23 @@ func ExtractContentWithCSS(content, includeSelector string, excludeSelectors []s
return "", fmt.Errorf("error extracting content with CSS selector: %v", err) return "", fmt.Errorf("error extracting content with CSS selector: %v", err)
} }
// Trim leading and trailing whitespace
selectedContent = strings.TrimSpace(selectedContent)
// Normalize newlines
selectedContent = strings.ReplaceAll(selectedContent, "\r\n", "\n")
selectedContent = strings.ReplaceAll(selectedContent, "\r", "\n")
// Remove indentation while preserving structure
lines := strings.Split(selectedContent, "\n")
for i, line := range lines {
lines[i] = strings.TrimSpace(line)
}
selectedContent = strings.Join(lines, "\n")
// Remove any leading or trailing newlines
selectedContent = strings.Trim(selectedContent, "\n")
logger.Printf("Extracted content length: %d\n", len(selectedContent)) logger.Printf("Extracted content length: %d\n", len(selectedContent))
return selectedContent, nil return selectedContent, nil
} }

View File

@@ -1,10 +1,13 @@
package scraper package scraper
import ( import (
"testing" "io"
"log"
"net/http" "net/http"
"net/http/httptest" "net/http/httptest"
"reflect"
"strings" "strings"
"testing"
) )
func TestIsAllowedURL(t *testing.T) { func TestIsAllowedURL(t *testing.T) {
@@ -48,9 +51,9 @@ func TestGetOverrides(t *testing.T) {
} }
tests := []struct { tests := []struct {
url string url string
expectedLocator string expectedLocator string
expectedExcludes []string expectedExcludes []string
}{ }{
{"https://example.com/normal", "main", []string{".ads"}}, {"https://example.com/normal", "main", []string{".ads"}},
{"https://example.com/special", ".special-content", []string{".sidebar"}}, {"https://example.com/special", ".special-content", []string{".sidebar"}},
@@ -69,6 +72,9 @@ func TestGetOverrides(t *testing.T) {
} }
func TestExtractContentWithCSS(t *testing.T) { func TestExtractContentWithCSS(t *testing.T) {
// Initialize logger for testing
logger = log.New(io.Discard, "", 0)
html := ` html := `
<html> <html>
<body> <body>
@@ -138,6 +144,12 @@ This is a **test** paragraph.
} }
func TestExtractLinks(t *testing.T) { func TestExtractLinks(t *testing.T) {
// Initialize Playwright before running the test
if err := InitPlaywright(); err != nil {
t.Fatalf("Failed to initialize Playwright: %v", err)
}
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(`