refactor!: unify the four product command trees behind ProductProfile - #16
Merged
Conversation
Every shared command now has ONE implementation in commands/,
parameterized by ProductProfile (the single source of per-product
config: endpoint, container, image, env prefix, control prefix,
display name). The gcp/az/oci command classes become ~8-line shims
(GcpStartCommand extends StartCommand { super(ProductProfile.GCP); })
that carry only their per-product help description; the three
near-identical *GlobalOptions clones are deleted. Each product tree
drops from ~1,360 to ~530 lines and copy-drift becomes impossible.
Mechanics: per-product option defaults are constructor-set field
values rendered in help via ${DEFAULT-VALUE} (annotation defaults are
compile-time constants); commands pre-initialize their GlobalOptions
mixin with the profile (picocli uses a non-null mixin field instance
as-is). Verified against a captured baseline of 480 CLI outputs
(every --help x 5 trees, env/status/doctor JSON, exit codes, routing)
plus new pinning tests: ProductProfileTest, ProductTreesParsingTest,
DoctorCheckListTest, GlobalOptionsTest.
Behavior changes, all deliberate:
- snapshot commands in gcp/az/oci trees now perform the real
/snapshots API calls with graceful degradation and exit 1 while the
server lacks the endpoints (previously: note + exit 0)
- product logs/services gained --service/--mode, and services now
resolves the endpoint from the container port mapping in all trees
- the AWS tree brands itself 'Floci AWS' in banners and help,
matching the other products
- snapshot errors link the product issue tracker instead of TODO.md
- completion generates from spec.root() instead of a hardcoded
FlociCli instance (output unchanged)
BREAKING CHANGE: 'floci gcp|az|oci snapshot export/import' (and bare
'floci snapshot ...' with a non-AWS default product) now exit 1
instead of 0 while server-side snapshot support is pending; CI
scripts relying on the silent success of stubbed snapshot commands
will fail.
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
|
| Filename | Overview |
|---|---|
| src/main/java/io/floci/cli/ProductProfile.java | Centralizes per-product name, image, ports, env prefix, and control-plane prefix for the unified command tree. |
| src/main/java/io/floci/cli/GlobalOptions.java | Single mixin with product-scoped defaults and resolvedEndpoint using product.defaultPort(). |
| src/main/java/io/floci/cli/commands/snapshot/SnapshotListCommand.java | Uses resolvedEndpoint before FlociHttpClient, fixing remapped-port reachability for list (and siblings save/load/delete). |
| src/main/java/io/floci/cli/commands/ServicesCommand.java | Adopts Docker port resolution and product control prefix tree-wide for services listing. |
Reviews (2): Last reviewed commit: "fix: snapshot save/load/list/delete reso..." | Re-trigger Greptile
Same port auto-detection status/services/wait use — a container started with --port <n> is now reachable by the snapshot commands without an explicit --endpoint. Applies to all four trees via the unified base commands.
Contributor
Author
|
Addressed in 7314d99: |
14 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Collapses the four near-identical product command trees into ONE implementation per shared command, parameterized by
ProductProfile— the single source of per-product config (endpoint, container, image, env prefix, control prefix, display name). Thegcp/az/ociclasses become ~8-line shims carrying only their per-product help description; the three*GlobalOptionsclones are deleted. Each product tree drops from ~1,360 to ~530 lines, the "apply every change to all four trees" rule is retired from AGENTS.md/CONTRIBUTING.md, and copy-drift (the source of several past bugs) becomes structurally impossible.Verified with a captured baseline of 480 CLI outputs (every
--help× 5 trees, env/status/doctor JSON, exit codes, default-product routing) diffed against main after every phase, plus native-image smoke tests across all trees.Deliberate behavior changes (all in CHANGELOG):
/snapshotsAPI calls with graceful degradation and exit 1 while server support is pending (previously note + exit 0) — see BREAKING CHANGE footer in the commitlogs/servicesgained--service/--mode(drift fix);servicesresolves the endpoint from the container port mapping in all trees (extends feat(oci): add floci oci command group for the Floci OCI emulator #15's OCI fix tree-wide)Type of change
fix:)feat:)feat!:orfix!:) — snapshot exit codes on stubbed treesProduct trees affected
commands/gcp/)commands/az/)Also
commands/oci/; the template predates the fourth tree.Checklist
mvn testpasses locally (66 tests)ProductProfileTest,ProductTreesParsingTest,DoctorCheckListTest,GlobalOptionsTest— first-ever coverage of the gcp/az/oci trees)CHANGELOG.mdentry added under[Unreleased]README.mdupdated (snapshot exit-code note)mvn package -Pnative) — per-tree smoke at the pilot phase and at the end