chore(release): version 4.1.0

Author: Pallab Maiti

.github/workflows/build-and-quality-checks.yml

@@ -1,7 +1,7 @@
 name: Code Quality Checks
 on:
   pull_request:
-    branches: ['v3.3']
+    branches: ['master']
     types: ['opened', 'reopened', 'synchronize']
 
 jobs:

.github/workflows/check-pr-title.yml

@@ -1,7 +1,7 @@
 name: Check PR title
 on:
   pull_request:
-    branches: ['v3.3']
+    branches: ['master']
     types: ['opened', 'reopened', 'edited', 'synchronize']
 
 jobs:

Readme.md

@@ -90,7 +90,7 @@ func main() {
 			Interval:     30 * time.Second,
 			BatchSize:    100,
 			Verbose:      true,
-			Gzip:         0,  // Enables Gzip compression - set to 1 to disable Gzip.
+			DisableGzip:  false  // Enables Gzip compression - set true to disable Gzip.
 		})
 
     // Enqueues a track event that will be sent asynchronously.
@@ -108,7 +108,7 @@ func main() {
 
 ## Gzip support
 
-The Go SDK supports Gzip compression from version 4.0.0 and it is enabled (set to `0`) by default. However, you can disable this feature by setting the `Gzip` parameter to `1` while initializing the SDK, as shown:
+The Go SDK supports Gzip compression from version 4.1.0 and it is enabled by default. However, you can disable this feature by setting the `DisableGzip` parameter to `true` while initializing the SDK, as shown:
 
 ```go
 client, _ := analytics.NewWithConfig(WRITE_KEY,
@@ -117,7 +117,7 @@ client, _ := analytics.NewWithConfig(WRITE_KEY,
 			Interval:     30 * time.Second,
 			BatchSize:    100,
 			Verbose:      true,
-			Gzip:         0  // Enables Gzip compression - set to 1 to disable Gzip.
+			DisableGzip:  false  // Enables Gzip compression - set true to disable Gzip.
 		})
 ```
 

analytics.go

@@ -18,7 +18,7 @@ import (
 )
 
 // Version of the client.
-const Version = "4.0.0"
+const Version = "4.1.0"
 
 // This interface is the main API exposed by the analytics package.
 // Values that satsify this interface are returned by the client constructors
@@ -449,7 +449,7 @@ func (c *client) upload(b []byte, targetNode string) error {
 		req      *http.Request
 		reqError error
 	)
-	if c.Config.Gzip == 0 {
+	if !c.Config.DisableGzip {
 		gzipPayload := func(data []byte) (io.Reader, error) {
 			var b bytes.Buffer
 			gz, err := gzip.NewWriterLevel(&b, gzip.BestSpeed)

analytics_test.go

@@ -231,7 +231,7 @@ func ExampleTrack() {
 	//       "context": {
 	//         "library": {
 	//           "name": "analytics-go",
-	//           "version": "4.0.0"
+	//           "version": "4.1.0"
 	//         }
 	//       },
 	//       "event": "Download",
@@ -493,7 +493,7 @@ func TestDisableGzipSupport(t *testing.T) {
 		BatchSize:    1,
 		now:          mockTime,
 		uid:          mockId,
-		Gzip:         1,
+		DisableGzip:  true,
 	})
 	defer client.Close()
 
@@ -763,8 +763,8 @@ func TestClientNewRequestError(t *testing.T) {
 			nil,
 			func(m Message, e error) { errchan <- e },
 		},
-		Transport: testTransportOK,
-		Gzip:      1,
+		Transport:   testTransportOK,
+		DisableGzip: true,
 	})
 
 	client.Enqueue(Track{UserId: "A", Event: "B"})

config.go

@@ -92,8 +92,11 @@ type Config struct {
 	// Maximum bytes in a batch
 	MaxBatchBytes int
 
-	// Disable/enable gzip support. 0 = Enable, 1 = Disable
+	// Deprecated: Gzip is deprecated, will be removed in next releases. Use DisableGzip.
 	Gzip int
+
+	// Disable/enable gzip support.
+	DisableGzip bool
 }
 
 // This constant sets the default endpoint to which client instances send
@@ -202,6 +205,10 @@ func makeConfig(c Config) Config {
 		c.MaxBatchBytes = defMaxBatchBytes
 	}
 
+	if c.Gzip != 0 {
+		c.DisableGzip = true
+	}
+
 	// We always overwrite the 'library' field of the default context set on the
 	// client because we want this information to be accurate.
 	c.DefaultContext.Library = LibraryInfo{

example/example.go

@@ -34,6 +34,7 @@ func main() {
 			Interval:     30 * time.Second,
 			BatchSize:    100,
 			Verbose:      true,
+			DisableGzip:  false,
 		})
 	defer client.Close()
 

fixtures/test-context-track.json

@@ -4,7 +4,7 @@
       "context": {
         "library": {
           "name": "analytics-go",
-          "version": "4.0.0"
+          "version": "4.1.0"
         },
         "whatever": "here"
       },

fixtures/test-enqueue-alias.json

@@ -9,7 +9,7 @@
       "context": {
         "library": {
           "name": "analytics-go",
-          "version": "4.0.0"
+          "version": "4.1.0"
         }
       },
       "channel": "server"

fixtures/test-enqueue-group.json

@@ -9,7 +9,7 @@
       "context": {
         "library": {
           "name": "analytics-go",
-          "version": "4.0.0"
+          "version": "4.1.0"
         }
       },
       "channel": "server",