How ovotech/comms-aws works
Main Components
a) Core Components:
• Auth Module (AWS Signing)
• Common Module (Shared Utilities)
• S3 Module (S3 Client Implementation)
b) External Dependencies/Integration Points:
• AWS Services (S3)
• fs2 (Functional Streams)
• Effect System (likely Cats Effect based on the functional nature)
Top Level (Client Applications)
• ▼
Module Layer
┌──────────────────────────────────────┐
• ┌─────────┐ ┌────────┐ ┌────┐ │
• Auth │ │ Common │ │ S3 │ │
• ┘ └────────┘ └────┘ │
• ┘
• ▼ ▼ ▼
Infrastructure Layer
┌──────────────────────────────────────┐
• AWS Service Integration │
• ┘
Component Details
Auth Module:
• AwsSigner component
• SignV4 authentication flow
• To other modules that require signing
Common Module:
• Shared components:
• CredentialsProvider
• HTTP Codecs
• Model definitions
• Custom Headers
S3 Module:
• S3 client implementation
• URI parsing utilities
• Connection to Auth module for request signing
Implementation Details to Highlight
• How the AwsSigner integrates with different AWS services
• Relationship between Common module utilities and other modules
• Demonstrate how the S3 client uses the auth module for request signing
Future Extensibility
A separate section showing:
• Planned extraction of DynamoDB client (dynosaur)
• Potential future AWS service integrations
• Integration points for future modules
Remember to:
• Version/status indicators for experimental components