review: typo, lint, and linter configuation.

Author: ldez

.github/workflows/main.yml

@@ -16,19 +16,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      # https://github.com/marketplace/actions/setup-go-environment
       - name: Set up Go ${{ env.GO_VERSION }}
         uses: actions/setup-go@v2
         with:
           go-version: ${{ env.GO_VERSION }}
 
-     # https://github.com/marketplace/actions/checkout
       - name: Check out code
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
 
-      # https://github.com/marketplace/actions/cache
       - name: Cache Go modules
         uses: actions/cache@v2
         with:
@@ -39,17 +36,15 @@ jobs:
 
       - name: Check and get dependencies
         run: |
-          go mod download
           go mod tidy
           git diff --exit-code go.mod
           git diff --exit-code go.sum
 
-      # https://golangci-lint.run/usage/install#other-ci
       - name: Install golangci-lint ${{ env.GOLANGCI_LINT_VERSION }}
         run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
 
       - name: Launch test
         run: go test ./
 
       - name: golangci-lint
-        run: golangci-lint run
+        run: golangci-lint run

.golangci.yml

@@ -86,11 +86,13 @@ issues:
     - 'ST1000: at least one file in a package should have a package comment'
     - 'G204: Subprocess launched with variable'
     - 'G304: Potential file inclusion via variable'
+    - 'ST1020: comment on exported (.*)'
     - 'exported: exported (.*) be unexported'
     - 'exported: comment on exported (.*)'
-    - 'ST1020: comment on exported (.*)'
 
   exclude-rules:
+    - path: http2utils/utils.go
+      text: 'G103: Use of unsafe calls should be audited'
     - path: hpack.go
       text:  'SA6002: argument should be pointer-like to avoid allocations'
     - path: hpack.go
@@ -99,7 +101,5 @@ issues:
       text: 'SA9003: empty branch'
     - path: server.go
       text: 'appendAssign: append result not assigned to the same slice'
-    - path: http2utils/utils.go
-      text: 'G103: Use of unsafe calls should be audited'
     - path: server.go
       text: 'cyclomatic complexity 34 of func'

README.md

@@ -1,6 +1,6 @@
 # HTTP2
 
-http2 is a implementation of HTTP/2 protocol for [fasthttp](https://github.com/valyala/fasthttp).
+http2 is an implementation of HTTP/2 protocol for [fasthttp](https://github.com/valyala/fasthttp).
 
 # Download
 
@@ -10,14 +10,16 @@ go get github.com/dgrr/[email protected]
 
 # Help
 
-If you need any help setting up, contributing or understanding this repo, you can contact me on [gofiber's Discord](https://gofiber.io/discord).
+If you need any help to set up, contributing or understanding this repo, you can contact me on [gofiber's Discord](https://gofiber.io/discord).
 
 # How to use the server?
 
 The server can only be used if your server supports TLS.
 Then, you can call [ConfigureServer](https://pkg.go.dev/github.com/dgrr/[email protected]/http2#ConfigureServer).
 
 ```go
+package main
+
 import (
 	"github.com/valyala/fasthttp"
 	"github.com/dgrr/http2"

SECURITY.md

@@ -19,7 +19,7 @@ endeavor to keep you informed of the progress being made towards a fix and full
 These updates will be sent at least every five days.
 In reality, this is more likely to be every 24-48 hours.
 
-If you have not received a reply to your email within 48 hours or you have not heard from the security
+If you have not received a reply to your email within 48 hours, or you have not heard from the security
 team for the past five days please contact us by email to [email protected] or by Telegram message
 to [our support](https://t.me/highload_support).
 Please note that [email protected] list includes all developers, who may be outside our opensource security team.
@@ -56,7 +56,7 @@ If you have any suggestions to improve this policy, please send an email to oss-
 
 ### PGP Key for [email protected]
 
-We accept PGP-encrypted email, but the majority of the security team are not regular PGP users
+We accept PGP-encrypted email, but the majority of the security team are not regular PGP users,
 so it's somewhat inconvenient. Please only use PGP for critical security reports.
 
 ```

client.go

@@ -18,7 +18,7 @@ type ClientOpts struct {
 	PingInterval time.Duration
 
 	// OnRTT is assigned to every client after creation, and the handler
-	// will be called after every RTT measurement (after receiving a PONG mesage).
+	// will be called after every RTT measurement (after receiving a PONG message).
 	OnRTT func(time.Duration)
 }
 

conn.go

@@ -131,7 +131,7 @@ func NewConn(c net.Conn, opts ConnOpts) *Conn {
 	return nc
 }
 
-// Dialer allows to create HTTP/2 connections by specifying an address and tls configuration.
+// Dialer allows creating HTTP/2 connections by specifying an address and tls configuration.
 type Dialer struct {
 	// Addr is the server's address in the form: `host:port`.
 	Addr string
@@ -558,7 +558,7 @@ func (c *Conn) readNext() (fr *FrameHeader, err error) {
 		switch fr.Type() {
 		case FrameSettings:
 			st := fr.Body().(*Settings)
-			if !st.IsAck() { // if has ack, just ignore
+			if !st.IsAck() { // if it has ack, just ignore
 				c.handleSettings(st)
 			}
 		case FrameWindowUpdate:

data.go

@@ -46,7 +46,7 @@ func (data *Data) EndStream() bool {
 	return data.endStream
 }
 
-// Data returns the byte slice of the data readed/to be sendStream.
+// Data returns the byte slice of the data read/to be sendStream.
 func (data *Data) Data() []byte {
 	return data.b
 }

demo/go.sum

@@ -2,10 +2,8 @@ github.com/andybalholm/brotli v1.0.2 h1:JKnhI/XQ75uFBTiuzXpzFrUriDPiZjlOSzh6wXog
 github.com/andybalholm/brotli v1.0.2/go.mod h1:loMXtMfwqflxFJPmdbJO0a3KNoPuLBgiu3qAvBg8x/Y=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/dgrr/http2 v0.0.3 h1:2NijwvdUOP3AAAqViZL+U4iQgRJcjujnVEqLa7Q07J0=
-github.com/dgrr/http2 v0.0.3/go.mod h1:8048JZlnCAoD1CzeLKt0Tjjphzn6gCwZjYkCYp57Mb8=
-github.com/dgrr/websocket v0.0.7 h1:cC5iErIMYpu+W1tWB1NOfVPKhgAASf+Tl0sAdEHAxkQ=
-github.com/dgrr/websocket v0.0.7/go.mod h1:d30hG8q3dQuz6eSwROXzIodSvPTNi52j1VvxrK7RWXc=
+github.com/dgrr/http2 v0.1.1 h1:Xkkiv3i+nl75R9bS9+lawAL2IkQzDkHw9VT2KbzwSb8=
+github.com/dgrr/http2 v0.1.1/go.mod h1:534gu4ElcxFQDGimb9zgrC2cYTrQG2TdldOEnMSEPB8=
 github.com/dgrr/websocket v0.0.8 h1:8zQndnzaeo8wlxbbQXO/L9zWA9CNoTfD1dASdiSbJ34=
 github.com/dgrr/websocket v0.0.8/go.mod h1:d30hG8q3dQuz6eSwROXzIodSvPTNi52j1VvxrK7RWXc=
 github.com/fasthttp/router v1.4.0 h1:sWMk0q7M6Qj73eLIolh/934mKTNZIWDrEPDhZUF1pAg=

demo/main.go

@@ -52,8 +52,8 @@ func newBTCTiles() fasthttp.RequestHandler {
 		var row [][]byte
 		for xi := 0; xi < xt; xi++ {
 			si := im.(subImager).SubImage(image.Rectangle{
-				Min: image.Point{xi * tileSize, yi * tileSize},
-				Max: image.Point{(xi + 1) * tileSize, (yi + 1) * tileSize},
+				Min: image.Point{X: xi * tileSize, Y: yi * tileSize},
+				Max: image.Point{X: (xi + 1) * tileSize, Y: (yi + 1) * tileSize},
 			})
 			buf := new(bytes.Buffer)
 			if err := jpeg.Encode(buf, si, &jpeg.Options{Quality: 90}); err != nil {

errors.go

@@ -101,8 +101,8 @@ var (
 		HTTP11Required:       "HTTP/1.1 required",
 	}
 
-	// This error codes must be used with FrameGoAway.
-	ErrUnknowFrameType = NewError(
+	// ErrUnknownFrameType This error codes must be used with FrameGoAway.
+	ErrUnknownFrameType = NewError(
 		ProtocolError, "unknown frame type")
 	ErrMissingBytes = NewError(
 		ProtocolError, "missing payload bytes. Need more")

examples/client/main.go

@@ -3,12 +3,13 @@ package main
 import (
 	"encoding/json"
 	"fmt"
-	"github.com/dgrr/http2"
-	"github.com/valyala/fasthttp"
 	"log"
 	"sync"
 	"sync/atomic"
 	"time"
+
+	"github.com/dgrr/http2"
+	"github.com/valyala/fasthttp"
 )
 
 func main() {

frameHeader.go

@@ -10,14 +10,16 @@ import (
 )
 
 const (
-	// FrameHeader default size
+	// DefaultFrameSize FrameHeader default size
 	// http://httpwg.org/specs/rfc7540.html#FrameHeader
 	DefaultFrameSize = 9
 	// https://httpwg.org/specs/rfc7540.html#SETTINGS_MAX_FRAME_SIZE
 	defaultMaxLen = 1 << 14
+)
 
-	// Frame Flag (described along the frame types)
-	// More flags have been ignored due to redundancy.
+// Frame Flag (described along the frame types)
+// More flags have been ignored due to redundancy.
+const (
 	FlagAck        FrameFlags = 0x1
 	FlagEndStream  FrameFlags = 0x1
 	FlagEndHeaders FrameFlags = 0x4
@@ -192,7 +194,7 @@ func (f *FrameHeader) readFrom(br *bufio.Reader) (int64, error) {
 
 	if f.kind > FrameContinuation {
 		_, _ = br.Discard(f.length)
-		return 0, ErrUnknowFrameType
+		return 0, ErrUnknownFrameType
 	}
 	f.fr = AcquireFrame(f.kind)
 

headerField.go

@@ -108,12 +108,12 @@ func (hf *HeaderField) SetValue(value string) {
 	hf.value = append(hf.value[:0], value...)
 }
 
-// SetKeyString sets key to the field.
+// SetKeyBytes sets key to the field.
 func (hf *HeaderField) SetKeyBytes(key []byte) {
 	hf.key = append(hf.key[:0], key...)
 }
 
-// SetValueString sets value to the field.
+// SetValueBytes sets value to the field.
 func (hf *HeaderField) SetValueBytes(value []byte) {
 	hf.value = append(hf.value[:0], value...)
 }

hpack.go

@@ -10,7 +10,7 @@ import (
 // HPACK represents header compression methods to
 // encode and decode header fields in HTTP/2.
 //
-// HPACK is equivalent to a HTTP/1 header.
+// HPACK is equivalent to an HTTP/1 header.
 //
 // Use AcquireHPACK to acquire new HPACK structure.
 type HPACK struct {
@@ -19,13 +19,13 @@ type HPACK struct {
 
 	// DisableDynamicTable disables the usage of the dynamic table for
 	// the HPACK structure. If this option is true the HPACK won't add any
-	// field to the dynamic table unless it was sended by the peer.
+	// field to the dynamic table unless it was sent by the peer.
 	//
 	// This field was implemented because in many ways the server could modify
-	// the fields stablished by the client losing performance calculated by client.
+	// the fields established by the client losing performance calculated by client.
 	DisableDynamicTable bool
 
-	// the dynamic table is in a inverse order.
+	// the dynamic table is in an inverse order.
 	//
 	// the insertion point should be the beginning. But we are going to do
 	// the opposite, insert on the end and drop on the beginning.
@@ -162,7 +162,7 @@ func (hp *HPACK) peek(n uint64) *HeaderField {
 
 // find gets the index of existent key in static or dynamic tables.
 func (hp *HPACK) search(hf *HeaderField) (n uint64, fullMatch bool) {
-	// start searching in the dynamic table (probably it contains less fields than the static.
+	// start searching in the dynamic table (probably it contains fewer fields than the static).
 	for i, hf2 := range hp.dynamic {
 		if fullMatch = bytes.Equal(hf.key, hf2.key) && bytes.Equal(hf.value, hf2.value); fullMatch {
 			n = uint64(maxIndex + len(hp.dynamic) - i - 1)

hpack_test.go

@@ -445,7 +445,7 @@ func writeHPACKAndCheck(t *testing.T, hpack *HPACK, r []byte, fields, table []st
 	}
 
 	if i := compare(b, r); i != -1 {
-		t.Fatalf("failed in %d (%d): %s", i, tableSize, hexComparision(b[i:], r[i:]))
+		t.Fatalf("failed in %d (%d): %s", i, tableSize, hexComparison(b[i:], r[i:]))
 	}
 
 	n = 0
@@ -720,7 +720,7 @@ func TestHPACKWriteResponseWithHuffman(t *testing.T) { // WithHuffman
 	ReleaseHPACK(hpack)
 }
 
-func hexComparision(b, r []byte) (s string) {
+func hexComparison(b, r []byte) (s string) {
 	s += "\n"
 	for i := range b {
 		s += fmt.Sprintf("%x", b[i]) + " "

huffman.go

@@ -106,7 +106,7 @@ func (node *huffmanNode) add(sym byte, code uint32, length uint8) {
 	}
 
 	n := 8 - length
-	start, end := int(uint8(code<<n)), int(1<<n)
+	start, end := int(uint8(code<<n)), 1<<n
 	for i := start; i < start+end; i++ {
 		node.sub[i] = &huffmanNode{sym: sym, codeLen: length}
 	}

server.go

@@ -106,7 +106,7 @@ func (s *Server) ServeConn(c net.Conn) error {
 	for err == nil {
 		fr, err = ReadFrameFromWithSize(sc.br, sc.clientS.frameSize)
 		if err != nil {
-			if errors.Is(err, ErrUnknowFrameType) {
+			if errors.Is(err, ErrUnknownFrameType) {
 				err = nil
 				continue
 			}
@@ -127,7 +127,7 @@ func (s *Server) ServeConn(c net.Conn) error {
 		switch fr.Type() {
 		case FrameSettings:
 			st := fr.Body().(*Settings)
-			if !st.IsAck() { // if has ack, just ignore
+			if !st.IsAck() { // if it has ack, just ignore
 				sc.handleSettings(st)
 			}
 		case FrameWindowUpdate:

settings.go

@@ -4,16 +4,18 @@ const FrameSettings FrameType = 0x4
 
 var _ Frame = &Settings{}
 
+// default Settings parameters.
 const (
-	// default Settings parameters.
 	defaultHeaderTableSize   uint32 = 4096
 	defaultConcurrentStreams uint32 = 100
 	defaultWindowSize        uint32 = 1<<16 - 1
 	defaultDataFrameSize     uint32 = 1 << 14
 
 	maxFrameSize = 1<<24 - 1
+)
 
-	// FrameSettings string values (https://httpwg.org/specs/rfc7540.html#SettingValues)
+// FrameSettings string values (https://httpwg.org/specs/rfc7540.html#SettingValues)
+const (
 	HeaderTableSize      uint16 = 0x1
 	EnablePush           uint16 = 0x2
 	MaxConcurrentStreams uint16 = 0x3
@@ -25,7 +27,7 @@ const (
 // Settings is the options to establish between endpoints
 // when starting the connection.
 //
-// This options have been humanize.
+// These options have been humanized.
 type Settings struct {
 	ack         bool
 	rawSettings []byte
@@ -84,7 +86,7 @@ func (st *Settings) HeaderTableSize() uint32 {
 
 // SetPush allows to set the PushPromise settings.
 //
-// If value is true the Push Promise will be enable.
+// If value is true the Push Promise will be enabled.
 // if not the Push Promise will be disabled.
 func (st *Settings) SetPush(value bool) {
 	st.enablePush = value