linting

Author: mdigger

.gitignore

@@ -3,3 +3,5 @@
 .env
 *.log
 *.out
+cmd/fs_event_log/fs_event_log
+cmd/fs_event_log/fs_events_view

.golangci.yaml

@@ -0,0 +1,60 @@
+linters-settings:
+  errcheck:
+    check-type-assertions: true
+  forbidigo:
+    forbid:
+      # Unlike most projects, we're allowing the standard library's log
+      # package: this is a demo service, so let's keep it simple.
+      - '^fmt\.Print'
+      - '^print$'
+      - '^println$'
+      - '^panic$'
+      - '^log\.'
+  gci:
+    sections:
+      - standard # Standard section: captures all standard packages.
+      - default # Default section: contains all imports that could not be matched to another section type.
+  godox:
+    # TODO, OPT, etc. comments are fine to commit. Use FIXME comments for
+    # temporary hacks, and use godox to prevent committing them.
+    keywords: [FIXME]
+  varnamelen:
+    ignore-decls:
+      - f *os.File
+      - rw io.ReadWriter
+      - w io.Writer
+      - n int
+linters:
+  enable-all: true
+  disable:
+    - cyclop            # covered by gocyclo
+    - deadcode          # abandoned
+    - depguard          # in golangci-lint v1.53.0+ default requires only stdlib deps
+    - exhaustivestruct  # replaced by exhaustruct
+    - funlen            # rely on code review to limit function length
+    - gocognit          # dubious "cognitive overhead" quantification
+    - gofumpt           # prefer standard gofmt
+    - goimports         # rely on gci instead
+    - golint            # deprecated by Go team
+    - gomnd             # some unnamed constants are okay
+    - ifshort           # deprecated by author
+    - interfacer        # deprecated by author
+    - ireturn           # "accept interfaces, return structs" isn't ironclad
+    # - lll               # don't want hard limits for line length
+    - maintidx          # covered by gocyclo
+    - maligned          # readability trumps efficient struct packing
+    # - nlreturn          # generous whitespace violates house style
+    - nosnakecase       # deprecated in https://github.com/golangci/golangci-lint/pull/3065
+    - paralleltest      # in this project, it's not worth making all tests parallel
+    - scopelint         # deprecated by author
+    - structcheck       # abandoned
+    - testpackage       # internal tests are fine
+    - tparallel         # in this project, it's not worth making all tests parallel
+    - varcheck          # abandoned
+    # - wrapcheck         # don't _always_ need to wrap errors
+    # - wsl               # generous whitespace violates house style
+issues:
+  exclude:
+    # Don't ban use of fmt.Errorf to create new errors, but the remaining
+    # checks from err113 are useful.
+    - "err113: do not define dynamic errors.*"

client.go

@@ -21,6 +21,8 @@ type Client struct {
 }
 
 // Default timeout options.
+//
+//nolint:gochecknoglobals
 var (
 	DialTimeout = time.Second * 5
 	AuthTimeout = time.Second * 2
@@ -61,6 +63,7 @@ func NewClient(rwc io.ReadWriteCloser, password string, opts ...Option) (*Client
 
 	if err := conn.AuthTimeout(password, AuthTimeout); err != nil {
 		rwc.Close()
+
 		return nil, fmt.Errorf("failed to auth: %w", err)
 	}
 
@@ -80,7 +83,8 @@ func NewClient(rwc io.ReadWriteCloser, password string, opts ...Option) (*Client
 // Close closes the client connection.
 func (c *Client) Close() error {
 	c.sendRecv(cmd("exit")) //nolint:errcheck // ignore send error
-	return c.closer.Close()
+
+	return c.closer.Close() //nolint:wrapcheck
 }
 
 // API sends a command to the API and returns the response body or an error.
@@ -107,7 +111,7 @@ func (c *Client) API(command string) (string, error) {
 // When the command is done executing, FreeSWITCH fires an event with the result
 // and you can compare that to the Job-UUID to see what the result was. In order
 // to receive this event, you will need to subscribe to BACKGROUND_JOB events.
-func (c *Client) Job(command string) (id string, err error) {
+func (c *Client) Job(command string) (id string, err error) { //nolint:nonamedreturns
 	resp, err := c.sendRecv(cmd("bgapi", command))
 	if err != nil {
 		return "", err
@@ -127,6 +131,7 @@ func (c *Client) Job(command string) (id string, err error) {
 // to receive this event, you will need to subscribe to BACKGROUND_JOB events.
 func (c *Client) JobWithID(command, id string) error {
 	_, err := c.sendRecv(cmd("bgapi", command).WithJobUUID(id))
+
 	return err
 }
 
@@ -138,14 +143,17 @@ func (c *Client) JobWithID(command, id string) error {
 func (c *Client) Subscribe(names ...string) error {
 	cmdNames := buildEventNamesCmd(names...)
 	_, err := c.sendRecv(cmd("event", cmdNames))
+
 	return err
 }
 
 // Unsubscribe unsubscribes the client from one or more events.
 //
 // Suppress the specified type of event.
 // If name is empty then all events will be suppressed.
-func (c *Client) Unsubscribe(names ...string) (err error) {
+func (c *Client) Unsubscribe(names ...string) error {
+	var err error
+
 	cmdNames := buildEventNamesCmd(names...)
 	if cmdNames == eventAll {
 		_, err = c.sendRecv(cmd("noevents"))
@@ -176,6 +184,7 @@ func (c *Client) Unsubscribe(names ...string) (err error) {
 // events for multiple users on a particular conference.
 func (c *Client) Filter(eventHeader, valueToFilter string) error {
 	_, err := c.sendRecv(cmd("filter", eventHeader, valueToFilter))
+
 	return err
 }
 
@@ -186,6 +195,7 @@ func (c *Client) Filter(eventHeader, valueToFilter string) error {
 // is no use of the filter.
 func (c *Client) FilterDelete(eventHeader, valueToFilter string) error {
 	_, err := c.sendRecv(cmd("filter delete", eventHeader, valueToFilter))
+
 	return err
 }
 
@@ -202,6 +212,7 @@ func (c *Client) FilterDelete(eventHeader, valueToFilter string) error {
 // use a filter.
 func (c *Client) MyEvent(uuid string) error {
 	_, err := c.sendRecv(cmd("myevents", uuid))
+
 	return err
 }
 
@@ -220,13 +231,15 @@ func (c *Client) DivertEvents(on ...bool) error {
 	}
 
 	_, err := c.sendRecv(cmd("divert_events", val))
+
 	return err
 }
 
 // Send an event into the event system.
 func (c *Client) SendEvent(name string, headers map[string]string, body string) error {
 	_, err := c.sendRecv(
 		cmd("sendevent", name).WithMessage(headers, body))
+
 	return err
 }
 
@@ -235,33 +248,44 @@ func (c *Client) SendEvent(name string, headers map[string]string, body string)
 func (c *Client) SendMsg(uuid string, headers map[string]string, body string) error {
 	_, err := c.sendRecv(
 		cmd("sendmsg", uuid).WithMessage(headers, body))
+
 	return err
 }
 
+const (
+	commandReply     = "command/reply"
+	disconnectNotice = "text/disconnect-notice"
+	eventPlain       = "text/event-plain"
+)
+
 // runReader is a method of the Client struct that reads responses from the connection and handles them accordingly.
 func (c *Client) runReader(events chan<- Event, autoClose bool) {
 	c.conn.log.Info("esl: run response reading")
+
 	defer func() {
 		close(c.chResp)
 		close(c.chErr)
+
 		if autoClose && events != nil {
 			close(events)
 		}
+
 		c.conn.log.Info("esl: response reader stopped")
 	}()
 
 	for {
 		resp, err := c.conn.Read()
 		if err != nil {
 			c.chErr <- err
+
 			return // break on read error
 		}
 
-		switch ct := resp.ContentType(); ct {
-		case "api/response", "command/reply":
+		switch contentType := resp.ContentType(); contentType {
+		case "api/response", commandReply:
 			c.chResp <- resp
 
-		case "text/event-plain":
+		case eventPlain:
 			if events == nil {
 				continue // ignore events if no events channel is provided
 			}
@@ -270,18 +294,19 @@ func (c *Client) runReader(events chan<- Event, autoClose bool) {
 			if err != nil {
 				c.conn.log.Error("esl: failed to parse event",
 					slog.String("err", err.Error()))
+
 				continue // ignore bad event
 			}
 
 			c.conn.log.Info("esl: handle", slog.Any("event", event))
 			events <- event
 
-		case "text/disconnect-notice":
+		case disconnectNotice:
 			return // disconnect
 
 		default:
 			c.conn.log.Warn("esl: unexpected response",
-				slog.String("content-type", ct))
+				slog.String("content-type", contentType))
 		}
 	}
 }
@@ -302,12 +327,14 @@ func (c *Client) read() (response, error) {
 		if ok {
 			return response{}, err
 		}
+
 		return response{}, io.EOF // connection closed
 
 	case resp := <-c.chResp:
 		if err := resp.AsErr(); err != nil {
 			return response{}, err // response with error message
 		}
+
 		return resp, nil
 	}
 }

client_test.go

@@ -17,18 +17,18 @@ func TestClient(t *testing.T) {
 	go func() {
 		for ev := range events {
 			t.Logf("event %s [%d]", ev.Name(), ev.Sequence())
+
 			if ev.ContentLength() > 0 {
 				t.Logf("body: %s", ev.Body())
 			}
 		}
+
 		t.Log("events channel closed")
 	}()
 
 	client, err := Connect(addr, password,
 		WithEvents(events, true),
 		WithLog(slog.Default()),
-		// WithDumpIn(os.Stdout),
-		// WithDumpOut(os.Stderr),
 	)
 	if err != nil {
 		t.Skip("FreeSWITCH not running:", err)
@@ -43,6 +43,7 @@ func TestClient(t *testing.T) {
 	if err != nil {
 		t.Error(err)
 	}
+
 	_ = msg
 	// t.Log(msg)
 
@@ -56,38 +57,21 @@ func TestClient(t *testing.T) {
 	if err != nil {
 		t.Error(err)
 	}
+
 	if jobid == "" {
 		t.Error("incorrect job id:", jobid)
 	}
 
 	time.Sleep(time.Second * 5)
 }
 
-// for _, cmd := range []string{
-// 	// spell-checker:disable
-// 	"fsctl debug_level 9",
-// 	"fsctl loglevel 7",
-// 	"fsctl debug_sql",
-// 	"fsctl last_sps",
-// 	`json {"command" : "status", "data" : ""}`,
-// 	"md5 freeswitch-is-awesome",
-// 	"module_exists mod_callcenter",
-// 	"show channels as json",
-// 	"status",
-// 	// spell-checker:enable
-// } {
-// 	_, err := client.Job(cmd)
-// 	if err != nil {
-// 		return err
-// 	}
-// }
-
 func TestClientDefault(t *testing.T) {
 	client, err := Connect("", "ClueCon",
 		WithLog(slog.Default()),
 	)
 	if err != nil {
 		t.Skip("FreeSWITCH not running:", err)
 	}
+
 	client.Close()
 }