Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: gatewayd-io/gatewayd
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v0.10.0
Choose a base ref
...
head repository: gatewayd-io/gatewayd
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v0.10.1
Choose a head ref
  • 4 commits
  • 39 files changed
  • 2 contributors

Commits on Nov 11, 2024

  1. Update deps (#631)

    * Install latest version of OpenSSL to fix CVE-2024-9143
    * Update action
    * Fix linter error
    * Convert all function to pointer receivers
    mostafa authored Nov 11, 2024
    Configuration menu
    Copy the full SHA
    6184a83 View commit details
    Browse the repository at this point in the history

Commits on Nov 27, 2024

  1. Configuration menu
    Copy the full SHA
    cb993b2 View commit details
    Browse the repository at this point in the history

Commits on Dec 14, 2024

  1. feat(raft): Implement Raft-based Consistent Hash State Management (#636)

    * feat: Add Raft consensus for consistent hashing
    
    This commit introduces Raft consensus to maintain consistency of hash-to-proxy
    mappings across multiple GatewayD instances. Key changes include:
    
    - Add new Raft package implementing consensus protocol using HashiCorp's Raft
    - Integrate Raft with consistent hashing load balancer
    - Store proxy mappings in distributed state machine
    - Add configuration options for Raft cluster setup
    - Implement leadership monitoring and peer management
    - Add FSM snapshot and restore capabilities
    
    The implementation ensures that hash-to-proxy mappings remain consistent across
    cluster nodes, improving reliability for consistent hash-based load balancing.
    
    * refactor: update consistent hash implementation with block-based proxy mapping
    
    - Replace proxy ID with block name for consistent hash mapping
    - Remove direct raft node dependency from ConsistentHash struct
    - Add ProxyByBlock map to Server for block-based proxy lookups
    - Include group name in hash key generation for better distribution
    - Add proxy initialization during server startup
    - Update FSM to use consistent naming for hash map storage
    
    This change improves the consistent hashing mechanism by using block names
    instead of proxy IDs, making it more aligned with the block-based
    architecture while maintaining backwards compatibility with the original
    load balancing strategy.
    
    * refactor: remove proxy ID and related functionality
    
    - Remove unused UUID-based ID field from Proxy struct
    - Remove GetID() method from IProxy interface and Proxy implementation
    - Remove GetProxyByID() method from Server struct
    - Remove uuid package dependency
    
    The proxy ID was not being used meaningfully in the codebase, so removing it
    simplifies the proxy implementation.
    
    * feat(raft): Add Raft integration tests and consistent hash improvements
    
    This commit introduces comprehensive Raft testing infrastructure and enhances
    the consistent hash implementation with distributed state management.
    
    Key changes:
    - Add new test cases for Raft leadership, follower behavior, and FSM operations
    - Integrate Raft with consistent hash load balancer for distributed state
    - Add TestRaftHelper utility for simplified Raft testing setup
    - Update consistent hash tests to use Raft for state persistence
    - Add GetState method to RaftNode for state inspection
    - Improve test coverage for concurrent operations
    
    The changes ensure that proxy mappings are consistently maintained across
    the cluster using Raft consensus, making the load balancer more reliable
    in distributed environments.
    
    * feat(raft): add configurable directory and improve test stability
    
    - Add Directory field to Raft config to make raft storage location configurable
    - Use t.TempDir() in tests to ensure proper cleanup of test directories
    - Rename HashMapCommand to ConsistentHashCommand for better clarity
    - Update command type constants and map names to be more descriptive
    - Fix test flakiness by using unique node IDs and random available ports
    - Remove manual directory cleanup in favor of t.TempDir() cleanup
    - Update configuration files with raft directory settings
    
    This change improves test stability and makes the raft storage location
    configurable while cleaning up naming conventions throughout the raft package.
    
    * feat(config): add default Raft configuration values
    
    Add default configuration values for Raft consensus implementation:
    - RaftAddress: 127.0.0.1:2223
    - RaftNodeID: node1
    - RaftLeaderID: node1
    - RaftDirectory: raft
    
    This change initializes the default Raft configuration in the config loader.
    
    * refactor(raft): improve error handling and code organization
    
    - Enhance error handling with wrapped errors and detailed messages
    - Add meaningful constants for timeouts and configuration values
    - Rename RaftNode to Node for better clarity
    - Fix JSON field names to match Raft convention (nodeId, leaderId)
    - Add missing error checks in critical paths
    - Improve documentation and code comments
    - Update golangci linter settings to include raft package
    
    * Add temporary directory for Raft in Test_pluginScaffoldCmd
    
    - Introduced a temporary directory for Raft using t.TempDir() in the Test_pluginScaffoldCmd test case.
    - Set the GATEWAYD_RAFT_DIRECTORY environment variable to the new temporary directory.
    - This change ensures that Raft operations during testing are isolated and do not interfere with other tests or system directories.
    
    * feat(config): add JSON parsing for raft peers env variable
    
    - Replace loadEnvVars with loadEnvVarsWithTransform to handle complex env values
    - Add special handling for raft.peers to parse JSON array into RaftPeer structs
    - Update GlobalKoanf and PluginKoanf to use new transformer function
    
    This change allows proper parsing of list-type environment variables,
    specifically for raft peer configurations.
    
    * Add GRPC to raft
    
    Add gRPC support to the Raft implementation to enable proper request forwarding between nodes. Changes include:
    
    - Add protobuf definitions for Raft service with ForwardApply RPC
    - Add gRPC server and client implementations for Raft nodes
    - Update Raft configuration to include gRPC addresses
    - Implement request forwarding logic for non-leader nodes
    - Update node configuration to handle gRPC connections
    - Add proper cleanup of gRPC resources during shutdown
    
    The changes enable proper forwarding of apply requests from follower nodes to the leader, improving the distributed consensus mechanism.
    
    * feat: add Docker Compose configuration for Raft cluster setup
    
    Add docker-compose-raft.yaml that configures a 3-node GatewayD cluster using Raft consensus protocol. The setup includes:
    - 3 GatewayD nodes with Raft configuration
    - Separate read/write PostgreSQL instances
    - Redis for caching
    - Observability stack (Prometheus, Tempo, Grafana)
    - Plugin installation service
    
    This configuration enables high availability and leader election through Raft consensus.
    
    * refactor(raft): improve error handling and code clarity
    
    - Improve variable naming in loadEnvVarsWithTransform for better readability
    - Clean up error handling in forwardToLeader and ForwardApply
    - Add proper error propagation in RPC responses
    - Fix string type conversions for peer IDs and addresses
    - Organize imports and add missing error package
    - Remove unused convertPeers function
    - Add clarifying comments for Apply methods
    
    This commit focuses on code quality improvements and better error handling
    in the Raft implementation without changing core functionality.
    
    * Add unit tests for Raft RPC server and client
    
    - Implement `TestRPCServer_ForwardApply` to test the `ForwardApply` method of the RPC server, ensuring correct handling of apply requests with various configurations.
    - Implement `TestRPCClient` to verify the creation and management of RPC clients, including client retrieval and connection closure.
    - Utilize `setupGRPCServer` to create a gRPC server for testing purposes.
    - Ensure proper setup and teardown of test nodes and gRPC connections to maintain test isolation and reliability.
    
    * Update Raft configuration in gatewayd.yaml
    
    - Change `nodeId` and `leaderId` from `node2` to `node1`.
    - Add `grpcAddress` with value `127.0.0.1:50051`.
    - Update `peers` to an empty list instead of an empty dictionary.
    
    These changes adjust the Raft configuration to reflect the new node setup and include a gRPC address for communication.
    
    * Convert RaftPeer slice to string for environment variable compatibility
    
    The function `v1.NewStruct(args)` only accepts `NewValue`, which requires converting certain types to strings. This change adds support for converting a slice of `config.RaftPeer` to a comma-separated string format. Each peer is formatted as "ID:Address:GRPCAddress". This conversion is necessary to overwrite the peers as an environment variable.
    
    * Update checksum in gatewayd_plugins.yaml
    
    - Updated the checksum value for the plugin configuration to ensure integrity and consistency with the latest changes.
    
    * Refactor Raft configuration to use `IsBootstrap` flag
    
    - Replaced `LeaderID` with `IsBootstrap` in Raft configuration across multiple files.
    - Updated YAML configuration files (`gatewayd.yaml`, `docker-compose-raft.yaml`) to reflect the new `IsBootstrap` flag.
    - Modified Go source files (`config.go`, `constants.go`, `types.go`, `raft.go`) to use `IsBootstrap` instead of `LeaderID`.
    - Adjusted test cases in `raft_test.go`, `rpc_test.go`, and `raft_helpers.go` to accommodate the new `IsBootstrap` flag.
    - Ensured that the `IsBootstrap` flag is correctly set for nodes intended to bootstrap the Raft cluster.
    
    * Increase the sleep time to pass the test case on the local machine.
    
    * fix: resolve lint issues in rpc_test.go
    
    - Added `t.Helper()` to `setupGRPCServer` and `setupNodes` functions to improve test helper identification.
    - Corrected variable naming in `TestRPCServer_ForwardApply` for clarity and consistency.
    - Ensured comments end with a period for consistency.
    - Updated assertions to use `GetSuccess()` method for better readability.
    
    * feat: Improve code readability with comments and updates
    
    - Updated Docker image references in `docker-compose-raft.yaml` to use `gatewaydio/gatewayd:latest` and added `pull_policy: always` for consistent image updates.
    - Changed server and API addresses in `gatewayd.yaml` for better port management.
    - Enhanced logging in `raft.go` by switching from `Info` to `Debug` for certain messages to reduce verbosity.
    - Added detailed comments in `raft.go` and `rpc.go` to explain the purpose and functionality of key methods, improving code readability and maintainability.
    - Introduced new helper functions with comments to clarify their roles in the Raft and RPC processes.
    
    * Improve Redis container setup and async test handling
    
    - Updated `createTestRedis` in `act_helpers_test.go` to use `wait.ForAll` for better reliability by ensuring both log readiness and port listening.
    - Enhanced `Test_Run_Async_Redis` in `registry_test.go` by adding a context with a timeout to the consumer subscription for improved test robustness.
    - Simplified the sleep duration in `Test_Run_Async_Redis` to reduce unnecessary wait time.
    
    * Handle Fatal Error on Raft Node Initialization Failure
    
    - Added error handling to record and log errors when Raft node initialization fails.
    - Ensured the application exits with a specific error code if the Raft node cannot be started.
    - Updated tests to set environment variables for Raft node configuration.
    - Added a new error code for Raft node startup failure in the error definitions.
    
    This change ensures that if the Raft node cannot be configured and started, the application will terminate gracefully, preventing further execution with an invalid state.
    
    * Update test configuration in gatewayd.yaml
    
    - Changed the raft address from 127.0.0.1:2223 to 127.0.0.1:2222.
    - Updated the nodeID from node2 to node1.
    
    These updates are made to the test data configuration to align with the current test case requirements.
    
    * Update comment to accurately describe Raft configuration constants
    
    The comment above the constants was misleading, suggesting they were only command types. Updated the comment to reflect that these constants are related to Raft operations.
    
    * Simplify leader check in monitorLeadership function
    
    - Removed the unnecessary `isLeader` variable in the `monitorLeadership` function.
    - Directly checked the node's state against `raft.Leader` in the if condition.
    
    * Fix: Gracefully handle ErrRaftShutdown during Node shutdown
    
    Updated the `Shutdown` method in `raft.go` to gracefully handle the `ErrRaftShutdown` error. This change ensures that if the Raft node is already shut down, the error is ignored, preventing unnecessary error handling.
    sinadarbouy authored Dec 14, 2024
    Configuration menu
    Copy the full SHA
    c94c475 View commit details
    Browse the repository at this point in the history
  2. Update deps (#639)

    * Update SDK
    * Update deps
    * Regenerate stubs
    * Lint protobuf messages and add HTTP annotation
    * Regenerate stubs
    * Update golang.org/x/crypto to latest version to fix vulnerability
    mostafa authored Dec 14, 2024
    Configuration menu
    Copy the full SHA
    b6df86a View commit details
    Browse the repository at this point in the history
Loading