# nammayatri/shared-kernel-rs architecture

> Architecture diagram of the GitHub repository nammayatri/shared-kernel-rs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nammayatri/shared-kernel-rs
- Repository: https://github.com/nammayatri/shared-kernel-rs

## Overview

##### Project Type and Purpose
- This is a Rust-based backend microservice (“location-tracking-service”) organized as a Cargo workspace.
- Its primary role is to expose an HTTP/GRPC API for ingesting and querying geolocation data, persist that data in Redis, and interoperate with an upstream “dynamic-driver-offer-app” for authentication and testing flows.

##### File Structure Analysis
- Root: Cargo.toml defines a workspace.
- crates/macros: A procedural-macro crate; provides code-generation utilities at compile-time (not a runtime service component).
- crates/shared: A library crate containing common domain types, Redis client abstractions (commands, error handling, types).
- CI/dev config files: nix files, rust-toolchain.toml, justfiles – support reproducible builds, formatting, and services (Redis).

##### README Insights
- Dependencies: Redis (for state), dynamic-driver-offer-app (for auth), Postman/Newman (for testing).
- Build & run: via Nix flakes and Cargo; services-flake launches Redis locally.

- Top: HTTP server (actix-web / hyper)
- Middle: business logic (uses types and interfaces from crates/shared)
- Bottom: Redis adapter (crates/shared/src/redis)
5. Service’s data layer to Redis, labeling “GET/SET location data”.

- the Cargo workspace structure (macros + shared + main service)
- the runtime interactions (client ↔ service ↔ Redis/Auth)
- the architectural layering and code-generation aspects

## Diagram (Mermaid)

```mermaid
flowchart TB
  subgraph "Clients"
    direction TB
    ClientApp["Client App"]:::client
    Postman["Postman/Newman"]:::client
  end

  subgraph "Location-Tracking Service"
    direction TB
    subgraph "API Tier"
      direction TB
      HTTP["HTTP/GRPC Server"]:::service
    end
    subgraph "Domain Tier"
      direction TB
      BL["Business Logic"]:::service
      DomainTypes["Domain & Common Types"]:::library
    end
    subgraph "Data Tier"
      direction TB
      SharedRedis["Shared Redis Client Library"]:::library
      RedisAdapter["Redis Adapter"]:::service
      subgraph "Redis Client Modules"
        direction TB
        RedisMod["mod.rs"]:::library
        RedisCmd["commands.rs"]:::library
        RedisErr["error.rs"]:::library
        RedisTypes["types.rs"]:::library
      end
    end

    HTTP -->|"calls"| BL
    BL -->|"uses types"| DomainTypes
    BL -->|"uses client"| SharedRedis
    SharedRedis -->|"implements adapter"| RedisAdapter
    RedisAdapter -->|"executes"| RedisMod
  end

  subgraph "External Services"
    direction TB
    Auth["Auth Service (dynamic-driver-offer-app)"]:::external
    RedisStore["Redis Store"]:::database
  end

  subgraph "Dev Tooling & Config"
    direction TB
    Toolchain["rust-toolchain.toml"]:::infra
    Formatter["rustfmt.toml"]:::infra
    Readme["README.md"]:::infra
  end

  ClientApp -->|"HTTP/GRPC"| HTTP
  Postman -->|"HTTP/GRPC"| HTTP
  HTTP -->|"Validate JWT/OAuth"| Auth
  RedisAdapter -->|"GET/SET location data"| RedisStore

  MacrosCrate["Macros Crate"]:::library
  MacrosLib["macros/src/lib.rs"]:::library
  MacrosCrate -.->|compile-time| HTTP
  MacrosCrate -.->|compile-time| SharedRedis

  click HTTP "https://github.com/nammayatri/shared-kernel-rs/blob/backend/rust/initial-commit/Cargo.toml"
  click SharedRedis "https://github.com/nammayatri/shared-kernel-rs/tree/backend/rust/initial-commit/crates/shared/"
  click RedisCmd "https://github.com/nammayatri/shared-kernel-rs/blob/backend/rust/initial-commit/crates/shared/src/redis/commands.rs"
  click RedisErr "https://github.com/nammayatri/shared-kernel-rs/blob/backend/rust/initial-commit/crates/shared/src/redis/error.rs"
  click RedisTypes "https://github.com/nammayatri/shared-kernel-rs/blob/backend/rust/initial-commit/crates/shared/src/redis/types.rs"
  click RedisMod "https://github.com/nammayatri/shared-kernel-rs/blob/backend/rust/initial-commit/crates/shared/src/redis/mod.rs"
  click DomainTypes "https://github.com/nammayatri/shared-kernel-rs/blob/backend/rust/initial-commit/crates/shared/src/lib.rs"
  click MacrosCrate "https://github.com/nammayatri/shared-kernel-rs/tree/backend/rust/initial-commit/crates/macros/"
  click MacrosLib "https://github.com/nammayatri/shared-kernel-rs/blob/backend/rust/initial-commit/crates/macros/src/lib.rs"
  click Toolchain "https://github.com/nammayatri/shared-kernel-rs/blob/backend/rust/initial-commit/rust-toolchain.toml"
  click Formatter "https://github.com/nammayatri/shared-kernel-rs/blob/backend/rust/initial-commit/rustfmt.toml"
  click Readme "https://github.com/nammayatri/shared-kernel-rs/blob/backend/rust/initial-commit/README.md"

  classDef service fill:#add8e6,stroke:#000;
  classDef library fill:#90ee90,stroke:#000;
  classDef database fill:#87cefa,stroke:#000;
  classDef external fill:#add8e6,stroke:#000;
  classDef client fill:#d3d3d3,stroke:#000;
  classDef infra fill:#f0e68c,stroke:#000;
```
