feat(aop): remove setting.ini

- refactor aop for addJoinPoint api
- tc for addFunctionAlias/addClassNameAlias

pinpoint-apm/pinpoint-c-agent#543

Author: eeliu

.devcontainer/devcontainer.json

@@ -8,7 +8,9 @@
                 "streetsidesoftware.code-spell-checker",
                 "recca0120.vscode-phpunit",
                 "donjayamanne.githistory",
-                "adam-bender.commit-message-editor"
+                "adam-bender.commit-message-editor",
+                "bmewburn.vscode-intelephense-client",
+                "xdebug.php-debug"
             ]
         }
     }

.gitignore

@@ -2,10 +2,11 @@ composer.phar
 /vendor/
 .idea/
 composer.lock
-lib/pinpoint/test/Cache
+lib/pinpoint/test/Cache/
 lib/pinpoint/test/test.php
 *.ast
 
 # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
 # composer.lock
+lib/Pinpoint/test/Cache/Pinpoint/test/*.php

lib/Pinpoint/Common/ClassFile.php renamed to lib/Pinpoint/Common/AbstractClassFile.php

@@ -29,7 +29,7 @@
 use PhpParser\PrettyPrinter;
 
 /**
- * Class ClassFile
+ * Class AbstractClassFile
  *
  * A abstract php-parse node
  *      namespace node
@@ -39,7 +39,7 @@
  *
  * @package pinpoint\Common
  */
-abstract class ClassFile
+abstract class AbstractClassFile
 {
     public $appendingFile = array();
 

lib/Pinpoint/Common/Monitor.php renamed to lib/Pinpoint/Common/AbstractMonitor.php

@@ -19,7 +19,7 @@
 
 namespace Pinpoint\Common;
 
-abstract class Monitor
+abstract class AbstractMonitor
 {
     protected $monitor_name;
     protected $who;

lib/Pinpoint/Common/JoinClass.php renamed to lib/Pinpoint/Common/AspectClassHandle.php

@@ -20,7 +20,7 @@
 namespace Pinpoint\Common;
 
 
-class JoinClass
+class AspectClassHandle
 {
     public string $name;
     public $methodJoinPoints = array();

lib/Pinpoint/Common/CodeVisitor.php

@@ -44,7 +44,7 @@ public function enterNode(Node $node)
     {
         if ($node instanceof Node\Stmt\Namespace_) {
             foreach ($this->visitors as $visitor) {
-                assert($visitor instanceof  ClassFile);
+                assert($visitor instanceof  AbstractClassFile);
                 $visitor->handleEnterNamespaceNode($node);
             }
         } elseif ($node instanceof Node\Stmt\Use_) {

lib/Pinpoint/Common/GenOriginClassTemplateHelper.php

@@ -26,9 +26,9 @@
 namespace Pinpoint\Common;
 
 use PhpParser\Node;
-use Pinpoint\Common\ClassFile;
+use Pinpoint\Common\AbstractClassFile;
 
-class GenOriginClassTemplateHelper extends ClassFile
+class GenOriginClassTemplateHelper extends AbstractClassFile
 {
     protected $originClassFileDir;
     protected $originClassFilePath;
@@ -37,18 +37,18 @@ class GenOriginClassTemplateHelper extends ClassFile
     protected $funcAlias = [];
     protected $suffix_use = [];
     protected $methodJoint;
-    // private $joinClass;
-    public function __construct(JoinClass $joinClass, string $namePrefix)
+    // private $classHandler;
+    public function __construct(AspectClassHandle $classHandler, string $namePrefix)
     {
         parent::__construct($namePrefix);
-        $path = Utils::findFile($joinClass->name);
+        $path = Utils::findFile($classHandler->name);
 
         $this->originClassFileDir = dirname($path);
         $this->originClassFilePath = $path;
-        // $this->joinClass = $joinClass;
-        $this->classAliasSet  = $joinClass->classAlias;
-        $this->funcAlias = $joinClass->funcAlias;
-        $this->methodJoint = $joinClass->methodJoinPoints;
+        // $this->classHandler = $classHandler;
+        $this->classAliasSet  = $classHandler->classAlias;
+        $this->funcAlias = $classHandler->funcAlias;
+        $this->methodJoint = $classHandler->methodJoinPoints;
     }
 
     private function getRealNp($node)

lib/Pinpoint/Common/GenProxyClassTemplateHelper.php

@@ -25,12 +25,12 @@
 
 namespace Pinpoint\Common;
 
-use Pinpoint\Common\ClassFile;
+use Pinpoint\Common\AbstractClassFile;
 use PhpParser\BuilderFactory;
 use PhpParser\Node;
 use Pinpoint\Common\PluginParser;
 
-class GenProxyClassTemplateHelper extends ClassFile
+class GenProxyClassTemplateHelper extends AbstractClassFile
 {
     private $factory;
 
@@ -47,11 +47,11 @@ class GenProxyClassTemplateHelper extends ClassFile
     private $handleEndTraverseCb = [];
     public $methodJoinPoints = [];
 
-    public function __construct(JoinClass $joinClass, $prefix)
+    public function __construct(AspectClassHandle $classHandler, $prefix)
     {
         parent::__construct($prefix);
         $this->factory = new BuilderFactory();
-        $this->methodJoinPoints = $joinClass->methodJoinPoints;
+        $this->methodJoinPoints = $classHandler->methodJoinPoints;
     }
 
 
@@ -168,7 +168,7 @@ public function handleClassLeaveMethodNode($node, $monitorClassFullName)
         /// $_pinpoint_method_var = new pinpoint\Plugins\CommonPlugins(__FUNCTION__,self,$p);
         $newPluginsStm = new Node\Stmt\Expression(new Node\Expr\Assign(
             new Node\Expr\Variable($varName),
-            $this->factory->new(new Node\Name\FullyQualified($monitorClassFullName) , $methodParams)
+            $this->factory->new(new Node\Name\FullyQualified($monitorClassFullName), $methodParams)
         ));
 
         $thisMethod->addStmt($newPluginsStm);
@@ -540,7 +540,7 @@ function handleMagicConstNode($node)
     {
     }
 
-    function handleLeaveClassNode($node){
-
+    function handleLeaveClassNode($node)
+    {
     }
 }

lib/Pinpoint/Common/JoinClassInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * Copyright 2020-present NAVER Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Pinpoint\Common;
+
+interface  JoinClassInterface
+{
+    public function joinedClass(): array;
+}

lib/Pinpoint/Common/OriginFileVisitor.php

@@ -32,24 +32,24 @@ public function __construct()
         $this->phpFileParser = (new ParserFactory())->create(ParserFactory::ONLY_PHP7);
     }
 
-    public function runAllVisitor(string $fullPath, JoinClass $joinClass)
+    public function runAllVisitor(string $fullPath, AspectClassHandle $classHandler)
     {
-        $this->traverser->addVisitor($this->getVisitor($joinClass));
+        $this->traverser->addVisitor($this->getVisitor($classHandler));
         $code = file_get_contents($fullPath);
         $stmts = $this->phpFileParser->parse($code);
         $this->traverser->traverse($stmts);
     }
 
-    private function getVisitor(JoinClass $joinClass)
+    private function getVisitor(AspectClassHandle $classHandler)
     {
         $classPrefix = "";
         $visitors = [];
-        if (!empty($joinClass->getMethodJoinPoints())) {
+        if (!empty($classHandler->getMethodJoinPoints())) {
             $classPrefix = CLASS_PREFIX;
-            $visitors[] = new GenProxyClassTemplateHelper($joinClass, $classPrefix);
+            $visitors[] = new GenProxyClassTemplateHelper($classHandler, $classPrefix);
         }
 
-        $visitors[] = new GenOriginClassTemplateHelper($joinClass, $classPrefix);
+        $visitors[] = new GenOriginClassTemplateHelper($classHandler, $classPrefix);
         $codeVisitor = new CodeVisitor($visitors);
         return $codeVisitor;
     }

lib/Pinpoint/Common/PerRequest.php

@@ -19,13 +19,7 @@
 
 namespace Pinpoint\Common;
 
-interface  I_PerRequest
-{
-    public function joinedClass(): array;
-}
-
-
-class PerRequestDefault implements I_PerRequest
+class PerRequestDefault implements JoinClassInterface
 {
     public function joinedClass(): array
     {

lib/Pinpoint/Common/PinpointDriver.php

@@ -25,15 +25,13 @@
 
 namespace Pinpoint\Common;
 
-use Exception;
-use Pinpoint\Plugins\PerRequestPlugins;
 
 class PinpointDriver
 {
     protected static $instance;
     protected $clAr = [];
 
-    private I_PerRequest $reqInst;
+    private JoinClassInterface $reqInst;
 
     public static function getInstance()
     {
@@ -48,7 +46,7 @@ final private function __construct()
         if (defined('PP_REQ_PLUGINS')  && class_exists(PP_REQ_PLUGINS)) {
             $userPerRequestClass = PP_REQ_PLUGINS;
             $this->reqInst = new $userPerRequestClass();
-            assertInstanceOf('I_PerRequest', $this->reqInst);
+            assertInstanceOf('JoinClassInterface', $this->reqInst);
         } else {
             $this->reqInst = new PerRequestDefault();
         }
@@ -80,8 +78,8 @@ public function start()
             $fullPath = Utils::findFile($fullClassName);
             // Please DO NOT CHEAT ME
             assertFileExists($fullPath, "'$fullPath' must exist");
-            assertInstanceOf("\Pinpoint\Common\Pinpoint\JoinClass", $junction);
-            
+            assertInstanceOf("\Pinpoint\Common\Pinpoint\AspectClassHandle", $junction);
+
             $visitor = new OriginFileVisitor();
             $visitor->runAllVisitor($fullPath, $junction);
         }

lib/Pinpoint/Plugins/PerRequestPlugins.php renamed to lib/Pinpoint/Plugins/PinpointPerRequestPlugins.php

@@ -20,7 +20,7 @@
 
 require_once __DIR__ . "/__init__.php";
 
-class PerRequestPlugins
+class PinpointPerRequestPlugins
 {
     public $tid = null;
     public $sid = null;

lib/Pinpoint/Plugins/Yii2PerRequestPlugins.php

@@ -1,4 +1,5 @@
 <?php
+
 /******************************************************************************
  * Copyright 2020 NAVER Corp.                                                 *
  *                                                                            *
@@ -19,18 +20,20 @@
 
 use Yii;
 use Pinpoint\Common\Utils;
-use Pinpoint\Plugins\PerRequestPlugins;
+use Pinpoint\Plugins\PinpointPerRequestPlugins;
+use Pinpoint\Common\JoinClassInterface;
 
-class Yii2PerRequestPlugins extends PerRequestPlugins
+class Yii2PerRequestPlugins extends PinpointPerRequestPlugins implements JoinClassInterface
 {
     protected function __construct()
     {
         parent::__construct();
         // enable findFile patch
-        Utils::addLoaderPatch(array($this,'findFileInYii'),null);
+        Utils::addLoaderPatch(array($this, 'findFileInYii'), null);
     }
 
-    public function findFileInYii($className):string {
+    public function findFileInYii($className): string
+    {
         if (isset(Yii::$classMap[$className])) {
             $classFile = Yii::$classMap[$className];
             if (strpos($classFile, '@') === 0) {
@@ -46,4 +49,8 @@ public function findFileInYii($className):string {
         return "";
     }
 
+    public function joinedClass(): array
+    {
+        return [];
+    }
 }