Merge pull request #141 from neo4j-php/temp_dir

stefanak-michal · web-flow · commit 438c021c9ce6 · 2024-07-13T14:50:09.000+02:00
improved usage of temp directory.
diff --git a/src/Bolt.php b/src/Bolt.php
@@ -26,18 +26,25 @@ final class Bolt
 
     public function __construct(private IConnection $connection)
     {
-        if (!file_exists(getcwd() . DIRECTORY_SEPARATOR . 'temp' . DIRECTORY_SEPARATOR)) {
-            mkdir(getcwd() . DIRECTORY_SEPARATOR . 'temp');
+        $_ENV['TEMP_DIR'] = getenv('TEMP') ?: getenv('TMPDIR') ?: (dirname(__DIR__) . DIRECTORY_SEPARATOR . 'temp');
+        var_dump($_ENV['TEMP_DIR']);
+        if (!file_exists($_ENV['TEMP_DIR'])) {
+            mkdir($_ENV['TEMP_DIR'], recursive: true);
         }
+
         if (!getenv('BOLT_ANALYTICS_OPTOUT')) {
+            if (!file_exists($_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-analytics' . DIRECTORY_SEPARATOR)) {
+                mkdir($_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-analytics');
+            }
             $this->track();
         }
+
         $this->setProtocolVersions(5.4, 5, 4.4);
     }
 
     private function track(): void
     {
-        foreach (glob(getcwd() . DIRECTORY_SEPARATOR . 'temp' . DIRECTORY_SEPARATOR . 'queries.*.cnt') as $file) {
+        foreach (glob($_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-analytics' . DIRECTORY_SEPARATOR . 'queries.*.cnt') as $file) {
             $time = intval(explode('.', basename($file))[1]);
             if ($time < strtotime('today')) {
                 $count = file_get_contents($file);
diff --git a/src/helpers/FileCache.php b/src/helpers/FileCache.php
@@ -17,14 +17,13 @@ class FileCache implements CacheInterface
 
     public function __construct()
     {
-        $this->tempDir = getcwd() . DIRECTORY_SEPARATOR . 'temp' . DIRECTORY_SEPARATOR;
-
+        $this->tempDir = $_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-filecache' . DIRECTORY_SEPARATOR;
         if (!file_exists($this->tempDir)) {
-            mkdir(rtrim($this->tempDir, DIRECTORY_SEPARATOR));
+            mkdir($_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-filecache');
         }
 
         // clean old
-        foreach (scandir($this->tempDir . 'temp') as $file) {
+        foreach (scandir($this->tempDir) as $file) {
             if ($file == '.' || $file == '..')
                 continue;
             if (filemtime($this->tempDir . $file) < strtotime('-1 hour'))
diff --git a/src/protocol/AProtocol.php b/src/protocol/AProtocol.php
@@ -73,7 +73,7 @@ protected function write(iterable $generator): void
 
     private function track(): void
     {
-        $file = getcwd() . DIRECTORY_SEPARATOR . 'temp' . DIRECTORY_SEPARATOR . 'queries.' . strtotime('today') . '.cnt';
+        $file = $_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-analytics' . DIRECTORY_SEPARATOR . 'queries.' . strtotime('today') . '.cnt';
         $count = file_exists($file) ? intval(file_get_contents($file)) : 0;
         file_put_contents($file, $count + 1);
     }
diff --git a/tests/BoltTest.php b/tests/BoltTest.php
@@ -14,7 +14,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests
  */
-class BoltTest extends ATest
+class BoltTest extends TestLayer
 {
     public function testSockets(): void
     {
diff --git a/tests/PerformanceTest.php b/tests/PerformanceTest.php
@@ -14,7 +14,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests
  */
-class PerformanceTest extends ATest
+class PerformanceTest extends TestLayer
 {
     public function test50KRecords(): void
     {
diff --git a/tests/TestLayer.php b/tests/TestLayer.php
@@ -9,7 +9,7 @@
  * Class ATest
  * @package Bolt\tests
  */
-class ATest extends \PHPUnit\Framework\TestCase
+abstract class TestLayer extends \PHPUnit\Framework\TestCase
 {
     public static function setUpBeforeClass(): void
     {
diff --git a/tests/connection/ConnectionTest.php b/tests/connection/ConnectionTest.php
@@ -3,7 +3,7 @@
 namespace Bolt\tests\connection;
 
 use Bolt\Bolt;
-use Bolt\tests\ATest;
+use Bolt\tests\TestLayer;
 use Bolt\connection\{
     IConnection,
     Socket,
@@ -18,7 +18,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\connection
  */
-final class ConnectionTest extends ATest
+final class ConnectionTest extends TestLayer
 {
     public function provideConnections(): array
     {
diff --git a/tests/packstream/v1/BytesTest.php b/tests/packstream/v1/BytesTest.php
@@ -5,13 +5,13 @@
 use Bolt\Bolt;
 use Bolt\packstream\Bytes;
 use Bolt\protocol\AProtocol;
-use Bolt\tests\ATest;
+use Bolt\tests\TestLayer;
 
 /**
  * Class BytesTest
  * @package Bolt\tests\packstream\v1
  */
-class BytesTest extends ATest
+class BytesTest extends TestLayer
 {
     public function testInit(): AProtocol
     {
diff --git a/tests/packstream/v1/PackerTest.php b/tests/packstream/v1/PackerTest.php
@@ -4,7 +4,7 @@
 
 use Bolt\Bolt;
 use Bolt\protocol\AProtocol;
-use Bolt\tests\ATest;
+use Bolt\tests\TestLayer;
 
 /**
  * Class PackerTest
@@ -13,7 +13,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\packstream\v1
  */
-class PackerTest extends ATest
+class PackerTest extends TestLayer
 {
     public function testInit(): AProtocol
     {
diff --git a/tests/packstream/v1/UnpackerTest.php b/tests/packstream/v1/UnpackerTest.php
@@ -4,7 +4,7 @@
 
 use Bolt\Bolt;
 use Bolt\protocol\{AProtocol, Response};
-use Bolt\tests\ATest;
+use Bolt\tests\TestLayer;
 use Bolt\enum\Signature;
 
 /**
@@ -14,7 +14,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\packstream\v1
  */
-class UnpackerTest extends ATest
+class UnpackerTest extends TestLayer
 {
     public function testInit(): AProtocol
     {
diff --git a/tests/protocol/ProtocolLayer.php b/tests/protocol/ProtocolLayer.php
@@ -14,7 +14,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests
  */
-abstract class ATest extends TestCase
+abstract class ProtocolLayer extends TestCase
 {
     /**
      * @var string Temporal buffer for packed message to be read
@@ -100,8 +100,15 @@ public function readCallback(int $length = 2048): string
      */
     protected function setUp(): void
     {
-        if (!file_exists(getcwd() . DIRECTORY_SEPARATOR . 'temp' . DIRECTORY_SEPARATOR)) {
-            mkdir(getcwd() . DIRECTORY_SEPARATOR . 'temp');
+        $_ENV['TEMP_DIR'] = getenv('TEMP') ?: getenv('TMPDIR') ?: (dirname(__DIR__, 2) . DIRECTORY_SEPARATOR . 'temp');
+        if (!file_exists($_ENV['TEMP_DIR'])) {
+            mkdir($_ENV['TEMP_DIR'], recursive: true);
+        }
+
+        if (!getenv('BOLT_ANALYTICS_OPTOUT')) {
+            if (!file_exists($_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-analytics' . DIRECTORY_SEPARATOR)) {
+                mkdir($_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-analytics');
+            }
         }
 
         self::$readBuffer = '';
diff --git a/tests/protocol/V1Test.php b/tests/protocol/V1Test.php
@@ -12,7 +12,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V1Test extends ATest
+class V1Test extends ProtocolLayer
 {
     public function test__construct(): V1
     {
diff --git a/tests/protocol/V2Test.php b/tests/protocol/V2Test.php
@@ -12,7 +12,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V2Test extends ATest
+class V2Test extends ProtocolLayer
 {
     public function test__construct(): V2
     {
diff --git a/tests/protocol/V3Test.php b/tests/protocol/V3Test.php
@@ -12,7 +12,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V3Test extends ATest
+class V3Test extends ProtocolLayer
 {
     public function test__construct(): V3
     {
diff --git a/tests/protocol/V4Test.php b/tests/protocol/V4Test.php
@@ -12,7 +12,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V4Test extends ATest
+class V4Test extends ProtocolLayer
 {
     public function test__construct(): V4
     {
diff --git a/tests/protocol/V4_1Test.php b/tests/protocol/V4_1Test.php
@@ -12,7 +12,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V4_1Test extends ATest
+class V4_1Test extends ProtocolLayer
 {
     public function test__construct(): V4_1
     {
diff --git a/tests/protocol/V4_2Test.php b/tests/protocol/V4_2Test.php
@@ -3,7 +3,6 @@
 namespace Bolt\tests\protocol;
 
 use Bolt\protocol\V4_2;
-use Bolt\packstream\v1\{Packer, Unpacker};
 
 /**
  * Class V4_2Test
@@ -12,7 +11,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V4_2Test extends ATest
+class V4_2Test extends ProtocolLayer
 {
     public function test__construct(): V4_2
     {
diff --git a/tests/protocol/V4_3Test.php b/tests/protocol/V4_3Test.php
@@ -12,7 +12,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V4_3Test extends ATest
+class V4_3Test extends ProtocolLayer
 {
     public function test__construct(): V4_3
     {
diff --git a/tests/protocol/V4_4Test.php b/tests/protocol/V4_4Test.php
@@ -12,7 +12,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V4_4Test extends ATest
+class V4_4Test extends ProtocolLayer
 {
     public function test__construct(): V4_4
     {
diff --git a/tests/protocol/V5Test.php b/tests/protocol/V5Test.php
@@ -3,7 +3,6 @@
 namespace Bolt\tests\protocol;
 
 use Bolt\protocol\V5;
-use Bolt\packstream\v1\{Packer, Unpacker};
 
 /**
  * Class V5Test
@@ -12,7 +11,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V5Test extends ATest
+class V5Test extends ProtocolLayer
 {
     public function test__construct(): V5
     {
diff --git a/tests/protocol/V5_1Test.php b/tests/protocol/V5_1Test.php
@@ -12,7 +12,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V5_1Test extends \Bolt\tests\protocol\ATest
+class V5_1Test extends \Bolt\tests\protocol\ProtocolLayer
 {
     public function test__construct(): V5_1
     {
diff --git a/tests/protocol/V5_2Test.php b/tests/protocol/V5_2Test.php
@@ -9,7 +9,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V5_2Test extends \Bolt\tests\protocol\ATest
+class V5_2Test extends \Bolt\tests\protocol\ProtocolLayer
 {
     public function test__construct(): V5_2
     {
diff --git a/tests/protocol/V5_3Test.php b/tests/protocol/V5_3Test.php
@@ -12,7 +12,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V5_3Test extends \Bolt\tests\protocol\ATest
+class V5_3Test extends \Bolt\tests\protocol\ProtocolLayer
 {
     public function test__construct(): V5_3
     {
diff --git a/tests/protocol/V5_4Test.php b/tests/protocol/V5_4Test.php
@@ -9,7 +9,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class V5_4Test extends \Bolt\tests\protocol\ATest
+class V5_4Test extends \Bolt\tests\protocol\ProtocolLayer
 {
     public function test__construct(): V5_4
     {
diff --git a/tests/structures/StructureLayer.php b/tests/structures/StructureLayer.php
@@ -2,7 +2,7 @@
 
 namespace Bolt\tests\structures;
 
-use Bolt\tests\ATest;
+use Bolt\tests\TestLayer;
 use Exception;
 
 /**
@@ -11,7 +11,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol
  */
-class AStructures extends ATest
+class StructureLayer extends TestLayer
 {
     /**
      * How many iterations do for each date/time test
diff --git a/tests/structures/v1/StructuresTest.php b/tests/structures/v1/StructuresTest.php
@@ -34,7 +34,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests
  */
-class StructuresTest extends \Bolt\tests\structures\AStructures
+class StructuresTest extends \Bolt\tests\structures\StructureLayer
 {
     public function testInit(): AProtocol|V4_4|V4_3|V4_2|V3
     {
diff --git a/tests/structures/v4_3/StructuresTest.php b/tests/structures/v4_3/StructuresTest.php
@@ -26,7 +26,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol\v4_3
  */
-class StructuresTest extends \Bolt\tests\structures\AStructures
+class StructuresTest extends \Bolt\tests\structures\StructureLayer
 {
     public function testInit(): AProtocol|V4_4|V4_3
     {
diff --git a/tests/structures/v5/StructuresTest.php b/tests/structures/v5/StructuresTest.php
@@ -22,7 +22,7 @@
  * @link https://github.com/neo4j-php/Bolt
  * @package Bolt\tests\protocol\v5
  */
-class StructuresTest extends \Bolt\tests\structures\AStructures
+class StructuresTest extends \Bolt\tests\structures\StructureLayer
 {
     public function testInit(): AProtocol|V4_3|V4_4|V5|V5_1
     {

Original file line number	Diff line number	Diff line change
`@@ -26,18 +26,25 @@ final class Bolt`
`26`	`26`
`27`	`27`	`public function __construct(private IConnection $connection)`
`28`	`28`	`{`
`29`		`- if (!file_exists(getcwd() . DIRECTORY_SEPARATOR . 'temp' . DIRECTORY_SEPARATOR)) {`
`30`		`- mkdir(getcwd() . DIRECTORY_SEPARATOR . 'temp');`
	`29`	`+ $_ENV['TEMP_DIR'] = getenv('TEMP') ?: getenv('TMPDIR') ?: (dirname(__DIR__) . DIRECTORY_SEPARATOR . 'temp');`
	`30`	`+ var_dump($_ENV['TEMP_DIR']);`
	`31`	`+ if (!file_exists($_ENV['TEMP_DIR'])) {`
	`32`	`+ mkdir($_ENV['TEMP_DIR'], recursive: true);`
`31`	`33`	`}`
	`34`	`+`
`32`	`35`	`if (!getenv('BOLT_ANALYTICS_OPTOUT')) {`
	`36`	`+ if (!file_exists($_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-analytics' . DIRECTORY_SEPARATOR)) {`
	`37`	`+ mkdir($_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-analytics');`
	`38`	`+ }`
`33`	`39`	`$this->track();`
`34`	`40`	`}`
	`41`	`+`
`35`	`42`	`$this->setProtocolVersions(5.4, 5, 4.4);`
`36`	`43`	`}`
`37`	`44`
`38`	`45`	`private function track(): void`
`39`	`46`	`{`
`40`		`- foreach (glob(getcwd() . DIRECTORY_SEPARATOR . 'temp' . DIRECTORY_SEPARATOR . 'queries.*.cnt') as $file) {`
	`47`	`+ foreach (glob($_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-analytics' . DIRECTORY_SEPARATOR . 'queries.*.cnt') as $file) {`
`41`	`48`	`$time = intval(explode('.', basename($file))[1]);`
`42`	`49`	`if ($time < strtotime('today')) {`
`43`	`50`	`$count = file_get_contents($file);`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ protected function write(iterable $generator): void`
`73`	`73`
`74`	`74`	`private function track(): void`
`75`	`75`	`{`
`76`		`- $file = getcwd() . DIRECTORY_SEPARATOR . 'temp' . DIRECTORY_SEPARATOR . 'queries.' . strtotime('today') . '.cnt';`
	`76`	`+ $file = $_ENV['TEMP_DIR'] . DIRECTORY_SEPARATOR . 'php-bolt-analytics' . DIRECTORY_SEPARATOR . 'queries.' . strtotime('today') . '.cnt';`
`77`	`77`	`$count = file_exists($file) ? intval(file_get_contents($file)) : 0;`
`78`	`78`	`file_put_contents($file, $count + 1);`
`79`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`* @link https://github.com/neo4j-php/Bolt`
`15`	`15`	`* @package Bolt\tests`
`16`	`16`	`*/`
`17`		`-class BoltTest extends ATest`
	`17`	`+class BoltTest extends TestLayer`
`18`	`18`	`{`
`19`	`19`	`public function testSockets(): void`
`20`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`* Class ATest`
`10`	`10`	`* @package Bolt\tests`
`11`	`11`	`*/`
`12`		`-class ATest extends \PHPUnit\Framework\TestCase`
	`12`	`+abstract class TestLayer extends \PHPUnit\Framework\TestCase`
`13`	`13`	`{`
`14`	`14`	`public static function setUpBeforeClass(): void`
`15`	`15`	`{`