コードを計測することで捉える問題点 / phpcondo2024

PHPカンファレンス北海道2024の登壇資料です。
https://phpcon.hokkaido.jp/

Transcript

1. PHP 2024 2024.01.13 Yuta Ohashi
2. / @blue_goheimochi , , , , PUBG MOBILE,
4. 4 • • • • • • etc...
5. 5 • : phpcpd • Copy/Paste Detector (CPD) for PHP code. • 2023 1 • • Don t Repeat Yourself •
6. 6 phpcpd 6.0.3 by Sebastian Bergmann. Found 184 clones with 9893 duplicated lines in 142 files: - /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:166-524 (358 lines) /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:170-528 ~~~~~~~~~~ - /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:321-561 (240 lines) /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:334-574 ~~~~~~~~~~~ - /app/xxxxxx/controllers/xxxxxx.php:909-1084 (175 lines) /app/xxxxxx/controllers/xxxxxx.php:1247-1422 ~~~~~~~~~~ 8.41% duplicated lines out of 112932 total lines of code. Average size of duplication is 54 lines, largest clone has 358 of lines 184 142 9,893
7. 7 phpcpd 6.0.3 by Sebastian Bergmann. Found 184 clones with 9893 duplicated lines in 142 files: - /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:166-524 (358 lines) /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:170-528 ~~~~~~~~~~ - /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:321-561 (240 lines) /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:334-574 ~~~~~~~~~~~ - /app/xxxxxx/controllers/xxxxxx.php:909-1084 (175 lines) /app/xxxxxx/controllers/xxxxxx.php:1247-1422 ~~~~~~~~~~ 8.41% duplicated lines out of 112932 total lines of code. Average size of duplication is 54 lines, largest clone has 358 of lines View
8. 8 phpcpd 6.0.3 by Sebastian Bergmann. Found 184 clones with 9893 duplicated lines in 142 files: - /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:166-524 (358 lines) /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:170-528 ~~~~~~~~~~ - /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:321-561 (240 lines) /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:334-574 ~~~~~~~~~~~ - /app/xxxxxx/controllers/xxxxxx.php:909-1084 (175 lines) /app/xxxxxx/controllers/xxxxxx.php:1247-1422 ~~~~~~~~~~ 8.41% duplicated lines out of 112932 total lines of code. Average size of duplication is 54 lines, largest clone has 358 of lines Fat
9. 9 phpcpd 6.0.3 by Sebastian Bergmann. Found 184 clones with 9893 duplicated lines in 142 files: - /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:166-524 (358 lines) /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:170-528 ~~~~~~~~~~ - /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:321-561 (240 lines) /app/xxxxxx/xxxxxx/xxxxxx/xxxxxx.php:334-574 ~~~~~~~~~~~ - /app/xxxxxx/controllers/xxxxxx.php:909-1084 (175 lines) /app/xxxxxx/controllers/xxxxxx.php:1247-1422 ~~~~~~~~~~ 8.41% duplicated lines out of 112932 total lines of code. Average size of duplication is 54 lines, largest clone has 358 of lines 112,932 8.41% 54 358
10. 10 • : 112,932 • : 8.41% • : 9,893 • : 184 • 規 : 142
11. 11 • • • • • •
12. 12 • : terryyin/lizard • Lizard is an extensible Cyclomatic Complexity Analyzer for many programming languages(PHP Python ) • • • • if/else, for, switch •
13. 13 10 25% 30 40% 50 70% 75 98%
14. 14 • : terryyin/lizard • Lizard is an extensible Cyclomatic Complexity Analyzer for many programming languages(PHP Python ) • • • if/else, for, switch • ========================================================================================= !!!! Warnings (cyclomatic_complexity > 15 or length > 1000 or parameter_count > 100) !!!! ================================================ NLOC CCN token PARAM length location ------------------------------------------------ 247 63 2436 0 353 aaaaAction@41-393@./xxxxx/controllers/zzzzController.php 139 41 1272 0 202 bbbbAction@625-826@./xxxxx/controllers/zzzzController.php 124 39 1018 0 161 ccccAction@77-237@./xxxxx/controllers/zzzzController.php 81 37 351 1 84 xxxx@840-923@./xxxx/xxxx/Controller/xxxx/Abstract.php 152 37 1086 0 197 xxxxAction@21-217@./xxxx/xxxx/xxxx/xxxxController.php 143 36 1110 0 197 xxxxAction@740-936@./xxxx/xxxx/xxxxController.php 150 35 1516 0 223 xxxxAction@33-255@./xxxx/controllers/xxxxController.php 63 34 741 1 72 xxxx@16-87@./xxxx/xxxx/xxxx/xxxx/xxxx/xxxx.php 81 34 917 0 106 aaaaAction@229-334@./yyyy/controllers/yyyyController.php 110 31 1071 0 143 xxxxAction@20-162@./xxxx/controllers/xxxxController.php 75 30 753 0 108 bbbb@79-186@./xxxx/controllers/yyyyController.php 97 29 926 0 127 ccccAction@609-735@./xxxx/controllers/yyyyController.php ========================================================================================== Total nloc Avg.NLOC AvgCCN Avg.token Fun Cnt Warning cnt Fun Rt nloc Rt ------------------------------------------------------------------------------------------ 33248 16.3 2.3 104.2 1743 11 0.01 0.05 63 70%
15. 15 • : terryyin/lizard • Lizard is an extensible Cyclomatic Complexity Analyzer for many programming languages(PHP Python ) • • • if/else, for, switch • ========================================================================================= !!!! Warnings (cyclomatic_complexity > 15 or length > 1000 or parameter_count > 100) !!!! ================================================ NLOC CCN token PARAM length location ------------------------------------------------ 247 63 2436 0 353 aaaaAction@41-393@./xxxxx/controllers/zzzzController.php 139 41 1272 0 202 bbbbAction@625-826@./xxxxx/controllers/zzzzController.php 124 39 1018 0 161 ccccAction@77-237@./xxxxx/controllers/zzzzController.php 81 37 351 1 84 xxxx@840-923@./xxxx/xxxx/Controller/xxxx/Abstract.php 152 37 1086 0 197 xxxxAction@21-217@./xxxx/xxxx/xxxx/xxxxController.php 143 36 1110 0 197 xxxxAction@740-936@./xxxx/xxxx/xxxxController.php 150 35 1516 0 223 xxxxAction@33-255@./xxxx/controllers/xxxxController.php 63 34 741 1 72 xxxx@16-87@./xxxx/xxxx/xxxx/xxxx/xxxx/xxxx.php 81 34 917 0 106 aaaaAction@229-334@./yyyy/controllers/yyyyController.php 110 31 1071 0 143 xxxxAction@20-162@./xxxx/controllers/xxxxController.php 75 30 753 0 108 bbbb@79-186@./xxxx/controllers/yyyyController.php 97 29 926 0 127 ccccAction@609-735@./xxxx/controllers/yyyyController.php ========================================================================================== Total nloc Avg.NLOC AvgCCN Avg.token Fun Cnt Warning cnt Fun Rt nloc Rt ------------------------------------------------------------------------------------------ 33248 16.3 2.3 104.2 1743 11 0.01 0.05 3
16. 16 • ( ): 69,946 • CCN: 2.8 • CCN • :4,518
17. 17 • • • • •
18. 18 • : phpmd unusedcode • • • • •
19. 19 • : phpmd unusedcode • • • • • <?php class Sample { private static $start = 1; private $end = 2; private $piyo = 3; public function addOne() { $item = 1; return $this->piyo++; } private function execute($text) { } }
20. 20 • : phpmd unusedcode • • • • • <?php class Sample { private static $start = 1; private $end = 2; private $piyo = 3; public function addOne() { $item = 1; return $this->piyo++; } private function execute($text) { } }
21. 21 • : phpmd unusedcode • • • • • FILE: /app/sample.php ---------------------- 5 | VIOLATION | Avoid unused private fields such as '$start'. 6 | VIOLATION | Avoid unused private fields such as '$end'. 11 | VIOLATION | Avoid unused local variables such as '$item'. 15 | VIOLATION | Avoid unused private methods such as 'execute'. 15 | VIOLATION | Avoid unused parameters such as '$text'.
22. 22 • • • • • • Rector, PHPStan
23. 23 1) sample.php:1 ---------- begin diff ---------- @@ @@ class Sample { - private static int $start = 1; - private $end = 2; private $piyo = 3; public function addOne() { - $item = 1; return $this->piyo++; - } - - private function execute($text) - { } } ----------- end diff ----------- Rectorの場合
24. 24 <?php class Sample { private $piyo = 3; public function addOne() { return $this->piyo++; } } <?php class Sample { private static $start = 1; private $end = 2; private $piyo = 3; public function addOne() { $item = 1; return $this->piyo++; } private function execute($text) { } } Rectorの場合
25. 25 • : PHPStan, Psalm • (= ) • • •
26. 26 • : PHP CSFixer, PHP CodeSni er • PSR-12 PSR-2 • •
27. 27 🙋 🙋 🙋
28. 28 % git clone git@github.com:blue-goheimochi/php-metrics-tools.git % cd php-metrics-tools % make build % export TARGET_DIR=/Path/To/Target/Dir % make phpcpd
29. 29 • 12 • phpcpd, lizard, churn-php, phpmd, phpstan, rector, phpmetrics, composer-unused, phpmnd, phpcs, php-cs-fixer, phpinsights • • 800MB • ro
30. 30 • : Software metric • • by
31. 31 • • • • : • ... • 24 •
32. 32 • • 1 • • •
33. なぜコード計測をして問題点を捉えたいのか？？
34. 34 • • • • • •
36. 36 • • • • • • etc...etc...etc... • 🐌
39. 39 (legacy)
41. 41 3 • • •
42. 42 3 • • • •
43. 43 3 • • • • •
44. 44 3 • • • • • • • •
45. 45 3 • • • •
47. 47 3 • • •
48. 48 3 • • • •
49. 49 3 • • • • • •
50. 50 3 • • • • • • •
51. 51 3 • • • • •
53. 53 • • • • •
54. 54 • • • • • •
56. 56 • • • • • • etc...
57. 57 • • • : • : • •
59. 59 • • 70% • SHS
60. 60 • GQM Goal Question Metric •
61. 61 • The core assumption behind GQM is simple:to measure something well, you must understand why you re measuring • • Improve system availability from the users point of view. • Decrease the development time for new microservices from the product managers viewpoint. • Reduce technical debt in the architecture from the perspective of software developers. • Reduce the number of bugs being released into production. • Detect more problems in production before our users do. • Improve the machine learning model s accuracy from the users viewpoint. • Make better design decisions in the architecture from the development team s perspective.
62. 62 How • • • • ex) •
64. 64 • • • • Four Keys
65. 65 • : Git • Git •
66. 66 • : Google Analytics • • •
67. 67 • : New Relic, Datadog, Mackerel, Sentry • APM • • •
68. 68 Four Keys • For keys • • •
69. 69 • • • •
70. 70 • • • •
73. まとめ
74. 74 • • • • • • •