Bekerjasama untuk Slack sebagai Pembangun Sumber Terbuka: Bahagian 2

Rekap Bahagian 1

Dalam catatan blog pertama saya, saya berkongsi perjalanan saya menyumbang kepada Slack SDK sebagai pembangun sumber terbuka. Saya menangani isu yang berkaitan dengan memastikan URL asas untuk permintaan API mempunyai garis miring mengekor untuk memudahkan pembinaan URL dan mengelakkan ketidakkonsistenan. Jika anda belum membacanya lagi, saya syorkan bermula di sana untuk mendapatkan konteks untuk susulan ini.

---

Cabaran Baru Timbul

Selepas melengkapkan sumbangan pertama saya, saya tidak sabar-sabar untuk menangani isu lain dalam projek yang sama. Semasa saya bersedia untuk memulakan, saya melihat masalah dalam salah satu ujian pengesahan. Isu ini berpunca daripada ciri garis miring yang saya laksanakan sebelum ini.

Inilah yang berlaku: base_url kini sentiasa mempunyai garis miring mengekor yang dilampirkan semasa pemula. Walau bagaimanapun, kaedah_api yang digunakan dalam beberapa kes ujian juga bermula dengan a /. Gabungan ini menyebabkan garis miring berganda (cth., https://slack.com/api//auth.test), yang melanggar beberapa permintaan API.

---

Melaporkan Isu

Menyedari kepentingan pepijat ini, saya segera melaporkannya kepada penyelenggara dan membuka isu baharu yang menerangkan masalah itu. Untuk memastikan ketelusan dan menyediakan laluan penyelesaian yang jelas, saya turut menyerahkan permintaan tarik yang menangani pepijat. Walau bagaimanapun, penyelenggara memutuskan untuk mengembalikan gabungan asal saya untuk mengelakkan gangguan di cawangan utama dan meminta saya menyerahkan PR baharu dengan pembetulan dan ujian yang diperlukan untuk kes tepi.

---

Pembaikan dan Pelaksanaan Baharu

Untuk menangani masalah itu, saya mengolah semula fungsi _get_url dan menambah perlindungan tambahan untuk mengelakkan garis miring berganda, walaupun kedua-dua base_url dan api_method mengandungi garis miring atau terarah.

Berikut ialah pelaksanaan yang dikemas kini:

def _get_url(base_url: str, api_method: str) -> str:
    """Joins the base Slack URL and an API method to form an absolute URL.

    Args:
        base_url (str): The base URL (always ends with '/').
        api_method (str): The Slack Web API method. e.g., 'chat.postMessage'.

    Returns:
        str: The absolute API URL, e.g., 'https://slack.com/api/chat.postMessage'.
    """
    # Strip leading slash from api_method to prevent double slashes
    api_method = api_method.lstrip("/")
    return urljoin(base_url, api_method)

---

Pelarasan utama

1. Strip Leading Slash: Dengan menggunakan .lstrip("/") pada api_method, fungsi ini memastikan tiada garis miring berganda berlaku semasa penyatuan.
2. Peningkatan Kes Ujian: Saya mengembangkan suite ujian untuk merangkumi senario seperti:
   • base_url dengan dan tanpa garis miring.
   • api_method dengan dan tanpa garis miring utama. Kes tepi di mana kedua-duanya mempunyai garis miring.

Berikut ialah contoh ujian yang dikemas kini:

def test_get_url_prevent_double_slash(self):
    api_url = _get_url("https://slack.com/api/", "/auth.test")
    self.assertEqual(api_url, "https://slack.com/api/auth.test", "Should prevent double slashes")

    api_url = _get_url("https://slack.com/api", "auth.test")
    self.assertEqual(api_url, "https://slack.com/api/auth.test", "Should handle base_url without trailing slash")

    api_url = _get_url("https://slack.com/api/", "auth.test")
    self.assertEqual(api_url, "https://slack.com/api/auth.test", "Should handle api_method without leading slash")

    api_url = _get_url("https://slack.com/api", "/auth.test")
    self.assertEqual(api_url, "https://slack.com/api/auth.test", "Should handle both inputs cleanly")

---

Refleksi pada Kes Pengujian dan Tepi

Pengalaman ini mengajar saya kepentingan ujian yang menyeluruh. Walaupun pelaksanaan asal saya melepasi semua ujian sedia ada, ia tidak mengambil kira kes kelebihan tertentu, seperti garis miring utama dalam api_method.

Berikut ialah pengambilan utama saya:

1. Ujian Unit Tidak Kalis Mudah: Walaupun ujian unit membantu menangkap banyak isu, mereka mungkin tidak meliputi semua kes tepi. Ciri masih boleh mempunyai hujung yang longgar, terutamanya jika input berbeza secara meluas.
2. Bekerjasama dan Berkomunikasi: Melaporkan pepijat dengan segera dan membincangkan penyelesaian dengan penyelenggara boleh mengelakkan gangguan yang lebih besar. Keputusan mereka untuk mengembalikan perubahan saya menekankan kepentingan memastikan cawangan utama stabil.
3. Lelaran dan Pelajari: Sumbangan sumber terbuka adalah berulang. Setiap langkah ialah peluang untuk menambah baik, belajar daripada maklum balas dan mengukuhkan amalan pengekodan anda.

---

Fikiran Akhir

Menyumbang kepada SDK Slack merupakan pengalaman yang tidak ternilai. Perjalanan ini, daripada melaksanakan ciri baharu kepada menyelesaikan kesan sampingan yang tidak diingini, menyerlahkan kerumitan pembangunan perisian dunia sebenar dan semangat kerjasama sumber terbuka.

Jika anda mempertimbangkan untuk menyumbang kepada projek sumber terbuka, jangan biarkan ketakutan untuk membuat kesilapan menghalang anda. Setiap pepijat, setiap pembetulan dan setiap ujian yang ditulis adalah satu langkah ke arah menjadi pembangun yang lebih baik.

Apakah cabaran yang telah anda hadapi dalam sumbangan sumber terbuka anda? Jom bincang dalam komen di bawah!

Atas ialah kandungan terperinci Bekerjasama untuk Slack sebagai Pembangun Sumber Terbuka: Bahagian 2. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!