From e89a3242ab37021630853b799565d3fe11e2bd80 Mon Sep 17 00:00:00 2001
From: Richardas Kuchinskas <r.kuchinskas@vk.team>
Date: Tue, 24 Oct 2023 17:52:46 +0300
Subject: [PATCH] fixed duplicate bug in trait inspection apply added new test
 from kphp moved

---
 .../InternalSymbolUsageInspection.kt          | 19 +++++++++++++------
 .../TraitsNesting/Photos/.modulite.yaml       | 11 +----------
 .../006_known_bugs.php}                       | 10 ++++------
 .../Feed006}/.modulite.yaml                   |  3 ++-
 .../Feed006}/PrivClass.php                    |  2 +-
 .../Feed006}/PrivTrait.php                    |  2 +-
 .../Feed006}/PubFeed.php                      |  2 +-
 .../101_trait_not_required.php                |  7 +++++++
 .../Engines101/LikesEngineTrait101.php        | 14 ++++++++++++++
 .../ExternalEngines101/Tweets101.php          |  9 +++++++++
 .../Photos101/.modulite.yaml                  | 17 +++++++++++++++++
 .../Photos101/Photo101.php                    | 12 ++++++++++++
 .../com/vk/modulite/tests/KphpGoldenTests.kt  |  4 +++-
 13 files changed, 85 insertions(+), 27 deletions(-)
 rename src/test/fixtures/kphp_golden/{101_trait_in_module_internal/101_known_bugs.php => 006_known_bugs/006_known_bugs.php} (64%)
 rename src/test/fixtures/kphp_golden/{101_trait_in_module_internal/Feed101 => 006_known_bugs/Feed006}/.modulite.yaml (62%)
 rename src/test/fixtures/kphp_golden/{101_trait_in_module_internal/Feed101 => 006_known_bugs/Feed006}/PrivClass.php (84%)
 rename src/test/fixtures/kphp_golden/{101_trait_in_module_internal/Feed101 => 006_known_bugs/Feed006}/PrivTrait.php (84%)
 rename src/test/fixtures/kphp_golden/{101_trait_in_module_internal/Feed101 => 006_known_bugs/Feed006}/PubFeed.php (91%)
 create mode 100644 src/test/fixtures/kphp_golden/101_trait_not_required/101_trait_not_required.php
 create mode 100644 src/test/fixtures/kphp_golden/101_trait_not_required/Engines101/LikesEngineTrait101.php
 create mode 100644 src/test/fixtures/kphp_golden/101_trait_not_required/ExternalEngines101/Tweets101.php
 create mode 100644 src/test/fixtures/kphp_golden/101_trait_not_required/Photos101/.modulite.yaml
 create mode 100644 src/test/fixtures/kphp_golden/101_trait_not_required/Photos101/Photo101.php

diff --git a/src/main/kotlin/com/vk/modulite/inspections/InternalSymbolUsageInspection.kt b/src/main/kotlin/com/vk/modulite/inspections/InternalSymbolUsageInspection.kt
index 7778d1b..e700dc2 100644
--- a/src/main/kotlin/com/vk/modulite/inspections/InternalSymbolUsageInspection.kt
+++ b/src/main/kotlin/com/vk/modulite/inspections/InternalSymbolUsageInspection.kt
@@ -15,6 +15,7 @@ import com.jetbrains.php.lang.psi.visitors.PhpElementVisitor
 import com.vk.modulite.SymbolName
 import com.vk.modulite.composer.ComposerPackage
 import com.vk.modulite.modulite.Modulite
+import com.vk.modulite.modulite.ModuliteRequires
 import com.vk.modulite.modulite.ModuliteRestrictionChecker
 import com.vk.modulite.psi.extensions.files.containingComposerPackage
 import com.vk.modulite.psi.extensions.files.containingModulite
@@ -240,7 +241,7 @@ class InternalSymbolUsageInspection : LocalInspectionTool() {
                         restricted to $readableName, $refModulite is not required by ${context.modulite}
                     """.trimIndent()
                 } else if(symbolElement is PhpClass && symbolElement.isTrait){
-                    val (classes,methods) = collectTraitReferenceUsage(reference)
+                    val (classes,methods) = collectTraitReferenceUsage(reference,context.modulite?.requires )
                     quickFixes.add(AddSymbolToRequiresQuickFix(context.modulite!!, classes+methods))
 
                     """
@@ -265,7 +266,7 @@ class InternalSymbolUsageInspection : LocalInspectionTool() {
                 """.trimIndent()
             }
         }
-
+context.modulite?.requires
         registerModuliteProblem(
             problemElement,
             text,
@@ -314,7 +315,7 @@ class InternalSymbolUsageInspection : LocalInspectionTool() {
         return Pair(classesToRequire, methodsToRequire)
     }
 
-    private fun collectTraitReferenceUsage(reference: PhpReference)
+    private fun collectTraitReferenceUsage(reference: PhpReference, moduliteRequires : ModuliteRequires? = null)
             : Pair<List<SymbolName>, List<SymbolName>> {
         val traitsClasses: MutableList<PhpClass> = arrayListOf()
         val methodsNames: MutableCollection<Method> = arrayListOf()
@@ -361,9 +362,15 @@ class InternalSymbolUsageInspection : LocalInspectionTool() {
             requireMethods.addAll(methods)
         }
 
-        val traitsSymbolsName = traitsClasses.distinct().mapNotNull { processElement(it, reference) }
-        val traitsSymbolName = requireMethods.distinct().mapNotNull { processElement(it, reference) }
+        val traitsClassName = traitsClasses.distinct().mapNotNull { processElement(it, reference) }
+        val traitsMethodsName = requireMethods.distinct().mapNotNull { processElement(it, reference) }
+
+        moduliteRequires?.symbols?.let { currentModuleSymbols ->
+            val filteredMethods = traitsMethodsName.filterNot { it in currentModuleSymbols }
+            val filteredClasses = traitsClassName.filterNot { it in currentModuleSymbols }
+            return Pair(filteredClasses, filteredMethods)
+        }
 
-        return Pair(traitsSymbolsName, traitsSymbolName)
+        return Pair(traitsClassName, traitsMethodsName)
     }
 }
diff --git a/src/test/fixtures/golden/TraitsNesting/Photos/.modulite.yaml b/src/test/fixtures/golden/TraitsNesting/Photos/.modulite.yaml
index beaf5ad..859bbe6 100644
--- a/src/test/fixtures/golden/TraitsNesting/Photos/.modulite.yaml
+++ b/src/test/fixtures/golden/TraitsNesting/Photos/.modulite.yaml
@@ -16,17 +16,8 @@ require:
   - "\\Engines\\LikesEngineTrait"
   - "\\Engines\\MusicEngineTrait"
   - "\\Engines\\VideosEngineTrait"
-  - "\\Engines\\FriendsEngineTrait::friendList()"
-  - "\\Engines\\FriendsEngineTrait::printFriendList()"
-  - "\\Engines\\LikesEngineTrait::print()"
-  - "\\Engines\\LikesEngineTrait::printTweetsLikes()"
-  - "\\Engines\\MusicEngineTrait::musicList()"
-  - "\\Engines\\MusicEngineTrait::musicListPrint()"
+  - "\\ExternalEngines\\Tweets::printTweetsLikesCountByUser()"
   - "\\Engines\\TestEngine::tester()"
-  - "\\Engines\\VideosEngineTrait::printVideosList()"
-  - "\\Engines\\VideosEngineTrait::videosList()"
-
-
 
 # Granting partial access to internal symbols, "as an exception".
 allow-internal-access:
diff --git a/src/test/fixtures/kphp_golden/101_trait_in_module_internal/101_known_bugs.php b/src/test/fixtures/kphp_golden/006_known_bugs/006_known_bugs.php
similarity index 64%
rename from src/test/fixtures/kphp_golden/101_trait_in_module_internal/101_known_bugs.php
rename to src/test/fixtures/kphp_golden/006_known_bugs/006_known_bugs.php
index 481dcdd..15f6c07 100644
--- a/src/test/fixtures/kphp_golden/101_trait_in_module_internal/101_known_bugs.php
+++ b/src/test/fixtures/kphp_golden/006_known_bugs/006_known_bugs.php
@@ -5,16 +5,14 @@
 require_once 'kphp_tester_include.php';
 #endif
 
-class MMM101 {
-    use Feed101\PrivTrait;
-//      ^^^^^^^^^^^^^^^^^
-//      error: restricted to use Feed101\PrivTrait, it's internal in @feed
+class MMM006 {
+    use Feed006\PrivTrait;
 }
-(new MMM101)->showThisClass();
+(new MMM006)->showThisClass();
 
 // here $impl is auto-deduced as PrivClass because of typed callable
 // so, we can call its instance methods, since we don't analyze instance methods
 // but we can't write a type hint or extract this callback into another var, as we can't use that internal class in phpdoc
-Feed101\PubFeed::accessToPrivClass(function($impl) {        // function(PrivClass $impl) is erroneous
+Feed006\PubFeed::accessToPrivClass(function($impl) {        // function(PrivClass $impl) is erroneous
     $impl->myMethod();
 });
diff --git a/src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/.modulite.yaml b/src/test/fixtures/kphp_golden/006_known_bugs/Feed006/.modulite.yaml
similarity index 62%
rename from src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/.modulite.yaml
rename to src/test/fixtures/kphp_golden/006_known_bugs/Feed006/.modulite.yaml
index 1185b57..9301cba 100644
--- a/src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/.modulite.yaml
+++ b/src/test/fixtures/kphp_golden/006_known_bugs/Feed006/.modulite.yaml
@@ -1,8 +1,9 @@
 name: "@feed"
-namespace: "\\Feed101"
+namespace: "\\Feed006"
 
 export:
   - "PubFeed"
+  - "PrivTrait"
 
 force-internal:
 
diff --git a/src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/PrivClass.php b/src/test/fixtures/kphp_golden/006_known_bugs/Feed006/PrivClass.php
similarity index 84%
rename from src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/PrivClass.php
rename to src/test/fixtures/kphp_golden/006_known_bugs/Feed006/PrivClass.php
index 015e603..cf5f4a9 100644
--- a/src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/PrivClass.php
+++ b/src/test/fixtures/kphp_golden/006_known_bugs/Feed006/PrivClass.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Feed101;
+namespace Feed006;
 
 class PrivClass {
     public function myMethod() {
diff --git a/src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/PrivTrait.php b/src/test/fixtures/kphp_golden/006_known_bugs/Feed006/PrivTrait.php
similarity index 84%
rename from src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/PrivTrait.php
rename to src/test/fixtures/kphp_golden/006_known_bugs/Feed006/PrivTrait.php
index 22983b1..b653eb3 100644
--- a/src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/PrivTrait.php
+++ b/src/test/fixtures/kphp_golden/006_known_bugs/Feed006/PrivTrait.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Feed101;
+namespace Feed006;
 
 trait PrivTrait {
     function showThisClass() {
diff --git a/src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/PubFeed.php b/src/test/fixtures/kphp_golden/006_known_bugs/Feed006/PubFeed.php
similarity index 91%
rename from src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/PubFeed.php
rename to src/test/fixtures/kphp_golden/006_known_bugs/Feed006/PubFeed.php
index 534c8fc..1eae8d7 100644
--- a/src/test/fixtures/kphp_golden/101_trait_in_module_internal/Feed101/PubFeed.php
+++ b/src/test/fixtures/kphp_golden/006_known_bugs/Feed006/PubFeed.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Feed101;
+namespace Feed006;
 
 class PubFeed {
     /**
diff --git a/src/test/fixtures/kphp_golden/101_trait_not_required/101_trait_not_required.php b/src/test/fixtures/kphp_golden/101_trait_not_required/101_trait_not_required.php
new file mode 100644
index 0000000..6c5b429
--- /dev/null
+++ b/src/test/fixtures/kphp_golden/101_trait_not_required/101_trait_not_required.php
@@ -0,0 +1,7 @@
+@ok
+<?php
+#ifndef KPHP
+require_once 'kphp_tester_include.php';
+#endif
+
+\Photos101\Photo101::printPhotoLikes();
diff --git a/src/test/fixtures/kphp_golden/101_trait_not_required/Engines101/LikesEngineTrait101.php b/src/test/fixtures/kphp_golden/101_trait_not_required/Engines101/LikesEngineTrait101.php
new file mode 100644
index 0000000..13b5005
--- /dev/null
+++ b/src/test/fixtures/kphp_golden/101_trait_not_required/Engines101/LikesEngineTrait101.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Engines101;
+
+trait LikesEngineTrait101 {
+  public static function print(): void {
+    echo "like";
+  }
+
+  public static function printTweetsLikes(): void {
+    \ExternalEngines101\Tweets101::printTweetsLikesCountByUser();
+    $_ = new \ExternalEngines101\Tweets101();
+  }
+}
diff --git a/src/test/fixtures/kphp_golden/101_trait_not_required/ExternalEngines101/Tweets101.php b/src/test/fixtures/kphp_golden/101_trait_not_required/ExternalEngines101/Tweets101.php
new file mode 100644
index 0000000..34fd95f
--- /dev/null
+++ b/src/test/fixtures/kphp_golden/101_trait_not_required/ExternalEngines101/Tweets101.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace ExternalEngines101;
+
+class Tweets101 {
+  public static function printTweetsLikesCountByUser() {
+    echo "ExternalEngines: tweets like for this user";
+  }
+}
diff --git a/src/test/fixtures/kphp_golden/101_trait_not_required/Photos101/.modulite.yaml b/src/test/fixtures/kphp_golden/101_trait_not_required/Photos101/.modulite.yaml
new file mode 100644
index 0000000..306240e
--- /dev/null
+++ b/src/test/fixtures/kphp_golden/101_trait_not_required/Photos101/.modulite.yaml
@@ -0,0 +1,17 @@
+name: "@photos"
+description: ""
+namespace: "Photos101\\"
+
+# "Public API" of the modulite: classes, functions, constants, etc.
+# Symbols not listed here will be internal.
+export:
+  - "Photo101"
+
+# Class members to exclude, they override "export".
+force-internal:
+
+# Dependencies: other modulites, global classes, defines, etc.
+require:
+  
+# Granting partial access to internal symbols, "as an exception".
+allow-internal-access:
diff --git a/src/test/fixtures/kphp_golden/101_trait_not_required/Photos101/Photo101.php b/src/test/fixtures/kphp_golden/101_trait_not_required/Photos101/Photo101.php
new file mode 100644
index 0000000..4dc9434
--- /dev/null
+++ b/src/test/fixtures/kphp_golden/101_trait_not_required/Photos101/Photo101.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Photos101;
+
+class Photo101 {
+  use \Engines101\LikesEngineTrait101;
+//    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+//error: restricted to use Engines101\LikesEngineTrait101, it's not required by @photos
+  public static function printPhotoLikes() {
+    self::print();
+  }
+}
diff --git a/src/test/kotlin/com/vk/modulite/tests/KphpGoldenTests.kt b/src/test/kotlin/com/vk/modulite/tests/KphpGoldenTests.kt
index 5d2b890..f79ae15 100644
--- a/src/test/kotlin/com/vk/modulite/tests/KphpGoldenTests.kt
+++ b/src/test/kotlin/com/vk/modulite/tests/KphpGoldenTests.kt
@@ -8,6 +8,7 @@ class KphpGoldenTests : ModuliteInspectionTestBase() {
     fun `test 003_allow_internal`()         = runFixture("kphp_golden/003_allow_internal")
     fun `test 004_instance_methods`()       = runFixture("kphp_golden/004_instance_methods")
     fun `test 005_inheritance`()            = runFixture("kphp_golden/005_inheritance")
+    fun `test 006_known_bugs`()             = runFixture("kphp_golden/006_known_bugs")
     fun `test 008_mod_generics`()           = runFixture("kphp_golden/008_mod_generics")
     fun `test 009_mod_magic_m`()            = runFixture("kphp_golden/009_mod_magic_m")
     fun `test 010_mod_unreachable`()        = runFixture("kphp_golden/010_mod_unreachable")
@@ -20,5 +21,6 @@ class KphpGoldenTests : ModuliteInspectionTestBase() {
     //fun `test 007_composer_ok`()          = runFixture("kphp_golden/007_composer_ok")
 
     fun `test 100_wrong_static_bindings`()      = runFixture("kphp_golden/100_wrong_static_bindings")
-    fun `test 101_trait_in_module_internal`()   = runFixture("kphp_golden/101_trait_in_module_internal")
+    fun `test 101_trait_not_required`()         = runFixture("kphp_golden/101_trait_not_required")
+
 }