Merge branch 'development' into docs/issue-2557-log-levels

Author: gitcrusher

.github/workflows/go.yml

@@ -111,7 +111,7 @@ jobs:
       # Upload coverage report for the 1.24 Go version only
       - name: Upload Test Coverage
         if: ${{ matrix.go-version == '1.24'}}
-        uses: actions/upload-artifact@v5
+        uses: actions/upload-artifact@v6
         with:
           name: Example-Test-Report
           path: profile.cov
@@ -186,7 +186,7 @@ jobs:
       # Upload coverage report for the 1.24 Go version only
       - name: Upload Test Coverage
         if: ${{ matrix.go-version == '1.24'}}
-        uses: actions/upload-artifact@v5
+        uses: actions/upload-artifact@v6
         with:
           name: PKG-Coverage-Report
           path: profile.cov
@@ -203,7 +203,7 @@ jobs:
 
       # Download coverage reports from previous jobs
       - name: Download Coverage Report
-        uses: actions/download-artifact@v6
+        uses: actions/download-artifact@v7
         with:
           path: artifacts
 
@@ -297,7 +297,7 @@ jobs:
 
       # Upload submodule coverage reports as an artifact
       - name: Upload Coverage Reports
-        uses: actions/upload-artifact@v5
+        uses: actions/upload-artifact@v6
         with:
           name: submodule-coverage-reports
           path: coverage_reports/*.cov
@@ -325,7 +325,7 @@ jobs:
 
       # Download coverage artifacts
       - name: Download Coverage Report
-        uses: actions/download-artifact@v6
+        uses: actions/download-artifact@v7
         with:
           path: artifacts
 

CONTRIBUTING.md

@@ -1,7 +1,7 @@
 ## Contribution Guidelines
 * Minor changes can be done directly by editing code on GitHub. GitHub automatically creates a temporary branch and
   files a PR. This is only suitable for really small changes like: spelling fixes, variable name changes or error string
-  change etc. For larger commits, following steps are recommended.
+  change etc. For larger commits, the following steps are recommended.
 * (Optional) If you want to discuss your implementation with the users of GoFr, use the GitHub discussions of this repo.
 * Configure your editor to use goimports and golangci-lint on file changes. Any code which is not formatted using these
   tools, will fail on the pipeline.
@@ -16,7 +16,7 @@
   No PR should ever decrease the overall code coverage.
 * Once your code changes are done along with the test cases, submit a PR to development branch. Please note that all PRs
   are merged from feature branches to development first.
-* PR should be raised only when development is complete and the code is ready for review. This approach helps reduce the number of open pull requests and facilitates a more efficient review process for the team.
+* A PR should be raised only when development is complete and the code is ready for review. This approach helps reduce the number of open pull requests and facilitates a more efficient review process for the team.
 * All PRs need to be reviewed by at least 2 GoFr developers. They might reach out to you for any clarification.
 * Thank you for your contribution. :)
 

docs/advanced-guide/handling-file/page.md

@@ -103,66 +103,75 @@ func main() {
 
 ### Google Cloud Storage (GCS) Bucket as File-Store
 
-To run GCS File-Store locally we can use fake-gcs-server:
-`docker run -it --rm -p 4443:4443 -e STORAGE_EMULATOR_HOST=0.0.0.0:4443 fsouza/fake-gcs-server:latest`
+**Local Setup with fake-gcs-server:**
+
+1. Start fake-gcs-server with HTTP:
+```bash
+docker run -d --name fake-gcs-server -p 4443:4443 \
+  fsouza/fake-gcs-server -scheme http -port 4443
+```
+
+2. Create a bucket:
+```bash
+curl -X POST http://localhost:4443/storage/v1/b?project=my-project-id \
+  -H "Content-Type: application/json" \
+  -d '{"name":"my-bucket"}'
+```
+
+3. Set environment variable in your `configs/.env` file:
+```bash
+STORAGE_EMULATOR_HOST=localhost:4443
+```
+
+4. Connect to GCS in your application:
 
 ```go
 package main
 
 import (
 	"gofr.dev/pkg/gofr"
-
 	"gofr.dev/pkg/gofr/datasource/file/gcs"
 )
 
 func main() {
 	app := gofr.New()
 
-	// Option 1: Using JSON credentials with local emulator
-	fs, err := gcs.New(&gcs.Config{
-		EndPoint:        "http://localhost:4566",
-		BucketName:      "my-bucket",
-		CredentialsJSON: readFile("gcs-credentials.json"),
-		ProjectID:       "my-project-id",
-	})
-
-	if err != nil {
-		app.Logger().Fatalf("Failed to initialize GCS: %v", err)
-
-	}
-
-	app.AddFileStore(fs)
+	// Local setup with fake-gcs-server (uses STORAGE_EMULATOR_HOST)
+	app.AddFileStore(gcs.New(&gcs.Config{
+		BucketName: "my-bucket",
+		ProjectID:  "my-project-id",
+	}))
 
-    // Option 2: Using default credentials (GOOGLE_APPLICATION_CREDENTIALS)
-    // fs, err := gcs.New(&gcs.Config{
-    //     BucketName: "my-bucket",
-    //     ProjectID:  "my-project-id",
-    // }))
-
-    // Option 3: Direct connection to real GCS (no EndPoint)
-    // fs, err := gcs.New(&gcs.Config{
-    //     BucketName:      "my-bucket",
-    //     CredentialsJSON: readFile("prod-creds.json"),
-    //     ProjectID:       "my-project-id",
-    // }))
-	
+	app.Run()
 	app.Run()
 }
+```
 
-// Helper function to read credentials file
-func readFile(filename string) []byte {
-    data, err := os.ReadFile(filename)
-    if err != nil {
-        log.Fatalf("Failed to read credentials file: %v", err)
-    }
-    return data
-}
+**Production Setup:**
 
+For production, authenticate using one of these methods:
+
+```go
+// Option 1: Using GOOGLE_APPLICATION_CREDENTIALS environment variable
+// Set: export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json
+app.AddFileStore(gcs.New(&gcs.Config{
+	BucketName: "my-bucket",
+	ProjectID:  "my-project-id",
+}))
+
+// Option 2: Using CredentialsJSON directly
+credJSON, _ := os.ReadFile("gcs-credentials.json")
+app.AddFileStore(gcs.New(&gcs.Config{
+	BucketName:      "my-bucket",
+	CredentialsJSON: string(credJSON),
+	ProjectID:       "my-project-id",
+}))
 ```
 
-> **Note:** When connecting to the actual GCS service, authentication can be provided via CredentialsJSON or the GOOGLE_APPLICATION_CREDENTIALS environment variable.
-> When using fake-gcs-server, authentication is not required.
-> Currently supports one bucket per file-store instance.
+> **Note:** 
+> - When `STORAGE_EMULATOR_HOST` is set, the client automatically connects to the local emulator without authentication.
+> - For production, use either `GOOGLE_APPLICATION_CREDENTIALS` environment variable or `CredentialsJSON` config field
+> - Currently supports one bucket per file-store instance
 
 ### Azure File Storage as File-Store
 

docs/advanced-guide/http-communication/page.md

@@ -88,6 +88,13 @@ func Customer(ctx *gofr.Context) (any, error) {
 
 GoFr provides its user with additional configurational options while registering HTTP service for communication. These are:
 
+- **ConnectionPoolConfig** - This option allows the user to configure HTTP connection pool settings to optimize performance for high-frequency requests. The default Go HTTP client has `MaxIdleConnsPerHost: 2`, which is often insufficient for microservices making frequent requests to the same host. This configuration allows customizing:
+  - `MaxIdleConns`: Maximum idle connections across all hosts. If not explicitly set (0), a default of 100 will be used.
+  - `MaxIdleConnsPerHost`: Maximum idle connections per host (critical for performance). If set to 0, Go's DefaultMaxIdleConnsPerHost (2) will be used. Negative values will cause validation error.
+  - `IdleConnTimeout`: How long to keep idle connections alive. If not explicitly set (0), a default of 90 seconds will be used.
+  
+  **Important**: `ConnectionPoolConfig` must be applied **first** when using multiple options, as it needs access to the underlying HTTP client transport.
+
 - **APIKeyConfig** - This option allows the user to set the `API-Key` Based authentication as the default auth for downstream HTTP Service.
 - **BasicAuthConfig** - This option allows the user to set basic auth (username and password) as the default auth for downstream HTTP Service.
 
@@ -127,6 +134,14 @@ StopCleanup()
 rc := redis.NewClient(a.Config, a.Logger(), a.Metrics())
 
 a.AddHTTPService("cat-facts", "https://catfact.ninja",
+	// ConnectionPoolConfig must be applied FIRST
+	&service.ConnectionPoolConfig{
+		MaxIdleConns:        100,              // Maximum idle connections across all hosts
+		MaxIdleConnsPerHost: 20,               // Maximum idle connections per host (increased from default 2)
+		IdleConnTimeout:     90 * time.Second, // Keep connections alive for 90 seconds
+	},
+	
+	// Other options can follow in any order
 	service.NewAPIKeyConfig("some-random-key"),
 	service.NewBasicAuthConfig("username", "password"),