More updates to linting and remove REST service

Author: mjc-gh

.github/workflows/ci.yml

@@ -44,7 +44,7 @@ jobs:
 
     - name: Set up tools
       env:
-        PISCES_CHROMEDP_REMOTE_URL: "http://localhost:9222"
+        CHROMEDP_REMOTE_URL: "http://localhost:9222"
       run: |
         go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
 

.github/workflows/release.yml

@@ -30,8 +30,8 @@ jobs:
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
-          name: pisces-${{ matrix.goos }}-${{ matrix.goarch }}
-          path: build/pisces*
+          name: virgo-${{ matrix.goos }}-${{ matrix.goarch }}
+          path: build/virgo*
 
   release:
     needs: build
@@ -55,22 +55,22 @@ jobs:
 
       - name: Prepare for release
         run: |
-          tar -czvf pisces-darwin-amd64.tar.gz artifacts/pisces-darwin-amd64/pisces
-          tar -czvf pisces-darwin-arm64.tar.gz artifacts/pisces-darwin-arm64/pisces
-          tar -czvf pisces-linux-amd64.tar.gz artifacts/pisces-linux-amd64/pisces
-          tar -czvf pisces-linux-arm64.tar.gz artifacts/pisces-linux-arm64/pisces
-          zip -r pisces-win-amd64.zip artifacts/pisces-windows-amd64/pisces
-          zip -r pisces-win-arm64.zip artifacts/pisces-windows-arm64/pisces
+          tar -czvf virgo-darwin-amd64.tar.gz artifacts/virgo-darwin-amd64/virgo
+          tar -czvf virgo-darwin-arm64.tar.gz artifacts/virgo-darwin-arm64/virgo
+          tar -czvf virgo-linux-amd64.tar.gz artifacts/virgo-linux-amd64/virgo
+          tar -czvf virgo-linux-arm64.tar.gz artifacts/virgo-linux-arm64/virgo
+          zip -r virgo-win-amd64.zip artifacts/virgo-windows-amd64/virgo
+          zip -r virgo-win-arm64.zip artifacts/virgo-windows-arm64/virgo
 
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
           body_path: ${{ github.workspace }}_RELEASE_NOTES.txt
           draft: true
           files: |
-            pisces-darwin-amd64.tar.gz
-            pisces-darwin-arm64.tar.gz
-            pisces-linux-amd64.tar.gz
-            pisces-linux-arm64.tar.gz
-            pisces-win-amd64.zip
-            pisces-win-arm64.zip
+            virgo-darwin-amd64.tar.gz
+            virgo-darwin-arm64.tar.gz
+            virgo-linux-amd64.tar.gz
+            virgo-linux-arm64.tar.gz
+            virgo-win-amd64.zip
+            virgo-win-arm64.zip

.golangci.yml

@@ -2,22 +2,13 @@ version: "2"
 linters:
   default: all
   disable:
-    # TODO: Get these linters enabled
-    - contextcheck
-    - gochecknoglobals
-    - godox
-    - ireturn
-    - tparallel
-    - paralleltest
-
+    - gomodguard # deprecated
     # These are disabled for now, primarily out of author preference
     - cyclop
     - depguard
     - embeddedstructfieldcheck
     - exhaustruct
-    - funlen
-    - lll
-    - gocognit
+    - godox
     - mnd
     - noinlineerr
     - testpackage
@@ -30,7 +21,28 @@ linters:
     rules:
       - path: engine/crawler.go
         linters:
+          - funlen
+          - gocognit
           - nestif
+      - path: internal/browser/profiles.go
+        linters:
+          - lll
+      - path: logger.go
+        linters:
+          - gochecknoglobals
+      - path: internal/pagetest/pagetest.go
+        linters:
+          - gosec
+      - path: "cmd/(.+)/main.go"
+        linters:
+          - funlen
+          - gochecknoglobals
+      - path: '(.+)_test\.go'
+        linters:
+          - funlen
+          - goconst
+          - lll
+          - paralleltest
 
   settings:
     tagliatelle:

cmd/virgo-web/main.go

@@ -17,6 +17,8 @@ import (
 	"github.com/urfave/cli/v3"
 )
 
+const URL = "url"
+
 var ErrInvalidDeviceProperties = errors.New("invalid device properties")
 var ErrScreenShotFailed = errors.New("screenshot result error")
 
@@ -34,7 +36,9 @@ func main() {
 		&cli.IntFlag{Name: "concurrency", Aliases: []string{"c"}, Usage: "number of concurrent workers"},
 		&cli.IntFlag{Name: "remote-port", Usage: "remote DevTools port"},
 		&cli.StringFlag{Name: "remote-host", Usage: "remote DevTools host"},
-		&cli.StringFlag{Name: "device-type", Value: "desktop", Usage: "device type (desktop/mobile/tablet)", Action: validDeviceType},
+		&cli.StringFlag{
+			Name: "device-type", Value: "desktop", Usage: "device type (desktop/mobile/tablet)", Action: validDeviceType,
+		},
 		&cli.StringFlag{Name: "device-size", Value: "large", Usage: "device size preset", Action: validDeviceSize},
 		&cli.StringFlag{Name: "user-agent", Value: "chrome", Usage: "browser user-agent preset"},
 	}
@@ -53,7 +57,7 @@ func main() {
 				Name:  "screenshot",
 				Usage: "Screenshot one or more URLs",
 				Arguments: []cli.Argument{
-					&cli.StringArgs{Name: "url", Min: 1, Max: -1},
+					&cli.StringArgs{Name: URL, Min: 1, Max: -1},
 				},
 				Flags: append([]cli.Flag{
 					&cli.StringFlag{Name: "output-dir", Value: "tmp/", Aliases: []string{"o"}, Usage: "directory for screenshots"},
@@ -64,7 +68,7 @@ func main() {
 			}, {
 				Name:      "markdown",
 				Usage:     "Get the markdown content of a URL",
-				Arguments: []cli.Argument{&cli.StringArg{Name: "url"}},
+				Arguments: []cli.Argument{&cli.StringArg{Name: URL}},
 				Flags: append([]cli.Flag{
 					&cli.BoolFlag{Name: "include-images", Aliases: []string{"i"}, Usage: "include images in markdown output"},
 				}, baseFlags...),
@@ -78,7 +82,7 @@ func main() {
 			}, {
 				Name:      "plaintext",
 				Usage:     "Get the plantext content of a URL",
-				Arguments: []cli.Argument{&cli.StringArg{Name: "url"}},
+				Arguments: []cli.Argument{&cli.StringArg{Name: URL}},
 				Flags:     baseFlags,
 				Action: func(ctx context.Context, cmd *cli.Command) error {
 					return runTask(ctx, cmd, "plaintext", map[string]any{}, stdOutCallback)
@@ -100,12 +104,12 @@ func runTask(ctx context.Context, cmd *cli.Command, name string, params map[stri
 	deviceType := cmd.StringArg("device-type")
 	remoteHost := cmd.String("remote-host")
 	remotePort := cmd.Int("remote-port")
-	urls := cmd.StringArgs("url")
+	urls := cmd.StringArgs(URL)
 
 	opts := []engine.Option{engine.WithLogger(virgo.Logger())}
 
 	if len(urls) == 0 {
-		url := cmd.StringArg("url")
+		url := cmd.StringArg(URL)
 		urls = []string{url}
 	}
 
@@ -147,7 +151,7 @@ func stdOutCallback(cmd *cli.Command, e *engine.Engine) error {
 		}
 
 		logger.Debug().
-			Str("url", r.URL).
+			Str(URL, r.URL).
 			Str("duration", r.Elapsed.String()).
 			Msg("plaintext result")
 
@@ -186,7 +190,7 @@ func screenshotCallback(cmd *cli.Command, e *engine.Engine) error {
 		}
 
 		logger.Debug().
-			Str("url", r.URL).
+			Str(URL, r.URL).
 			Str("duration", r.Elapsed.String()).
 			Msg("screenshot result")
 

cmd/virgo/main.go

@@ -38,6 +38,8 @@ func TestWithRemoteAllocator(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
 			engine := New(1, WithRemoteAllocator(tt.host, tt.port))
 
 			assert.Equal(t, tt.expectedUrl, engine.config.remoteURL)
@@ -49,6 +51,8 @@ func TestWithLogger(t *testing.T) {
 	t.Parallel()
 
 	t.Run("sets logger on engine", func(t *testing.T) {
+		t.Parallel()
+
 		logger := zerolog.Nop()
 
 		engine := New(1, WithLogger(&logger))
@@ -62,6 +66,8 @@ func TestNew(t *testing.T) {
 	t.Parallel()
 
 	t.Run("creates engine with valid concurrency", func(t *testing.T) {
+		t.Parallel()
+
 		concurrency := 5
 		engine := New(concurrency)
 
@@ -72,6 +78,8 @@ func TestNew(t *testing.T) {
 	})
 
 	t.Run("sets minimum concurrency to 1 when less than 1", func(t *testing.T) {
+		t.Parallel()
+
 		engine := New(0)
 		assert.Equal(t, 1, engine.config.concurrency)
 
@@ -80,6 +88,8 @@ func TestNew(t *testing.T) {
 	})
 
 	t.Run("creates engine with multiple options", func(t *testing.T) {
+		t.Parallel()
+
 		logger := zerolog.Nop()
 		host := "localhost"
 		port := 9222
@@ -97,6 +107,8 @@ func TestNew(t *testing.T) {
 	})
 
 	t.Run("creates engine with no options", func(t *testing.T) {
+		t.Parallel()
+
 		engine := New(2)
 
 		assert.NotNil(t, engine)
@@ -106,6 +118,8 @@ func TestNew(t *testing.T) {
 	})
 
 	t.Run("channels have correct buffer sizes", func(t *testing.T) {
+		t.Parallel()
+
 		concurrency := 10
 		engine := New(concurrency)
 
@@ -121,6 +135,8 @@ func TestOptions_CanBeComposed(t *testing.T) {
 	t.Parallel()
 
 	t.Run("options can be created and applied separately", func(t *testing.T) {
+		t.Parallel()
+
 		logger := zerolog.Nop()
 
 		opts := []Option{

engine/engine_test.go

@@ -7,7 +7,7 @@ const SIZE_SMALL = "small"
 const PROFILE_DESKTOP = "desktop"
 const PROFILE_MOBILE = "mobile"
 
-var ChromeDesktopUserAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36"
+const ChromeDesktopUserAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36"
 
 func IsValidDeviceType(deviceType string) bool {
 	return (deviceType == PROFILE_DESKTOP) || (deviceType == PROFILE_MOBILE)

internal/browser/profiles.go

@@ -95,12 +95,12 @@ func (h handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 
 func NewTestContext() (context.Context, context.CancelFunc) {
 	ctx := context.Background()
-	remoteUrl, useRemote := os.LookupEnv("virgo_CHROMEDP_REMOTE_URL")
+	remoteUrl, useRemote := os.LookupEnv("CHROMEDP_REMOTE_URL")
 	if useRemote {
 		return browser.StartRemote(ctx, remoteUrl)
 	}
 
-	_, useHeadfull := os.LookupEnv("virgo_HEADFULL")
+	_, useHeadfull := os.LookupEnv("CHROMEDP_HEADFULL")
 
 	return browser.StartLocal(ctx, useHeadfull)
 }