#343 Prepare for versioned release (#346)

docktermj · web-flow · commit 5ffd97e7763d · 2025-05-21T14:56:16.000-04:00
diff --git a/.github/linters/bearer.yml b/.github/linters/bearer.yml
@@ -0,0 +1,2 @@
+rule:
+  skip-rule: []
diff --git a/.github/workflows/bearer.yaml b/.github/workflows/bearer.yaml
@@ -0,0 +1,22 @@
+name: bearer
+
+on:
+  push:
+    branches-ignore: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  rule_check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Bearer
+        uses: bearer/bearer-action@v2
+        with:
+          config-file: .github/linters/bearer.yml
diff --git a/.github/workflows/go-test-windows.yaml b/.github/workflows/go-test-windows.yaml
@@ -16,8 +16,6 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
 
       - name: Setup go ${{ matrix.go }}
         uses: actions/setup-go@v5
diff --git a/.vscode/cspell.json b/.vscode/cspell.json
@@ -66,11 +66,12 @@
     ".dockerignore",
     ".git/*",
     ".github/linters/.golangci.yaml",
-    ".history/*",
     ".gitignore",
+    ".history/*",
     "**/*.go",
     "**/*.mod",
     "**/*.sum",
+    "bearer.ignore",
     "Makefile"
   ]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning].
 
 -
 
+## [0.4.4] - 2025-05-21
+
+### Changed in 0.4.4
+
+- Improved error messages
+
 ## [0.4.3] - 2025-04-30
 
 ### Changed in 0.4.3
diff --git a/Makefile b/Makefile
@@ -71,6 +71,7 @@ dependencies-for-development: dependencies-for-development-osarch-specific
 	@go install github.com/vladopajic/go-test-coverage/v2@latest
 	@go install golang.org/x/tools/cmd/godoc@latest
 	@go install golang.org/x/vuln/cmd/govulncheck@latest
+	@go install mvdan.cc/gofumpt@latest
 	@sudo npm install -g cspell@latest
 
 
@@ -191,6 +192,11 @@ update-pkg-cache:
 # Specific programs
 # -----------------------------------------------------------------------------
 
+.PHONY: bearer
+bearer:
+	@bearer scan --config-file .github/linters/bearer.yml .
+
+
 .PHONY: cspell
 cspell:
 	@cspell lint --dot .
diff --git a/go.mod b/go.mod
@@ -8,8 +8,8 @@ require (
 	github.com/aws/aws-sdk-go-v2/service/sqs v1.38.5
 	github.com/rabbitmq/amqp091-go v1.10.0
 	github.com/roncewind/go-util v0.0.5
-	github.com/senzing-garage/go-helpers v0.6.11
-	github.com/senzing-garage/go-logging v1.5.2
+	github.com/senzing-garage/go-helpers v0.6.12
+	github.com/senzing-garage/go-logging v1.5.3
 	github.com/senzing-garage/sz-sdk-go v0.15.3
 	github.com/sourcegraph/conc v0.3.0
 	github.com/stretchr/testify v1.10.0
@@ -31,6 +31,6 @@ require (
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/senzing-garage/go-messaging v1.5.3 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
-	golang.org/x/exp v0.0.0-20250408133849-7e4ce0ab07d0 // indirect
+	golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
diff --git a/go.sum b/go.sum
@@ -42,10 +42,10 @@ github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjR
 github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
 github.com/roncewind/go-util v0.0.5 h1:SiXs7Si68b/5paClS7QPyJ4yDnOQ3lJdi7SXhxgjBFo=
 github.com/roncewind/go-util v0.0.5/go.mod h1:3W93f0MuKIQJA21OqGPcjzw87zc1TFFTn/O0lWB2Ahg=
-github.com/senzing-garage/go-helpers v0.6.11 h1:cwXZLVFKRnriyX+RCaS1Rg9+x7/sJcJjN0TIVZo/vdo=
-github.com/senzing-garage/go-helpers v0.6.11/go.mod h1:xjTBckB68M54X5fPyG1ArjXsqfs4rW4CKLNkMDFxAmo=
-github.com/senzing-garage/go-logging v1.5.2 h1:9Rhsvxu6jLHfCLIoDxSMXX0sf/w0TY/L7i7fFfSdP64=
-github.com/senzing-garage/go-logging v1.5.2/go.mod h1:+QsFSi/qKmCC3YAyuXcRbQlBpvpmhTWLWVH2Miap1Fw=
+github.com/senzing-garage/go-helpers v0.6.12 h1:RnoDm2pnVMMGslDbJxtgZpGpuSR5dK+T7BZYoXjRaeM=
+github.com/senzing-garage/go-helpers v0.6.12/go.mod h1:/gceFlOcg8+0ujQH/CzLjqVAsXtR9xRJgMWDlpSqHGY=
+github.com/senzing-garage/go-logging v1.5.3 h1:RYF5hHL4fAUzOFMQwwotT5/I0YD3ItDF589wKtw73X4=
+github.com/senzing-garage/go-logging v1.5.3/go.mod h1:AAZvO6ectkKzD1ZbUl24X1TOd3riCQLYaMKgBnuiZF0=
 github.com/senzing-garage/go-messaging v1.5.3 h1:bH+LtEgNJj/PRbg1VMK9/Gk457CdfdcjMiubxffbTog=
 github.com/senzing-garage/go-messaging v1.5.3/go.mod h1:7qvSNAVyWcSIcsnDAm8obCxHItljN295O3fX4bOgfp0=
 github.com/senzing-garage/sz-sdk-go v0.15.3 h1:fq5eZgEooZaQZCv6Knt1zkpo0C9QU1CLS9LCOkRanqo=
@@ -58,8 +58,8 @@ go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
 go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
 go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
 go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
-golang.org/x/exp v0.0.0-20250408133849-7e4ce0ab07d0 h1:R84qjqJb5nVJMxqWYb3np9L5ZsaDtB+a39EqjV0JSUM=
-golang.org/x/exp v0.0.0-20250408133849-7e4ce0ab07d0/go.mod h1:S9Xr4PYopiDyqSyp5NjCrhFrqg6A5zA2E/iPHPhqnS8=
+golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6 h1:y5zboxd6LQAqYIhHnB48p0ByQ/GnQx2BE33L8BOHQkI=
+golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6/go.mod h1:U6Lno4MTRCDY+Ba7aCcauB9T60gsv5s4ralQzP72ZoQ=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
diff --git a/queues/rabbitmq/main.go b/queues/rabbitmq/main.go
@@ -54,4 +54,4 @@ var IDMessages = map[int]string{
 // Status strings for specific messages.
 var IDStatuses = map[int]string{}
 
-var errPackage = errors.New("rabbitmq")
+var errForPackage = errors.New("rabbitmq")
diff --git a/queues/rabbitmq/managedConsumer.go b/queues/rabbitmq/managedConsumer.go
@@ -2,7 +2,6 @@ package rabbitmq
 
 import (
 	"context"
-	"fmt"
 	"runtime"
 
 	amqp "github.com/rabbitmq/amqp091-go"
@@ -43,26 +42,25 @@ func (job *RabbitConsumerJob) Execute(ctx context.Context) error {
 			flags = senzing.SzWithInfo
 		}
 
-		result, err := (*job.engine).AddRecord(ctx, record.DataSource, record.ID, record.JSON, flags)
+		_, err := (*job.engine).AddRecord(ctx, record.DataSource, record.ID, record.JSON, flags)
 		if err != nil {
-			return fmt.Errorf(
-				"add record error, record id: %s, message id: %s, result: %s, %w",
+			return wraperror.Errorf(
+				err,
+				"add record error, record id: %s, message id: %s",
 				job.delivery.MessageId,
 				record.ID,
-				result,
-				err,
 			)
 		}
 
 		// when we successfully process a delivery, acknowledge it.
 		err = job.delivery.Ack(false)
 
-		return wraperror.Errorf(err, "queues.rabbitmq.Execute.Ack error: %w", err)
+		return wraperror.Errorf(err, "Ack")
 	}
 	// when we get an invalid delivery, negatively acknowledge and send to the dead letter queue
 	err := job.delivery.Nack(false, false)
 
-	return fmt.Errorf("invalid deliver from RabbitMQ, message id: %s, %w", job.delivery.MessageId, err)
+	return wraperror.Errorf(err, "invalid deliver from RabbitMQ, message id: %s", job.delivery.MessageId)
 }
 
 // Whenever Execute() returns an error or panics, this is called.
@@ -126,13 +124,13 @@ func StartManagedConsumer(
 
 	client, err := NewClient(urlString)
 	if err != nil {
-		return fmt.Errorf("unable to get a new RabbitMQ client %w", err)
+		return wraperror.Errorf(err, "unable to get a new RabbitMQ client")
 	}
 	defer client.Close()
 
 	deliveries, err := client.Consume(numberOfWorkers)
 	if err != nil {
-		return fmt.Errorf("unable to get a new RabbitMQ delivery channel %w", err)
+		return wraperror.Errorf(err, "unable to get a new RabbitMQ delivery channel")
 	}
 
 	workerPool := pool.New().WithMaxGoroutines(numberOfWorkers)
diff --git a/queues/rabbitmq/managedProducer.go b/queues/rabbitmq/managedProducer.go
@@ -2,9 +2,9 @@ package rabbitmq
 
 import (
 	"context"
-	"fmt"
 	"runtime"
 
+	"github.com/senzing-garage/go-helpers/wraperror"
 	"github.com/senzing-garage/go-queueing/queues"
 	"github.com/sourcegraph/conc/pool"
 )
@@ -90,18 +90,18 @@ func processRecord(ctx context.Context, record queues.Record, newClientFn func()
 	err = client.Push(ctx, record)
 	if err != nil {
 		// on error, create a new RabbitMQ client
-		err = fmt.Errorf("error pushing record, creating new client %w", err)
+		err = wraperror.Errorf(err, "error pushing record, creating new client")
 		// put a new client in the pool, dropping the current one
-		newClient, newClientErr := newClientFn()
-		if newClientErr != nil {
-			err = fmt.Errorf("error creating new client %w %w", newClientErr, err)
+		newClient, errNewClientFn := newClientFn()
+		if errNewClientFn != nil {
+			err = wraperror.Errorf(err, "error creating new client: %s", errNewClientFn.Error())
 		} else {
 			clientPool <- newClient
 		}
 		// make sure to close the old client
-		closeErr := client.Close()
-		if closeErr != nil {
-			err = fmt.Errorf("error closing client %w %w", closeErr, err)
+		errClose := client.Close()
+		if errClose != nil {
+			err = wraperror.Errorf(err, "error closing client: %s", errClose.Error())
 		}
 
 		return err
@@ -124,7 +124,7 @@ func createClients(ctx context.Context, numOfClients int, newClientFn func() (*C
 
 		client, err := newClientFn()
 		if err != nil {
-			errorStack = fmt.Errorf("error creating new client %w", err)
+			errorStack = wraperror.Errorf(err, "error creating new client")
 		} else {
 			countOfClientsCreated++
 			clientPool <- client
diff --git a/queues/rabbitmq/rabbitmq.go b/queues/rabbitmq/rabbitmq.go
@@ -3,7 +3,6 @@ package rabbitmq
 import (
 	"context"
 	"crypto/rand"
-	"fmt"
 	"math/big"
 	"net/url"
 	"time"
@@ -54,12 +53,12 @@ const (
 func NewClient(urlString string) (*ClientRabbitMQ, error) {
 	u, err := url.Parse(urlString)
 	if err != nil {
-		return nil, wraperror.Errorf(err, "unable to parse RabbitMQ URL string error: %w", err)
+		return nil, wraperror.Errorf(err, "unable to parse RabbitMQ URL string")
 	}
 
 	queryMap, _ := url.ParseQuery(u.RawQuery)
 	if len(queryMap["exchange"]) < 1 || len(queryMap["queue-name"]) < 1 {
-		return nil, wraperror.Errorf(errPackage, "please define an exchange and queue-name as query parameters")
+		return nil, wraperror.Errorf(errForPackage, "please define an exchange and queue-name as query parameters")
 	}
 
 	routingKey := queryMap["queue-name"][0]
@@ -94,7 +93,7 @@ func NewClient(urlString string) (*ClientRabbitMQ, error) {
 // Close will cleanly shutdown the channel and connection.
 func (client *ClientRabbitMQ) Close() error {
 	if !client.isReady {
-		return wraperror.Errorf(errPackage, "already closed: not connected to the server")
+		return wraperror.Errorf(errForPackage, "already closed: not connected to the server")
 	}
 
 	close(client.done)
@@ -138,7 +137,7 @@ func (client *ClientRabbitMQ) Consume(prefetch int) (<-chan amqp.Delivery, error
 		0,        // prefetch size
 		false,    // global
 	); err != nil {
-		return nil, fmt.Errorf("unable to set the RabbitMQ channel quality of service %w", err)
+		return nil, wraperror.Errorf(err, "unable to set the RabbitMQ channel quality of service")
 	}
 
 	channel, err := client.channel.Consume(
@@ -151,7 +150,7 @@ func (client *ClientRabbitMQ) Consume(prefetch int) (<-chan amqp.Delivery, error
 		nil,              // args
 	)
 
-	return channel, wraperror.Errorf(err, "queues.rabbitmq.UnsafePush error: %w", err)
+	return channel, wraperror.Errorf(err, wraperror.NoMessage)
 }
 
 // Init initializes a single RabbitMQ client that will automatically
@@ -200,7 +199,7 @@ func (client *ClientRabbitMQ) Push(ctx context.Context, record queues.Record) er
 			client.log(3001, client.resendDelay, record.GetMessageID(), err)
 			select {
 			case <-client.done:
-				return wraperror.Errorf(errPackage, "client is shutting down")
+				return wraperror.Errorf(errForPackage, "client is shutting down")
 			case <-time.After(client.resendDelay):
 				client.resendDelay = client.progressiveDelay(client.resendDelay)
 			}
@@ -249,7 +248,7 @@ func (client *ClientRabbitMQ) UnsafePush(ctx context.Context, record queues.Reco
 		},
 	)
 
-	return wraperror.Errorf(err, "queues.rabbitmq.UnsafePush error: %w", err)
+	return wraperror.Errorf(err, wraperror.NoMessage)
 }
 
 // ----------------------------------------------------------------------------
@@ -278,7 +277,7 @@ func (client *ClientRabbitMQ) changeConnection(connection *amqp.Connection) {
 func (client *ClientRabbitMQ) connect(addr string) (*amqp.Connection, error) {
 	conn, err := amqp.Dial(addr)
 	if err != nil {
-		return nil, fmt.Errorf("unable to dial RabbitMQ address: %v, error: %w", addr, err)
+		return nil, wraperror.Errorf(err, "unable to dial RabbitMQ address: %v", addr)
 	}
 
 	client.changeConnection(conn)
@@ -370,12 +369,12 @@ func (client *ClientRabbitMQ) init(conn *amqp.Connection) error {
 
 	channel, err := conn.Channel()
 	if err != nil {
-		return fmt.Errorf("unable to initialize the RabbitMQ channel %w", err)
+		return wraperror.Errorf(err, "unable to initialize the RabbitMQ channel")
 	}
 
 	err = channel.Confirm(false)
 	if err != nil {
-		return wraperror.Errorf(err, "queues.rabbitmq.init error: %w", err)
+		return wraperror.Errorf(err, "Confirm")
 	}
 
 	err = channel.ExchangeDeclare(
@@ -388,7 +387,7 @@ func (client *ClientRabbitMQ) init(conn *amqp.Connection) error {
 		nil,                 // arguments
 	)
 	if err != nil {
-		return fmt.Errorf("unable to declare the RabbitMQ exchange %w", err)
+		return wraperror.Errorf(err, "unable to declare the RabbitMQ exchange")
 	}
 
 	var queue amqp.Queue
@@ -402,7 +401,7 @@ func (client *ClientRabbitMQ) init(conn *amqp.Connection) error {
 		nil,              // arguments
 	)
 	if err != nil {
-		return fmt.Errorf("unable to initialize the RabbitMQ queue %w", err)
+		return wraperror.Errorf(err, "unable to initialize the RabbitMQ queue")
 	}
 
 	err = channel.QueueBind(
@@ -413,7 +412,7 @@ func (client *ClientRabbitMQ) init(conn *amqp.Connection) error {
 		nil,
 	)
 	if err != nil {
-		return fmt.Errorf("unable to bind the RabbitMQ queue %w", err)
+		return wraperror.Errorf(err, "unable to bind the RabbitMQ queue")
 	}
 
 	client.changeChannel(channel)
diff --git a/queues/sqs/managedConsumer.go b/queues/sqs/managedConsumer.go
diff --git a/queues/sqs/managedProducer.go b/queues/sqs/managedProducer.go
diff --git a/queues/sqs/sqs.go b/queues/sqs/sqs.go

Original file line number	Diff line number	Diff line change
`@@ -66,11 +66,12 @@`
`66`	`66`	`".dockerignore",`
`67`	`67`	`".git/*",`
`68`	`68`	`".github/linters/.golangci.yaml",`
`69`		`- ".history/*",`
`70`	`69`	`".gitignore",`
	`70`	`+ ".history/*",`
`71`	`71`	`"*/.go",`
`72`	`72`	`"*/.mod",`
`73`	`73`	`"*/.sum",`
	`74`	`+ "bearer.ignore",`
`74`	`75`	`"Makefile"`
`75`	`76`	`]`
`76`	`77`	`}`