Merge pull request #186 from aykhans/feat/captcha-template-funcs

feat: add captcha solving template funcs for 2Captcha, Anti-Captcha, and CapSolver

README.md

@@ -20,7 +20,7 @@
 
 ## Overview
 
-Sarin is designed for efficient HTTP load testing with minimal resource consumption. It prioritizes simplicity—features like templating add zero overhead when unused.
+Sarin is designed for efficient HTTP load testing with minimal resource consumption. It prioritizes simplicity and features like templating add zero overhead when unused.
 
 | ✅ Supported                                               | ❌ Not Supported                |
 | ---------------------------------------------------------- | ------------------------------- |
@@ -106,7 +106,7 @@ For detailed documentation on all configuration options (URL, method, timeout, c
 
 ## Templating
 
-Sarin supports Go templates in URL paths, methods, bodies, headers, params, cookies, and values. Use the 320+ built-in functions to generate dynamic data for each request.
+Sarin supports Go templates in URL paths, methods, bodies, headers, params, cookies, and values. Use the 340+ built-in functions to generate dynamic data for each request.
 
 **Example:**
 

docs/configuration.md

@@ -1,6 +1,6 @@
 # Configuration
 
-Sarin supports environment variables, CLI flags, and YAML files. However, they are not exactly equivalent—YAML files have the most configuration options, followed by CLI flags, and then environment variables.
+Sarin supports environment variables, CLI flags, and YAML files. However, they are not exactly equivalent: YAML files have the most configuration options, followed by CLI flags, and then environment variables.
 
 When the same option is specified in multiple sources, the following priority order applies:
 
@@ -107,9 +107,9 @@ If all four files define `url`, the value from `config3.yaml` wins.
 
 **Merge behavior by field:**
 
-- **Scalar fields** (`url`, `requests`, `duration`, `timeout`, `concurrency`, etc.) — higher priority overrides lower priority
-- **Method and Body** — higher priority overrides lower priority (no merging)
-- **Headers, Params, Cookies, Proxies, Values, Lua, and Js** — accumulated across all config files
+- **Scalar fields** (`url`, `requests`, `duration`, `timeout`, `concurrency`, etc.): higher priority overrides lower priority
+- **Method and Body**: higher priority overrides lower priority (no merging)
+- **Headers, Params, Cookies, Proxies, Values, Lua, and Js**: accumulated across all config files
 
 ## URL
 
@@ -408,7 +408,7 @@ SARIN_VALUES="key1=value1"
 
 Lua script(s) for request transformation. Each script must define a global `transform` function that receives a request object and returns the modified request object. Scripts run after template rendering, before the request is sent.
 
-If multiple Lua scripts are provided, they are chained in order—the output of one becomes the input to the next. When both Lua and JavaScript scripts are specified, all Lua scripts run first, then all JavaScript scripts.
+If multiple Lua scripts are provided, they are chained in order-the output of one becomes the input to the next. When both Lua and JavaScript scripts are specified, all Lua scripts run first, then all JavaScript scripts.
 
 **Script sources:**
 
@@ -473,7 +473,7 @@ SARIN_LUA='function transform(req) req.headers["X-Custom"] = "my-value" return r
 
 JavaScript script(s) for request transformation. Each script must define a global `transform` function that receives a request object and returns the modified request object. Scripts run after template rendering, before the request is sent.
 
-If multiple JavaScript scripts are provided, they are chained in order—the output of one becomes the input to the next. When both Lua and JavaScript scripts are specified, all Lua scripts run first, then all JavaScript scripts.
+If multiple JavaScript scripts are provided, they are chained in order-the output of one becomes the input to the next. When both Lua and JavaScript scripts are specified, all Lua scripts run first, then all JavaScript scripts.
 
 **Script sources:**
 

docs/templating.md

@@ -236,7 +236,7 @@ Captcha functions solve a captcha challenge through a third-party solving servic
 
 The functions are organized by service: `twocaptcha_*`, `anticaptcha_*`, and `capsolver_*`. Each accepts the API key as the first argument so no global configuration is required — bring your own key and use any of the supported services per template.
 
-> **Important — performance and cost:**
+> **Important: performance and cost:**
 >
 > - **Each call is slow.** Solving typically takes ~5–60 seconds because the function blocks the template render until the third-party service returns a token. Internally the solver polls every 1s and gives up after 120s.
 > - **Each call costs money.** Every successful solve is billed by the captcha service (typically $0.001–$0.003 per solve). For high-volume tests, your captcha bill grows linearly with request count.

go.mod

@@ -15,7 +15,7 @@ require (
 	github.com/yuin/gopher-lua v1.1.2
 	go.aykhans.me/utils v1.0.7
 	go.yaml.in/yaml/v4 v4.0.0-rc.4
-	golang.org/x/net v0.52.0
+	golang.org/x/net v0.53.0
 )
 
 require (
@@ -52,7 +52,7 @@ require (
 	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
 	github.com/yuin/goldmark v1.8.2 // indirect
 	github.com/yuin/goldmark-emoji v1.0.6 // indirect
-	golang.org/x/sys v0.42.0 // indirect
-	golang.org/x/term v0.41.0 // indirect
-	golang.org/x/text v0.35.0 // indirect
+	golang.org/x/sys v0.43.0 // indirect
+	golang.org/x/term v0.42.0 // indirect
+	golang.org/x/text v0.36.0 // indirect
 )

go.sum

@@ -109,16 +109,16 @@ go.yaml.in/yaml/v4 v4.0.0-rc.4 h1:UP4+v6fFrBIb1l934bDl//mmnoIZEDK0idg1+AIvX5U=
 go.yaml.in/yaml/v4 v4.0.0-rc.4/go.mod h1:aZqd9kCMsGL7AuUv/m/PvWLdg5sjJsZ4oHDEnfPPfY0=
 golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI=
 golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo=
-golang.org/x/net v0.52.0 h1:He/TN1l0e4mmR3QqHMT2Xab3Aj3L9qjbhRm78/6jrW0=
-golang.org/x/net v0.52.0/go.mod h1:R1MAz7uMZxVMualyPXb+VaqGSa3LIaUqk0eEt3w36Sw=
+golang.org/x/net v0.53.0 h1:d+qAbo5L0orcWAr0a9JweQpjXF19LMXJE8Ey7hwOdUA=
+golang.org/x/net v0.53.0/go.mod h1:JvMuJH7rrdiCfbeHoo3fCQU24Lf5JJwT9W3sJFulfgs=
 golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
-golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
-golang.org/x/term v0.41.0 h1:QCgPso/Q3RTJx2Th4bDLqML4W6iJiaXFq2/ftQF13YU=
-golang.org/x/term v0.41.0/go.mod h1:3pfBgksrReYfZ5lvYM0kSO0LIkAl4Yl2bXOkKP7Ec2A=
-golang.org/x/text v0.35.0 h1:JOVx6vVDFokkpaq1AEptVzLTpDe9KGpj5tR4/X+ybL8=
-golang.org/x/text v0.35.0/go.mod h1:khi/HExzZJ2pGnjenulevKNX1W67CUy0AsXcNubPGCA=
+golang.org/x/sys v0.43.0 h1:Rlag2XtaFTxp19wS8MXlJwTvoh8ArU6ezoyFsMyCTNI=
+golang.org/x/sys v0.43.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
+golang.org/x/term v0.42.0 h1:UiKe+zDFmJobeJ5ggPwOshJIVt6/Ft0rcfrXZDLWAWY=
+golang.org/x/term v0.42.0/go.mod h1:Dq/D+snpsbazcBG5+F9Q1n2rXV8Ma+71xEjTRufARgY=
+golang.org/x/text v0.36.0 h1:JfKh3XmcRPqZPKevfXVpI1wXPTqbkE5f7JA92a55Yxg=
+golang.org/x/text v0.36.0/go.mod h1:NIdBknypM8iqVmPiuco0Dh6P5Jcdk8lJL0CUebqK164=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

internal/sarin/captcha.go

@@ -14,10 +14,10 @@ import (
 
 const (
 	captchaPollInterval = 1 * time.Second
-	captchaTimeout      = 120 * time.Second
+	captchaPollTimeout  = 120 * time.Second
 )
 
-var captchaHTTPClient = &http.Client{Timeout: captchaTimeout}
+var captchaHTTPClient = &http.Client{Timeout: 5 * time.Second}
 
 // solveCaptcha creates a task on the given captcha service and polls until it is solved,
 // returning the extracted token from the solution object.
@@ -31,8 +31,9 @@ var captchaHTTPClient = &http.Client{Timeout: captchaTimeout}
 // It can return the following errors:
 //   - types.ErrCaptchaKeyEmpty
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
-//   - types.CaptchaTimeoutError
+//   - types.CaptchaPollTimeoutError
 //   - types.CaptchaSolutionKeyError
 func solveCaptcha(baseURL, apiKey string, task map[string]any, solutionKey string, taskIDIsString bool) (string, error) {
 	if apiKey == "" {
@@ -52,6 +53,7 @@ func solveCaptcha(baseURL, apiKey string, task map[string]any, solutionKey strin
 //
 // It can return the following errors:
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
 func captchaCreateTask(baseURL, apiKey string, task map[string]any) (string, error) {
 	body := map[string]any{
@@ -61,7 +63,7 @@ func captchaCreateTask(baseURL, apiKey string, task map[string]any) (string, err
 
 	data, err := json.Marshal(body)
 	if err != nil {
-		return "", types.NewCaptchaRequestError("createTask", err)
+		return "", types.NewCaptchaDecodeError("createTask", err)
 	}
 
 	resp, err := captchaHTTPClient.Post(
@@ -81,7 +83,7 @@ func captchaCreateTask(baseURL, apiKey string, task map[string]any) (string, err
 		TaskID           json.RawMessage `json:"taskId"`
 	}
 	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
-		return "", types.NewCaptchaRequestError("createTask", err)
+		return "", types.NewCaptchaDecodeError("createTask", err)
 	}
 
 	if result.ErrorID != 0 {
@@ -98,15 +100,15 @@ func captchaCreateTask(baseURL, apiKey string, task map[string]any) (string, err
 }
 
 // captchaPollResult polls the getTaskResult endpoint at captchaPollInterval until the task
-// is solved, an error is returned by the service, or the overall captchaTimeout is hit.
+// is solved, an error is returned by the service, or the overall captchaPollTimeout is hit.
 //
 // It can return the following errors:
-//   - types.CaptchaTimeoutError
-//   - types.CaptchaRequestError
+//   - types.CaptchaPollTimeoutError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
 //   - types.CaptchaSolutionKeyError
 func captchaPollResult(baseURL, apiKey, taskID, solutionKey string, taskIDIsString bool) (string, error) {
-	ctx, cancel := context.WithTimeout(context.Background(), captchaTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), captchaPollTimeout)
 	defer cancel()
 
 	ticker := time.NewTicker(captchaPollInterval)
@@ -115,12 +117,18 @@ func captchaPollResult(baseURL, apiKey, taskID, solutionKey string, taskIDIsStri
 	for {
 		select {
 		case <-ctx.Done():
-			return "", types.NewCaptchaTimeoutError(taskID)
+			return "", types.NewCaptchaPollTimeoutError(taskID)
 		case <-ticker.C:
 			token, err := captchaGetTaskResult(baseURL, apiKey, taskID, solutionKey, taskIDIsString)
 			if errors.Is(err, types.ErrCaptchaProcessing) {
 				continue
 			}
+			// Retry on transient HTTP errors (timeouts, connection resets, etc.)
+			// instead of failing the entire solve. The poll loop timeout will
+			// eventually catch permanently unreachable services.
+			if _, ok := errors.AsType[types.CaptchaRequestError](err); ok {
+				continue
+			}
 			if err != nil {
 				return "", err
 			}
@@ -134,6 +142,7 @@ func captchaPollResult(baseURL, apiKey, taskID, solutionKey string, taskIDIsStri
 // It can return the following errors:
 //   - types.ErrCaptchaProcessing
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
 //   - types.CaptchaSolutionKeyError
 func captchaGetTaskResult(baseURL, apiKey, taskID, solutionKey string, taskIDIsString bool) (string, error) {
@@ -146,7 +155,7 @@ func captchaGetTaskResult(baseURL, apiKey, taskID, solutionKey string, taskIDIsS
 
 	data, err := json.Marshal(bodyMap)
 	if err != nil {
-		return "", types.NewCaptchaRequestError("getTaskResult", err)
+		return "", types.NewCaptchaDecodeError("getTaskResult", err)
 	}
 
 	resp, err := captchaHTTPClient.Post(
@@ -167,7 +176,7 @@ func captchaGetTaskResult(baseURL, apiKey, taskID, solutionKey string, taskIDIsS
 		Solution         map[string]any `json:"solution"`
 	}
 	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
-		return "", types.NewCaptchaRequestError("getTaskResult", err)
+		return "", types.NewCaptchaDecodeError("getTaskResult", err)
 	}
 
 	if result.ErrorID != 0 {
@@ -199,8 +208,9 @@ const twoCaptchaBaseURL = "https://api.2captcha.com"
 // It can return the following errors:
 //   - types.ErrCaptchaKeyEmpty
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
-//   - types.CaptchaTimeoutError
+//   - types.CaptchaPollTimeoutError
 //   - types.CaptchaSolutionKeyError
 func twoCaptchaSolveRecaptchaV2(apiKey, websiteURL, websiteKey string) (string, error) {
 	return solveCaptcha(twoCaptchaBaseURL, apiKey, map[string]any{
@@ -216,8 +226,9 @@ func twoCaptchaSolveRecaptchaV2(apiKey, websiteURL, websiteKey string) (string,
 // It can return the following errors:
 //   - types.ErrCaptchaKeyEmpty
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
-//   - types.CaptchaTimeoutError
+//   - types.CaptchaPollTimeoutError
 //   - types.CaptchaSolutionKeyError
 func twoCaptchaSolveRecaptchaV3(apiKey, websiteURL, websiteKey, pageAction string) (string, error) {
 	task := map[string]any{
@@ -237,8 +248,9 @@ func twoCaptchaSolveRecaptchaV3(apiKey, websiteURL, websiteKey, pageAction strin
 // It can return the following errors:
 //   - types.ErrCaptchaKeyEmpty
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
-//   - types.CaptchaTimeoutError
+//   - types.CaptchaPollTimeoutError
 //   - types.CaptchaSolutionKeyError
 func twoCaptchaSolveTurnstile(apiKey, websiteURL, websiteKey, cData string) (string, error) {
 	task := map[string]any{
@@ -261,8 +273,9 @@ const antiCaptchaBaseURL = "https://api.anti-captcha.com"
 // It can return the following errors:
 //   - types.ErrCaptchaKeyEmpty
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
-//   - types.CaptchaTimeoutError
+//   - types.CaptchaPollTimeoutError
 //   - types.CaptchaSolutionKeyError
 func antiCaptchaSolveRecaptchaV2(apiKey, websiteURL, websiteKey string) (string, error) {
 	return solveCaptcha(antiCaptchaBaseURL, apiKey, map[string]any{
@@ -279,8 +292,9 @@ func antiCaptchaSolveRecaptchaV2(apiKey, websiteURL, websiteKey string) (string,
 // It can return the following errors:
 //   - types.ErrCaptchaKeyEmpty
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
-//   - types.CaptchaTimeoutError
+//   - types.CaptchaPollTimeoutError
 //   - types.CaptchaSolutionKeyError
 func antiCaptchaSolveRecaptchaV3(apiKey, websiteURL, websiteKey, pageAction string) (string, error) {
 	task := map[string]any{
@@ -301,8 +315,9 @@ func antiCaptchaSolveRecaptchaV3(apiKey, websiteURL, websiteKey, pageAction stri
 // It can return the following errors:
 //   - types.ErrCaptchaKeyEmpty
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
-//   - types.CaptchaTimeoutError
+//   - types.CaptchaPollTimeoutError
 //   - types.CaptchaSolutionKeyError
 func antiCaptchaSolveHCaptcha(apiKey, websiteURL, websiteKey string) (string, error) {
 	return solveCaptcha(antiCaptchaBaseURL, apiKey, map[string]any{
@@ -318,8 +333,9 @@ func antiCaptchaSolveHCaptcha(apiKey, websiteURL, websiteKey string) (string, er
 // It can return the following errors:
 //   - types.ErrCaptchaKeyEmpty
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
-//   - types.CaptchaTimeoutError
+//   - types.CaptchaPollTimeoutError
 //   - types.CaptchaSolutionKeyError
 func antiCaptchaSolveTurnstile(apiKey, websiteURL, websiteKey, cData string) (string, error) {
 	task := map[string]any{
@@ -342,8 +358,9 @@ const capSolverBaseURL = "https://api.capsolver.com"
 // It can return the following errors:
 //   - types.ErrCaptchaKeyEmpty
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
-//   - types.CaptchaTimeoutError
+//   - types.CaptchaPollTimeoutError
 //   - types.CaptchaSolutionKeyError
 func capSolverSolveRecaptchaV2(apiKey, websiteURL, websiteKey string) (string, error) {
 	return solveCaptcha(capSolverBaseURL, apiKey, map[string]any{
@@ -359,8 +376,9 @@ func capSolverSolveRecaptchaV2(apiKey, websiteURL, websiteKey string) (string, e
 // It can return the following errors:
 //   - types.ErrCaptchaKeyEmpty
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
-//   - types.CaptchaTimeoutError
+//   - types.CaptchaPollTimeoutError
 //   - types.CaptchaSolutionKeyError
 func capSolverSolveRecaptchaV3(apiKey, websiteURL, websiteKey, pageAction string) (string, error) {
 	task := map[string]any{
@@ -380,8 +398,9 @@ func capSolverSolveRecaptchaV3(apiKey, websiteURL, websiteKey, pageAction string
 // It can return the following errors:
 //   - types.ErrCaptchaKeyEmpty
 //   - types.CaptchaRequestError
+//   - types.CaptchaDecodeError
 //   - types.CaptchaAPIError
-//   - types.CaptchaTimeoutError
+//   - types.CaptchaPollTimeoutError
 //   - types.CaptchaSolutionKeyError
 func capSolverSolveTurnstile(apiKey, websiteURL, websiteKey, cData string) (string, error) {
 	task := map[string]any{

internal/types/errors.go

@@ -520,15 +520,35 @@ func (e CaptchaRequestError) Unwrap() error {
 	return e.Err
 }
 
-type CaptchaTimeoutError struct {
+type CaptchaDecodeError struct {
+	Endpoint string
+	Err      error
+}
+
+func NewCaptchaDecodeError(endpoint string, err error) CaptchaDecodeError {
+	if err == nil {
+		err = errNoError
+	}
+	return CaptchaDecodeError{Endpoint: endpoint, Err: err}
+}
+
+func (e CaptchaDecodeError) Error() string {
+	return fmt.Sprintf("captcha %s decode failed: %v", e.Endpoint, e.Err)
+}
+
+func (e CaptchaDecodeError) Unwrap() error {
+	return e.Err
+}
+
+type CaptchaPollTimeoutError struct {
 	TaskID string
 }
 
-func NewCaptchaTimeoutError(taskID string) CaptchaTimeoutError {
-	return CaptchaTimeoutError{TaskID: taskID}
+func NewCaptchaPollTimeoutError(taskID string) CaptchaPollTimeoutError {
+	return CaptchaPollTimeoutError{TaskID: taskID}
 }
 
-func (e CaptchaTimeoutError) Error() string {
+func (e CaptchaPollTimeoutError) Error() string {
 	return fmt.Sprintf("captcha solving timed out (taskId: %s)", e.TaskID)
 }