chore: support retries for test mode

Author: martinnaj

CHANGELOG.md

@@ -5,6 +5,12 @@ 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.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.20.0] - 2026-02-02
+
+### Changed
+- Support for retries
+- Upgraded Go to 1.25.6
+
 ## [0.19.1] - 2026-02-02
 
 ### Changed
@@ -130,6 +136,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release
 
+[0.20.0]: https://github.com/gooddata/gooddata-neobackstop/compare/v0.19.1...v0.20.0
 [0.19.1]: https://github.com/gooddata/gooddata-neobackstop/compare/v0.19.0...v0.19.1
 [0.19.0]: https://github.com/gooddata/gooddata-neobackstop/compare/v0.18.0...v0.19.0
 [0.18.0]: https://github.com/gooddata/gooddata-neobackstop/compare/v0.17.0...v0.18.0

Dockerfile

@@ -1,5 +1,5 @@
 # Stage 0: Build the base go system with playwright drivers
-FROM 020413372491.dkr.ecr.us-east-1.amazonaws.com/pullthrough/docker.io/library/golang:1.25.4-bookworm AS basesystem
+FROM 020413372491.dkr.ecr.us-east-1.amazonaws.com/pullthrough/docker.io/library/golang:1.25.6-bookworm AS basesystem
 WORKDIR /
 
 # Install CA certs & dependencies
@@ -14,7 +14,7 @@ RUN apt-get update && apt-get install -y \
 RUN GOOS=linux GOARCH=${TARGETARCH} go run github.com/playwright-community/playwright-go/cmd/playwright@latest install --with-deps chromium firefox
 
 # Stage 1: Build the Go app
-FROM 020413372491.dkr.ecr.us-east-1.amazonaws.com/pullthrough/docker.io/library/golang:1.25.4-bookworm AS builder
+FROM 020413372491.dkr.ecr.us-east-1.amazonaws.com/pullthrough/docker.io/library/golang:1.25.6-bookworm AS builder
 WORKDIR /app
 
 # Copy Go module files and download dependencies

README.md

@@ -41,7 +41,7 @@ go get github.com/gooddata/gooddata-neobackstop@latest
 ### Building from Source
 
 Prerequisites:
-- Go 1.25.4 or later
+- Go 1.25.6 or later
 - Playwright browsers (installed automatically on first run)
 
 ```bash
@@ -126,7 +126,7 @@ func main() {
 
     // Convert to internal format
     internalScenarios := converters.ScenariosToInternal(
-        cfg.Browsers, cfg.Viewports, scenarios,
+        cfg.Browsers, cfg.Viewports, cfg.RetryCount, scenarios,
     )
 
     // Install and run Playwright
@@ -192,7 +192,7 @@ func main() {
     json.Unmarshal(scenariosBytes, &scenarios)
 
     internalScenarios := converters.ScenariosToInternal(
-        cfg.Browsers, cfg.Viewports, scenarios,
+        cfg.Browsers, cfg.Viewports, cfg.RetryCount, scenarios,
     )
 
     // Find a specific scenario to debug
@@ -323,7 +323,8 @@ The main configuration file controls browser settings, viewports, output paths,
         ]
     },
     "asyncCaptureLimit": 2,
-    "asyncCompareLimit": 6
+    "asyncCompareLimit": 6,
+    "retryCount": 0
 }
 ```
 
@@ -342,6 +343,7 @@ The main configuration file controls browser settings, viewports, output paths,
 | `args`                           | object     | Browser-specific launch arguments          |
 | `asyncCaptureLimit`              | number     | Max concurrent screenshot captures         |
 | `asyncCompareLimit`              | number     | Max concurrent image comparisons           |
+| `retryCount`                     | number     | Extra retries on mismatch in test mode     |
 
 #### Viewport Configuration
 
@@ -376,24 +378,25 @@ Defines the test scenarios - which pages to capture and how to interact with the
 
 #### Scenario Options
 
-| Option                | Type             | Description                                 |
-|-----------------------|------------------|---------------------------------------------|
-| `id`                  | string           | Unique identifier for the scenario          |
-| `label`               | string           | Human-readable label (used in reports)      |
-| `url`                 | string           | URL to navigate to                          |
-| `browsers`            | string[]         | Override global browsers for this scenario  |
-| `viewports`           | Viewport[]       | Override global viewports for this scenario |
-| `readySelector`       | string           | CSS selector to wait for before capture     |
-| `reloadAfterReady`    | boolean          | Reload page after ready selector appears    |
-| `delay`               | number \| object | Wait time after ready (see below)           |
-| `keyPressSelector`    | object           | Element to focus and key to press           |
-| `hoverSelector`       | string           | Single element to hover over                |
-| `hoverSelectors`      | array            | Multiple elements to hover in sequence      |
-| `clickSelector`       | string           | Single element to click                     |
-| `clickSelectors`      | array            | Multiple elements to click in sequence      |
-| `postInteractionWait` | string \| number | Wait after interactions (selector or ms)    |
-| `scrollToSelector`    | string           | Element to scroll into view                 |
-| `misMatchThreshold`   | number           | Allowed mismatch percentage (0-100)         |
+| Option                | Type             | Description                                       |
+|-----------------------|------------------|---------------------------------------------------|
+| `id`                  | string           | Unique identifier for the scenario                |
+| `label`               | string           | Human-readable label (used in reports)            |
+| `url`                 | string           | URL to navigate to                                |
+| `browsers`            | string[]         | Override global browsers for this scenario        |
+| `viewports`           | Viewport[]       | Override global viewports for this scenario       |
+| `readySelector`       | string           | CSS selector to wait for before capture           |
+| `reloadAfterReady`    | boolean          | Reload page after ready selector appears          |
+| `delay`               | number \| object | Wait time after ready (see below)                 |
+| `keyPressSelector`    | object           | Element to focus and key to press                 |
+| `hoverSelector`       | string           | Single element to hover over                      |
+| `hoverSelectors`      | array            | Multiple elements to hover in sequence            |
+| `clickSelector`       | string           | Single element to click                           |
+| `clickSelectors`      | array            | Multiple elements to click in sequence            |
+| `postInteractionWait` | string \| number | Wait after interactions (selector or ms)          |
+| `scrollToSelector`    | string           | Element to scroll into view                       |
+| `misMatchThreshold`   | number           | Allowed mismatch percentage (0-100)               |
+| `retryCount`          | number           | Extra retries for the scenario (overrides global) |
 
 ## Scenario Examples
 

VERSION

@@ -1 +1 @@
-0.19.1
+0.20.0

config/types.go

@@ -21,4 +21,5 @@ type Config struct {
 	AsyncCaptureLimit     int                          `json:"asyncCaptureLimit"`
 	AsyncCompareLimit     int                          `json:"asyncCompareLimit"`
 	RequireSameDimensions bool                         `json:"requireSameDimensions"`
+	RetryCount            int                          `json:"retryCount"`
 }

converters/converters.go

@@ -9,7 +9,12 @@ import (
 	"github.com/gooddata/gooddata-neobackstop/viewport"
 )
 
-func scenarioToInternal(b browser.Browser, v viewport.Viewport, s scenario.Scenario) internals.Scenario {
+func scenarioToInternal(b browser.Browser, v viewport.Viewport, rc int, s scenario.Scenario) internals.Scenario {
+	retryCount := rc
+	if s.RetryCount != nil {
+		retryCount = *s.RetryCount
+	}
+
 	return internals.Scenario{
 		Browser:             b,
 		Viewport:            v,
@@ -28,34 +33,35 @@ func scenarioToInternal(b browser.Browser, v viewport.Viewport, s scenario.Scena
 		PostInteractionWait: s.PostInteractionWait,
 		ScrollToSelector:    s.ScrollToSelector,
 		MisMatchThreshold:   s.MisMatchThreshold,
+		RetryCount:          retryCount,
 	}
 }
 
-func ScenariosToInternal(browsers []browser.Browser, viewports []viewport.Viewport, scenarios []scenario.Scenario) []internals.Scenario {
+func ScenariosToInternal(browsers []browser.Browser, viewports []viewport.Viewport, retryCount int, scenarios []scenario.Scenario) []internals.Scenario {
 	output := make([]internals.Scenario, 0) // we could pre-calculate this, but until we do multi-browser testing, it's not worth it
 
 	for _, s := range scenarios {
 		if s.Browsers == nil {
 			for _, b := range browsers {
 				if s.Viewports == nil {
 					for _, v := range viewports {
-						output = append(output, scenarioToInternal(b, v, s))
+						output = append(output, scenarioToInternal(b, v, retryCount, s))
 					}
 				} else {
 					for _, v := range s.Viewports {
-						output = append(output, scenarioToInternal(b, v, s))
+						output = append(output, scenarioToInternal(b, v, retryCount, s))
 					}
 				}
 			}
 		} else {
 			for _, b := range s.Browsers {
 				if s.Viewports == nil {
 					for _, v := range viewports {
-						output = append(output, scenarioToInternal(b, v, s))
+						output = append(output, scenarioToInternal(b, v, retryCount, s))
 					}
 				} else {
 					for _, v := range s.Viewports {
-						output = append(output, scenarioToInternal(b, v, s))
+						output = append(output, scenarioToInternal(b, v, retryCount, s))
 					}
 				}
 			}

go.mod

@@ -1,6 +1,6 @@
 module github.com/gooddata/gooddata-neobackstop
 
-go 1.25.4
+go 1.25.6
 
 require github.com/playwright-community/playwright-go v0.5200.1
 

internals/types.go

@@ -26,4 +26,5 @@ type Scenario struct {
 	PostInteractionWait *scenario.SelectorThenDelay             `json:"postInteractionWait"`
 	ScrollToSelector    *string                                 `json:"scrollToSelector"`
 	MisMatchThreshold   *float64                                `json:"misMatchThreshold"`
+	RetryCount          int                                     `json:"retryCount"`
 }

main.go

@@ -94,7 +94,7 @@ func main() {
 	}
 
 	// build internal scenarios
-	internalScenarios := converters.ScenariosToInternal(configuration.Browsers, configuration.Viewports, scenarios)
+	internalScenarios := converters.ScenariosToInternal(configuration.Browsers, configuration.Viewports, configuration.RetryCount, scenarios)
 
 	numInternalScenarios := len(internalScenarios)
 	fmt.Println("Generated", numInternalScenarios, "internal scenarios")
@@ -205,6 +205,9 @@ func main() {
 		if compareResult.HasReference {
 			r.ReferenceFileName = compareResult.ScreenshotterResult.FileName
 			r.MatchesReference = &compareResult.MatchesReference
+			if compareResult.ScreenshotterResult.RetriesUsed != nil && *compareResult.ScreenshotterResult.RetriesUsed > 0 {
+				r.RetriesUsed = compareResult.ScreenshotterResult.RetriesUsed
+			}
 
 			if !compareResult.MatchesReference {
 				// diff will exist

result/types.go

@@ -12,4 +12,5 @@ type Result struct {
 	MatchesReference   *bool              `json:"matches_reference"`
 	DiffFileName       *string            `json:"diff_file_name"`
 	MisMatchPercentage *float64           `json:"misMatchPercentage"`
+	RetriesUsed        *int               `json:"retriesUsed,omitempty"`
 }