דיווח לספקי הדפדפנים על בעיות שאתם מוצאים בדפדפן שלהם הוא חלק בלתי נפרד משיפור פלטפורמת האינטרנט.
דיווח על באג בצורה טובה דורש קצת עבודה. המטרה שלכם צריכה להיות להקל ככל האפשר על מהנדסי הדפדפן למצוא את מה שלא תקין, להגיע לשורש הבעיה, והכי חשוב – למצוא דרך לתקן אותה. באגים שמתקדמים מהר הם בדרך כלל כאלה שקל לשחזר, עם התנהגות צפויה וברורה.
איך מוודאים שמדובר בבאג
השלב הראשון הוא להבין מהי ההתנהגות "הנכונה".
מהי ההתנהגות הנכונה?
עיינו במסמכי התיעוד הרלוונטיים של ה-API ב-MDN, או נסו למצוא מפרטים קשורים. המידע הזה יכול לעזור לכם להחליט איזה API באמת לא תקין, איפה הוא לא תקין ומה ההתנהגות הצפויה.
האם הוא פועל בדפדפן אחר?
בדרך כלל, התנהגות שונה בין דפדפנים מקבלת עדיפות גבוהה יותר כבעיית יכולת פעולה הדדית, במיוחד כשהדפדפן שמכיל את הבאג הוא החריג. נסו לבדוק את הגרסאות העדכניות של Chrome, Firefox, Safari ו-Edge, אולי באמצעות כלי כמו BrowserStack.
אם אפשר, כדאי לבדוק שהדף לא מתנהג בכוונה בצורה שונה בגלל זיהוי סוכן המשתמש. בכלי הפיתוח ל-Chrome, נסו להגדיר את המחרוזת User-Agent לדפדפן אחר.
האם הוא הפסיק לפעול בגרסה האחרונה?
האם זה עבד כמו שצריך בעבר, אבל הפסיק לעבוד בגרסה עדכנית של הדפדפן? כך נוכל לטפל ברגרסיות כאלה הרבה יותר מהר, במיוחד אם תציינו את מספר הגרסה שבה הפיצ'ר פעל ואת מספר הגרסה שבה הוא נכשל. אתם יכולים להשתמש בכלים כמו BrowserStack כדי לבדוק גרסאות ישנות של דפדפנים. כדי לחפש את השינוי, אפשר להשתמש בכלים כמו bisect-builds (ל-Chromium).
אם הבעיה היא רגרסיה ואפשר לשחזר אותה, בדרך כלל אפשר למצוא את שורש הבעיה ולתקן אותה במהירות.
האם גם אחרים נתקלים באותה בעיה?
אם אתם נתקלים בבעיות, סביר להניח שגם מפתחים אחרים נתקלים בהן. קודם כל, נסו לחפש את הבאג ב-Stack Overflow. כך תוכלו לתרגם בעיה מופשטת ל-API ספציפי שלא פועל, ולמצוא פתרון זמני עד שהבאג יתוקן.
האם כבר דיווחתם על זה בעבר?
אחרי שאתם מבינים מהו הבאג, הגיע הזמן לבדוק אם הוא כבר דווח. כדי לעשות את זה, אתם יכולים לחפש במסד הנתונים של הבאגים בדפדפן.
- דפדפנים מבוססי Chromium: https://crbug.com
- Firefox: https://bugzilla.mozilla.org/
- דפדפנים שמבוססים על Safari ו-WebKit: https://bugs.webkit.org/
אם מצאתם באג קיים שמתאר את הבעיה, אתם יכולים להוסיף את התמיכה שלכם על ידי סימון בכוכב, הוספה למועדפים או הוספת תגובה לבאג. בנוסף, בהרבה אתרים אתם יכולים להוסיף את עצמכם לרשימת המכותבים ולקבל עדכונים כשהבאג משתנה.
אם אתם מחליטים להגיב על הבאג, כדאי לכלול מידע על האופן שבו הבאג משפיע על האתר שלכם. אל תוסיפו תגובות בסגנון "+1", כי מערכות למעקב אחרי באגים בדרך כלל שולחות אימיילים על כל תגובה.
דיווח על הבאג
אם הבאג לא דווח בעבר, זה הזמן לספר עליו לספק הדפדפן.
יצירת מקרה בדיקה מצומצם
במאמר של Mozilla מוסבר איך ליצור מקרה בדיקה מצומצם. בקיצור, תיאור של הבעיה הוא התחלה מצוינת, אבל אין תחליף להדגמה מקושרת בדיווח על הבאג שמראה את הבעיה. כדי להגדיל את הסיכוי להתקדמות מהירה, הדוגמה צריכה להכיל את הקוד המינימלי האפשרי שנדרש כדי להדגים את הבעיה. דוגמת קוד מינימלית היא הדבר הכי חשוב שאתם יכולים לעשות כדי להגדיל את הסיכויים שהבאג יתוקן.
ריכזנו כאן כמה טיפים לצמצום מקרה בדיקה:
- מורידים את דף האינטרנט, מוסיפים את
<base href="https://original.url">ובודקים אם הבאג קיים באופן מקומי. יכול להיות שיהיה צורך בשרת HTTPS פעיל אם כתובת ה-URL משתמשת ב-HTTPS. - בודקים את הקבצים המקומיים בגרסאות ה-build העדכניות של כמה שיותר דפדפנים.
- נסו לרכז את כל המידע בקובץ אחד.
- מסירים קוד (מתחילים בדברים שיודעים שהם מיותרים) עד שהבאג נעלם.
- השתמשו בניהול גרסאות כדי לשמור את העבודה ולבטל דברים שהשתבשו.
אירוח של מקרה בדיקה ממוזער
אם אתם מחפשים מקום טוב לארח בו את מקרה הבדיקה הממוזער, יש כמה מקומות טובים זמינים:
חשוב לזכור שבחלק מהאתרים האלה התוכן מוצג ב-iframe, ולכן יכול להיות שהתכונות או הבאגים יתנהגו בצורה שונה.
דיווח על הבעיה
אחרי שצמצמתם את מקרה הבדיקה, אתם מוכנים לדווח על הבאג. עוברים לאתר המתאים למעקב אחרי באגים ויוצרים דיווח חדש.
- דפדפנים שמבוססים על Chromium – https://crbug.com/new
- Firefox – https://bugzilla.mozilla.org/
- דפדפנים שמבוססים על Safari ו-WebKit – https://bugs.webkit.org/
הוסיפו תיאורים ברורים ושלבים לשחזור הבעיה
קודם כול, תארו את הבעיה בצורה ברורה כדי שהמהנדסים יבינו במהירות מה הבעיה ויעזרו לכם לפתור אותה.
When installing a PWA using the `beforeinstallprompt.prompt()`, the
`appinstalled` event fires before the call to `prompt()` resolves.
לאחר מכן, תארו בפירוט את השלבים שנדרשים כדי לשחזר את הבעיה, וציינו מה הייתה התוצאה הצפויה ומה הייתה התוצאה בפועל.
What is the expected result? In the console:
0. INSTALL: Available (logged when `beforeinstallprompt` event fired)
1. INSTALL_PROMPT_RESPONSE: {outcome: "accepted", platform: "web"}
(logged when beforeinstallprompt.prompt()` resolves)
2. INSTALL: Success (logged when `appinstalled` event fired)
What is the actual result? In the console:
0. INSTALL: Available (logged when `beforeinstallprompt` event fired)
1. INSTALL: Success (logged when `appinstalled` event fired)
2. INSTALL_PROMPT_RESPONSE: {outcome: "accepted", platform: "web"}
(logged when beforeinstallprompt.prompt()` resolves)
למידע נוסף, קראו את ההנחיות לכתיבת דוח על באג ב-MDN.
בונוס: הוספת צילום מסך או הקלטת מסך של הבעיה
זה לא חובה, אבל בדרך כלל כדאי להוסיף צילום מסך או הקלטת מסך של הבעיה. זה שימושי במיוחד כשבאגים מתרחשים אחרי כמה שלבים או פעילות חריגה. הקלטות מסך וצילומי מסך יכולים לעזור למהנדסי הדפדפן להבין מה קרה.
לכלול פרטים על הסביבה
יש באגים שאפשר לשחזר רק במערכות הפעלה מסוימות, או רק בסוגים ספציפיים של מסכים (לדוגמה, DPI נמוך או DPI גבוה). חשוב לכלול את הפרטים של כל סביבות הבדיקה שבהן השתמשתם.
שליחת הבאג
בסיום, שולחים את הבאג. כדאי לבדוק את האימייל כדי לראות אם קיבלת תשובות לגבי הבאג. בדרך כלל, במהלך הבדיקה, למהנדסים יש שאלות נוספות. אם הם יתקשו לשחזר את הבעיה, יכול להיות שהם יפנו אליכם.