tc-gold-api
ASP.NET Core 8 API running the Gold incentive process — calculating commission earned by Travel Counsellors towards Gold status (periods, groups, pots) from BackOffice commission events.
Health score
0 to 100 across seven weighted factors; nothing is hidden. Green is 75 and above, amber 50 to 74, red below 50. How scoring works.
Facts
| Languages | csharp |
| Frameworks | ASP.NET Core 8, FluentValidation 11, Serilog, AutoMapper 13, Swashbuckle |
| Runtimes | .NET 8 |
| Tests / CI | some / CI in place |
| Last commit | 2026-07-16 |
| Owner | Owner unknown (mapping to be curated) |
| Domain | Agent tools and community (system generated; curate in repo-owners.json to override) |
| Product area | Shared platform |
| Hosted | On-prem Deployed to our own machines
|
| Releases | 2 release pipeline(s): \finance\gold\tc-gold-api; \finance\gold\tc-gold-api Stealth |
| Integration | rest, redis-streams, wcf, jwt |
| Source | Open in Azure DevOps |
Dependencies in context
Entanglement
loosely attached Bound into the core by 1 mechanism(s).
- Speaks WCF (client)
Detaches when its WCF surface gains a modern interface or its WCF calls move to one.
Migration playbooks
Generated from this repo's assessment data: what is feasible, what blocks it, and the steps in order. Ratings: green means actionable now, amber means sequence other work first, red means blocked, grey means not applicable.
ZDD adoption
Ready with guardrailsClose: the deployment path exists, but specific checks are needed first, typically raising tests, auditing serialized data, or respecting a shared schema with expand and contract. Test coverage is thin; ZDD shifts the safety net onto automation.
- 1 system(s) depend on this repo; during a rolling deploy they will talk to old and new versions at once, so responses must stay compatible
- Consumes WCF contract packages: never take a breaking client bump mid-feature, and treat obsolete warnings as migration debt
- Serialized state or messages in flight (Redis or queues): new code must deserialize objects written by the previous version
- Adopt the four-stage discipline from the ZDD engineering standard: pre-deployment compatibility, deployment, feature activation behind a flag, post-release cleanup.
- Raise automated test coverage first: ZDD trades the end-of-sprint manual gate for continuous automated confidence, so the tests are the entry ticket.
- Make every change dual-version safe: backwards-compatible APIs (new major version for breaking wire changes), expand and contract for any schema change, and consumers tolerant of unknown fields.
- Audit serialized data: anything in Redis, queues or shared caches must deserialize cleanly across adjacent versions.
- Wrap behaviour changes in feature flags so code deploys dark and release becomes a business decision, not a deployment event.
- Route deployments through the Workflow Engine's automated drain, deploy, health-check, return cycle (the path proven by the first automated production run in mid-2026).
- Verify with area-scoped regression rather than the whole-platform cycle, and watch error rates after rollout with automated rollback on alert.
SQL Server exit
Not applicableNo SQL Server dependency is recorded for this repo. Nothing to migrate.
Containerisation
Ready to containeriseModern runtime, no hosted legacy transport: this service can follow the estate's proven container path (Dockerfile, shared pipeline template, ECS via Terraform).
- Add a Dockerfile and make the app read all configuration from environment variables and the secrets manager, never from machine-local files.
- Log to stdout and expose a health check endpoint so ECS can supervise it.
- Adopt the shared ci.yml pipeline template with the container parameters (awsRegion, containerAfterBuild, ecsTerraformRepo), which is exactly how the estate's existing AWS services deploy.
- Define the service in the Terraform repo, deploy to a non-production environment, then shift traffic and disarm the deployment-group release pipeline.
Recommended actions
No specific actions for this repo. It either needs only normal maintenance, or its work is covered by an estate-level action. See the full programme.
Assessment notes
tc-gold-api
Purpose
Implements the "new Gold process": consumes commission events (raised by BackOffice via TC.Phenix.Accounts.Events on Redis streams) to accumulate per-salesperson Gold pots, tracks Gold periods and groups with team awareness, exposes status/migration endpoints, and triggers "hit Gold"/"close to Gold" email notifications through the Phenix notifications API.
Tech stack
C# on .NET 8, layered solution (API, Common, DataAccess, Data.ChangeScripts) with Asp.Versioning, FluentValidation, AutoMapper, Correlate correlation IDs, Serilog, Swashbuckle, PhenixAuth JWT authentication, TC.ConnectionBroker suite (Api/Mongo/Redis/Wcf), TC.Streams Redis-stream integration with MediatR handlers, TC.ScriptRunner.Mongo for schema change scripts, plus System.ServiceModel packages for CoreWCF-style clients.
Deployment
Included as prod_application with 2 releases: \finance\gold\tc-gold-api and \finance\gold\tc-gold-api Stealth, built from tc-gold-api CI (YAML via shared templates; SDK pinned to 6.x even though projects target net8.0). README documents QA/Staging/Live/Training/DR release stages; per-environment appsettings including LiveProviderQA and DataFixQA.
Dependencies
Internal: TC.ConnectionBroker.* (tc-connectionbroker), TC.Exceptions.WebApiClient.AspNetCore (webapi-exceptions), TC.Phenix.Accounts.Events (backoffice — upstream commission-event producer), TC.ExchangeRate.ServiceContract (exchange-rate-service), TC.UserAccount.ServiceContract (backoffice-useraccount-service), TC.UserAccountLegacy.ServiceContract (backoffice-useraccount-legacy), and a brokered PhenixNotifications HTTP client (phenix-notifications-api) for Gold email notifications. External: New Relic APM.
Data stores
Owns the Gold MongoDB database (GoldPeriod, GoldGroup, SalesPersonGoldPot, SalesPersonGoldStatus, CommissionEvent, GoldLogEvent, GoldEventConfig collections) plus a gold_logs Mongo database for request/response logging. Consumes/produces on the shared Redis Streams target.
Integration points
REST/JSON API (versioned, Swagger) behind PhenixAuth JWT; inbound commission events over Redis streams; outbound WCF calls to exchange-rate and user-account services; outbound REST to the notifications API.
Code health
One xunit test project (Common.Tests) with ~396 Fact/Theory cases covering handlers and validators against fake repositories — decent for the domain layer but no API/DataAccess coverage. README is substantive (architecture, controllers, event testing guidance). Actively developed, last commit 2026-07-16.
Modernisation risks
Low — modern .NET 8 with YAML CI and reasonable tests. Watch items: WCF client dependencies on legacy exchange-rate/user-account services, coupling to BackOffice event contracts over the shared Redis stream, and the CI template still pinning SDK 6.x. A dedicated GoldEventController exists to simulate Redis events, which is useful but exposes test-only surface in production code.