بتل کد Battle Codeدارد باز می‌شود…

پیدا کردن باگ

باگ‌زدایی کار کارآگاه‌هاست: سرنخ جمع می‌کنی، صحنه را بازسازی می‌کنی و دنبال دلیل اصلی می‌گردی. این‌ها ابزارها و اصطلاح‌های همین کارند.

کلمه‌های مرکب: دو کلمه، یک معنی تازه

انگلیسی دوست دارد دو کلمه‌ی ساده را به هم بچسباند و کلمه‌ی تازه بسازد: break + point = breakpoint، ‏work + around = workaround، ‏trace + back = traceback. اگر کلمه‌ی بلندی دیدی، آن را از وسط نصف کن و هر تکه را جدا معنی کن. بعضی‌ها هنوز جدا نوشته می‌شوند ولی یک معنی دارند، مثل root cause.

هشت کلمه‌ی این درس

debug (دیباگ): باگ‌زدایی؛ پیدا کردن و برداشتن اشتباه کد

de- یعنی «برداشتن» و bug یعنی اشتباه کد: debug یعنی باگ را پیدا کردن و برداشتن. این کار کارآگاهی است: سرنخ جمع می‌کنی (پیام خطا، مقدار متغیرها)، حدس می‌زنی و حدست را امتحان می‌کنی. ابزار این کار debugger است. DEBUG اسم ریزترین سطح پیام‌های لاگ هم هست: جزئیاتی که فقط موقع عیب‌یابی لازم می‌شوند.

I spent two hours trying to debug this function.

دو ساعت وقت گذاشتم تا این تابع را باگ‌زدایی کنم.

breakpoint (بْرِیک‌پوینت): نقطه‌ی توقف برای بررسی برنامه

break یعنی توقف و point یعنی نقطه: breakpoint نقطه‌ای است که می‌خواهی برنامه آن‌جا بایستد. در ادیتور کنار شماره‌ی خط کلیک می‌کنی و یک نقطه‌ی قرمز می‌آید. وقتی اجرا به آن خط برسد، برنامه مکث می‌کند و تو می‌توانی مقدار همه‌ی متغیرها را ببینی و خط‌به‌خط جلو بروی. مثل دکمه‌ی مکث وسط فیلم.

Set a breakpoint on line 12 and run the program again.

روی خط ۱۲ یک نقطه‌ی توقف بگذار و برنامه را دوباره اجرا کن.

log (لاگ): گزارش ثبت‌شده از کارهای برنامه

log در اصل دفتری بود که ناخدای کشتی هر روز اتفاق‌های سفر را در آن می‌نوشت. log برنامه هم همین است: فهرستی از اتفاق‌ها با ساعت و تاریخ. وقتی چیزی خراب می‌شود، اولین جایی است که باید نگاه کنی. فعل هم هست: to log یعنی ثبت کردن؛ console.log یعنی «این را در کنسول بنویس».

Check the server log to see what happened before the crash.

لاگ سرور را ببین تا بفهمی قبل از خرابی چه اتفاقی افتاده است.

console (کانسول): پنجره‌ی متنی پیام‌ها و دستورها

console در اصل میز فرمان یک دستگاه بزرگ بود. امروز به پنجره‌ای متنی می‌گویند که برنامه پیام‌هایش را آن‌جا می‌نویسد و تو می‌توانی در آن دستور تایپ کنی. کنسول مرورگر با کلید F12 باز می‌شود و خطاهای جاوااسکریپت صفحه با رنگ قرمز آن‌جا می‌آیند. در پایتون، خروجی print در کنسول دیده می‌شود.

Open the browser console to see the error messages.

کنسول مرورگر را باز کن تا پیام‌های خطا را ببینی.

inspect (اینسپِکت): از نزدیک و با دقت بررسی کردن

inspect یعنی چیزی را با دقت وارسی کردن، کاری که بازرس (inspector) می‌کند. در مرورگر اگر روی هر جای صفحه راست‌کلیک کنی و Inspect را بزنی، ابزار توسعه‌دهنده باز می‌شود و HTML و CSS همان تکه را نشان می‌دهد. موقع باگ‌زدایی هم inspect a variable یعنی مقدار یک متغیر را در لحظه‌ی توقف نگاه کردن.

Right-click the button and choose Inspect to see its HTML.

روی دکمه راست‌کلیک کن و Inspect را بزن تا HTML آن را ببینی.

reproduce (ری‌پْرودوس): دوباره به وجود آوردن (یک باگ)

re- یعنی «دوباره» و produce یعنی تولید کردن: reproduce یعنی باگ را دوباره به وجود آوردن. تا نتوانی باگی را هر وقت خواستی تکرار کنی، نه می‌توانی دلیلش را پیدا کنی و نه مطمئن شوی که درست شده است. برای همین هر گزارش باگ خوب بخشی به نام Steps to reproduce دارد: قدم‌هایی که خطا را دوباره نشان می‌دهند.

I cannot reproduce the bug on my computer.

نمی‌توانم این باگ را روی کامپیوتر خودم دوباره به وجود بیاورم.

root cause (روت کاز): علت ریشه‌ای؛ دلیل اصلی مشکل

root یعنی ریشه و cause یعنی علت: root cause یعنی دلیل اصلی و اولِ یک مشکل. خطایی که می‌بینی معمولاً فقط نشانه است، مثل تب؛ علت ریشه‌ای همان بیماری است. اگر فقط نشانه را برطرف کنی، مشکل از جای دیگری بیرون می‌زند. پایتون در خطاهای زنجیره‌ای خودش علت را نشان می‌دهد: بالاترین خطا معمولاً ریشه است.

The root cause of the crash was an empty config file.

علت ریشه‌ای از کار افتادن برنامه یک فایل تنظیمات خالی بود.

workaround (وُرک‌اِراند): راه دور زدن مشکل؛ چاره‌ی موقت

work around یعنی «دور چیزی کار کردن»: مشکل را حل نمی‌کنی، دورش می‌زنی. workaround راه موقتی است که کار را راه می‌اندازد، در حالی که خودِ باگ سر جایش است؛ مثل سطلی که زیر سقفِ چکه‌کن می‌گذاری. وقتی باگ در کتابخانه‌ی کس دیگری است و نمی‌توانی درستش کنی، چاره‌ی خوبی است؛ فقط یادت نرود موقتی است.

There is no fix yet, but here is a simple workaround.

هنوز راه‌حل اصلی نیامده، ولی این یک راه ساده برای دور زدن مشکل است.

شکار یک باگ

Ali: The game freezes sometimes, but I cannot reproduce it on my laptop.
Sara: Did you check the console in the browser?
Ali: Yes. The log shows "score is NaN" just before it freezes.
Sara: Good clue. Put a breakpoint on the line that changes the score and inspect the values.
Ali: Found it! The root cause is an empty input: the code turns it into NaN.
Sara: Nice debugging. Fix the real problem; do not just add a workaround.

علی: بازی گاهی قفل می‌کند، ولی نمی‌توانم روی لپ‌تاپ خودم دوباره به وجودش بیاورم.
سارا: کنسول مرورگر را نگاه کردی؟
علی: بله. لاگ درست قبل از قفل شدن نشان می‌دهد «score is NaN».
سارا: سرنخ خوبی است. روی خطی که امتیاز را عوض می‌کند یک نقطه‌ی توقف بگذار و مقدارها را بررسی کن.
علی: پیدایش کردم! علت ریشه‌ای یک ورودی خالی است: کد آن را به NaN تبدیل می‌کند.
سارا: باگ‌زدایی خوبی بود. مشکل واقعی را درست کن؛ فقط یک راه دور زدن اضافه نکن.