allow grpc's MaxMsgRecvSize to be set via a config (#291)

* add ability to set MaxRecvMsgSize via config, #2305

Signed-off-by: sriv <[email protected]>

* bump version -> 4.2.0

Signed-off-by: sriv <[email protected]>

* update gh actions and go versions

Signed-off-by: sriv <[email protected]>

Signed-off-by: sriv <[email protected]>

.github/workflows/deploy.yml

@@ -12,10 +12,10 @@ jobs:
     steps:
       - uses: actions/checkout@v1
 
-      - name: Setup go 1.16
-        uses: actions/setup-go@v1
+      - name: Setup go 1.19
+        uses: actions/setup-go@v3
         with:
-          go-version: 1.16
+          go-version: '>=1.19.0'
 
       - name: build
         run: |

.github/workflows/golangci-lint.yml

@@ -11,9 +11,9 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3
         with:
           # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
           version: latest

.github/workflows/test.yml

@@ -16,12 +16,12 @@ jobs:
 
     steps:
 
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
 
-      - name: Setup go 1.16
-        uses: actions/setup-go@v1
+      - name: Setup go 1.19
+        uses: actions/setup-go@v3
         with:
-          go-version: 1.16
+          go-version: '>=1.19.0'
 
       - name: Download packages
         run: |

env/env.go

@@ -26,6 +26,7 @@ const (
 	SaveExecutionResult         = "save_execution_result"
 	pluginKillTimeout           = "plugin_kill_timeout"
 	gaugeMinifyReports          = "gauge_minify_reports"
+	gaugeMaxMessageSize         = "gauge_max_message_size"
 )
 
 func GetCurrentExecutableDir() (string, string) {
@@ -100,6 +101,15 @@ func isEnvSet(envName string) bool {
 	return strings.ToLower(envValue) == "true"
 }
 
+func GetMaxMessageSize() int {
+	m := os.Getenv(gaugeMaxMessageSize)
+	r, err := strconv.Atoi(m)
+	if err != nil {
+		return 1024
+	}
+	return r
+}
+
 // PluginKillTimeout returns the plugin_kill_timeout in seconds
 var PluginKillTimeout = func() int {
 	e := os.Getenv(pluginKillTimeout)

env/env_test.go

@@ -0,0 +1,29 @@
+package env
+
+import "testing"
+
+func TestMaxRecvMsgSize(t *testing.T) {
+	t.Run("empty value should return default", func(t *testing.T) {
+		t.Setenv(gaugeMaxMessageSize, "")
+		v := GetMaxMessageSize()
+		if v != 1024 {
+			t.Errorf("Expected 1024, got %d", v)
+		}
+	})
+
+	t.Run("non-numeric should return default", func(t *testing.T) {
+		t.Setenv(gaugeMaxMessageSize, "abcd")
+		v := GetMaxMessageSize()
+		if v != 1024 {
+			t.Errorf("Expected 1024, got %d", v)
+		}
+	})
+
+	t.Run("numeric should return set value", func(t *testing.T) {
+		t.Setenv(gaugeMaxMessageSize, "2048")
+		v := GetMaxMessageSize()
+		if v != 2048 {
+			t.Errorf("Expected 2048, got %d", v)
+		}
+	})
+}

main.go

@@ -58,7 +58,9 @@ func main() {
 		if err != nil {
 			logger.Fatalf("failed to start server.")
 		}
-		server := grpc.NewServer(grpc.MaxRecvMsgSize(1024 * 1024 * 1024))
+		mSize := env.GetMaxMessageSize()
+		logger.Debugf("Setting MaxRecvMsgSize = %d MB", mSize)
+		server := grpc.NewServer(grpc.MaxRecvMsgSize(mSize * 1024 * 1024))
 		h := &handler{server: server}
 		gauge_messages.RegisterReporterServer(server, h)
 		logger.Infof("Listening on port:%d", l.Addr().(*net.TCPAddr).Port)

plugin.json

@@ -28,5 +28,5 @@
     "scope": [
         "Execution"
     ],
-    "version": "4.1.5"
+    "version": "4.2.0"
 }