Cách báo cáo lỗi trình duyệt chính xác

Việc thông báo cho nhà cung cấp trình duyệt về các vấn đề bạn phát hiện được trong trình duyệt của họ là một phần không thể thiếu trong việc cải thiện nền tảng web.

Việc gửi báo cáo lỗi chính xác sẽ mất một chút thời gian. Mục tiêu của bạn là giúp các kỹ sư trình duyệt dễ dàng tìm thấy lỗi, tìm ra nguyên nhân gốc rễ và quan trọng nhất là tìm ra cách khắc phục. Những lỗi được xử lý nhanh chóng thường là những lỗi dễ tái hiện và có hành vi dự kiến rõ ràng.

Xác minh rằng đó là lỗi

Bước đầu tiên là tìm hiểu xem hành vi "đúng" sẽ như thế nào.

Hành vi chính xác là gì?

Hãy xem tài liệu về API liên quan trên MDN hoặc thử tìm thông số kỹ thuật liên quan. Thông tin này có thể giúp bạn quyết định xem API nào thực sự bị hỏng, hỏng ở đâu và hành vi dự kiến là gì.

Tính năng này có hoạt động trên một trình duyệt khác không?

Hành vi khác nhau giữa các trình duyệt thường được ưu tiên cao hơn vì đây là vấn đề về khả năng tương tác, đặc biệt là khi trình duyệt chứa lỗi là trình duyệt duy nhất có hành vi khác biệt. Hãy thử kiểm tra trên các phiên bản mới nhất của Chrome, Firefox, Safari và Edge, có thể sử dụng một công cụ như BrowserStack.

Nếu có thể, hãy kiểm tra để đảm bảo rằng trang không cố ý hoạt động khác đi do tác nhân người dùng đánh hơi. Trong Chrome DevTools, hãy thử đặt chuỗi User-Agent thành một trình duyệt khác.

Có phải lỗi này xảy ra trong một bản phát hành gần đây không?

Tính năng này có hoạt động như mong đợi trước đây nhưng lại gặp lỗi trong bản phát hành trình duyệt gần đây không? Bạn có thể xử lý các lỗi hồi quy như vậy nhanh hơn nhiều, đặc biệt là nếu bạn cung cấp số phiên bản hoạt động được và số phiên bản không hoạt động được. Bạn có thể sử dụng các công cụ như BrowserStack để kiểm tra các phiên bản trình duyệt cũ. Sử dụng các công cụ như công cụ bisect-builds (cho Chromium) để tìm kiếm thay đổi.

Nếu vấn đề là một lỗi hồi quy và có thể tái hiện, thì nguyên nhân gốc thường có thể được tìm thấy và khắc phục nhanh chóng.

Những người khác có gặp phải vấn đề tương tự không?

Nếu bạn gặp vấn đề, thì có thể các nhà phát triển khác cũng gặp vấn đề tương tự. Trước tiên, hãy thử tìm lỗi trên Stack Overflow. Điều này có thể giúp bạn chuyển một vấn đề trừu tượng thành một API bị hỏng cụ thể, và có thể giúp bạn tìm ra giải pháp ngắn hạn cho đến khi lỗi được khắc phục.

Vấn đề này đã từng được báo cáo chưa?

Sau khi bạn đã biết lỗi đó là gì, hãy kiểm tra xem lỗi đó đã được báo cáo hay chưa bằng cách tìm kiếm trong cơ sở dữ liệu lỗi của trình duyệt.

Nếu bạn tìm thấy một lỗi hiện có mô tả vấn đề, hãy thể hiện sự ủng hộ của bạn bằng cách gắn dấu sao, thêm vào mục yêu thích hoặc bình luận về lỗi đó. Ngoài ra, trên nhiều trang web, bạn có thể thêm chính mình vào danh sách CC và nhận thông tin cập nhật khi lỗi thay đổi.

Nếu bạn quyết định bình luận về lỗi, hãy cung cấp thông tin về mức độ ảnh hưởng của lỗi đối với trang web của bạn. Tránh thêm các nhận xét kiểu "+1" vì trình theo dõi lỗi thường gửi email cho mọi nhận xét.

Báo cáo lỗi

Nếu lỗi chưa được báo cáo trước đó, thì đã đến lúc bạn nên thông báo cho nhà cung cấp trình duyệt về lỗi đó.

Tạo một trường hợp kiểm thử tối giản

Mozilla có một bài viết hay về cách tạo một trường hợp kiểm thử tối giản. Nói một cách ngắn gọn, mặc dù nội dung mô tả vấn đề là một khởi đầu tuyệt vời, nhưng không gì có thể vượt qua việc cung cấp một bản minh hoạ được liên kết trong lỗi cho thấy vấn đề. Để tối đa hoá cơ hội tiến triển nhanh, ví dụ này phải chứa mã tối thiểu có thể cần thiết để minh hoạ vấn đề. Mã mẫu tối thiểu là điều quan trọng nhất bạn có thể làm để tăng tỷ lệ lỗi được khắc phục.

Dưới đây là một số mẹo để giảm thiểu trường hợp kiểm thử:

  • Tải trang web xuống, thêm <base href="https://original.url"> rồi xác minh rằng lỗi này tồn tại trên thiết bị. Điều này có thể yêu cầu một máy chủ HTTPS đang hoạt động nếu URL sử dụng HTTPS.
  • Kiểm tra các tệp cục bộ trên bản dựng mới nhất của nhiều trình duyệt nhất có thể.
  • Hãy cố gắng gộp mọi thứ vào 1 tệp.
  • Xoá mã (bắt đầu bằng những thứ bạn biết là không cần thiết) cho đến khi lỗi biến mất.
  • Sử dụng tính năng quản lý phiên bản để có thể lưu công việc và huỷ những thao tác không đúng.

Lưu trữ một trường hợp kiểm thử đã rút gọn

Nếu bạn đang tìm một nơi phù hợp để lưu trữ trường hợp kiểm thử đã rút gọn, thì có một số nơi phù hợp như sau:

Xin lưu ý rằng một số trang web trong số đó hiển thị nội dung trong một iframe, điều này có thể khiến các tính năng hoặc lỗi hoạt động theo cách khác.

Gửi vấn đề của bạn

Sau khi có trường hợp kiểm thử tối giản, bạn đã sẵn sàng gửi báo cáo lỗi đó. Hãy truy cập vào trang web theo dõi lỗi phù hợp và tạo một vấn đề mới.

Thêm nội dung mô tả và các bước rõ ràng để tái hiện vấn đề

Trước tiên, hãy cung cấp nội dung mô tả rõ ràng để giúp các kỹ sư nhanh chóng hiểu được vấn đề là gì và giúp phân loại vấn đề.

When installing a PWA using the `beforeinstallprompt.prompt()`, the
`appinstalled` event fires before the call to `prompt()` resolves.

Tiếp theo, hãy cung cấp các bước chi tiết cần thiết để tái hiện vấn đề và mô tả kết quả dự kiến và kết quả thực tế.

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)

Để biết thêm thông tin, hãy xem Nguyên tắc viết báo cáo lỗi trên MDN.

Thông tin bổ sung: Thêm ảnh chụp màn hình hoặc bản ghi màn hình về vấn đề

Mặc dù không bắt buộc, nhưng bạn nên thêm ảnh chụp màn hình hoặc bản ghi màn hình về vấn đề. Điều này đặc biệt hữu ích khi lỗi xảy ra sau một vài bước hoặc hoạt động bất thường. Bản ghi màn hình và ảnh chụp màn hình thường có thể minh hoạ rõ hơn những gì đã xảy ra với các kỹ sư trình duyệt.

Cung cấp thông tin chi tiết về môi trường

Một số lỗi chỉ có thể tái hiện trên một số hệ điều hành nhất định hoặc chỉ trên một số loại màn hình cụ thể (ví dụ: DPI thấp hoặc DPI cao). Hãy nhớ cung cấp thông tin chi tiết về mọi môi trường thử nghiệm mà bạn đã sử dụng.

Gửi lỗi

Cuối cùng, hãy gửi lỗi. Hãy theo dõi email để biết thông tin phản hồi về lỗi. Thông thường, trong quá trình điều tra, các kỹ sư có thể có thêm câu hỏi. Nếu gặp khó khăn trong việc tái hiện vấn đề, họ có thể liên hệ với bạn.