phpBB Ext Check - Diskussion bezüglich Prozedur und Reports

[LukeWCS]

Der Prüfumfang von EC hat Zuwachs bekommen und zwar in Bezug auf composer.json.

Voraussetzungen-Prüfung

Kürzlich bin ich auf der Suche nach etwas anderem auf einen Beitrag von Crizzo gestossen, bei dem es um ein Tool zur Prüfung dieser für phpBB und EC wichtigen Datei geht. Ich hatte dann erste Tests mit diesem Tool in der Shell vorgenommen und festgestellt, dass der Prüf-Umfang durchaus dabei hilfreich sein kann, Fehler bei der technischen Struktur zu erkennen und Details zu ermitteln. EC selber konnte bisher nur feststellen, ob die Datei eine gültige Struktur hat oder nicht, jedoch im Fehlerfall keinerlei Details nennen, da PHP selber eben auch nur zurückgibt ob die Datei gültig ist oder nicht, ohne im Fehlerfall Details zu liefern.

Nachdem ich in EC für Composer Validator ein passendes Prüf-Modul geschrieben und so das Tool in EC einbinden konnte, habe ich umfangreiche Tests innerhalb EC durchgeführt um sicher zu gehen, dass das Zusammenspiel von EC und Composer Validator problemlos ist. Dabei habe ich auch viele Stichproben von Exts von phpBB.de genommen und da das Tool eben auch auch Warnungen und Hinweise bezüglich inhaltlicher Struktur geben kann, gab es dabei auch kleinere Auffälligkeiten bei ein paar Exts. Nachfolgend die entsprechenden Ausschnitte aus dem Log, reduziert auf den technischen Namen und Version der jeweiligen Ext und dem zugehörigen Composer Validator Ergebnis Code (2 = Warnung, 3 = Fehler).

chris1278_jsclock_1-0-3 CVAL=3
imcger_imgupload_1-4-6 CVAL=3
kirk_bbcodepage_3-0-0 CVAL=3
hjw_calendar_1-1-3 CVAL=3
moemorox_qaip_1-0-3 CVAL=2

Wer die Details wissen will, lässt die besagte Ext einfach mit EC 1.9.4 erneut prüfen. Fragen zu den Meldungen kann man wie gehabt hier besprechen.

Zum Composer Validator muss aber klar gesagt werden:

• Ich habe Composer Validator nicht wegen der Prüfung auf inhaltliche Struktur eingebaut (was ohnehin schon von EPV erledigt wird), sondern wegen Prüfung der technischen Struktur, da EC diesen Punkt bezüglich Details bislang nicht abdecken konnte.
• Composer Validator ist, wie Variable Analysis, kein auf phpBB Exts spezialisiertes Tool. Der Composer Validator prüft eine composer.json mit Schwerpunkt auf die Befindlichkeiten von Composer und https://packagist.org und ist somit für uns nur bedingt relevant, was die inhaltliche Struktur angeht.

EC 1.9.4 ist jetzt live.

phpBB PHP Strict Standard Extensions

Dann noch etwas anderes: PPSSE wird zukünftig keine *.css und *.js mehr prüfen können sobald CodeSniffer 4.0 zur Verfügung steht und bei EC eingebunden ist. Aufgefallen im Rahmen meines Bug Reports bezüglich veralteter phpBB CodeSniffer Regelwerke: PHPBB-17510. Der relevante Changelog Eintrag bei CS 3.13.0 wäre das hier:

Deprecated

• Sniffs which don't listen for PHP, like JS/CSS specific sniffs. [#894]

Quelle: Deprecated

Ich habe das auch bereits mit CS 4.0 Beta1 vorab getestet und das hat die Ankündigung bestätigt. Da wird dann beim Versuch PPSSE auf diese Dateitypen anzuwenden die Meldung ausgegeben, dass diese Dateien keine Strukturen enthalten, die geprüft werden könnten. Deshalb muss ich diese Dateitypen dann bei PPSSE entfernen, um diese dann unnötigen Meldungen zu vermeiden.

Diejenigen Entwickler die noch nicht unseren EditorConfig Standard eingerichtet haben, sollten das also nachholen, damit die von PPSSE bisher gemeldeten Fehler bei diesen beiden Dateitypen gar nicht erst entstehen können.

[Kirk]

Erstmal Danke für´s Update
Was die besagte EXT von mir angeht, so hatte in der composer jenes "email": " mail.com" statt "email": "mail.com" also ein Leerzeichen nach " versehentlich eingebaut.

[LukeWCS]

Speziell der Fehler mit dem führenden Leerzeichen hat zumindest innerhalb phpBB keine Auswirkung. Generell kann man sagen: alles was einem Composer Validator meldet, nachdem EC die Datei bereits erfolgreich prüfen konnte, sind reine Formfehler die normal keine funktionellen Auswirkungen haben sollten, da phpBB in der Richtung eigentlich robust genug ist. Sieht man ja auch an den hier gezeigten 5 Beispielen, die haben alle verschiedene Warnungen und Fehler in composer.json, funktionieren aber trotzdem.

Anders sieht es aus, wenn die JSON Struktur selber defekt wäre, dann kann EC jetzt mehr mitteilen als nur "Nee, mag ich nicht!".

edit: Composer Validator ist jetzt auch im Startbeitrag berücksichtigt. Den Punkt 3 in die Abschnitte 3.1 und 3.2 aufgeteilt und das Tool bei 3.1 aufgeführt. Ausserdem wird das Tool auch im Abschnitt 4.1 berücksichtigt.

[LukeWCS]

EC 1.9.5 ist live. Neben Fixes für EC und Tools gab es einige Detail-Verbesserungen und auch unter der Haube wurde vieles verbessert und modernisiert.

Der Startbeitrag wurde an das EC Update angepasst. Unter anderem wurde der Punkt 3 wieder in seine vorherige Struktur zurückversetzt und die - jetzt unnötige - Unterteilung in die Unterpunkte 3.1 und 3.2 entfernt.

Während der Entwicklung des EC Updates entdeckte ich erneut einen kleinen Fehler bei EPV, den ich nach einer gründlichen Untersuchung gemeldet und auch einen Fix mitgeliefert habe:

Missing name property in composer.json causes 2 PHP problems

MattF hat das gestern Nacht übernommen und bei EC ist jetzt natürlich auch die neueste EPV Version vorhanden.

[Mike-on-Tour]

Da hast du wieder großartige Arbeit geleistet.
Habe das gerade mal ausprobiert, und was soll ich sagen, die neue Prüfung der composer.json ist wirklich sehr umfangreich und deckt Fehler ab, an die ich früher gar nicht gedacht hätte, z.B. die Angabe nur der major und minor version für phpBB.

[Talk19zehn]

Da hast du ja wieder ordentlich nachgelegt.

Jupp soeben die VL 2.4.0 durchlaufen lassen und der neue Test in deiner neuen umfangreicheren Version 1.9.5 wurde, wie zuvor auch, bestanden.

LG

[oxpus]

Dem schließe ich mich an.
Saubere Arbeit und die Ergebnisse sind weiterhin top.

Mein Respekt ist Dir sicher.

[LukeWCS]

Danke für eure Rückmeldungen.

die neue Prüfung der composer.json ist wirklich sehr umfangreich und deckt Fehler ab, an die ich früher gar nicht gedacht hätte

Insbesondere wenn die Datei technische Defekte hat, bekommt man sehr hilfreiche Infos über Art und Ort des Problems. Ich musste den Prüfumfang sogar ein wenig drosseln, denn sonst bekämen wir - für uns - unsinnige "Probleme" gemeldet, z.B. wenn in composer.json die Eigenschaft version definiert ist, denn das ist in einer reinen Composer Umgebung anscheinend eher hinderlich. Für uns aber ist diese Eigenschaft immens wichtig, da davon die Versionsprüfung von phpBB abhängig ist und Entwickler ja auch längst gezielt mit dieser Eigenschaft per Code hantieren.

Allerdings gibts auch ein Manko: die Laufzeiten von composer validate sind teilweise extrem. Da kann es passieren, dass dieses Tool gleich oder sogar länger läuft, als alle anderen Tools zusammen und das obwohl die anderen Tools nicht nur eine einzige Datei zu prüfen haben, sondern dutzende bis hunderte und das bei deutlich grösserem Prüfumfang (z.B. PHPC). Wurde kurz zuvor schon mal eine Prüfung mit EC ausgeführt, kann es sein, dass Composer Validator sehr fix ausgeführt wird, weil dann wohl der System Cache greift.

Muss man beobachten. Notfalls müsste man das Tool auf die Voraussetzungen-Prüfung beschränken und das Tool nur dann ausführen, wenn EC das ZIP abgelehnt hat, damit man wenigstens die Infos zu den Defekten bekommt. Allerdings würde dann auch der zusätzliche Prüfumfang für die inhaltliche Struktur wegfallen und das wäre ein kleiner Rückschritt. Jetzt wo das Tool bei EC etabliert ist, wollen wir darauf ja wohl eher nicht mehr verzichten. Je mehr hilfreiche Infos, desto besser.

[Talk19zehn]

Nun, im ersten Test von heute dauerte es ein wenig länger (blaufarbene Ladebalken) und im zweiten Test derselben EXT lief der Check rasant durch.
Wobei es sich ja eher um eine "MINI-EXT" im Vergleich zu anderen Extensionen handelt.

Logisch ist die Zeitverzögerung und ich wünsche mir für dich, dass andere EXT-Entwickler ihre Beobachtungen bzgl. der Laufzeit schildern.

LG

[Kirk]

Danke fürs Update
Interessant, beim Test einer meiner EXT hatte in der composer einen mini Fehler drin, ich hatte in der Zeile "email" so " EMAIL" statt so "EMAIL" drin stehen. Schon wurde dies bemängelt.
Edit:
Warum wird in der composer nicht die korrekte Zeile sondern jenes In Factory.php line 317 angezeigt?