ai-flow-dev 2.1.3 → 2.1.5

package/templates/backend/docs/operations.template.md

@@ -14,11 +14,51 @@
 
 **Container:** {{#IF_DOCKER}}Yes - Docker{{ELSE}}No{{/IF_DOCKER}}
 
----
+### Deployment Strategy
+
+**Strategy:** {{DEPLOYMENT_STRATEGY}}
+
+{{#IF BLUE_GREEN}}
+**Blue-Green Deployment:**
+
+- Active environment: {{ACTIVE_ENVIRONMENT}}
+- Standby environment: {{STANDBY_ENVIRONMENT}}
+- Switch mechanism: {{SWITCH_MECHANISM}}
+- Rollback time: < {{ROLLBACK_TIME}} seconds
+  {{/IF}}
+
+{{#IF CANARY}}
+**Canary Deployment:**
+
+- Initial canary percentage: {{CANARY_INITIAL_PERCENTAGE}}%
+- Rollout increments: {{CANARY_INCREMENTS}}
+- Success criteria: {{CANARY_SUCCESS_CRITERIA}}
+- Automatic rollback: {{CANARY_AUTO_ROLLBACK}}
+  {{/IF}}
+
+{{#IF ROLLING}}
+**Rolling Deployment:**
+
+- Max unavailable: {{ROLLING_MAX_UNAVAILABLE}}
+- Max surge: {{ROLLING_MAX_SURGE}}
+- Health check: {{ROLLING_HEALTH_CHECK}}
+  {{/IF}}
+
+### Rollback Plan
+
+**Trigger:** {{ROLLBACK_TRIGGER}}
+
+**Process:**
+{{#EACH ROLLBACK_STEP}}
+{{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
+{{/EACH}}
+
+## **Rollback Time:** < {{ROLLBACK_TARGET_TIME}} minutes
 
 ## 🌍 Environments
 
 {{#EACH ENVIRONMENT}}
+
 ### {{ENV_NAME}}
 
 **Purpose:** {{ENV_PURPOSE}}
@@ -30,13 +70,12 @@
 **Auto-deploy:** {{ENV_AUTO_DEPLOY}}
 
 **Configuration:**
+
 ```bash
 {{ENV_CONFIG}}
 ```
 
-{{/EACH}}
-
----
+## {{/EACH}}
 
 ## 📦 Build & Deploy
 
@@ -52,14 +91,17 @@
 
 {{#EACH DEPLOYMENT_STEP}}
 {{STEP_NUMBER}}. **{{STEP_TITLE}}**
-   ```bash
-   {{STEP_COMMAND}}
-   ```
-   {{STEP_DESCRIPTION}}
+
+```bash
+{{STEP_COMMAND}}
+```
+
+{{STEP_DESCRIPTION}}
 
 {{/EACH}}
 
 {{#IF_DOCKER}}
+
 ### Docker
 
 **Dockerfile:** `{{DOCKERFILE_PATH}}`
@@ -69,23 +111,24 @@
 ```
 
 **Build Image:**
+
 ```bash
 {{DOCKER_BUILD_COMMAND}}
 ```
 
 **Run Container:**
+
 ```bash
 {{DOCKER_RUN_COMMAND}}
 ```
 
 **Docker Compose:**
+
 ```yaml
-{{DOCKER_COMPOSE_EXAMPLE}}
+{ { DOCKER_COMPOSE_EXAMPLE } }
 ```
 
-{{/IF_DOCKER}}
-
----
+## {{/IF_DOCKER}}
 
 ## 🔄 CI/CD Pipeline
 
@@ -97,16 +140,17 @@
 
 {{#EACH PIPELINE_STAGE}}
 {{STAGE_NUMBER}}. **{{STAGE_NAME}}**
-   - {{STAGE_DESCRIPTION}}
-   - Duration: ~{{STAGE_DURATION}}
-   - Fails if: {{STAGE_FAILURE_CONDITION}}
+
+- {{STAGE_DESCRIPTION}}
+- Duration: ~{{STAGE_DURATION}}
+- Fails if: {{STAGE_FAILURE_CONDITION}}
 
 {{/EACH}}
 
 ### Pipeline Configuration
 
 ```yaml
-{{CICD_CONFIG_EXAMPLE}}
+{ { CICD_CONFIG_EXAMPLE } }
 ```
 
 ---
@@ -119,8 +163,9 @@
 
 **Metrics Tracked:**
 {{#EACH METRIC}}
+
 - **{{METRIC_NAME}}**: {{METRIC_DESCRIPTION}} (threshold: {{METRIC_THRESHOLD}})
-{{/EACH}}
+  {{/EACH}}
 
 **Dashboard:** {{APM_DASHBOARD_URL}}
 
@@ -132,15 +177,18 @@
 
 **Log Levels:**
 {{#EACH LOG_LEVEL}}
+
 - **{{LEVEL_NAME}}**: {{LEVEL_USAGE}}
-{{/EACH}}
+  {{/EACH}}
 
 **Example Log Entry:**
+
 ```json
 {{LOG_ENTRY_EXAMPLE}}
 ```
 
 **Viewing Logs:**
+
 ```bash
 {{VIEW_LOGS_COMMAND}}
 ```
@@ -148,6 +196,7 @@
 ### Metrics
 
 {{#EACH TRACKED_METRIC}}
+
 #### {{METRIC_NAME}}
 
 **Description:** {{METRIC_DESCRIPTION}}
@@ -156,21 +205,21 @@
 
 **Alert:** {{METRIC_ALERT_CONDITION}}
 
-{{/EACH}}
-
----
+## {{/EACH}}
 
 ## 🚨 Alerting
 
 ### Alert Channels
 
 {{#EACH ALERT_CHANNEL}}
+
 - **{{CHANNEL_NAME}}**: {{CHANNEL_PURPOSE}}
-{{/EACH}}
+  {{/EACH}}
 
 ### Alert Rules
 
 {{#EACH ALERT_RULE}}
+
 #### {{ALERT_NAME}}
 
 **Condition:** {{ALERT_CONDITION}}
@@ -181,9 +230,7 @@
 
 **Action:** {{ALERT_ACTION}}
 
-{{/EACH}}
-
----
+## {{/EACH}}
 
 ## 🔧 Configuration
 
@@ -191,15 +238,18 @@
 
 **Required:**
 {{#EACH REQUIRED_ENV_VAR}}
+
 - `{{VAR_NAME}}` - {{VAR_DESCRIPTION}}
-{{/EACH}}
+  {{/EACH}}
 
 **Optional:**
 {{#EACH OPTIONAL_ENV_VAR}}
+
 - `{{VAR_NAME}}` - {{VAR_DESCRIPTION}} (default: {{VAR_DEFAULT}})
-{{/EACH}}
+  {{/EACH}}
 
 **Per Environment:**
+
 ```bash
 # Development
 {{DEV_ENV_VARS}}
@@ -249,6 +299,7 @@
 {{/IF}}
 
 **Migration Windows:**
+
 - Preferred time: {{MIGRATION_WINDOW_TIME}}
 - Duration: {{MIGRATION_WINDOW_DURATION}}
 - Notification: {{MIGRATION_NOTIFICATION}}
@@ -260,6 +311,7 @@
 **Tool:** {{CONNECTION_POOL_TOOL}}
 
 **Settings:**
+
 - Min connections: {{POOL_MIN_CONNECTIONS}}
 - Max connections: {{POOL_MAX_CONNECTIONS}}
 - Connection timeout: {{POOL_CONNECTION_TIMEOUT}}ms
@@ -267,11 +319,13 @@
 - Max lifetime: {{POOL_MAX_LIFETIME}}ms
 
 **Configuration:**
+
 ```{{LANGUAGE}}
 {{CONNECTION_POOL_CONFIG_EXAMPLE}}
 ```
 
 **Monitoring:**
+
 - Active connections: {{POOL_MONITORING_ACTIVE}}
 - Idle connections: {{POOL_MONITORING_IDLE}}
 - Wait time: {{POOL_MONITORING_WAIT}}
@@ -286,11 +340,13 @@
 **Location:** {{BACKUP_LOCATION}}
 
 **Backup Command:**
+
 ```bash
 {{BACKUP_COMMAND}}
 ```
 
 **Restore Command:**
+
 ```bash
 {{RESTORE_COMMAND}}
 ```
@@ -316,20 +372,22 @@
 
 **Auto-scaling:**
 {{#IF AUTO_SCALING}}
+
 - Enabled: Yes
 - Min instances: {{SCALING_MIN}}
 - Max instances: {{SCALING_MAX}}
 - Target CPU: {{SCALING_TARGET_CPU}}%
 - Target Memory: {{SCALING_TARGET_MEMORY}}%
-{{ELSE}}
+  {{ELSE}}
 - Enabled: No - Manual scaling
-{{/IF}}
+  {{/IF}}
 
 ### Vertical Scaling
 
 {{VERTICAL_SCALING_DESCRIPTION}}
 
 **Current Resources:**
+
 - CPU: {{CURRENT_CPU}}
 - Memory: {{CURRENT_MEMORY}}
 - Disk: {{CURRENT_DISK}}
@@ -376,13 +434,12 @@ GET /health/live     - Liveness check
 
 **Rotation:** {{SECRETS_ROTATION_POLICY}}
 
-**Access:** {{SECRETS_ACCESS_POLICY}}
-
----
+## **Access:** {{SECRETS_ACCESS_POLICY}}
 
 ## 📝 Runbooks
 
 {{#EACH RUNBOOK}}
+
 ### {{RUNBOOK_TITLE}}
 
 **Trigger:** {{RUNBOOK_TRIGGER}}
@@ -390,26 +447,29 @@ GET /health/live     - Liveness check
 **Steps:**
 {{#EACH RUNBOOK_STEP}}
 {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
-   ```bash
-   {{STEP_COMMAND}}
-   ```
-{{/EACH}}
+
+```bash
+{{STEP_COMMAND}}
+```
 
 {{/EACH}}
 
----
+## {{/EACH}}
 
 ## 🐛 Troubleshooting
 
 {{#EACH TROUBLESHOOTING_GUIDE}}
+
 ### {{ISSUE_TITLE}}
 
 **Symptoms:**
 {{#EACH SYMPTOM}}
+
 - {{SYMPTOM_DESCRIPTION}}
-{{/EACH}}
+  {{/EACH}}
 
 **Diagnosis:**
+
 ```bash
 {{DIAGNOSIS_COMMAND}}
 ```
@@ -419,13 +479,12 @@ GET /health/live     - Liveness check
 {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
 {{/EACH}}
 
-{{/EACH}}
-
----
+## {{/EACH}}
 
 ## 📈 Performance Optimization
 
 {{#EACH OPTIMIZATION}}
+
 ### {{OPTIMIZATION_NAME}}
 
 **Current:** {{CURRENT_STATE}}
@@ -434,17 +493,16 @@ GET /health/live     - Liveness check
 
 **Implementation:** {{OPTIMIZATION_IMPLEMENTATION}}
 
-{{/EACH}}
-
----
+## {{/EACH}}
 
 ## 🔄 Rollback Procedures
 
 ### When to Rollback
 
 {{#EACH ROLLBACK_TRIGGER}}
+
 - {{TRIGGER_DESCRIPTION}}
-{{/EACH}}
+  {{/EACH}}
 
 ### Rollback Steps
 
@@ -474,6 +532,7 @@ GET /health/live     - Liveness check
 **Rollback:** {{BLUE_GREEN_ROLLBACK}}
 
 **Benefits:**
+
 - Zero-downtime deployments
 - Instant rollback capability
 - Easy A/B testing
@@ -488,6 +547,7 @@ GET /health/live     - Liveness check
 **Enabled:** Yes
 
 **Strategy:**
+
 - Initial traffic: {{CANARY_INITIAL_TRAFFIC}}%
 - Gradual increase: {{CANARY_GRADUAL_INCREASE}}% per {{CANARY_INCREASE_INTERVAL}}
 - Success criteria: {{CANARY_SUCCESS_CRITERIA}}
@@ -512,15 +572,17 @@ GET /health/live     - Liveness check
 {{/EACH}}
 
 **Implementation:**
+
 ```{{LANGUAGE}}
 {{GRACEFUL_SHUTDOWN_EXAMPLE}}
 ```
 
 **Configuration:**
+
 - Shutdown timeout: {{SHUTDOWN_TIMEOUT}}s
 - Health check grace period: {{HEALTH_CHECK_GRACE_PERIOD}}s
 - Connection drain timeout: {{CONNECTION_DRAIN_TIMEOUT}}s
-{{/IF}}
+  {{/IF}}
 
 ### Circuit Breakers
 
@@ -531,6 +593,7 @@ GET /health/live     - Liveness check
 
 **Configuration:**
 {{#EACH CIRCUIT_BREAKER}}
+
 #### {{SERVICE_NAME}}
 
 - Failure threshold: {{FAILURE_THRESHOLD}}%
@@ -542,6 +605,7 @@ GET /health/live     - Liveness check
 **Fallback Strategy:** {{FALLBACK_STRATEGY}}
 
 **Implementation:**
+
 ```{{LANGUAGE}}
 {{CIRCUIT_BREAKER_EXAMPLE}}
 ```
@@ -558,6 +622,7 @@ GET /health/live     - Liveness check
 **Retry Strategy:** {{RETRY_STRATEGY}}
 
 {{#EACH RETRY_POLICY}}
+
 #### {{SERVICE_NAME}}
 
 - Max attempts: {{MAX_ATTEMPTS}}
@@ -569,8 +634,74 @@ GET /health/live     - Liveness check
 {{/EACH}}
 
 {{ELSE}}
+
 - Retry policies to be configured per service.
-{{/IF}}
+  {{/IF}}
+
+### Timeout & Retry Matrix
+
+| Service/Dependency | Timeout | Retries | Backoff | Notes |
+| ------------------ | ------- | ------- | ------- | ----- |
+
+{{#EACH TIMEOUT_POLICY}}
+| {{SERVICE_NAME}} | {{TIMEOUT}}ms | {{RETRIES}} | {{BACKOFF}} | {{NOTES}} |
+{{/EACH}}
+
+**Global Defaults:**
+
+- Default HTTP timeout: {{DEFAULT_HTTP_TIMEOUT}}ms
+- Default retries: {{DEFAULT_RETRIES}}
+- Default backoff: {{DEFAULT_BACKOFF}}
+
+**Non-Retryable Errors:**
+{{#EACH NON_RETRYABLE_ERROR}}
+
+- `{{ERROR_CODE}}`: {{REASON}}
+  {{/EACH}}
+
+---
+
+## 📋 Request/Response Logging
+
+### Log Strategy by Environment
+
+| Environment | Level | Body Logging | Performance Logging |
+| ----------- | ----- | ------------ | ------------------- |
+
+{{#EACH LOGGING_STRATEGY}}
+| {{ENVIRONMENT}} | {{LEVEL}} | {{BODY_LOGGING}} | {{PERFORMANCE_LOGGING}} |
+{{/EACH}}
+
+### Request Logging
+
+**Fields Logged:**
+{{#EACH REQUEST_LOG_FIELD}}
+
+- {{#IF ENABLED}}✅{{ELSE}}❌{{/IF}} `{{FIELD_NAME}}` - {{DESCRIPTION}}
+  {{/EACH}}
+
+### Response Logging
+
+**Fields Logged:**
+{{#EACH RESPONSE_LOG_FIELD}}
+
+- {{#IF ENABLED}}✅{{ELSE}}❌{{/IF}} `{{FIELD_NAME}}` - {{DESCRIPTION}}
+  {{/EACH}}
+
+### Sensitive Data Masking
+
+| Field Pattern | Masking Strategy |
+| ------------- | ---------------- |
+
+{{#EACH MASKING_RULE}}
+| `{{PATTERN}}` | {{STRATEGY}} |
+{{/EACH}}
+
+**Implementation Example:**
+
+```{{LANGUAGE}}
+{{MASKING_EXAMPLE}}
+```
 
 ---
 
@@ -580,9 +711,7 @@ GET /health/live     - Liveness check
 
 **Duration:** {{MAINTENANCE_DURATION}}
 
-**Notification:** {{MAINTENANCE_NOTIFICATION}}
-
----
+## **Notification:** {{MAINTENANCE_NOTIFICATION}}
 
 **Document Version:** 1.0
 

package/templates/backend/docs/testing.template.md

@@ -1,9 +1,7 @@
 # Testing Strategy
 
 > Testing approach, standards, and quality requirements for {{PROJECT_NAME}}
-
 ---
-
 ## 🎯 Testing Philosophy
 
 {{TESTING_PHILOSOPHY}}
@@ -13,9 +11,7 @@
 - All tests must pass before merge
 - No skipped tests in main branch
 - Critical paths require integration tests
-
 ---
-
 ## 🧪 Testing Framework
 
 **Primary Framework:** {{TEST_FRAMEWORK}}
@@ -25,9 +21,7 @@
 **Mocking Library:** {{MOCKING_LIBRARY}}
 
 **Test Runner:** {{TEST_RUNNER}}
-
 ---
-
 ## 📊 Test Types
 
 ### Unit Tests ({{UNIT_TEST_PERCENTAGE}}% of tests)
@@ -222,9 +216,7 @@
 - ❌ Never run in production without approval
 
 {{/IF}}
-
 ---
-
 ## 📁 Test Organization
 
 ### File Structure
@@ -284,9 +276,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
   });
 });
 ```
-
 ---
-
 ## 🎭 Mocking Strategy
 
 ### What to Mock
@@ -324,9 +314,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
 ```{{LANGUAGE}}
 {{TIME_MOCK_EXAMPLE}}
 ```
-
 ---
-
 ## 🗄️ Test Database
 
 ### Strategy
@@ -383,9 +371,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
 ```{{LANGUAGE}}
 {{DB_CLEANUP_EXAMPLE}}
 ```
-
 ---
-
 ## 🏭 Test Data Factories
 
 **Library:** {{FACTORY_LIBRARY}}
@@ -411,9 +397,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
 - ✅ Allow overrides for specific tests
 - ✅ Keep factories DRY
 - ❌ Don't hardcode test data in tests
-
 ---
-
 ## ✅ Test Structure
 
 ### AAA Pattern (Arrange, Act, Assert)
@@ -427,9 +411,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
 ```{{LANGUAGE}}
 {{GIVEN_WHEN_THEN_EXAMPLE}}
 ```
-
 ---
-
 ## 🎯 Testing Best Practices
 
 ### General
@@ -474,9 +456,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
 - External libraries
 - Getters/setters without logic
 - Auto-generated code
-
 ---
-
 ## 🔧 Test Configuration
 
 ### Jest Configuration
@@ -502,9 +482,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
   }
 }
 ```
-
 ---
-
 ## 🚀 Running Tests
 
 ### Local Development
@@ -542,9 +520,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
 ```yaml
 {{CICD_TEST_CONFIG}}
 ```
-
 ---
-
 ## 📊 Coverage Reports
 
 ### Viewing Coverage
@@ -576,9 +552,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
 ```
 
 **Enforcement:** Tests fail if coverage drops below thresholds
-
 ---
-
 ## 🧬 Test Examples
 
 ### Service Test
@@ -604,9 +578,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
 ```{{LANGUAGE}}
 {{E2E_TEST_FULL_EXAMPLE}}
 ```
-
 ---
-
 ## 🔒 Testing Security
 
 ### Authentication Tests
@@ -626,9 +598,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
 ```{{LANGUAGE}}
 {{INPUT_VALIDATION_TEST_EXAMPLE}}
 ```
-
 ---
-
 ## 🐛 Debugging Tests
 
 ### Debug Configuration
@@ -647,9 +617,7 @@ describe('{{DESCRIBE_EXAMPLE}}', () => {
 # Debug with breakpoints
 {{DEBUG_WITH_BREAKPOINTS}}
 ```
-
 ---
-
 ## 📝 Test Documentation
 
 ### When to Document Tests
@@ -680,9 +648,7 @@ describe('Order Total Calculation', () => {
   // tests...
 });
 ```
-
 ---
-
 ## 🚨 Continuous Testing
 
 ### Pre-commit Hooks
@@ -705,9 +671,7 @@ describe('Order Total Calculation', () => {
 **Runs:**
 - Full test suite
 - Coverage check
-
 ---
-
 ## 📈 Test Metrics
 
 ### Tracked Metrics
@@ -723,9 +687,7 @@ describe('Order Total Calculation', () => {
 {{#EACH TEST_GOAL}}
 - **{{GOAL_NAME}}**: {{GOAL_TARGET}}
 {{/EACH}}
-
 ---
-
 ## 🔄 Test Maintenance
 
 ### Regular Tasks
@@ -744,19 +706,17 @@ describe('Order Total Calculation', () => {
 - [ ] Coverage meets threshold
 - [ ] No skipped/disabled tests (without reason)
 - [ ] Test names are descriptive
-
 ---
-
 ## 📚 Resources
 
 {{#EACH TESTING_RESOURCE}}
 - [{{RESOURCE_NAME}}]({{RESOURCE_URL}})
 {{/EACH}}
-
 ---
-
 **Document Version:** 1.0
 
 **Last Updated:** {{GENERATION_DATE}}
 
 **Generated by:** AI Flow v1.0.0
+
+