refactor: [#294] create Network domain type and migrate service configs #295
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Create Network enum in src/domain/topology/ with Database, Metrics, Visualization, and Proxy variants - Implement custom Serialize for template compatibility (outputs name string) - Add name(), driver(), all(), Display trait implementations - Migrate TrackerServiceConfig, MysqlServiceConfig, CaddyServiceConfig, PrometheusServiceConfig, and GrafanaServiceConfig to use Vec<Network> - Add comprehensive unit tests for network assignment rules - All 1953 unit tests pass - E2E infrastructure and deployment tests pass
josecelano
added a commit
that referenced
this pull request
Jan 25, 2026
josecelano
force-pushed
the
294-phase-1-network-domain-types
branch
from
0f3b32e to
3d3b2b1
Compare
Member
Author
|
ACK 3d3b2b1 |
This was referenced Jan 25, 2026
josecelano
added a commit
that referenced
this pull request
Jan 25, 2026
…gregate (P2.1, P2.2) d51857b docs: [#296] add Phase 3 port topology to epic and create draft issue (Jose Celano) cf3b6f3 feat: [#296] add network descriptions as inline comments in docker-compose.yml (Jose Celano) a5071c9 docs: [#296] move network security docs from template to Rust module (Jose Celano) cee9de8 docs: [#296] update documentation with Phase 2 PR #297 completion (Jose Celano) f9de701 refactor: [#296] create DockerComposeTopology aggregate and derive networks (Jose Celano) Pull request description: # Phase 2: Create DockerComposeTopology Aggregate **Issue**: #296 **Epic**: #287 (Docker Compose Topology Domain Model Refactoring) ## Summary This PR implements Phase 2 of the Docker Compose Topology refactoring, introducing the `DockerComposeTopology` aggregate and establishing the single source of truth pattern for network derivation. ## Changes ### P2.1: Service Enum and Aggregate - **`Service` enum** (`src/domain/topology/service.rs`): Type-safe service identification with 5 variants: - `Tracker` - Core BitTorrent tracker - `MySQL` - Database service - `Prometheus` - Metrics collection - `Grafana` - Visualization - `Caddy` - TLS proxy - **`DockerComposeTopology` aggregate** (`src/domain/topology/aggregate.rs`): - Collects all `ServiceTopology` entries - Derives `required_networks()` from service configurations - Ensures deterministic ordering (alphabetical by name) - Enforces invariants: no orphan networks - **`ServiceTopology` struct**: Links services to their network assignments ### P2.2: Network Derivation in Context and Template - **`NetworkDefinition` type** (`context/network_definition.rs`): Template-friendly network representation - **Context updates** (`context/mod.rs`, `context/builder.rs`): - Added `required_networks` field to `DockerComposeContext` - Added `derive_required_networks()` method in builder - Networks collected from all enabled services, deduplicated, sorted - **Template update** (`docker-compose.yml.tera`): - Replaced 4 conditional network blocks with single `required_networks` loop - Before: `{%- if mysql %}\n database_network:\n driver: bridge\n{%- endif %}` - After: `{%- for net in required_networks %}\n {{ net.name }}:\n driver: {{ net.driver }}\n{%- endfor %}` ## Test Coverage - 14 new tests for `DockerComposeTopology` aggregate - 12 new tests for `Service` enum - 5 new tests for `NetworkDefinition` - 12 new tests for `required_networks` derivation in context - All 389 unit tests pass - All E2E tests pass (infrastructure lifecycle + deployment workflow) ## Behavioral Equivalence The generated `docker-compose.yml` output is functionally identical before and after this change. The only difference is implementation: networks are now derived from service configurations rather than duplicated in template conditionals. ## Files Changed | File | Change | |------|--------| | `src/domain/topology/service.rs` | **NEW** - Service enum | | `src/domain/topology/aggregate.rs` | **NEW** - DockerComposeTopology aggregate | | `src/domain/topology/mod.rs` | Modified - exports new types | | `src/domain/mod.rs` | Modified - re-exports new types | | `context/network_definition.rs` | **NEW** - NetworkDefinition type | | `context/mod.rs` | Modified - required_networks field + tests | | `context/builder.rs` | Modified - derive_required_networks() | | `docker-compose.yml.tera` | Modified - uses required_networks loop | ## Progress Update After this PR: - ✅ ADR-01: Bind Mount Standardization (PR #289) - ✅ BUG-01: Remove invalid Grafana template branch (PR #291) - ✅ Phase 0: Bind mounts (PR #293) - ✅ Phase 1: Network domain types (PR #295) - ✅ **Phase 2: DockerComposeTopology aggregate** (this PR) - ⏳ Phase 3: Service volumes with bind mount type (next) - ⏳ Phase 4: Integration in builder pipeline (final) ACKs for top commit: josecelano: ACK d51857b Tree-SHA512: f8faa90b6211e491c9e9be05d762c12d1cac6ed5e0bb671877ec007b129784f2bad1dacbf16b37c6c77f6a35024f4ada8dbf23b5a8fa260f52b511a55005538c
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements Phase 1 of Epic #287 (Docker Compose Topology Domain Model Refactoring).
Changes
P1.1: Create Network Domain Type
Created
Networkenum insrc/domain/topology/network.rswith four variants:Database- for database servicesMetrics- for Prometheus/exportersVisualization- for GrafanaProxy- for Caddy reverse proxyImplemented:
name()- returns network name string (e.g., "database_network")driver()- returns Docker driver (always "bridge")all()- returns slice of all network variantsDisplaytrait for user-friendly outputSerialize- outputs network name string for Tera template compatibilityHashandEqfor use in HashSet collectionsP1.2: Migrate Service Configs to Use Network Enum
Updated all service config types to use
Vec<Network>instead ofVec<String>:TrackerServiceConfigMysqlServiceConfigCaddyServiceConfigPrometheusServiceConfigGrafanaServiceConfigAdded comprehensive unit tests validating network assignment rules for each service.
Testing
Related Issues
Checklist