วิธีรายงานข้อบกพร่องที่ดีเกี่ยวกับเบราว์เซอร์

การแจ้งผู้ให้บริการเบราว์เซอร์เกี่ยวกับปัญหาที่คุณพบในเบราว์เซอร์เป็นส่วนสำคัญในการทำให้แพลตฟอร์มเว็บดีขึ้น

การยื่นข้อบกพร่องที่ดีแต่ต้องใช้เวลาดำเนินการเล็กน้อย เป้าหมายของคุณควรเป็นการทำให้วิศวกรเบราว์เซอร์ค้นหาสิ่งที่เสีย เข้าถึงสาเหตุของปัญหา และที่สำคัญที่สุดคือค้นหาวิธีแก้ไขได้ง่ายที่สุด ข้อบกพร่องที่แก้ไขได้รวดเร็ว มักจะจำลองซ้ำได้ง่ายและมีลักษณะการทำงานที่คาดหวังที่ชัดเจน

ยืนยันว่าเป็นข้อบกพร่อง

ขั้นตอนแรกคือการพิจารณาว่าลักษณะการทำงานที่ "ถูกต้อง" ควรเป็นอย่างไร

ลักษณะการทำงานที่ถูกต้องคืออะไร

ตรวจสอบเอกสาร API ที่เกี่ยวข้องใน MDN หรือลองค้นหาข้อกำหนดที่เกี่ยวข้อง ข้อมูลนี้จะช่วยให้คุณตัดสินใจได้ว่า API ใดเสียจริง เสียที่ใด และลักษณะการทำงานที่คาดหวังคืออะไร

ตรวจสอบว่าใช้งานในเบราว์เซอร์อื่นได้หรือไม่

โดยทั่วไปแล้ว พฤติกรรมที่แตกต่างกันระหว่างเบราว์เซอร์จะได้รับการจัดลำดับความสำคัญสูงกว่าเป็นปัญหาด้านความสามารถในการทำงานร่วมกัน โดยเฉพาะอย่างยิ่งเมื่อเบราว์เซอร์ที่มีข้อบกพร่องเป็นเบราว์เซอร์ที่แปลกแยก ลองทดสอบใน Chrome, Firefox, Safari และ Edge เวอร์ชันล่าสุด โดยอาจใช้เครื่องมืออย่าง BrowserStack

หากเป็นไปได้ ให้ตรวจสอบว่าหน้าเว็บไม่ได้ตั้งใจทำงานแตกต่างออกไปเนื่องจากการตรวจจับ User Agent ในเครื่องมือสำหรับนักพัฒนาเว็บใน Chrome ให้ลองตั้งค่าสตริง User-Agent เป็นเบราว์เซอร์อื่น

ฟีเจอร์นี้หยุดทำงานในรุ่นล่าสุดใช่ไหม

ก่อนหน้านี้ฟีเจอร์นี้ทำงานตามที่คาดไว้ แต่หยุดทำงานในเบราว์เซอร์รุ่นล่าสุดใช่ไหม การถดถอยดังกล่าวสามารถดำเนินการได้เร็วขึ้นมาก โดยเฉพาะอย่างยิ่งหากคุณระบุหมายเลขเวอร์ชันที่ใช้งานได้และเวอร์ชันที่ล้มเหลว คุณสามารถใช้เครื่องมืออย่าง BrowserStack เพื่อตรวจสอบเบราว์เซอร์เวอร์ชันเก่าได้ ใช้เครื่องมืออย่างเช่น เครื่องมือ bisect-builds (สำหรับ Chromium) เพื่อค้นหาการเปลี่ยนแปลง

หากปัญหาเป็นข้อถดถอยและสามารถจำลองได้ โดยปกติแล้วจะสามารถค้นหาและแก้ไขสาเหตุของปัญหาได้อย่างรวดเร็ว

คนอื่นๆ พบปัญหาเดียวกันไหม

หากคุณพบปัญหา ก็เป็นไปได้ว่านักพัฒนาแอปรายอื่นๆ ก็พบปัญหาเช่นกัน ก่อนอื่น ให้ลองค้นหาข้อบกพร่องใน Stack Overflow ซึ่งอาจช่วยให้คุณแปลปัญหาเชิงนามธรรมเป็น API ที่ใช้งานไม่ได้ที่เฉพาะเจาะจง และอาจช่วยให้คุณพบวิธีแก้ปัญหาชั่วคราวจนกว่าข้อบกพร่องจะได้รับการแก้ไข

เคยมีการรายงานมาก่อนไหม

เมื่อคุณทราบแล้วว่าข้อบกพร่องคืออะไร ก็ถึงเวลาตรวจสอบว่ามีรายงานข้อบกพร่องดังกล่าวแล้วหรือยังโดยค้นหาฐานข้อมูลข้อบกพร่องของเบราว์เซอร์

หากพบข้อบกพร่องที่มีอยู่ซึ่งอธิบายปัญหา ให้เพิ่มการสนับสนุนโดยติดดาว เพิ่มในรายการโปรด หรือแสดงความคิดเห็นเกี่ยวกับข้อบกพร่องนั้น และในหลายๆ เว็บไซต์ คุณสามารถเพิ่มตัวเองลงในรายชื่อ CC และรับข้อมูลอัปเดตเมื่อมีการเปลี่ยนแปลงข้อบกพร่อง

หากคุณตัดสินใจที่จะแสดงความคิดเห็นเกี่ยวกับข้อบกพร่อง ให้ระบุข้อมูลเกี่ยวกับผลกระทบของข้อบกพร่องที่มีต่อเว็บไซต์ของคุณ หลีกเลี่ยงการเพิ่มความคิดเห็นในรูปแบบ "+1" เนื่องจากเครื่องมือติดตามข้อบกพร่องมักจะส่งอีเมลสำหรับทุกความคิดเห็น

รายงานข้อบกพร่อง

หากยังไม่มีการรายงานข้อบกพร่องมาก่อน ก็ถึงเวลาแจ้งให้ผู้ให้บริการเบราว์เซอร์ทราบแล้ว

สร้างกรอบการทดสอบที่ย่อขนาด

Mozilla มีบทความดีๆ เกี่ยวกับวิธีสร้างกรอบการทดสอบที่ลดขนาดลง สรุปสั้นๆ ก็คือ แม้ว่าคำอธิบายปัญหาจะเป็นจุดเริ่มต้นที่ดี แต่ก็ไม่มีอะไรดีไปกว่าการระบุการสาธิตที่ลิงก์ไว้ในข้อบกพร่องซึ่งแสดงปัญหา ตัวอย่างควรมีโค้ดขั้นต่ำที่จำเป็นในการแสดงปัญหาเพื่อให้ดำเนินการได้อย่างรวดเร็วที่สุด ตัวอย่างโค้ดที่สั้นกระชับเป็นสิ่งสำคัญที่สุดที่คุณทำได้เพื่อเพิ่มโอกาสในการแก้ไขข้อบกพร่อง

เคล็ดลับบางประการในการลดขนาดกรอบการทดสอบมีดังนี้

  • ดาวน์โหลดหน้าเว็บ เพิ่ม <base href="https://original.url"> และยืนยันว่ามีข้อบกพร่องอยู่ภายในเครื่อง ซึ่งอาจต้องใช้เซิร์ฟเวอร์ HTTPS ที่ใช้งานอยู่หาก URL ใช้ HTTPS
  • ทดสอบไฟล์ในเครื่องกับบิลด์ล่าสุดของเบราว์เซอร์ต่างๆ ให้มากที่สุด
  • ลองรวมทุกอย่างไว้ในไฟล์เดียว
  • นำโค้ดออก (เริ่มจากสิ่งที่คุณทราบว่าไม่จำเป็น) จนกว่าข้อบกพร่องจะหายไป
  • ใช้การควบคุมเวอร์ชันเพื่อให้คุณบันทึกงานและเลิกทำสิ่งที่ผิดพลาดได้

โฮสต์กรอบการทดสอบที่ลดขนาดแล้ว

หากคุณกำลังมองหาที่ที่ดีในการโฮสต์กรอบการทดสอบที่ลดขนาดแล้ว ก็มีตัวเลือกดีๆ อยู่หลายแห่ง ดังนี้

โปรดทราบว่าเว็บไซต์เหล่านั้นหลายแห่งแสดงเนื้อหาใน iframe ซึ่งอาจทำให้ฟีเจอร์หรือข้อบกพร่องทำงานแตกต่างออกไป

รายงานปัญหา

เมื่อได้กรอบการทดสอบที่ย่อแล้ว คุณก็พร้อมที่จะรายงานข้อบกพร่องนั้น ไปที่เว็บไซต์ติดตามข้อบกพร่องที่ถูกต้อง แล้วสร้างปัญหาใหม่

เพิ่มคำอธิบายและขั้นตอนที่ชัดเจนเพื่อจำลองปัญหา

ก่อนอื่น ให้ระบุคำอธิบายที่ชัดเจนเพื่อช่วยให้วิศวกรเข้าใจปัญหาได้อย่างรวดเร็วและช่วยคัดแยกปัญหา

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

โบนัส: เพิ่มภาพหน้าจอหรือ Screencast ของปัญหา

แม้ว่าจะไม่จำเป็น แต่การเพิ่มภาพหน้าจอหรือ Screencast ของปัญหาที่เกิดขึ้นมักจะเป็นประโยชน์ ซึ่งจะมีประโยชน์อย่างยิ่งเมื่อข้อบกพร่องเกิดขึ้นหลังจากทำตามขั้นตอนหลายขั้นตอนหรือมีกิจกรรมที่ผิดปกติ Screencast และภาพหน้าจอมักจะแสดงให้วิศวกรเบราว์เซอร์เห็นสิ่งที่เกิดขึ้นได้ดีกว่า

ระบุรายละเอียดของสภาพแวดล้อม

ข้อบกพร่องบางอย่างจะเกิดขึ้นซ้ำได้เฉพาะในระบบปฏิบัติการบางระบบ หรือเฉพาะในจอแสดงผลบางประเภทเท่านั้น (เช่น DPI ต่ำหรือ DPI สูง) อย่าลืมระบุรายละเอียดของสภาพแวดล้อมการทดสอบที่คุณใช้

ส่งข้อบกพร่อง

สุดท้าย ให้ส่งข้อบกพร่อง โปรดคอยตรวจสอบอีเมลเพื่อดูการตอบกลับเกี่ยวกับข้อบกพร่อง โดยปกติแล้ว ในระหว่างการตรวจสอบ วิศวกรอาจมีคำถามเพิ่มเติม หากพบปัญหาในการจำลองปัญหา ทีมอาจติดต่อคุณ