Add get coaching session by id (#168)

* Add a new docs/release-notes/ directory where each release's notes are stored in addition to being part of a GitHub release.

* Implements a GET endpoint for retrieving a coaching session by it's specific id

* Run cargo fmt

* Address all of the failing clippy lint errors so the GitHub Actions lint stage passes.

* Implement a UserCanAccessCoachingSession Check and use it when retrieving a coaching session by id

* Run cargo fmt

Author: jhodapp

docs/release-notes/RELEASE_NOTES_1.0.0-beta1.md

@@ -0,0 +1,185 @@
+# 🚀 Refactor Platform v1.0.0-beta1
+
+**First Public Beta Release**
+
+We're excited to announce the first public beta release of the Refactor Coaching & Mentorship Platform! This Rust-based backend provides a comprehensive web API for coaching and mentoring software engineers, designed for professional coaches, informal mentors, and engineering leaders.
+
+## 🎯 What's New
+
+### 🏗️ **Core Platform Architecture**
+
+- **Layered Architecture**: Clean separation between web, domain, entity API, and data layers
+- **Domain-Driven Design**: Business logic centralized in the domain layer with clear entity relationships
+- **Repository Pattern**: Abstracted database operations through the entity API layer
+- **RESTful API**: Comprehensive HTTP API with OpenAPI documentation
+
+### 👥 **User Management & Authentication**
+
+- **Session-based Authentication**: Secure cookie-based user sessions with `axum-login`
+- **Role-based Access Control**: Admin and user roles with granular permissions
+- **User Profiles**: Complete user management with profile updates and password changes
+- **Organization Membership**: Users can belong to multiple organizations
+
+### 🏢 **Organization Management**
+
+- **Multi-tenant Architecture**: Support for multiple coaching organizations
+- **Organization Administration**: Create, update, and manage coaching organizations
+- **User Assignment**: Add and remove users from organizations
+- **Hierarchical Permissions**: Organization-scoped access controls
+
+### 🤝 **Coaching Relationship Management**
+
+- **Coach-Coachee Relationships**: Formal relationship tracking between coaches and coachees
+- **Relationship Lifecycle**: Create, manage, and archive coaching relationships
+- **Cross-organizational Support**: Relationships can span multiple organizations
+
+### 📝 **Coaching Session Management**
+
+- **Session Tracking**: Schedule and document coaching sessions
+- **Session Notes**: Rich text note-taking with TipTap integration for collaborative editing
+- **Session History**: Complete timeline of coaching interactions
+
+### 🎯 **Goal & Action Management**
+
+- **Overarching Goals**: Long-term objectives for coaching relationships
+- **Action Items**: Specific, trackable commitments and next steps
+- **Status Tracking**: Monitor progress with customizable status workflows (Not Started, In Progress, Completed, Won't Do)
+- **Due Date Management**: Time-bound action items with deadline tracking
+
+### 📋 **Agreements & Documentation**
+
+- **Coaching Agreements**: Formal agreements and contracts management
+- **Document Lifecycle**: Create, update, and manage coaching documentation
+- **Structured Data**: Consistent data models across all coaching artifacts
+
+### 🔗 **External Integrations**
+
+- **TipTap Cloud**: Real-time collaborative document editing
+- **JWT Token Generation**: Secure token-based authentication for external services
+- **API Versioning**: Built-in support for API evolution and backward compatibility
+
+## 🛠️ **Technical Highlights**
+
+### 🦀 **Modern Rust Stack**
+
+- **Axum Web Framework**: High-performance async web server
+- **SeaORM**: Type-safe database operations with PostgreSQL
+- **Tokio Runtime**: Efficient async/await concurrency
+- **UUID-based IDs**: Globally unique identifiers for all entities
+
+### 📊 **Database & Migrations**
+
+- **PostgreSQL Backend**: Robust relational database with full ACID compliance
+- **Schema Migrations**: Versioned database schema with rollback support
+- **Connection Pooling**: Efficient database connection management
+- **SSL Support**: Secure database connections for production environments
+
+### 🚀 **Production-Ready Deployment**
+
+- **Docker Containerization**: Multi-stage builds for optimized container images
+- **Docker Compose**: Complete local development and production deployment setup
+- **Health Checks**: Built-in health monitoring and service dependencies
+- **Environment Configuration**: Comprehensive environment variable management
+
+### 🔒 **Security Features**
+
+- **HTTPS/TLS**: Secure communication with SSL certificate management
+- **CORS Configuration**: Configurable cross-origin resource sharing
+- **Input Validation**: Comprehensive request validation and sanitization
+- **Error Handling**: Structured error responses with proper HTTP status codes
+
+### 📚 **API Documentation**
+
+- **OpenAPI/Swagger**: Auto-generated API documentation with RapiDoc
+- **Type Safety**: Full TypeScript-compatible API schemas
+- **Interactive Documentation**: Built-in API explorer and testing interface
+
+### 🔧 **Development Experience**
+
+- **Hot Reload**: Fast development iteration with cargo watch
+- **Database Seeding**: Test data generation for development
+- **Comprehensive Logging**: Structured logging with configurable levels
+- **Debug Tools**: Built-in debugging and diagnostic endpoints
+
+## 🚀 **Deployment & Infrastructure**
+
+### ☁️ **Cloud-Ready Architecture**
+
+- **DigitalOcean Integration**: Automated deployment to DigitalOcean infrastructure
+- **Tailscale Networking**: Secure private networking for deployments
+- **GitHub Actions**: Automated CI/CD with comprehensive testing
+- **Multi-Environment Support**: Separate staging and production environments
+
+### 🐳 **Container Orchestration**
+
+- **Multi-Service Setup**: Coordinated deployment of backend, frontend, and database
+- **Nginx Reverse Proxy**: Load balancing and SSL termination
+- **Database Migrations**: Automated schema migrations on deployment
+- **Environment Variables**: Comprehensive configuration management
+
+## 📖 **Documentation**
+
+This release includes comprehensive documentation:
+
+- **Architecture Diagrams**: Visual system overview and component relationships
+- **API Documentation**: Complete endpoint reference with examples
+- **Deployment Guides**: Step-by-step deployment instructions
+- **Development Setup**: Local development environment configuration
+- **Database Schema**: Entity-relationship diagrams and migration guides
+
+## 🧪 **What's Beta About This Release**
+
+This beta release is feature-complete for core coaching workflows but may have:
+
+- Minor API changes before v1.0.0 stable
+- Additional configuration options and fine-tuning
+- Performance optimizations based on real-world usage
+- Extended test coverage and edge case handling
+
+## 🔮 **What's Next**
+
+Looking ahead to v1.0.0 stable:
+
+- **Enhanced Reporting**: Analytics and progress tracking dashboards
+- **Notification System**: Email and in-app notifications for important events
+- **Advanced Permissions**: Fine-grained access controls and custom roles
+- **API Rate Limiting**: Production-scale request throttling
+- **Audit Logging**: Comprehensive activity tracking for compliance
+
+## 🚀 **Getting Started**
+
+### Prerequisites
+
+- Docker & Docker Compose
+- PostgreSQL (local or remote)
+- Rust 1.70+ (for local development)
+
+### Quick Start
+
+```bash
+git clone https://github.com/refactor-group/refactor-platform-rs.git
+cd refactor-platform-rs
+docker-compose --env-file .env.local up --build
+```
+
+Visit `http://localhost:4000/rapidoc` for interactive API documentation.
+
+### Configuration
+
+All configuration is managed through environment variables. See our [Environment Variables Guide](docs/runbooks/adding_new_environment_variables_backend.md) for complete configuration options.
+
+## 🤝 **Contributing**
+
+We welcome contributions! Please see our contributing guidelines and check out our [good first issues](https://github.com/refactor-group/refactor-platform-rs/labels/good%20first%20issue).
+
+## 📞 **Support**
+
+- **Documentation**: [docs/](docs/)
+- **Issues**: [GitHub Issues](https://github.com/refactor-group/refactor-platform-rs/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/refactor-group/refactor-platform-rs/discussions)
+
+---
+
+**Full Changelog**: https://github.com/refactor-group/refactor-platform-rs/commits/1.0.0-beta1
+
+_This beta release represents months of development creating a robust, scalable platform for coaching and mentoring software engineers. We're excited to get feedback from the community as we work toward our stable 1.0.0 release!_

domain/src/coaching_session.rs

@@ -19,7 +19,7 @@ struct SessionDate(NaiveDateTime);
 impl SessionDate {
     fn new(date: NaiveDateTime) -> Result<Self, Error> {
         let truncated = date.duration_trunc(TimeDelta::minutes(1)).map_err(|err| {
-            warn!("Failed to truncate date_time: {:?}", err);
+            warn!("Failed to truncate date_time: {err:?}");
             Error {
                 source: Some(Box::new(err)),
                 error_kind: DomainErrorKind::Internal(InternalErrorKind::Other(
@@ -48,10 +48,7 @@ pub async fn create(
     coaching_session_model.date = SessionDate::new(coaching_session_model.date)?.into_inner();
 
     let document_name = generate_document_name(&organization.slug, &coaching_relationship.slug);
-    info!(
-        "Attempting to create Tiptap document with name: {}",
-        document_name
-    );
+    info!("Attempting to create Tiptap document with name: {document_name}");
     coaching_session_model.collab_document_name = Some(document_name.clone());
 
     let tiptap = TiptapDocument::new(config).await?;

domain/src/error.rs

@@ -54,7 +54,7 @@ pub enum ExternalErrorKind {
 
 impl fmt::Display for Error {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(f, "Domain Error: {:?}", self)
+        write!(f, "Domain Error: {self:?}")
     }
 }
 

domain/src/gateway/tiptap.rs

@@ -24,7 +24,7 @@ async fn build_auth_headers(config: &Config) -> Result<reqwest::header::HeaderMa
     })?;
     let mut headers = reqwest::header::HeaderMap::new();
     let mut auth_value = reqwest::header::HeaderValue::from_str(&auth_key).map_err(|err| {
-        warn!("Failed to create auth header value: {:?}", err);
+        warn!("Failed to create auth header value: {err:?}");
         Error {
             source: Some(Box::new(err)),
             error_kind: DomainErrorKind::Internal(InternalErrorKind::Other(
@@ -64,7 +64,7 @@ impl TiptapDocument {
             .send()
             .await
             .map_err(|e| {
-                warn!("Failed to send request: {:?}", e);
+                warn!("Failed to send request: {e:?}");
                 Error {
                     source: Some(Box::new(e)),
                     error_kind: DomainErrorKind::External(ExternalErrorKind::Network),
@@ -75,7 +75,7 @@ impl TiptapDocument {
             Ok(())
         } else {
             let error_text = response.text().await.unwrap_or_default();
-            warn!("Failed to create Tiptap document: {}", error_text);
+            warn!("Failed to create Tiptap document: {error_text}");
             Err(Error {
                 source: None,
                 error_kind: DomainErrorKind::External(ExternalErrorKind::Network),
@@ -86,7 +86,7 @@ impl TiptapDocument {
     pub async fn delete(&self, document_name: &str) -> Result<(), Error> {
         let url = self.format_url(document_name);
         let response = self.client.delete(url).send().await.map_err(|e| {
-            warn!("Failed to send request: {:?}", e);
+            warn!("Failed to send request: {e:?}");
             Error {
                 source: Some(Box::new(e)),
                 error_kind: DomainErrorKind::External(ExternalErrorKind::Network),
@@ -97,10 +97,7 @@ impl TiptapDocument {
         if status.is_success() || status.as_u16() == 404 {
             Ok(())
         } else {
-            warn!(
-                "Failed to delete Tiptap document: {}, with status: {}",
-                document_name, status
-            );
+            warn!("Failed to delete Tiptap document: {document_name}, with status: {status}");
             Err(Error {
                 source: None,
                 error_kind: DomainErrorKind::External(ExternalErrorKind::Network),

domain/src/jwt/mod.rs

@@ -48,8 +48,7 @@ pub async fn generate_collab_token(
 
     let collab_document_name = coaching_session.collab_document_name.ok_or_else(|| {
         warn!(
-            "Failed to get collab document name from coaching session with ID: {}",
-            coaching_session_id
+            "Failed to get collab document name from coaching session with ID: {coaching_session_id}"
         );
         Error {
             source: None,

entity_api/src/action.rs

@@ -14,7 +14,7 @@ pub async fn create(
     action_model: Model,
     user_id: Id,
 ) -> Result<Model, Error> {
-    debug!("New Action Model to be inserted: {:?}", action_model);
+    debug!("New Action Model to be inserted: {action_model:?}");
 
     let now = chrono::Utc::now();
 
@@ -38,7 +38,7 @@ pub async fn update(db: &DatabaseConnection, id: Id, model: Model) -> Result<Mod
 
     match result {
         Some(action) => {
-            debug!("Existing Action model to be Updated: {:?}", action);
+            debug!("Existing Action model to be Updated: {action:?}");
 
             let active_model: ActiveModel = ActiveModel {
                 id: Unchanged(action.id),
@@ -55,7 +55,7 @@ pub async fn update(db: &DatabaseConnection, id: Id, model: Model) -> Result<Mod
             Ok(active_model.update(db).await?.try_into_model()?)
         }
         None => {
-            error!("Action with id {} not found", id);
+            error!("Action with id {id} not found");
 
             Err(Error {
                 source: None,
@@ -74,7 +74,7 @@ pub async fn update_status(
 
     match result {
         Some(action) => {
-            debug!("Existing Action model to be Updated: {:?}", action);
+            debug!("Existing Action model to be Updated: {action:?}");
 
             let active_model: ActiveModel = ActiveModel {
                 id: Unchanged(action.id),
@@ -91,7 +91,7 @@ pub async fn update_status(
             Ok(active_model.update(db).await?.try_into_model()?)
         }
         None => {
-            error!("Action with id {} not found", id);
+            error!("Action with id {id} not found");
 
             Err(Error {
                 source: None,

entity_api/src/agreement.rs

@@ -14,7 +14,7 @@ pub async fn create(
     agreement_model: Model,
     user_id: Id,
 ) -> Result<Model, Error> {
-    debug!("New Agreement Model to be inserted: {:?}", agreement_model);
+    debug!("New Agreement Model to be inserted: {agreement_model:?}");
 
     let now = chrono::Utc::now();
 
@@ -35,7 +35,7 @@ pub async fn update(db: &DatabaseConnection, id: Id, model: Model) -> Result<Mod
 
     match result {
         Some(agreement) => {
-            debug!("Existing Agreement model to be Updated: {:?}", agreement);
+            debug!("Existing Agreement model to be Updated: {agreement:?}");
 
             let active_model: ActiveModel = ActiveModel {
                 id: Unchanged(agreement.id),
@@ -49,7 +49,7 @@ pub async fn update(db: &DatabaseConnection, id: Id, model: Model) -> Result<Mod
             Ok(active_model.update(db).await?.try_into_model()?)
         }
         None => {
-            debug!("Agreement with id {} not found", id);
+            debug!("Agreement with id {id} not found");
 
             Err(Error {
                 source: None,

entity_api/src/coaching_relationship.rs

@@ -22,10 +22,7 @@ pub async fn create(
     organization_id: Id,
     coaching_relationship_model: Model,
 ) -> Result<CoachingRelationshipWithUserNames, Error> {
-    debug!(
-        "New Coaching Relationship Model to be inserted: {:?}",
-        coaching_relationship_model
-    );
+    debug!("New Coaching Relationship Model to be inserted: {coaching_relationship_model:?}");
 
     let coach = user::find_by_id(db, coaching_relationship_model.coach_id).await?;
     let coachee = user::find_by_id(db, coaching_relationship_model.coachee_id).await?;

entity_api/src/coaching_session.rs

@@ -11,10 +11,7 @@ pub async fn create(
     db: &DatabaseConnection,
     coaching_session_model: Model,
 ) -> Result<Model, Error> {
-    debug!(
-        "New Coaching Session Model to be inserted: {:?}",
-        coaching_session_model
-    );
+    debug!("New Coaching Session Model to be inserted: {coaching_session_model:?}");
 
     let now = chrono::Utc::now();
 

entity_api/src/error.rs

@@ -38,7 +38,7 @@ pub enum EntityApiErrorKind {
 
 impl fmt::Display for Error {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(f, "Entity API Error: {:?}", self)
+        write!(f, "Entity API Error: {self:?}")
     }
 }