Catatan Tutorials

Error handling: gagal dengan jelas

Pasti ada yang salah: input yang keliru, file yang hilang, server yang tidak menjawab. Pertanyaannya, apakah program Anda mengatakannya dengan jelas atau diam-diam jalan terus dengan data yang salah. Kegagalan diam-diam, pesan error yang berguna, exception vs nilai error, di mana menangkapnya, dan fail fast, di Python, PHP, Go, dan JavaScript.

7 menit bacaTersedia juga dalam bahasa Inggris →

Setiap program pasti bertemu hal yang tidak diduga: baris CSV dengan 3x di kolom jumlah, file yang tidak ada, nilai konfigurasi yang lupa diisi, API yang timeout. Anda tidak bisa mencegah semuanya. Yang bisa Anda tentukan adalah bagaimana program bersikap saat itu terjadi.

Ada dua pilihan buruk dan satu yang baik. Program bisa crash dengan pesan yang tidak dipahami siapa pun. Program bisa jalan terus diam-diam dengan data yang salah. Atau program bisa gagal dengan jelas: berhenti di tempat yang tepat, mengatakan apa yang salah dan di mana, dan meninggalkan keadaan yang rapi. Bagian ini membahas pilihan ketiga.

Error terburuk adalah yang tidak terlihat

Ini total bulanan dari bagian 9, ditulis dengan cara yang “aman” supaya baris yang rusak tidak membuatnya crash:

rows = [("book", "2", "85000"), ("pen", "10", "4000"), ("mug", "3x", "35000")]

def total_silent(rows):
    total = 0
    for product, qty, price in rows:
        try:
            total += int(qty) * int(price)
        except:
            pass
    return total

print("silent:", total_silent(rows))
silent: 210000

Tidak crash. Tapi juga salah. Total sebenarnya, kalau baris mug diisi dengan benar sebagai 3, adalah 315.000. Baris mug hilang begitu saja, dan tidak ada yang diberi tahu. Laporan ini mungkin dipakai untuk membayar pemasok atau melapor pajak. Crash justru lebih baik.

Zen of Python merangkum aturannya dalam dua baris:

“Errors should never pass silently.” “Unless explicitly silenced.”

Error tidak boleh lewat diam-diam, kecuali sengaja dibungkam. Sengaja artinya Anda yang memutuskan, dengan alasan yang bisa dijelaskan, dan sebaiknya program tetap mencatat apa yang dilewati (seperti laporan di bagian 9 yang menulis “1 invalid row skipped”). except: pass yang membungkus sebongkah kode adalah kebalikannya.

Pesan error yang baik menjawab tiga pertanyaan

Error bawaan Python untuk baris rusak itu akurat:

ValueError: invalid literal for int() with base 10: '3x'

Tapi tidak menyebut file mana, baris mana, kolom mana. Di impor 40.000 baris, itulah bedanya perbaikan lima detik dan satu jam mencari. Pesan error yang berguna menjawab:

  1. Apa yang salah? (“qty must be a whole number”)
  2. Di mana? (“line 4”)
  3. Dengan nilai apa? (“got ‘3x’”)

Tambahkan konteks itu di tempat Anda memilikinya, dan tetap lampirkan error aslinya. Di Python, raise ... from melakukan ini; tutorial Python menyebut klausa from dipakai “To indicate that an exception is a direct consequence of another”, untuk menandai bahwa satu exception adalah akibat langsung dari exception lain, dan “This can be useful when you are transforming exceptions.”

class InvalidRow(Exception):
    pass

def parse_row(line_no, row):
    product, qty, price = row
    try:
        return product, int(qty), int(price)
    except ValueError as e:
        raise InvalidRow(
            f"line {line_no}: qty/price must be whole numbers, got qty={qty!r} price={price!r}"
        ) from e
Traceback (most recent call last):
  File ".../loud.py", line 7, in parse_row
    return product, int(qty), int(price)
ValueError: invalid literal for int() with base 10: '3x'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  ...
InvalidRow: line 4: qty/price must be whole numbers, got qty='3x' price='35000'

Keduanya ada: penyebab tingkat rendah dan pesan yang bisa ditindaklanjuti orang. (Baris 4 karena header ada di baris 1.)

Perhatikan juga except ValueError, bukan except:. Saran tutorial Python: “it is good practice to be as specific as possible with the types of exceptions that we intend to handle, and to allow any unexpected exceptions to propagate on.” Artinya: tangkap yang Anda duga dan tahu cara menanganinya, biarkan sisanya naik ke atas.

Dua gaya: exception dan nilai error

Bahasa pemrograman menangani error dengan dua cara utama.

Exception (Python, PHP, JavaScript, Java, C#): error melompat keluar dari fungsi saat ini dan naik ke atas call stack sampai ada yang menangkapnya. Kode di antaranya tidak perlu menyebutnya. Jalur normal jadi bersih, tapi artinya setiap pemanggilan bisa melempar exception, dan itu tidak terlihat dari tempat pemanggilannya.

Nilai error (Go, dan Rust dengan caranya sendiri): error hanyalah nilai yang dikembalikan, dan pemanggil wajib memeriksanya. Ringkasan dari blog Go hanya tiga kata, “Errors are values”, dengan konsekuensinya: “Values can be programmed, and since errors are values, errors can be programmed.” Nilai bisa diprogram, jadi error pun bisa diprogram.

var ErrInvalidRow = errors.New("invalid row")

func parseQty(line int, raw string) (int, error) {
	qty, err := strconv.Atoi(raw)
	if err != nil {
		return 0, fmt.Errorf("line %d: %w: %w", line, ErrInvalidRow, err)
	}
	return qty, nil
}
line 4: invalid row: strconv.Atoi: parsing "3x": invalid syntax
true

Verb %w membungkus error asli di dalam error baru, dan “Wrapping an error with %w makes it available to errors.Is and errors.As”. Jadi pemanggil tetap bisa bertanya errors.Is(err, ErrInvalidRow) dan mendapat true, baris kedua di atas. Hal yang sama berlaku untuk error dari standard library: membaca file yang tidak ada menghasilkan open orders.csv: no such file or directory, dan errors.Is(err, os.ErrNotExist) bernilai true.

Tidak ada gaya yang paling baik di semua situasi. Tujuannya sama: jangan kehilangan error-nya, dan jangan kehilangan konteksnya.

JavaScript punya gagasan “bungkus dan simpan penyebabnya” yang sama. MDN: properti cause “indicates the specific original cause of the error” dan dipakai “when catching and re-throwing an error with a more-specific or useful error message”:

function parseConfig(text) {
  try {
    return JSON.parse(text);
  } catch (err) {
    throw new Error("config.json is not valid JSON", { cause: err });
  }
}
config.json is not valid JSON
cause: SyntaxError: Expected double-quoted property name in JSON at position 14 (line 1 column 15)

PHP: waspadai konversi yang diam-diam

PHP perlu catatan khusus, karena sebagian konversinya gagal tanpa suara:

var_dump((int) "3x");    // int(3)
var_dump((int) "abc");   // int(0)

Cast tidak pernah protes. "3x" jadi 3, dan "abc" jadi 0. Kunci array yang hilang hanya menghasilkan warning lalu null, yang jadi 0 dalam perhitungan:

PHP Warning:  Undefined array key "qty" in Command line code on line 1
int(0)

Kalau warning tidak dipantau, itu lagi-lagi total yang salah tanpa suara. PHP 8 lebih ketat di beberapa tempat ("abc" * 2 sekarang melempar TypeError: Unsupported operand types: string * int), tapi untuk input sebaiknya Anda validasi secara eksplisit dan lempar exception saat salah:

function parseQty(string $raw): int {
    $qty = filter_var($raw, FILTER_VALIDATE_INT);
    if ($qty === false) {
        throw new InvalidArgumentException("qty must be a whole number, got '$raw'");
    }
    return $qty;
}
// parseQty("3x") → InvalidArgumentException: qty must be a whole number, got '3x'

Fail fast

“a fail-fast system is one that immediately reports at its interface any condition that is likely to indicate a failure.” Sistem seperti ini langsung melaporkan kondisi yang kemungkinan besar berarti kegagalan, dan “designed to stop normal operation rather than attempt to continue a possibly flawed process”: berhenti, bukan meneruskan proses yang mungkin cacat.

Praktiknya: periksa sedini mungkin, di tepi tempat data masuk. Pengaturan yang hilang harus menghentikan program saat start, bukan saat pelanggan pertama mencoba reset password tiga hari kemudian:

REQUIRED = ("DATABASE_URL", "SMTP_HOST")

def load_settings(env):
    missing = [key for key in REQUIRED if not env.get(key)]
    if missing:
        raise SystemExit(f"Cannot start: missing settings {', '.join(missing)}")
    return {key: env[key] for key in REQUIRED}
Cannot start: missing settings SMTP_HOST
exit code: 1

Hal yang sama berlaku untuk input pengguna, baris CSV, dan respons API: validasi saat datang, lalu ubah jadi nilai yang bersih (parse_order di bagian 9 melakukan persis ini). Sisa kode jadi bisa memercayai apa yang diterimanya.

Di mana menangkapnya

Pegangan yang berguna: lempar di bawah, tangkap di atas.

  • Kode tingkat rendah (mengurai baris, membaca file) biasanya tidak tahu harus berbuat apa terhadap error. Apakah baris rusak harus menghentikan seluruh impor? Dilewati? Dilaporkan? Tergantung pemanggilnya. Jadi ia melempar error, beserta konteksnya.
  • Kode tingkat tinggi (handler request, perintah, job) tahu situasinya. Di situlah Anda memutuskan: tampilkan pesan ke pengguna, catat detailnya ke log, lewati dan hitung, coba lagi, atau berhenti.

Dan di paling atas, sediakan satu tempat yang menangkap semua hal tak terduga, mencatat detail lengkapnya untuk Anda, dan menampilkan sesuatu yang singkat dan aman ke pengguna. Pengguna sebaiknya melihat “Baris 4 tidak bisa diimpor: jumlah harus bilangan bulat”, bukan stack trace berisi path file dan SQL. Menampilkan bagian dalam sistem juga masalah keamanan, yang akan dibahas lagi di bagian 22.

Bereskan, bahkan saat gagal

Saat sesuatu gagal di tengah jalan, mungkin ada file yang masih terbuka, transaksi setengah tertulis, atau lock yang masih dipegang. finally di Python “will execute as the last task before the try statement completes”, dan “runs whether or not the try statement produces an exception”: selalu dijalankan di akhir, ada exception atau tidak:

def import_file(path):
    print("open", path)
    try:
        raise InvalidRow("line 4: ...")
    finally:
        print("close", path)
open orders.csv
close orders.csv
report to user: line 4: ...

Kebanyakan bahasa punya bentuk yang lebih rapi untuk kasus umum: with open(...) di Python, defer f.Close() di Go, finally di PHP dan JavaScript, dan transaksi database yang di-rollback kalau ada yang gagal. Pakai itu, supaya error tidak meninggalkan kekacauan.

Error yang diduga dan yang tidak

Membedakan dua jenis ini membantu:

  • Kegagalan yang diduga adalah bagian dari kehidupan normal: input tidak valid, file tidak ada, pembayaran ditolak, jaringan timeout. Tangani dengan sengaja, dengan pesan yang jelas, dan kadang dengan mencoba ulang.
  • Bug adalah hal yang seharusnya tidak pernah terjadi: None di tempat yang selalu seharusnya ada nilainya, indeks melewati ujung list. Jangan disembunyikan. Biarkan gagal dengan keras, catat ke log, lalu perbaiki kodenya.

Glosarium Python menjelaskan gaya umum di Python, EAFP (“Easier to ask for forgiveness than permission”), yang “assumes the existence of valid keys or attributes and catches exceptions if the assumption proves false”: berasumsi semuanya ada, lalu menangkap exception kalau ternyata tidak. Gaya ini cocok untuk kegagalan yang diduga. Tapi bukan izin untuk membungkus bug dengan try sampai bug-nya diam.

Kenapa ini penting sehari-hari

  • Data yang salah lebih buruk daripada tidak ada data. Crash akan diperhatikan dan diperbaiki. Laporan yang salah diam-diam justru dipercaya.
  • Waktu support. “Baris 4: jumlah harus bilangan bulat, didapat ‘3x’” membuat pengguna bisa memperbaiki filenya sendiri. “Terjadi kesalahan” berubah jadi tiket.
  • Debugging. Error dengan konteks dan penyebab asli biasanya langsung menunjuk ke masalahnya. Bagian 15 melanjutkan dari sini.
  • Kode hasil AI sering membungkus segala hal dengan try/except atau catch (e) {} yang luas supaya terlihat “tangguh”. Periksa apa yang ditangkap, dan apa yang terjadi pada error-nya.

Coba sendiri

  1. Cari di kode Anda except:, except Exception: pass, catch (e) {} atau @ di PHP. Untuk masing-masing, putuskan: perlu dibuat spesifik, dicatat ke log, atau dihapus?
  2. Ambil satu pesan error dari proyek Anda dan tulis ulang supaya menjawab apa, di mana, dan dengan nilai apa.
  3. Buat sebuah skrip memeriksa pengaturan wajibnya saat start dan keluar dengan pesan jelas kalau ada yang hilang.
  4. Di PHP, bandingkan (int) "12abc", intval("12abc"), dan filter_var("12abc", FILTER_VALIDATE_INT). Mana yang akan Anda pakai untuk input pengguna?

Ringkasan

  • Gagal dengan jelas: berhenti di tempat yang tepat, katakan apa yang salah, dan tinggalkan keadaan rapi.
  • Kegagalan diam-diam adalah yang terburuk: “Errors should never pass silently. Unless explicitly silenced.”
  • Pesan error yang baik menyebut apa, di mana, dan dengan nilai apa, serta menyimpan penyebab aslinya (raise ... from, %w, { cause }).
  • Tangkap error yang spesifik, biarkan yang tidak terduga naik; lempar di bawah, tangkap di atas.
  • Fail fast: validasi pengaturan dan input di tepi.
  • Pakai finally, with, defer, dan transaksi supaya kegagalan tidak meninggalkan kekacauan.
  • Tangani kegagalan yang diduga dengan sengaja; biarkan bug terdengar keras.

Referensi