feat: Enhance CMS Microservice with SystemConstants and SmsTemplates
- Added SystemConstants class to centralize hardcoded values for club configuration, commission configuration, and package amounts. - Introduced SmsTemplates class to manage SMS message templates for various user notifications. - Implemented automatic SMS sending for Daya Loan approval notifications. - Updated BackOffice UI to include App Version management features. - Fixed mapping issues in Mapster profiles for improved data handling. - Updated changelog and documentation to reflect recent changes and configurations.
This commit is contained in:
masoodafar-web
+25
-39
@@ -1,66 +1,52 @@
|
||||
# CMS Microservice - Network & Club Commission System
|
||||
|
||||
[]()
|
||||
[]()
|
||||
[]()
|
||||
[]()
|
||||
|
||||
## 📊 Project Status (2025-12-18)
|
||||
## 📊 Project Status (2025-12-27)
|
||||
|
||||
**Overall Progress**: 85% Complete (7/10 phases)
|
||||
**Production Readiness**: 95%
|
||||
**Overall Progress**: 98% Complete
|
||||
**Production Readiness**: 99%
|
||||
**MVP Status**: ✅ 100% Complete
|
||||
|
||||
### ✅ Completed Phases (7)
|
||||
### ✅ Completed Phases
|
||||
1. ✅ Domain Layer (Entities, Enums, Value Objects)
|
||||
2. ✅ Club Membership System
|
||||
3. ✅ Binary Network Tree
|
||||
4. ✅ **Commission Calculation & Background Worker** (MVP)
|
||||
4. ✅ Commission Calculation & Background Worker (MVP)
|
||||
5. ✅ Protobuf gRPC Services
|
||||
6. ✅ History & Configuration Management
|
||||
7. ✅ Database Migration & Seed Data
|
||||
8. ✅ App Version Management
|
||||
9. ✅ SMS Templates & SystemConstants
|
||||
|
||||
### 🟡 Partially Complete (1)
|
||||
- Phase 10: Withdrawal & Settlement (40%)
|
||||
### 🟡 Partially Complete
|
||||
- Withdrawal & Settlement (40%)
|
||||
- ✅ Commands & Database
|
||||
- ❌ Payment Gateway Integration
|
||||
|
||||
### ❌ Not Started (1)
|
||||
- Phase 9: Club Shop & Product Integration (0%)
|
||||
|
||||
### ⏸️ Postponed (1)
|
||||
- Phase 7: Testing (Unit, Integration, Load tests)
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Recent Updates (2025-12-18 / ۲۸ آذر)
|
||||
## 🚀 Recent Updates (2025-12-27 / ۷ دی)
|
||||
|
||||
### Entity Configuration - Persian Encoding Fix ✅
|
||||
- ✅ **Geography Entities**: Country, State, City
|
||||
- ✅ **Change**: All string columns now `NVARCHAR` with `Persian_100_CI_AI` collation
|
||||
- ✅ **Migration**: `FixPersianCollation_Geography`
|
||||
- ✅ **Fixes**: Persian characters display correctly in Geography tables
|
||||
### SystemConstants - مقادیر ثابت ✅
|
||||
- ✅ **فایل جدید**: `Domain/Common/SystemConstants.cs`
|
||||
- ✅ `GoldenPackageAmount = 56_000_000` - پکیج طلایی
|
||||
- ✅ `DayaLoanAmount = 56_000_000` - وام دایا
|
||||
- ✅ حذف مقادیر hardcode از همه handlers
|
||||
|
||||
### Previous Updates (2025-12-01)
|
||||
- ✅ **MailKit 4.14.1** for Email (SMTP with HTML templates)
|
||||
- ✅ **Kavenegar 1.2.5** for SMS (Iranian SMS gateway)
|
||||
- ✅ User.Email field added with migration
|
||||
- ✅ 3 notification types: Commission, Club activation, Errors
|
||||
- ✅ Persian RTL templates with rich formatting
|
||||
- ✅ Production configuration guide created
|
||||
### SmsTemplates - قالبهای پیامک ✅
|
||||
- ✅ **فایل جدید**: `Domain/Common/SmsTemplates.cs`
|
||||
- ✅ قالبها: DayaLoan, ClubActivated, PackagePurchased, Commission, Withdrawal, OTP, Welcome
|
||||
- ✅ ارسال SMS خودکار هنگام تأیید وام دایا
|
||||
|
||||
### Hangfire Job Scheduling - COMPLETED ✅
|
||||
- ✅ Dashboard UI at `/hangfire`
|
||||
- ✅ Cron schedule: Sunday 00:05 UTC
|
||||
- ✅ SQL Server persistence
|
||||
- ✅ Manual trigger API endpoints
|
||||
- ✅ Distributed execution support
|
||||
### Mapping Fixes ✅
|
||||
- ✅ `AppVersionProfile.cs` - Map List to GetAllAppVersionsResponse
|
||||
|
||||
### Infrastructure Enhancements - COMPLETED ✅
|
||||
- ✅ Health Check endpoints (`/health`, `/health/ready`, `/health/live`)
|
||||
- ✅ AlertService (structured logging for Sentry/Slack)
|
||||
- ✅ Retry logic (Polly 8.5.0 with exponential backoff)
|
||||
- ✅ WorkerExecutionLog (database audit trail)
|
||||
- ✅ CurrentUserService (JWT authentication context)
|
||||
### Previous Updates (2025-12-26)
|
||||
- ✅ **App Version Management**: Entity, gRPC, Handlers
|
||||
- ✅ **ReferralCode in Network Tree**: SP + Proto update
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,65 @@
|
||||
# راهنمای پیکربندی Email و SMS
|
||||
|
||||
## قالبهای پیامک (SmsTemplates)
|
||||
|
||||
> **فایل**: `CMSMicroservice.Domain/Common/SmsTemplates.cs`
|
||||
|
||||
همه قالبهای پیامک در یک کلاس متمرکز شدهاند:
|
||||
|
||||
```csharp
|
||||
public static class SmsTemplates
|
||||
{
|
||||
// وام دایا
|
||||
public static string DayaLoanReceived(string? firstName, long amount)
|
||||
=> $"{GetUserName(firstName)} عزیز، مبلغ {amount:N0} ریال وام دایا به کیف پول شما واریز شد. کارابازار";
|
||||
|
||||
// فعالسازی باشگاه
|
||||
public static string ClubActivated(string? firstName)
|
||||
=> $"{GetUserName(firstName)} عزیز، حساب باشگاه شما فعال شد. کارابازار";
|
||||
|
||||
// خرید پکیج
|
||||
public static string PackagePurchased(string? firstName, string packageName)
|
||||
=> $"{GetUserName(firstName)} عزیز، پکیج {packageName} با موفقیت خریداری شد. کارابازار";
|
||||
|
||||
// واریز کمیسیون
|
||||
public static string CommissionDeposited(string? firstName, long amount)
|
||||
=> $"{GetUserName(firstName)} عزیز، مبلغ {amount:N0} ریال کمیسیون به کیف پول شما واریز شد. کارابازار";
|
||||
|
||||
// برداشت موفق
|
||||
public static string WithdrawalSuccess(string? firstName, long amount)
|
||||
=> $"{GetUserName(firstName)} عزیز، درخواست برداشت {amount:N0} ریال با موفقیت انجام شد. کارابازار";
|
||||
|
||||
// پیوستن به شبکه
|
||||
public static string NetworkJoined(string? firstName, string referrerName)
|
||||
=> $"{GetUserName(firstName)} عزیز، به شبکه {referrerName} پیوستید. کارابازار";
|
||||
|
||||
// زیرمجموعه جدید
|
||||
public static string NewDownline(string? firstName, string newMemberName)
|
||||
=> $"{GetUserName(firstName)} عزیز، {newMemberName} به زیرمجموعه شما اضافه شد. کارابازار";
|
||||
|
||||
// کد OTP
|
||||
public static string OtpCode(string code)
|
||||
=> $"کد تأیید شما: {code}\nکارابازار";
|
||||
|
||||
// خوشآمدگویی
|
||||
public static string Welcome(string? firstName)
|
||||
=> $"{GetUserName(firstName)} عزیز، به کارابازار خوش آمدید!";
|
||||
}
|
||||
```
|
||||
|
||||
### نحوه استفاده:
|
||||
|
||||
```csharp
|
||||
// تزریق سرویس
|
||||
private readonly IKavenegarService _smsService;
|
||||
|
||||
// ارسال پیامک
|
||||
var message = SmsTemplates.DayaLoanReceived(user.FirstName, 56_000_000);
|
||||
await _smsService.SendAsync(user.PhoneNumber, message);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## تنظیمات Email (Gmail)
|
||||
|
||||
### مرحله 1: ایجاد App Password در Gmail
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
# 🔧 SystemConstants - مقادیر ثابت سیستم
|
||||
|
||||
> **فایل**: `CMSMicroservice.Domain/Common/SystemConstants.cs`
|
||||
> **آخرین بروزرسانی**: ۷ دی ۱۴۰۴
|
||||
|
||||
---
|
||||
|
||||
## 📋 هدف
|
||||
|
||||
این کلاس شامل تمام مقادیر ثابت سیستم است که در چندین جای مختلف استفاده میشوند.
|
||||
به جای hardcode کردن اعداد در کد، از این ثابتها استفاده کنید.
|
||||
|
||||
---
|
||||
|
||||
## 📊 مقادیر موجود
|
||||
|
||||
### Club Configuration
|
||||
|
||||
| ثابت | مقدار | توضیح |
|
||||
|------|-------|-------|
|
||||
| `ClubJoiningPercentage` | 0.35 (35%) | درصد کمیسیون پیوستن به باشگاه |
|
||||
| `ClubActivationThreshold` | 0.5 (50%) | آستانه فعالسازی باشگاه |
|
||||
|
||||
### Commission Configuration
|
||||
|
||||
| ثابت | مقدار | توضیح |
|
||||
|------|-------|-------|
|
||||
| `MaxCalculationAttempts` | 3 | حداکثر تلاش برای محاسبه کمیسیون |
|
||||
| `DefaultCommissionPoolDays` | 7 | تعداد روزهای استخر کمیسیون |
|
||||
|
||||
### Package Amounts
|
||||
|
||||
| ثابت | مقدار | توضیح |
|
||||
|------|-------|-------|
|
||||
| `GoldenPackageAmount` | 56,000,000 | مبلغ پکیج طلایی (56 میلیون ریال) |
|
||||
| `DayaLoanAmount` | 56,000,000 | مبلغ وام دایا (56 میلیون ریال) |
|
||||
|
||||
---
|
||||
|
||||
## 💻 کد
|
||||
|
||||
```csharp
|
||||
namespace CMSMicroservice.Domain.Common;
|
||||
|
||||
/// <summary>
|
||||
/// مقادیر ثابت سیستم که در چند جای مختلف استفاده میشوند
|
||||
/// </summary>
|
||||
public static class SystemConstants
|
||||
{
|
||||
// Club Configuration
|
||||
public const decimal ClubJoiningPercentage = 0.35m; // 35% کمیسیون پیوستن به باشگاه
|
||||
public const decimal ClubActivationThreshold = 0.5m; // 50% آستانه فعالسازی
|
||||
|
||||
// Commission Configuration
|
||||
public const int MaxCalculationAttempts = 3; // حداکثر تلاش محاسبه
|
||||
public const int DefaultCommissionPoolDays = 7; // روزهای استخر کمیسیون
|
||||
|
||||
// Package Amounts
|
||||
public const long GoldenPackageAmount = 56_000_000; // 56 میلیون - پکیج طلایی
|
||||
public const long DayaLoanAmount = 56_000_000; // 56 میلیون - وام دایا
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔍 نحوه استفاده
|
||||
|
||||
### در Handler ها:
|
||||
|
||||
```csharp
|
||||
using CMSMicroservice.Domain.Common;
|
||||
|
||||
public class ProcessDayaLoanApprovalCommandHandler
|
||||
{
|
||||
public async Task<Unit> Handle(...)
|
||||
{
|
||||
// به جای: var amount = 56_000_000;
|
||||
var amount = SystemConstants.DayaLoanAmount;
|
||||
|
||||
await DepositToWallet(userId, amount);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### در Validation ها:
|
||||
|
||||
```csharp
|
||||
public class ValidateGoldenPackagePurchaseQueryHandler
|
||||
{
|
||||
public async Task<bool> Handle(...)
|
||||
{
|
||||
var requiredAmount = SystemConstants.GoldenPackageAmount;
|
||||
return user.WalletBalance >= requiredAmount;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ قوانین
|
||||
|
||||
1. **همیشه از ثابتها استفاده کنید** - هرگز مقادیر magic number در کد ننویسید
|
||||
2. **تغییر مقادیر** - برای تغییر یک مقدار، فقط این فایل را تغییر دهید
|
||||
3. **ثابتهای جدید** - اگر مقداری در بیش از یک جا استفاده میشود، به این فایل اضافه کنید
|
||||
4. **نامگذاری** - از نامهای توصیفی استفاده کنید (مثلاً `GoldenPackageAmount` نه `Amount1`)
|
||||
|
||||
---
|
||||
|
||||
## 📁 فایلهای مرتبط
|
||||
|
||||
- `SmsTemplates.cs` - قالبهای پیامک
|
||||
- `ProcessDayaLoanApprovalCommandHandler.cs` - استفاده از DayaLoanAmount
|
||||
- `ValidateGoldenPackagePurchaseQueryHandler.cs` - استفاده از GoldenPackageAmount
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Related Docs
|
||||
|
||||
- [email-sms-configuration.md](email-sms-configuration.md) - تنظیمات SMS و قالبها
|
||||
- [CHANGELOG-2025-12-27.md](../../CHANGELOG-2025-12-27.md) - تاریخچه تغییرات
|
||||
Reference in New Issue
Block a user