Merge pull request #71 from 8hrsk/Added-a-skill-for-playwright-browser-automation-with-Go
go-playwright skill for go browser automation
This commit is contained in:
76
skills/go-playwright/SKILL.md
Normal file
76
skills/go-playwright/SKILL.md
Normal file
@@ -0,0 +1,76 @@
|
||||
---
|
||||
name: go-playwright
|
||||
description: Expert capability for robust, stealthy, and efficient browser automation using Playwright Go.
|
||||
risk: safe
|
||||
source: https://github.com/playwright-community/playwright-go
|
||||
---
|
||||
|
||||
# Playwright Go Automation Expert
|
||||
|
||||
## Overview
|
||||
This skill provides a comprehensive framework for writing high-performance, production-grade browser automation scripts using `github.com/playwright-community/playwright-go`. It enforces architectural best practices (contexts over instances), robust error handling, structured logging (Zap), and advanced human-emulation techniques to bypass anti-bot systems.
|
||||
|
||||
## When to Use This Skill
|
||||
- Use when the user asks to "scrape," "automate," or "test" a website using Go.
|
||||
- Use when the target site has complex dynamic content (SPA, React, Vue) requiring a real browser.
|
||||
- Use when the user mentions "stealth," "avoiding detection," "cloudflare," or "human-like" behavior.
|
||||
- Use when debugging existing Playwright scripts.
|
||||
|
||||
## Safety & Risk
|
||||
**Risk Level: 🔵 Safe**
|
||||
|
||||
- **Sandboxed Execution:** Browser contexts are isolated; they do not persist data to the host machine unless explicitly saved.
|
||||
- **Resource Management:** Designed to close browsers and contexts via `defer` to prevent memory leaks.
|
||||
- **No External State-Change:** Default behavior is read-only (scraping/testing) unless the script is explicitly designed to submit forms or modify data.
|
||||
|
||||
## Limitations
|
||||
- **Environment Dependencies:** Requires Playwright drivers and browsers to be installed (`go run github.com/playwright-community/playwright-go/cmd/playwright@latest install --with-deps`).
|
||||
- **Resource Intensity:** Launching full browser instances (even headless) consumes significant RAM/CPU. Use single-browser/multi-context architecture.
|
||||
- **Bot Detection:** While this skill includes stealth techniques, extremely strict anti-bot systems (e.g., rigorous Cloudflare settings) may still detect automation.
|
||||
- **CAPTCHAs:** Does not include built-in CAPTCHA solving capabilities.
|
||||
|
||||
## Strategic Implementation Guidelines
|
||||
|
||||
### 1. Architecture: Contexts vs. Browsers
|
||||
**CRITICAL:** Never launch a new `Browser` instance for every task.
|
||||
- **Pattern:** Launch the `Browser` *once* (singleton). Create a new `BrowserContext` for each distinct session or task.
|
||||
- **Why:** Contexts are lightweight and created in milliseconds. Browsers take seconds to launch.
|
||||
- **Isolation:** Contexts provide complete isolation (cookies, cache, storage) without the overhead of a new process.
|
||||
|
||||
### 2. Logging & Observability
|
||||
- **Library:** Use `go.uber.org/zap` exclusively.
|
||||
- **Rule:** Do not use `fmt.Println`.
|
||||
- **Modes:**
|
||||
- **Dev:** `zap.NewDevelopment()` (Console friendly)
|
||||
- **Prod:** `zap.NewProduction()` (JSON structured)
|
||||
- **Traceability:** Log every navigation, click, and input with context fields (e.g., `logger.Info("clicking button", zap.String("selector", sel))`).
|
||||
|
||||
### 3. Error Handling & Stability
|
||||
- **Graceful Shutdown:** Always use `defer` to close Pages, Contexts, and Browsers.
|
||||
- **Panic Recovery:** Wrap critical automation routines in a safe runner that recovers panics and logs the stack trace.
|
||||
- **Timeouts:** Never rely on default timeouts. Set explicit timeouts (e.g., `playwright.PageClickOptions{Timeout: playwright.Float(5000)}`).
|
||||
|
||||
### 4. Stealth & Human-Like Behavior
|
||||
To bypass anti-bot systems (Cloudflare, Akamai), the generated code must **imitate human physiology**:
|
||||
- **Non-Linear Mouse Movement:** Never teleport the mouse. Implement a helper that moves the mouse along a Bezier curve with random jitter.
|
||||
- **Input Latency:** never use `Fill()`. Use `Type()` with random delays between keystrokes (50ms–200ms).
|
||||
- **Viewport Randomization:** Randomize the viewport size slightly (e.g., 1920x1080 ± 15px) to avoid fingerprinting.
|
||||
- **Behavioral Noise:** Randomly scroll, focus/unfocus the window, or hover over irrelevant elements ("idling") during long waits.
|
||||
- **User-Agent:** Rotate User-Agents for every new Context.
|
||||
|
||||
### 5. Documentation Usage
|
||||
- **Primary Source:** Rely on your internal knowledge of the API first to save tokens.
|
||||
- **Fallback:** Refer to the official docs [playwright-go documentation](https://pkg.go.dev/github.com/playwright-community/playwright-go#section-documentation) ONLY if:
|
||||
- You encounter an unknown error.
|
||||
- You need to implement complex network interception or authentication flows.
|
||||
- The API has changed significantly.
|
||||
|
||||
## Resources
|
||||
- `resources/implementation-playbook.md` for detailed code examples and implementation patterns.
|
||||
|
||||
|
||||
### Summary Checklist for Agent
|
||||
- Is Debug Mode on? -> `Headless=false`, `SlowMo=100+`.
|
||||
- Is it a new user identity? -> `NewContext`, apply new Proxy, rotate `User-Agent`.
|
||||
- Is the action critical? -> Wrap in `SafeAction` with Zap logging.
|
||||
- Is the target guarded (Cloudflare/Akamai)? -> Enable `HumanType`, `BezierMouse`, and Stealth Scripts.
|
||||
110
skills/go-playwright/resources/implementation-playbook.md
Normal file
110
skills/go-playwright/resources/implementation-playbook.md
Normal file
@@ -0,0 +1,110 @@
|
||||
# Playwright Go Automation - Implementation Playbook
|
||||
|
||||
## Code Examples
|
||||
|
||||
### Standard Initialization (Headless + Zap)
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
|
||||
"github.com/playwright-community/playwright-go"
|
||||
"go.uber.org/zap"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// 1. Setup Logger
|
||||
logger, _ := zap.NewDevelopment()
|
||||
defer logger.Sync()
|
||||
|
||||
// 2. Start Playwright Driver
|
||||
pw, err := playwright.Run()
|
||||
if err != nil {
|
||||
logger.Fatal("could not start playwright", zap.Error(err))
|
||||
}
|
||||
|
||||
// 3. Launch Browser (Singleton)
|
||||
// Use Headless: false and SlowMo for Debugging
|
||||
browser, err := pw.Chromium.Launch(playwright.BrowserTypeLaunchOptions{
|
||||
Headless: playwright.Bool(false),
|
||||
SlowMo: playwright.Float(100), // Slow actions by 100ms for visibility
|
||||
})
|
||||
if err != nil {
|
||||
logger.Fatal("could not launch browser", zap.Error(err))
|
||||
}
|
||||
defer browser.Close() // Graceful cleanup
|
||||
|
||||
// 4. Create Isolated Context (Session)
|
||||
context, err := browser.NewContext(playwright.BrowserNewContextOptions{
|
||||
UserAgent: playwright.String("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"),
|
||||
Viewport: &playwright.Size{Width: 1920, Height: 1080},
|
||||
})
|
||||
if err != nil {
|
||||
logger.Fatal("could not create context", zap.Error(err))
|
||||
}
|
||||
defer context.Close()
|
||||
|
||||
// 5. Open Page
|
||||
page, _ := context.NewPage()
|
||||
|
||||
// ... Implementation ...
|
||||
// Example: page.Goto("https://example.com")
|
||||
}
|
||||
```
|
||||
|
||||
### Human-Like Typing & Interaction
|
||||
```go
|
||||
import (
|
||||
"math/rand"
|
||||
"time"
|
||||
)
|
||||
|
||||
// HumanType simulates a user typing with variable speed
|
||||
func HumanType(locator playwright.Locator, text string) {
|
||||
// Focus the element first (like a human)
|
||||
locator.Click()
|
||||
|
||||
for _, char := range text {
|
||||
// Random delay: 50ms to 150ms
|
||||
delay := time.Duration(rand.Intn(100) + 50) * time.Millisecond
|
||||
time.Sleep(delay)
|
||||
locator.Press(string(char))
|
||||
}
|
||||
}
|
||||
|
||||
// HumanClick adds offset and hesitation
|
||||
func HumanClick(page playwright.Page, selector string) {
|
||||
box, _ := page.Locator(selector).BoundingBox()
|
||||
if box == nil {
|
||||
return
|
||||
}
|
||||
|
||||
// Calculate center with random offset (jitter)
|
||||
// Note: This is an example logic.
|
||||
x := box.X + box.Width/2 + (rand.Float64()*10 - 5)
|
||||
y := box.Y + box.Height/2 + (rand.Float64()*10 - 5)
|
||||
|
||||
// Move mouse smoothly.
|
||||
// Ideally, implement a Bezier curve function for 'steps' to look truly human.
|
||||
page.Mouse().Move(x, y, playwright.MouseMoveOptions{Steps: playwright.Int(10)})
|
||||
time.Sleep(100 * time.Millisecond) // Hesitate
|
||||
page.Mouse().Click(x, y)
|
||||
}
|
||||
```
|
||||
|
||||
### Session Management (Save/Load Cookies)
|
||||
|
||||
```go
|
||||
func SaveSession(context playwright.BrowserContext, filepath string) {
|
||||
// cookies, _ := context.Cookies()
|
||||
// Serialize cookies to JSON and write to 'filepath'
|
||||
// Implementation left to user: json.Marshal(cookies) -> os.WriteFile
|
||||
}
|
||||
|
||||
func LoadSession(context playwright.BrowserContext, filepath string) {
|
||||
// Read JSON from 'filepath' and deserialize
|
||||
// var cookies []playwright.Cookie
|
||||
// context.AddCookies(cookies)
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user