Fix up comments

Author: cbullinger

generated-usage-examples/go/atlas-sdk-go/project-copy/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Notable changes to the project.
 
+## v1.2 (2025-08-17)
+### Added
+- Example scripts for scaling and archiving clusters.
+
 ## v1.1 (2025-06-17)
 ### Added
 - Example scripts for fetching cross-organization billing information.

generated-usage-examples/go/atlas-sdk-go/project-copy/README.md

@@ -16,8 +16,8 @@ Currently, the repository includes examples that demonstrate the following:
 - Download logs for a specific host
 - Pull and parse line-item-level billing data
 - Return all linked organizations from a specific billing organization
-- Get historical invoices for an organization 
-- Programmatically manage Atlas resources
+- Get historical invoices for an organization
+- Programmatically archive Atlas cluster data
 
 As the Architecture Center documentation evolves, this repository will be updated with new examples 
 and improvements to existing code. 
@@ -28,12 +28,15 @@ and improvements to existing code.
 .
 ├── examples             # Runnable examples by category
 │   ├── billing/
-│   └── monitoring/
+│   ├── monitoring/
+│   └── performance/
 ├── configs              # Atlas configuration template
 │   └── config.json
 ├── internal             # Shared utilities and helpers
+│   ├── archive/
 │   ├── auth/
 │   ├── billing/
+│   ├── clusters/
 │   ├── config/
 │   ├── data/
 │   ├── errors/
@@ -56,10 +59,13 @@ and improvements to existing code.
 
 ## Setting Environment Variables
 
-1. Create a `.env` file in the root directory with your MongoDB Atlas service account credentials:
+1. Create a `.env.<environment>` file in the root directory with your MongoDB Atlas service account credentials. For example, to create a `.env.development` file for your dev environment: 
    ```dotenv
    MONGODB_ATLAS_SERVICE_ACCOUNT_ID=your_service_account_id
    MONGODB_ATLAS_SERVICE_ACCOUNT_SECRET=your_service_account_secret
+   ATLAS_DOWNLOADS_DIR="tmp/atlas_downloads"
+   CONFIG_PATH="/configs"
+   APP_ENV="dev"
    ```
    > **NOTE:** For production, use a secrets manager (e.g. HashiCorp Vault, AWS Secrets Manager) 
    > instead of environment variables. 
@@ -121,6 +127,13 @@ go run examples/monitoring/metrics_disk/main.go
 go run examples/monitoring/metrics_process/main.go
 ```
 
+### Performance
+
+#### Archive Cluster Data
+```bash
+go run examples/performance/archiving/main.go
+```
+
 ## Changelog
 
 For list of major changes to this project, see [CHANGELOG](CHANGELOG.md).

generated-usage-examples/go/atlas-sdk-go/project-copy/internal/config/appcontext.go

@@ -13,6 +13,8 @@ import (
 	"atlas-sdk-go/internal/errors"
 )
 
+// Package config provides application context management, including environment-specific configurations
+// and caching mechanisms to optimize performance and reduce redundant loading of configurations.
 var (
 	cachedAppContext     *AppContext
 	cachedAppContextTime time.Time
@@ -41,12 +43,9 @@ type AppContext struct {
 // If strictValidation is true, invalid environments will return an error
 func LoadAppContext(explicitEnv string, strictValidation bool) (*AppContext, error) {
 	// Environment resolution priority:
-	// 1. Explicitly passed environment parameter
-	// 2. APP_ENV environment variable
-	// 3. Default to "development"
-	//
-	// Special environments:
-	// - "test": Used for automated testing, loads from .env.test and configs/config.test.json
+	// 1. An explicitly passed environment parameter
+	// 2. An APP_ENV environment variable
+	// 3. Otherwise, defaults to "development"
 
 	// Determine environment
 	env := explicitEnv
@@ -68,7 +67,6 @@ func LoadAppContext(explicitEnv string, strictValidation bool) (*AppContext, err
 	}
 	cacheMutex.RUnlock()
 
-	// Validate environment
 	if !ValidateEnvironment(env) {
 		if strictValidation {
 			return nil, fmt.Errorf("invalid environment: %s", env)
@@ -103,7 +101,6 @@ func LoadAppContext(explicitEnv string, strictValidation bool) (*AppContext, err
 	log.Printf("Loading configuration for environment: %s", env)
 	log.Printf("Using config file: %s", configPath)
 
-	// Load secrets and config
 	secrets, err := LoadSecrets()
 	if err != nil {
 		return nil, errors.WithContext(err, "loading secrets")
@@ -114,8 +111,7 @@ func LoadAppContext(explicitEnv string, strictValidation bool) (*AppContext, err
 		return nil, errors.WithContext(err, "loading config")
 	}
 
-	// Validate config with environment context
-	if err := config.Validate(env); err != nil {
+	if err = config.Validate(env); err != nil {
 		return nil, errors.WithContext(err, "validating config")
 	}
 
@@ -138,7 +134,9 @@ func LoadAppContext(explicitEnv string, strictValidation bool) (*AppContext, err
 	return appCtx, nil
 }
 
-// LoadAppContextWithContext Add context support to handle timeouts and cancellation
+// LoadAppContextWithContext initializes application context with environment-specific configuration using a provided context for cancellation support.
+// If explicitEnv is provided, it overrides the APP_ENV environment variable
+// If strictValidation is true, invalid environments will return an error
 func LoadAppContextWithContext(ctx context.Context, explicitEnv string, strictValidation bool) (*AppContext, error) {
 	// Use context for potential operations that may need cancellation
 	select {
@@ -168,27 +166,22 @@ func LoadAppContextWithContext(ctx context.Context, explicitEnv string, strictVa
 	}
 	cacheMutex.RUnlock()
 
-	// Rest of implementation mirrors LoadAppContext but with context checks
+	// The implementation mirrors LoadAppContext but with context checks
 	if !ValidateEnvironment(env) {
 		if strictValidation {
 			return nil, fmt.Errorf("invalid environment: %s", env)
 		}
 		log.Printf("Warning: Unexpected environment '%s' may cause issues", env)
 	}
 
-	// Special handling for test environment
-	if env == "test" {
-		log.Printf("Using test environment - ensure test fixtures are available")
-	}
-
 	// Add context check before expensive operations
 	select {
 	case <-ctx.Done():
 		return nil, fmt.Errorf("context cancelled while loading environment files: %w", ctx.Err())
 	default:
 	}
 
-	// Load environment files with improved approach
+	// Load environment files
 	envFiles := []string{
 		fmt.Sprintf(".env.%s", env),
 		".env",
@@ -223,7 +216,6 @@ func LoadAppContextWithContext(ctx context.Context, explicitEnv string, strictVa
 	log.Printf("Loading configuration for environment: %s", env)
 	log.Printf("Using config file: %s", configPath)
 
-	// Load secrets and config
 	secrets, err := LoadSecrets()
 	if err != nil {
 		return nil, errors.WithContext(err, "loading secrets")
@@ -234,8 +226,7 @@ func LoadAppContextWithContext(ctx context.Context, explicitEnv string, strictVa
 		return nil, errors.WithContext(err, "loading config")
 	}
 
-	// Validate config with environment context
-	if err := config.Validate(env); err != nil {
+	if err = config.Validate(env); err != nil {
 		return nil, errors.WithContext(err, "validating config")
 	}
 
@@ -258,73 +249,3 @@ func LoadAppContextWithContext(ctx context.Context, explicitEnv string, strictVa
 	return appCtx, nil
 }
 
-// getTestConfiguration provides specialized test configuration
-func getTestConfiguration() (*Config, *Secrets, error) {
-	// Check if specific test config file exists
-	testConfigFile := "configs/config.test.json"
-	if _, err := os.Stat(testConfigFile); err == nil {
-		config, err := LoadConfig(testConfigFile)
-		if err != nil {
-			return nil, nil, err
-		}
-
-		// Still use mock secrets to avoid requiring real credentials
-		mockSecrets := &Secrets{
-			ServiceAccountID:     "test-service-account-id",
-			ServiceAccountSecret: "test-service-account-secret",
-		}
-
-		return config, mockSecrets, nil
-	}
-
-	// Fall back to fully mocked configuration
-	return &Config{
-			BaseURL:     "https://cloud-mock.mongodb.com",
-			OrgID:       "test-org-id",
-			ProjectID:   "test-project-id",
-			ClusterName: "TestCluster",
-			ProcessID:   "test-cluster-shard-00-00.test.mongodb.net:27017",
-			HostName:    "test-cluster-shard-00-00.test.mongodb.net",
-		}, &Secrets{
-			ServiceAccountID:     "test-service-account-id",
-			ServiceAccountSecret: "test-service-account-secret",
-		}, nil
-}
-
-// Add diff support for testing
-func (a *AppContext) Diff(other *AppContext) []string {
-	var differences []string
-
-	if a.Environment != other.Environment {
-		differences = append(differences, fmt.Sprintf("Environment: %s vs %s",
-			a.Environment, other.Environment))
-	}
-
-	// Compare important config fields
-	if a.Config.BaseURL != other.Config.BaseURL {
-		differences = append(differences, fmt.Sprintf("BaseURL: %s vs %s",
-			a.Config.BaseURL, other.Config.BaseURL))
-	}
-
-	if a.Config.OrgID != other.Config.OrgID {
-		differences = append(differences, fmt.Sprintf("OrgID: %s vs %s",
-			a.Config.OrgID, other.Config.OrgID))
-	}
-
-	if a.Config.ProjectID != other.Config.ProjectID {
-		differences = append(differences, fmt.Sprintf("ProjectID: %s vs %s",
-			a.Config.ProjectID, other.Config.ProjectID))
-	}
-
-	if a.Config.ClusterName != other.Config.ClusterName {
-		differences = append(differences, fmt.Sprintf("ClusterName: %s vs %s",
-			a.Config.ClusterName, other.Config.ClusterName))
-	}
-
-	if a.Config.ProcessID != other.Config.ProcessID {
-		differences = append(differences, fmt.Sprintf("ProcessID: %s vs %s",
-			a.Config.ProcessID, other.Config.ProcessID))
-	}
-
-	return differences
-}

generated-usage-examples/go/atlas-sdk-go/project-copy/internal/config/loadconfig.go

@@ -8,6 +8,7 @@ import (
 	"atlas-sdk-go/internal/errors"
 )
 
+// Config holds the configuration for connecting to MongoDB Atlas
 type Config struct {
 	BaseURL     string `json:"MONGODB_ATLAS_BASE_URL"`
 	OrgID       string `json:"ATLAS_ORG_ID"`
@@ -18,6 +19,7 @@ type Config struct {
 }
 
 // LoadConfig reads a JSON configuration file and returns a Config struct
+// It validates required fields and returns an error if any validation fails.
 func LoadConfig(path string) (*Config, error) {
 	if path == "" {
 		return nil, &errors.ValidationError{
@@ -34,7 +36,7 @@ func LoadConfig(path string) (*Config, error) {
 	}
 
 	var config Config
-	if err := json.Unmarshal(data, &config); err != nil {
+	if err = json.Unmarshal(data, &config); err != nil {
 		return nil, errors.WithContext(err, "parsing configuration file")
 	}
 
@@ -62,6 +64,8 @@ func LoadConfig(path string) (*Config, error) {
 	return &config, nil
 }
 
+// Validate checks the configuration for required fields and environment-specific rules
+// It returns an error if any validation fails.
 func (c *Config) Validate(env string) error {
 	if c.BaseURL == "" {
 		return &errors.ValidationError{Message: "BaseURL is required"}

generated-usage-examples/go/atlas-sdk-go/project-copy/internal/config/loadenv.go

@@ -7,11 +7,14 @@ import (
 	"atlas-sdk-go/internal/errors"
 )
 
+// Environment variable names for service account credentials
 type Secrets struct {
 	ServiceAccountID     string
 	ServiceAccountSecret string
 }
 
+// LoadSecrets loads the required secrets from environment variables.
+// It returns a Secrets struct or an error if any required variable is missing.
 func LoadSecrets() (*Secrets, error) {
 	s := &Secrets{}
 	var missing []string