چکلیستی برای نوشتن کد باکیفیتتر؛ قبل از اینکه کدمون رو نهایی کنیم چه چیزهایی رو بررسی کنیم؟
یک چکلیست کاربردی برای بررسی کیفیت کد قبل از انتشار؛ از خوانایی، امنیت و اعتبارسنجی ورودیها تا صحت دادهها، مدیریت فایل، Performance، تست و معماری. مجموعهای از نکات که به نوشتن کدی قابل اعتمادتر و نگهداریپذیرتر کمک میکنن.
نوشتن کدی که کار میکنه، لزوماً به معنی نوشتن کد خوب نیست.
ممکنه یک API خروجی درستی برگردونه، اما در شرایط همزمانی اطلاعات رو خراب کنه. ممکنه آپلود فایل بدون مشکل انجام بشه، اما راهی برای آپلود فایل مخرب باز گذاشته باشیم. ممکنه یک سرویس بهدرستی کار کنه، اما مسئولیتهای زیادی رو به عهده گرفته باشه و نگهداریش سخت شده باشه.
کیفیت کد فقط به Clean Code یا انتخاب اسمهای خوب محدود نمیشه. باید مطمئن بشیم کدمون از نظر امنیت، صحت دادهها، عملکرد، معماری و قابلیت نگهداری هم قابل اعتماده.
توی این مطلب یک چکلیست کاربردی آماده کردیم که میتونیم قبل از نهایی کردن هر Feature، Pull Request یا حتی یک تغییر کوچک، ازش استفاده کنیم.
آیا از شرطهای تو در تو و پیچیدگی غیرضروری جلوگیری کردیم؟
آیا کامنتها واقعاً اطلاعات مفیدی اضافه میکنن یا صرفاً کاری رو که کد انجام میده تکرار میکنن؟
آیا نوع ورودی و خروجی متدها مشخصه؟
آیا از Magic Number و Magic String بدون دلیل استفاده نکردیم؟
۲. اعتبارسنجی و ورودیها (Validation)
آیا تمام ورودیهای کاربر در سمت سرور اعتبارسنجی میشن؟
آیا از دادههایvalidated()بهجای اعتماد مستقیم به کل Request استفاده کردیم؟
آیا ورودیهای شرطی (Conditional Validation) بهدرستی بررسی میشن؟
آیا محدودیت طول، اندازه، نوع و فرمت دادهها مشخصه؟
آیا برای آپلود فایل، هم MIME Type و هم Extension بررسی میشن؟
آیا به نام فایل، پسوند یا Content-Type ارسالی از سمت کلاینت اعتماد نکردیم؟
آیا URLهای ورودی از نظر ساختار و پروتکل مجاز بررسی میشن؟
آیا ورودیهای حساس در صورت نیاز نرمالسازی میشن؟
نکته: اعتبارسنجی سمت کلاینت برای تجربه کاربری مفیده، اما جایگزین اعتبارسنجی سمت سرور نیست.
۳. امنیت (Security)
آیا قبل از انجام عملیات، Authorization کاربر بررسی میشه؟
آیا کاربر فقط به منابعی که مجوز دسترسی بهشون رو داره دسترسی داره؟
آیا جلوی IDOR و دسترسی به اطلاعات کاربران دیگه گرفته شده؟
آیا اطلاعات حساس مثل Token، Password و Credentials در Logها یا Responseها قرار نمیگیرن؟
آیا اطلاعات حساس ذخیرهشده در دیتابیس بهدرستی محافظت میشن؟
آیا فایلهای آپلودشده در مسیرهای قابل اجرای کد ذخیره نمیشن؟
آیا نام فایلها توسط سرور تولید میشه؟
آیا محدودیت حجم و تعداد درخواستها (Rate Limiting) داریم؟
آیا به Headerهای قابل جعل مثلX-Real-IPبدون پیکربندی صحیح Trusted Proxies اعتماد نکردیم؟
آیا دسترسی به منابع خارجی و URLهای ورودی میتونه باعث SSRF یا دسترسی غیرمجاز بشه؟
۴. دیتابیس و صحت اطلاعات (Database Integrity)
آیا برای ارتباط بین جداول از Foreign Key مناسب استفاده کردیم؟
آیا محدودیتهای لازم مثل Unique Constraint در دیتابیس تعریف شدن؟
آیا Indexهای مناسب برای Queryهای پرتکرار داریم؟
آیا از ذخیره دادههای تکراری یا ناسازگار جلوگیری کردیم؟
آیا منطق مهم صحت دادهها فقط به Validation اپلیکیشن وابسته نیست؟
آیا در عملیات چندمرحلهای از Transaction استفاده کردیم؟
آیا Transaction فقط عملیات مرتبط با دیتابیس رو پوشش میده؟
آیا احتمال Race Condition در عملیات همزمان رو بررسی کردیم؟
آیا برای عملیات حساس از Lock مناسب استفاده کردیم؟
آیا ترتیب اجرای عملیات در شرایط Concurrent قابل پیشبینیه؟
نکته: Transaction بهتنهایی جلوی تمام مشکلات همزمانی رو نمیگیره. گاهی به Lock و Constraint در سطح دیتابیس هم نیاز داریم.
۵. مدیریت فایل و Storage
آیا فایلها قبل از ذخیره شدن اعتبارسنجی میشن؟
آیا MIME Type و Extension هر دو بررسی میشن؟
آیا نام فایلها توسط سرور تولید میشه؟
آیا فایلها در Storage مناسب و غیرقابل اجرای مستقیم ذخیره میشن؟
آیا محدودیت حجم فایل و فضای مصرفی کاربران داریم؟
آیا حذف فایل از Storage با حذف رکورد دیتابیس هماهنگه؟
آیا احتمال باقی موندن فایلهای بدون رکورد (Orphan Files) رو بررسی کردیم؟
آیا حذف فایلهای فیزیکی خارج از Transaction دیتابیس انجام میشه؟
آیا عملیات ناموفق Storage قابل تشخیص و Retry هست؟
آیا برای فایلهای پیچیده مثل ویدئو، اعتبارسنجی محتوای واقعی و محدودیت مدتزمان و Resolution در نظر گرفتیم؟
نکته: حذف فایل از دیسک قابل Rollback شدن توسط Database Transaction نیست. بنابراین باید برای شکست عملیات و پاکسازی فایلهای باقیمانده راهکار داشته باشیم.
۶. معماری و مسئولیتها (Architecture)
آیا Controller فقط مسئول هماهنگی درخواست HTTP هست؟
آیا Validation در Form Request یا لایه مناسب خودش قرار گرفته؟
آیا منطق اصلی Business Logic در جای مناسبی قرار داره؟
آیا Serviceها مسئولیت مشخص و محدودی دارن؟
آیا از ساخت Abstractionهای غیرضروری خودداری کردیم؟
آیا از Enum برای مقادیر ثابت و محدود استفاده کردیم؟
آیا Exceptionهای اختصاصی و معنادار داریم؟
آیا تبدیل Exceptionها به HTTP Response در لایه مناسبی انجام میشه؟
آیا Middlewareها مسئولیتهای مرتبط با درخواست رو مدیریت میکنن؟
آیا وابستگیهای کلاسها بهدرستی مدیریت شدن؟
۷. عملکرد و بهینهسازی (Performance)
آیا احتمال N+1 Query رو بررسی کردیم؟
آیا از Eager Loading در محل مناسب استفاده کردیم؟
آیا Queryهای غیرضروری یا تکراری داریم؟
آیا برای لیستهای بزرگ از Pagination استفاده کردیم؟
آیا فقط ستونهای موردنیاز رو از دیتابیس دریافت میکنیم؟
آیا عملیات سنگین و زمانبر به Queue منتقل شدن؟
آیا برای Cache کردن اطلاعات پرتکرار برنامه داریم؟
آیا درخواستهای خارجی Timeout مناسب دارن؟
آیا برای Retry کردن درخواستهای ناموفق محدودیت مشخصی داریم؟
آیا مصرف حافظه و منابع در پردازش فایلهای بزرگ کنترل میشه؟
۸. مدیریت خطاها و رفتار سیستم (Error Handling)
آیا خطاهای قابل پیشبینی بهدرستی مدیریت میشن؟
آیا برای هر خطا HTTP Status Code مناسب برمیگردونیم؟
آیا خطای Validation با خطای Server یا Storage اشتباه گرفته نمیشه؟
آیا Exceptionها رو بدون دلیل پنهان یا نادیده نمیگیریم؟
آیا پیام خطا برای کاربر امن و قابل فهمه؟
آیا جزئیات فنی لازم برای Debug در Log ثبت میشن؟
آیا شکست عملیات خارجی مثل Storage، Queue و APIهای شخص ثالث قابل پیگیریه؟
آیا عملیات Cleanup در صورت شکست قابل تکرار هست؟
۹. ارتباطات و عملیات غیرهمزمان (Async Operations)
آیا عملیات غیرضروری و زمانبر از چرخه اصلی Request خارج شدن؟
آیا Jobها در برابر اجرای چندباره (Duplicate Execution) مقاوم هستن؟
آیا عملیات حساس Idempotent طراحی شدن؟
آیا ترتیب اجرای Eventها و Jobها اهمیت داره؟
آیا Eventهای وابسته به Transaction بعد از Commit منتشر میشن؟
آیا برای Jobهای ناموفق Retry و Failure Handling داریم؟
آیا احتمال اجرای همزمان چند Job روی یک منبع مشترک بررسی شده؟
۱۰. فرانتاند و ارتباط با API
آیا ساختار Responseهای API قابل پیشبینی و یکپارچه است؟
آیا Frontend فقط به دادههایی دسترسی داره که واقعاً بهش نیاز داره؟
آیا Loading، Error و Empty State برای صفحات و کامپوننتها در نظر گرفته شدن؟
آیا از ارسال درخواستهای تکراری و غیرضروری جلوگیری کردیم؟
آیا State در محل مناسبی مدیریت میشه؟
آیا اعتبارسنجی فرمها تجربه کاربری مناسبی ایجاد میکنه؟
آیا خطاهای API به پیام قابل فهم برای کاربر تبدیل میشن؟
آیا دسترسیپذیری (Accessibility) در کامپوننتها رعایت شده؟
آیا اطلاعات حساس در Local Storage یا محیطهای غیرامن ذخیره نمیشن؟
آیا تغییرات API با قرارداد مورد انتظار Frontend سازگارن؟
۱۱. تست و قابلیت اطمینان (Testing)
آیا مسیر اصلی اجرای Feature تست شده؟
آیا ورودیهای نامعتبر تست شدن؟
آیا شرایط مرزی (Edge Cases) بررسی شدن؟
آیا دسترسی غیرمجاز تست شده؟
آیا شکست عملیات خارجی مثل Storage و API تست شده؟
آیا سناریوهای همزمانی و Race Condition بررسی شدن؟
آیا تستها به جزئیات داخلی پیادهسازی وابسته نیستن؟
آیا برای تغییرات جدید، تست Regression مناسبی داریم؟
۱۲. نگهداری و توسعهپذیری (Maintainability)
آیا تغییرات جدید با ساختار فعلی پروژه سازگارن؟
آیا تغییر یک بخش باعث شکستن بخشهای نامرتبط نمیشه؟
آیا کدهای مرده و وابستگیهای بلااستفاده حذف شدن؟
آیا مستندات لازم برای رفتارهای غیرمعمول نوشته شدن؟
آیا Migrationها با اطلاعات موجود سازگارن؟
آیا تغییرات Backward Compatibility رو در نظر گرفتن؟
آیا Logها و ابزارهای Monitoring اطلاعات کافی برای بررسی مشکلات فراهم میکنن؟
چکلیست نهایی قبل از Merge کردن Pull Request
در حال رسم نمودار…
اگر فرصت بررسی تمام موارد بالا رو نداریم، حداقل قبل از Merge این موارد رو بررسی کنیم:
منطق برنامه در شرایط عادی درست کار میکنه.
ورودیها اعتبارسنجی میشن و دسترسیها کنترل شدن.
اطلاعات دیتابیس در شرایط خطا و همزمانی خراب نمیشن.
عملیات فایل و Storage قابل اطمینان هستن.
Queryها و عملکرد برنامه بررسی شدن.
خطاها بهدرستی مدیریت میشن.
تستهای لازم نوشته و اجرا شدن.
کد خوانا، قابل نگهداری و بدون پیچیدگی غیرضروریه.
حرف آخر
قرار نیست تمام این موارد برای هر تغییر کوچکی به یک قانون سختگیرانه تبدیل بشن.
بعضی تغییرات فقط به چند مورد از این چکلیست نیاز دارن و بعضی Featureها، مخصوصاً بخشهایی که با اطلاعات حساس، فایلها، پرداختها یا عملیات همزمان سروکار دارن، به بررسی دقیقتری احتیاج دارن.
هدف این چکلیست این نیست که کد رو پیچیدهتر کنیم؛ هدف اینه که قبل از انتشار، مشکلاتی رو پیدا کنیم که شاید امروز دیده نشن، اما فردا هزینه زیادی برای رفعشون داشته باشن.
کد خوب فقط کدی نیست که امروز کار میکنه؛ کدیه که فردا هم بشه بهش اعتماد کرد و با خیال راحت توسعهاش داد.
نظرات
هنوز نظری ثبت نشده است. اولین نفر باشید!