fix(parser): apply version to user-agent (#26)

* fix(parser): apply version to user-agent

This moves the version var that we use LDL flags on builds to set to the current release version, and makes sure it is always applied by default.

* addresses pr feedback

Author: erraggy

.goreleaser.yaml

@@ -32,7 +32,7 @@ builds:
       - goos: windows
         goarch: arm64
     ldflags:
-      - -s -w -X main.version={{.Version}}
+      - -s -w -X github.com/erraggy/oastools.version={{.Version}}
 
 archives:
   - formats: [tar.gz]

build_details.go

@@ -0,0 +1,19 @@
+package oastools
+
+import "fmt"
+
+var (
+	// version is set via ldflags during build by GoReleaser
+	// For development builds, this will show "dev"
+	version = "dev"
+)
+
+// Version returns the compiled version or 'dev' if run from source
+func Version() string {
+	return version
+}
+
+// UserAgent returns the User-Agent string to use
+func UserAgent() string {
+	return fmt.Sprintf("oastools/%s", version)
+}

cmd/oastools/main.go

@@ -7,6 +7,7 @@ import (
 	"path/filepath"
 	"time"
 
+	"github.com/erraggy/oastools"
 	"github.com/erraggy/oastools/converter"
 	"github.com/erraggy/oastools/differ"
 	"github.com/erraggy/oastools/joiner"
@@ -15,10 +16,6 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
-// version is set via ldflags during build by GoReleaser
-// For development builds, this will show "dev"
-var version = "dev"
-
 func main() {
 	if len(os.Args) < 2 {
 		printUsage()
@@ -29,7 +26,7 @@ func main() {
 
 	switch command {
 	case "version", "-v", "--version":
-		fmt.Printf("oastools v%s\n", version)
+		fmt.Printf("oastools v%s\n", oastools.Version())
 	case "help", "-h", "--help":
 		printUsage()
 	case "validate":
@@ -60,7 +57,6 @@ func handleParse(args []string) {
 
 	// Create parser with version in User-Agent
 	p := parser.New()
-	p.UserAgent = fmt.Sprintf("oastools/%s", version)
 
 	// Parse the file or URL
 	result, err := p.Parse(specPath)
@@ -174,7 +170,6 @@ func handleValidate(args []string) {
 	v := validator.New()
 	v.StrictMode = strict
 	v.IncludeWarnings = !noWarnings
-	v.UserAgent = fmt.Sprintf("oastools/%s", version)
 
 	// Validate the file or URL with timing
 	startTime := time.Now()
@@ -524,7 +519,6 @@ func handleConvert(args []string) {
 	c := converter.New()
 	c.StrictMode = strict
 	c.IncludeInfo = !noWarnings
-	c.UserAgent = fmt.Sprintf("oastools/%s", version)
 
 	// Convert the file or URL with timing
 	startTime := time.Now()
@@ -671,7 +665,6 @@ func handleDiff(args []string) {
 		d.Mode = differ.ModeSimple
 	}
 	d.IncludeInfo = !noInfo
-	d.UserAgent = fmt.Sprintf("oastools/%s", version)
 
 	// Diff the files with timing
 	startTime := time.Now()

parser/parser.go

@@ -11,6 +11,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/erraggy/oastools"
 	semver "github.com/hashicorp/go-version"
 	"gopkg.in/yaml.v3"
 
@@ -33,7 +34,7 @@ func New() *Parser {
 	return &Parser{
 		ResolveRefs:       false,
 		ValidateStructure: true,
-		UserAgent:         "oastools",
+		UserAgent:         oastools.UserAgent(),
 	}
 }
 
@@ -154,7 +155,7 @@ func (p *Parser) fetchURL(urlStr string) ([]byte, string, error) {
 	// Set user agent (use default if not set)
 	userAgent := p.UserAgent
 	if userAgent == "" {
-		userAgent = "oastools"
+		userAgent = oastools.UserAgent()
 	}
 	req.Header.Set("User-Agent", userAgent)
 

parser/parser_test.go

@@ -2422,12 +2422,12 @@ paths: {}`
 		{
 			name:              "default user agent when not set",
 			userAgent:         "",
-			expectedUserAgent: "oastools",
+			expectedUserAgent: "oastools/dev",
 		},
 		{
 			name:              "default user agent from New()",
 			userAgent:         "default",
-			expectedUserAgent: "oastools",
+			expectedUserAgent: "oastools/dev",
 		},
 	}