Cara pemrakarsa dan peninjau melakukan tinjauan kode - DataWorks

Tinjauan kode adalah proses manual untuk mengoptimalkan kode produksi, meningkatkan kualitas kode pada tugas penjadwalan produksi, serta memastikan bahwa kode di lingkungan produksi memenuhi standar yang ditetapkan. Anda dapat mewajibkan tinjauan kode sebelum tugas diterapkan ke lingkungan produksi. Jika tinjauan kode wajib diaktifkan, hanya tugas yang lulus tinjauan yang dapat diterapkan ke lingkungan produksi.

Ikhtisar

Di DataWorks, Anda dapat mengaktifkan tinjauan kode wajib untuk mencegah kegagalan tugas akibat kode yang tidak sesuai, sehingga menghindari pemborosan sumber daya komputasi. Saat fitur ini diaktifkan, peninjau harus memeriksa secara ketat kualitas kode pada tugas tersebut guna mencegah penerapan kode bermasalah tanpa persetujuan.

Tinjauan wajib dinonaktifkan: Saat Anda mengirimkan node, Anda tetap dapat memulai tinjauan secara manual. Namun, node tersebut tetap dapat diterapkan terlepas dari hasil tinjauannya.
Tinjauan wajib diaktifkan: Saat Anda mengirimkan node, Anda harus memilih peninjau yang memenuhi syarat untuk melakukan tinjauan kode.
- Jika tinjauan disetujui, node melanjutkan proses pengiriman dan penerapan.
- Jika tinjauan tidak disetujui, node tidak dapat dikirim atau diterapkan. Anda harus memodifikasi kode berdasarkan komentar tinjauan dan memulai tinjauan baru. Node hanya dapat diterapkan setelah tinjauan baru tersebut disetujui.

Selain itu, saat memproses tiket tinjauan, peninjau dapat menggunakan AI untuk melakukan analisis cerdas terhadap perubahan kode dan dengan cepat memperoleh saran kesimpulan tinjauan, ringkasan perubahan, serta daftar isu guna membantu pengambilan keputusan manual. AI hanya memberikan saran; keputusan akhir apakah akan menyetujui atau tidak tetap berada di tangan peninjau.

Batasan

Fitur tinjauan kode hanya tersedia di DataWorks Edisi Profesional dan versi yang lebih tinggi. Pastikan Anda telah mengaktifkan DataWorks Edisi Profesional atau edisi yang lebih tinggi. Untuk informasi selengkapnya mengenai fitur-fitur pada berbagai edisi, lihat Edisi DataWorks.
Hanya Akun Alibaba Cloud, Workspace Administrator, atau Pengguna RAM dengan izin AliyunDataWorksFullAccess yang dapat mengaktifkan atau menonaktifkan tinjauan kode untuk suatu ruang kerja. Untuk informasi selengkapnya, lihat Pengguna, peran, dan izin.
Anda tidak dapat memulai tinjauan kode untuk jenis node khusus, seperti node komposit (misalnya do-while dan for-each), atau untuk file resource non-Python.

(Opsional) Administrator: Aktifkan tinjauan kode wajib

Administrator ruang kerja dapat mengaktifkan tinjauan kode wajib untuk suatu ruang kerja melalui halaman pengaturan Data Studio dengan mengikuti langkah-langkah berikut.

Catatan

Jika tinjauan kode wajib dinonaktifkan, Anda tetap dapat memulai tinjauan, tetapi proses tersebut tidak akan menghentikan penerapan.
Menghapus node tidak memicu tinjauan kode saat pengiriman.

Akses Pengaturan Keamanan dan Lainnya

Buka halaman Ruang Kerja di Konsol DataWorks. Di bilah navigasi atas, pilih wilayah yang diinginkan. Temukan ruang kerja yang dimaksud, lalu pilih Shortcuts > Data Studio di kolom Actions.
Buka halaman pengaturan Data Studio.
1. Di pojok kiri bawah, klik ikon dan pilih Data Studio Settings untuk membuka halaman pengaturan Data Studio.
2. Buka Pengaturan Keamanan dan Lainnya.
  Di halaman pengaturan Data Studio, alihkan ke tab Security Settings and Others.

Aktifkan tinjauan kode

Di tab Security Settings and Others, aktifkan Code Review > Mandatory Review.

Penting

Jika Anda tidak menemukan toggle Mandatory Review di tab Security Settings and Others, periksa edisi DataWorks Anda. Fitur tinjauan kode hanya tersedia di DataWorks Edisi Profesional dan versi yang lebih tinggi.

Parameter	Deskripsi
Mandatory Review	Menentukan apakah tinjauan kode diperlukan sebelum tugas di ruang kerja saat ini diterapkan ke lingkungan produksi.
Project Code Reviewer	Kustomisasi peninjau kode. Any Developer Role: Setelah tinjauan kode dimulai untuk suatu node, pengguna mana pun dengan peran developer di ruang kerja tersebut dapat dipilih sebagai peninjau. Peninjau spesifik ditentukan oleh orang yang menerapkan node tersebut. Specify development role users: Setelah tinjauan kode dimulai untuk suatu node, node tersebut hanya dapat dikirim dan diterapkan setelah pengguna yang ditentukan dengan peran developer menyetujui tinjauan tersebut. Catatan Hanya pengguna dengan peran developer di ruang kerja saat ini yang dapat dipilih sebagai peninjau. DataWorks memungkinkan Anda mengonfigurasi satu atau beberapa peninjau kode. Jika beberapa peninjau dikonfigurasi, tinjauan dianggap disetujui selama salah satu dari mereka menyetujuinya.
Specify Mandatory Code Review Baseline Scope	Menentukan node mana yang memerlukan tinjauan kode saat dikirim. Anda dapat menentukan node mana yang memerlukan tinjauan kode wajib berdasarkan prioritas baseline tempat node tersebut berada. Logikanya sebagai berikut: Saat cakupan tinjauan baseline diatur ke tugas non-baseline, tugas baru yang dibuat di ruang kerja saat ini memerlukan persetujuan. Saat cakupan tinjauan baseline diatur ke tugas baseline pada tingkat tertentu, node pada baseline tingkat tersebut di ruang kerja saat ini memerlukan persetujuan saat dikirim. Nilai numerik yang lebih tinggi pada tugas baseline menunjukkan prioritas yang lebih tinggi. Tugas baseline memiliki prioritas lebih tinggi daripada tugas non-baseline. Catatan Saat Anda memilih tugas non-baseline, semua node baru yang dibuat di ruang kerja memerlukan persetujuan.
Code Review Notification Method	Setelah Anda mengaktifkan tinjauan wajib, Anda dapat mengonfigurasi mekanisme notifikasi detail halus untuk memastikan informasi penting dikirimkan secara otomatis kepada pihak terkait: Untuk peninjau: Saat tugas tinjauan baru ditugaskan, sistem secara otomatis mengirimkan notifikasi untuk mengingatkan peninjau agar segera menanganinya. Untuk pengirim: Saat status tinjauan kode berubah (misalnya disetujui atau ditolak), pengirim menerima notifikasi pembaruan status secara real-time. Metode notifikasi berikut didukung: SMS, DingTalk Group Robot Webhook, Mail, WeChat Group Webhook, Lark Webhook, dan Standard Webhook. Pesan SMS dan panggilan telepon peringatan yang dihasilkan oleh tinjauan kode dihitung dalam penggunaan sumber daya peringatan Anda. Anda dapat melihat penggunaan sumber daya peringatan modul tinjauan kode di halaman Alert Resource di konsol manajemen. Untuk informasi selengkapnya, lihat View alert resource usage. Catatan Standard Webhook hanya tersedia di DataWorks Edisi Perusahaan. Konfigurasi keamanan robot grup DingTalk hanya mendukung verifikasi berbasis kata kunci, dan kata kunci tersebut harus mengandung `DataWorks`.

Pemrakarsa Tinjauan: Memulai tinjauan kode

Tinjauan kode dipicu saat Anda mengirimkan node. Setelah Anda memilih peninjau, tiket tinjauan akan dibuat. Jika administrator telah mengaktifkan tinjauan kode wajib, proses penerapan akan diblokir pada tahap production checker. Node hanya dapat diterapkan ke lingkungan produksi setelah tinjauan kode disetujui.

Catatan

Jika suatu node sudah memiliki tinjauan kode yang sedang berlangsung dan tinjauan baru dimulai, hasil tinjauan sebelumnya secara otomatis dibatalkan.
Menghapus node tidak memicu tinjauan kode.

Terapkan tugas tersebut.
1. Klik ikon untuk menyimpan node pengembangan data yang ingin Anda terapkan, lalu klik ikon untuk membuka halaman Online publishing content.
2. Klik tombol Start Release Production untuk memulai penerapan. Karena tinjauan kode wajib diaktifkan, proses penerapan diblokir pada tahap production checker. Node hanya dapat diterapkan setelah tinjauan kode disetujui.

Memulai tinjauan kode.

Klik Initiate Code Review. Di halaman konfigurasi Code Review, konfigurasikan Code Reviewer dan Description of change.

Item konfigurasi	Deskripsi
Code Reviewer	Pilih Project Code Reviewer yang dikonfigurasi di bawah kontrol ini. Anda dapat menentukan satu atau beberapa peninjau kode.
Description of change	Jelaskan perubahan kode dan informasi relevan lainnya.

Setelah konfigurasi selesai, klik Confirm untuk mengirimkan tinjauan kode.

Peninjau: Memproses tiket tinjauan

Peninjau kode dapat melihat catatan tinjauan yang tertunda dan memproses tiket tinjauan di menu Code Review List > Reviewed by Me.

Buka halaman tinjauan kode.
Klik ikon di panel navigasi kiri halaman Data Studio untuk membuka halaman Code Review List > Reviewed by Me, tempat Anda dapat melihat tiket tinjauan kode yang ditugaskan kepada Anda.
Memproses tiket tinjauan kode.
Di halaman Code Review List > Reviewed by Me, Anda dapat melihat detail tinjauan kode dan melakukan operasi pada tiket tinjauan.
- Di halaman daftar tinjauan kode: Anda dapat dengan cepat melakukan operasi berikut pada tiket tinjauan: By, Reject, Abandoned, Reopen, dan Share.
- Di halaman detail tinjauan kode:
  1. Di halaman Code Review List > Reviewed by Me, klik tiket tinjauan kode yang ingin Anda tinjau untuk membuka halaman Code Review Details. Di halaman ini, Anda dapat melihat perubahan pada kode dan pengaturan penjadwalan dibandingkan dengan versi produksi, lalu memutuskan apakah akan menyetujui tinjauan kode tersebut.
  2. Di bagian operasi tinjauan, peninjau dapat melakukan operasi tinjauan berikut pada tiket tinjauan:
    - : Menyetujui.
    - : Menolak.
    - : Mengabaikan.
    - : Membuka kembali.
    - Comments.
  Catatan
  - Abandoned: Mengabaikan proses tinjauan saat ini. Setelah tinjauan diabaikan, versi node saat ini dapat langsung dikirim dan diterapkan.
  - Reopen: Jika Anda ingin meninjau ulang proses tinjauan yang telah diabaikan, Anda dapat mengklik Reopen.
  Setelah tinjauan kode selesai, pemrakarsa tinjauan dapat melihat detail tinjauan dan mengelola tiket tinjauan di halaman Code Review List > Reviewed by Me.

Tinjauan cerdas AI

Peninjau dapat menggunakan AI untuk melakukan analisis cerdas terhadap perubahan kode saat ini dan dengan cepat memperoleh saran kesimpulan tinjauan, ringkasan perubahan, serta daftar isu guna membantu pengambilan keputusan manual. AI hanya memberikan saran tinjauan; keputusan akhir apakah akan menyetujui atau tidak tetap berada di tangan peninjau.

Hasilkan saran tinjauan AI.
Di bagian operasi tinjauan, klik ikon tinjauan cerdas di sebelah Comment. AI mulai menganalisis perubahan kode saat ini. Setelah analisis selesai, panel Generated Result akan ditampilkan.
Lihat hasil yang dihasilkan.
Panel Generated Result berisi informasi berikut:
- Review conclusion suggestion: AI memberikan saran berupa Recommend approval atau Recommend rejection.
- Change summary: Merangkum perubahan utama pada kode dan pengaturan penjadwalan.
Proses hasil yang dihasilkan.
- Accept: Menerima saran AI. Komentar tinjauan secara otomatis diisi ke dalam kotak komentar dan kesimpulan tinjauan AI disinkronkan. Anda mengirimkan tinjauan setelah konfirmasi.
- Regenerate: Jika Anda tidak puas dengan hasilnya, Anda dapat meminta AI menganalisis ulang perubahan dan menghasilkan saran tinjauan baru.
- Reject: Tidak menerima saran AI. Panel ditutup, dan tinjauan dilanjutkan secara manual.

Pemrakarsa Tinjauan: Melihat hasil tinjauan

Pemrakarsa tinjauan dapat melihat hasil tinjauan dan mengelola tiket tinjauan di menu Code Review List > Reviewed by Me > Created by Me.

Buka halaman tinjauan kode.
Klik tombol di panel navigasi kiri halaman Data Studio untuk membuka halaman tinjauan kode, tempat Anda dapat melihat tiket tinjauan kode Created by Me.
Konfirmasi hasil tinjauan.
Di halaman Code Review List > Reviewed by Me > Created by Me, Anda dapat melihat detail tinjauan kode dan melakukan operasi pada tiket tinjauan.
- Di halaman daftar tinjauan kode: Pemrakarsa tinjauan dapat dengan cepat melihat hasil tinjauan dan melakukan operasi berikut: Abandoned, Reopen, atau Share.
  Catatan
  Mengabaikan proses tinjauan saat ini. Setelah tinjauan diabaikan, versi node saat ini harus diajukan untuk tinjauan ulang atau tiket tinjauan harus dibuka kembali agar proses penerapan dapat dilanjutkan.
- Di halaman detail tinjauan kode: Di halaman Code Review List > Reviewed by Me, klik tiket tinjauan kode yang sesuai untuk membuka halaman Code Review Details, tempat Anda dapat memutuskan apakah akan Reopen atau Abandoned tinjauan kode tersebut.
Jika tinjauan tidak disetujui, node tidak dapat dikirim atau diterapkan. Anda harus memodifikasi kode berdasarkan komentar tinjauan dan memulai tinjauan baru. Node hanya dapat diterapkan setelah tinjauan baru tersebut disetujui.

Langkah berikutnya

Setelah tinjauan kode disetujui, Anda dapat melanjutkan proses penerapan. Jika tinjauan kode tidak disetujui, Anda dapat menyesuaikan kode berdasarkan komentar tinjauan dan memulai tinjauan kode baru.