Files
satellite-provider/_docs/02_document/modules/common_interfaces.md
T
Oleksandr Bezdieniezhnykh 6b373082c8 [AZ-315] Sync architecture docs after coupling refactor
Phase C of architecture coupling refactor (epic AZ-309). Closes the
last baseline finding (F5 — DataAccess incorrectly documented as
importing Common) and synchronizes the rest of _docs/02_document/
with the post-split project layout from AZ-312/313/314:

- module-layout.md: per-component sections for the three new csprojs
  with explicit ProjectReferences and the no-cross-sibling-reference
  invariant the split enforces.
- architecture.md: components and internal-communication tables
  updated to show calls flow through Common interfaces.
- architecture_compliance_baseline.md: F1..F5 marked Resolved with
  task IDs and commit refs; baseline summary now 0 findings.
- diagrams/components.md, components/03_tile_downloader/description.md,
  modules/{common_interfaces,services_tile_service,
  services_google_maps_downloader,tests_unit}.md updated for the
  split, RateLimitException relocation, and new ITileService methods.

Documentation-only batch — no code, no tests, no build changes.
Epic AZ-309 complete (6 tasks across 3 batches).

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-10 07:25:21 +03:00

3.2 KiB

Module: Common/Interfaces

Purpose

Service contracts defining the application's core operations. Implementations live in the per-component service projects (SatelliteProvider.Services.TileDownloader, SatelliteProvider.Services.RegionProcessing, SatelliteProvider.Services.RouteManagement). Cross-component runtime calls between Layer-3 components flow exclusively through these interfaces — there are no compile-time ProjectReference entries between the three sibling service projects.

Public Interface

ITileService

  • DownloadAndStoreTilesAsync(double lat, double lon, double sizeMeters, int zoomLevel, CancellationToken) → Task<List<TileMetadata>>: downloads missing tiles for a region and returns all tile metadata (existing + new)
  • GetTileAsync(Guid id) → Task<TileMetadata?>: retrieve a single tile by ID
  • GetTilesByRegionAsync(double lat, double lon, double sizeMeters, int zoomLevel) → Task<IEnumerable<TileMetadata>>: query tiles within a geographic region
  • GetOrDownloadTileAsync(int z, int x, int y, CancellationToken) → Task<TileBytes>: serve a tile by Z/X/Y, hitting cache, then repository, then downloader (added in AZ-310)
  • DownloadAndStoreSingleTileAsync(double latitude, double longitude, int zoomLevel, CancellationToken) → Task<TileMetadata>: download one tile by lat/lon and persist (added in AZ-311)

IRegionService

  • RequestRegionAsync(Guid id, double lat, double lon, double sizeMeters, int zoomLevel, bool stitchTiles) → Task<RegionStatus>: creates a region record and enqueues for async processing
  • GetRegionStatusAsync(Guid id) → Task<RegionStatus?>: retrieves current status of a region request
  • ProcessRegionAsync(Guid id, CancellationToken) → Task: executes tile downloading, CSV/summary generation, optional stitching

IRouteService

  • CreateRouteAsync(CreateRouteRequest request) → Task<RouteResponse>: validates input, calculates intermediate points, persists route + points, optionally creates geofence regions
  • GetRouteAsync(Guid id) → Task<RouteResponse?>: retrieves route with all points

ISatelliteDownloader

  • GetTiles(GeoPoint geoPoint, double radiusM, int zoomLevel, CancellationToken) → Task: legacy interface for tile downloading (not directly implemented by GoogleMapsDownloaderV2)

IRegionRequestQueue

  • EnqueueAsync(RegionRequest request, CancellationToken) → ValueTask: add region request to the bounded queue
  • DequeueAsync(CancellationToken) → ValueTask<RegionRequest?>: consume next request (blocks until available)
  • Count (int): current queue depth

Internal Logic

Pure interface definitions — no logic.

Dependencies

  • All interfaces reference DTOs from SatelliteProvider.Common.DTO

Consumers

  • Program.cs — DI registration of implementations
  • RegionProcessingService — consumes IRegionRequestQueue and IRegionService
  • RouteService — consumes IRegionService (for geofence region creation)
  • RouteProcessingService — consumes IRegionService via service provider scope
  • API endpoints — consume ITileService, IRegionService, IRouteService

Data Models

None defined here.

Configuration

None.

External Integrations

None.

Security

None.

Tests

No dedicated interface tests.