maria stan

Mariastan

Mariastan adalah alat analisis statis untuk pertanyaan Mariadb. Tujuan utamanya adalah untuk berfungsi sebagai dasar untuk ekstensi phpstan.

Status Saat Ini (24. 04. 2024):

Mariastan sangat tidak lengkap. Ini mencakup mungkin ~ 90% kasus penggunaan dalam basis kode besar di mana saya menggunakannya (ratusan tabel, ribuan kueri). Akibatnya tidak ada banyak aktivitas. Tetapi secara aktif dipertahankan dalam arti bahwa jika sesuatu rusak bagi saya, itu mungkin akan diperbaiki.

Jika Anda mencoba menggunakannya di proyek Anda, Anda cenderung mengalami kasus penggunaan yang tidak diimplementasikan (misalnya sintaks/fungsi yang tidak digunakan proyek saya). Jika itu terjadi, Anda harus siap untuk memperbaiki sesuatu untuk diri sendiri (kebanyakan hal harus mudah).

Tidak ada janji kompatibilitas ke belakang pada apa pun, dan tidak ada rilis - saya hanya menggunakan master.

Mariastan diuji dengan MariaDB 10.11 dan PHP 8.1-8.3.

Instalasi

Instal mariastan menggunakan composer require --dev schlndh/maria-stan:dev-master . Maka Anda harus menambahkan yang berikut ini ke phpstan.neon Anda.

 includes :
    - ./vendor/schlndh/maria-stan/extension.neon

Konfigurasi

Mariastan membutuhkan akses ke skema basis data. Cara termudah untuk menyediakannya adalah dengan membiarkannya terhubung langsung ke database. Anda harus menambahkan konfigurasi berikut ke phpstan.neon Anda dan menetapkan kredensial yang tepat:

 parameters : 
    maria-stan :
        db :
            # Change these to match your database
            host : 127.0.0.1
            port : 3306
            user : ' root '
            password : ' '
            database : ' db '

Mariastan membutuhkan akses ke database untuk mengambil skema untuk analisis kueri. Itu hanya membaca skema tabel dan tidak menulis apa pun. Namun demikian, jangan berikan akses ke database apa pun yang berisi data penting apa pun.

Atau, dimungkinkan juga untuk menggunakan Mariastan tanpa akses ke database selama analisis. Dalam hal ini Anda harus terlebih dahulu membuang skema menggunakan MariaDbFileDbReflection::dumpSchema dan menyimpannya ke dalam file. Berikut adalah contoh skrip yang melakukan itu:

 <?php

declare (strict_types= 1 );

use MariaStan  DbReflection  MariaDbFileDbReflection ;

require_once __DIR__ . ' /vendor/autoload.php ' ;

$ mysqli = new mysqli ( ' 127.0.0.1 ' , ' root ' , '' );
file_put_contents ( __DIR__ . ' /maria-stan-schema.dump ' , MariaDbFileDbReflection:: dumpSchema ( $ mysqli , ' database ' ));

Kemudian tambahkan yang berikut ini ke phpstan.neon Anda.

 parameters :
    maria-stan :
        reflection :
            file : %rootDir%/../../../maria-stan-schema.dump
services :
    mariaDbReflection : @ mariaDbFileDbReflection

Perhatikan bahwa ekspansi otomatis jalur relatif hanya berfungsi dengan konfigurasi PhPstan sendiri (yaitu ini adalah daftar kunci konfigurasi yang hardcoded). Jadi Anda harus memberikan jalur absolut ke file dump.

Lihat extension.neon untuk daftar lengkap parameter.

Penggunaan

Mariastan termasuk sampel ekstensi phpstan untuk mysqli. Namun, tujuan ekstensi ini hanya untuk memverifikasi integrasi dengan phpstan. Saya tidak berharap siapa pun benar -benar menggunakan mysqli secara langsung. Karena itu, Anda diharapkan untuk menulis ekstensi phpstan Anda sendiri yang terintegrasi dengan Mariastan. Jika Anda ingin menggunakan ekstensi mysqli termasuk ./vendor/schlndh/maria-stan/extension.mysqli.neon di phpstan.neon Anda.

Anda dapat menggunakan ekstensi MySQLI sebagai titik awal A memodifikasinya agar sesuai dengan kebutuhan Anda. Ide dasarnya adalah untuk mendapatkan string kueri dari Phpstan, berikan ke Mariastan untuk dianalisis dan kemudian melaporkan jenis hasil dan kesalahan kembali ke Phpstan.

Sebelum Anda mulai menerapkan ekstensi Anda sendiri untuk mengintegrasikan Mariastan ke dalam proyek Anda, Anda dapat dengan cepat mencobanya. Anda dapat mulai dengan memeriksa contoh sederhana yang menggunakan ekstensi MySQLI. Kemudian Anda dapat mencoba memanggil kueri dari basis kode Anda melalui MySQLI dan menganalisisnya dengan ekstensi MySQLI untuk memastikan bahwa Mariastan mendukung fitur yang digunakan proyek Anda.

Fitur

Berikut adalah daftar fitur yang dapat Anda terapkan ke dalam ekstensi phpstan Anda sendiri berdasarkan Mariastan (kebanyakan dari mereka harus ditunjukkan dalam ekstensi MySQLI):

• Jenis inferensi untuk hasil kueri. Ini saja sangat berharga saat menggunakan phpstan dengan kode yang berfungsi dengan data DB.
  • Mariastan kadang -kadang dapat menyimpulkan jenis yang lebih sempit daripada jenis yang dikembalikan oleh database (misalnya mysqli_result::fetch_fields ). Ini karena Mariastan dapat (dalam kasus sederhana) memahami pertanyaan seperti SELECT col FROM tbl WHERE col IS NOT NULL dan menghapus NULL dari jenis hasil, sedangkan Mariadb tampaknya tidak melakukan itu.
• Deteksi Kesalahan Dasar. Misalnya:
  • Tabel yang tidak diketahui, kolom, ...
  • Nama kolom yang ambigu,
  • jumlah placeholder yang tidak cocok,
  • Data yang hilang untuk kolom wajib di INSERT / REPLACE
  • ...
• Laporkan penggunaan tabel/kolom yang sudah usang.
• Kisaran Jumlah Baris: Dalam kasus sederhana mariastan dapat menentukan jumlah baris yang dikembalikan (misalnya SELECT COUNT(*) FROM tbl ) yang dapat digunakan untuk mempersempit jenis metode pengembalian seperti mysqli_result::fetch_all (yaitu non-empty-array ).
• Tipe Kolom Overrides: Anda dapat mengganti jenis kolom (misalnya karena tabelnya "statis") dan bahkan menyebarkannya secara otomatis melalui kunci asing.
• Jenis PHPDOC Kustom: Misalnya MySqLitableassocrowType.

Batasan

• Saat ini tidak ada invalidasi cache yang diimplementasikan untuk phpstan. Tidak jelas apakah hal seperti itu bahkan mudah dimungkinkan. Lihat diskusi ini. Namun, itu hanya penting untuk perubahan skema (yaitu jika Anda mengubah kueri dalam file PHP PHPStan akan membatalkannya secara otomatis).
• Tidak ada dukungan untuk pembangun kueri. Analisis mengharapkan kueri sebagai string pada input.
• Kueri harus diketahui sepenuhnya secara statis. Jika Anda memiliki kode seperti ini:

   function foo ( mysqli $ db , int $ count ) {
      return $ db -> prepare ( " SELECT * FROM tbl WHERE id IN ( " . implode ( ' , ' , array_fill ( 0 , $ count , ' ? ' )) . ' ) ' );
  }

  Phpstan tidak akan dapat mengevaluasinya secara statis dan dengan demikian Mariastan tidak memiliki apa pun untuk dianalisis.
• Tidak ada dukungan untuk tabel sementara.
• Tidak ada dukungan untuk beberapa database.
• Keterbatasan di atas adalah yang utama dalam jangka panjang. Tapi selain mereka, semuanya hanya diterapkan sebagian.

Proyek serupa

Staabm/phpstan-dba

Sejauh yang saya tahu, Phpstan-DBA bekerja dengan melaksanakan pertanyaan untuk mendapatkan informasi tentang jenis hasil, kesalahan, ... Mariastan di sisi lain menganalisis pertanyaan secara statis. Manfaat Phpstan-DBA meliputi:

• Dukungan mudah untuk beberapa database. Dengan Mariastan ini tidak mungkin (dengan kemungkinan pengecualian mysql).
• Pemeriksaan kesalahan yang lebih lengkap dan andal berkat database yang melakukan pengangkatan berat. Di sisi lain, database hanya mengembalikan satu kesalahan pada satu waktu, sedangkan Mariastan mungkin dapat menemukan beberapa masalah sekaligus.
• Analisis Rencana Kueri. Ini tampaknya tidak layak dilakukan secara statis. Di sisi lain, saya tidak yakin seberapa bermanfaat ini dalam praktiknya terutama jika Anda tidak ingin memberikan akses phpstan-DBA ke data produksi.
• Tampaknya lebih mudah untuk memulainya, karena memiliki ekstensi untuk beberapa abstraksi database.

Ada beberapa kelemahan kecil untuk pendekatan Phpstan-DBA:

• Tidak ada jalur untuk analisis statis penuh (yaitu tidak memerlukan database yang sedang berjalan di titik mana pun). Mariastan saat ini juga membutuhkan database yang sedang berjalan (untuk mendapatkan data dari information_schema , tidak harus pada waktu analisis). Tetapi dimungkinkan untuk mengimplementasikan CREATE TABLE (dll.) Menguras dan mengimplementasikan refleksi DB di atas itu.
• Karena kueri dieksekusi, harus berhati -hati dengan kueri modifikasi data/skema. Saya melihat beberapa kondisi yang membatasi untuk SELECT kueri di beberapa tempat, serta penggunaan transaksi. Oleh karena itu, saya tidak yakin seberapa baik mendukung INSERT dll. (Setidaknya ada beberapa tes).