Ensure client can be included multiple times (#112)

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

Author: timacdonald

agent/build/agent.phar

@@ -1 +1 @@
-7ED0671E0BC3D3BC20837BE227703B6BC3E44074F55B2DC4272CEC3E27F85F6A717C348F8EFFED9BDC60B800981607F11C3C9E7CD212B276CD1B44073DA19FB5
+3E3D0C08BC6FCCF589A14C1C7E511DE77511531765C98E5C4A59490423C635FFE149E3B9071EF49D01D87BAB652685F77574C55F9A6684EE0759D59BD83ABE0E

agent/build/signature.txt

@@ -48,7 +48,7 @@
         "allow-plugins": {
             "pestphp/pest-plugin": true
         },
-        "autoloader-suffix": "AppChecksum"
+        "autoloader-suffix": "zUjV6thn8dELeOw6"
     },
     "minimum-stability": "stable",
     "prefer-stable": true

agent/composer.json

@@ -1 +1 @@
-C4C1117363E561968FD49DB562F5BE87665BCF3CA381D76F91F3AC7F586AFCB73D11D09CF32E405E93C6F8175144A8D1808F0EFE885280E5C55F7DDF157AAF56
+B53311EA72F09FFB7975024C4941F38D47FC0E85523D00479457711092912C42FF31A92A27944719E49CEBC5F14504402CD103C0253325D6EBEC9F9C7A13B895

client/build/client.phar

@@ -44,7 +44,7 @@
         "allow-plugins": {
             "pestphp/pest-plugin": true
         },
-        "autoloader-suffix": "AppChecksum"
+        "autoloader-suffix": "XxO1QeBIKrkR2oWT"
     },
     "minimum-stability": "stable",
     "prefer-stable": true

client/build/signature.txt

@@ -0,0 +1,25 @@
+<?php
+
+namespace Laravel\NightwatchClient;
+
+use function call_user_func;
+use function class_exists;
+
+return call_user_func(static function () {
+    if (! class_exists(Cache::class, autoload: false)) {
+        class Cache
+        {
+            /**
+             * @var IngestFactory
+             */
+            public static $ingestFactory;
+        }
+
+        /** @var IngestFactory $ingestFactory */
+        require __DIR__.'/build/client.phar';
+
+        Cache::$ingestFactory = $ingestFactory;
+    }
+
+    return Cache::$ingestFactory;
+});

client/composer.json

@@ -2,4 +2,17 @@
 
 return [
     'prefix' => 'NightwatchClient_kden27khxA4QoEfj',
+    'patchers' => [
+        // There are situations when this file is manually required twice by
+        // Box. This has been seen mostly during installation scripts when the
+        // agent is not running and an exception is thrown. We ensure the file
+        // is only ever required once to fix this issue manually.
+        static function (string $filePath, string $prefix, string $content): string {
+            if ($filePath === 'vendor/composer/InstalledVersions.php') {
+                $content = str_replace('class InstalledVersions', "\nif (class_exists(InstalledVersions::class, autoload: false)) { return; }\n\nclass InstalledVersions", $content);
+            }
+
+            return $content;
+        },
+    ],
 ];

client/entry.php

@@ -15,7 +15,7 @@ public function __construct(
         //
     }
 
-    public function write(string $payload): void
+    public function __invoke(string $payload): void
     {
         if ($payload !== '') {
             await($this->connector->connect($this->transmitTo))->end($payload);

client/scoper.inc.php

@@ -2,33 +2,18 @@
 
 namespace Laravel\NightwatchClient;
 
+require __DIR__.'/../vendor/react/async/src/functions_include.php';
+require __DIR__.'/../vendor/react/promise/src/functions_include.php';
 require __DIR__.'/../vendor/autoload.php';
 
-/*
- * Input...
- */
-
-/** @var ?string $payload */
-$payload ??= '';
-/** @var ?string $transmitTo */
-$transmitTo ??= '127.0.0.1:2407';
-/** @var ?float $ingestTimeout */
-$ingestTimeout ??= 0.5;
-/** @var ?float $ingestConnectionTimeout */
-$ingestConnectionTimeout ??= 0.5;
-
-/*
- * Initialize services...
- */
-
-$ingest = (new IngestFactory)(
-    transmitTo: $transmitTo,
-    ingestTimeout: $ingestTimeout,
-    ingestConnectionTimeout: $ingestConnectionTimeout,
-);
-
-/*
- * Get things rolling...
- */
-
-$ingest->write($payload);
+$ingestFactory = static function (
+    ?string $transmitTo = null,
+    ?float $ingestTimeout = null,
+    ?float $ingestConnectionTimeout = null,
+): Ingest {
+    return (new IngestFactory)(
+        transmitTo: $transmitTo ?? '127.0.0.1:2407',
+        ingestTimeout: $ingestTimeout ?? 0.5,
+        ingestConnectionTimeout: $ingestConnectionTimeout ?? 0.5,
+    );
+};

client/src/Ingest.php

@@ -0,0 +1,33 @@
+<?php
+
+use Symfony\Component\Process\Process;
+
+test('entry point can be accessed and ingest resolved multiple times', function () {
+    $path = __DIR__.'/fixtures/include_entry_point_multiple_times.php';
+    $process = Process::fromShellCommandline("php -f {$path}");
+    $process->setTimeout(10);
+
+    $process->mustRun();
+
+    expect($process->getOutput())->toBe(<<<OUTPUT
+        Closure
+        NightwatchClient_kden27khxA4QoEfj\\Laravel\\NightwatchClient\Ingest
+        Closure
+        NightwatchClient_kden27khxA4QoEfj\\Laravel\\NightwatchClient\Ingest
+        Closure
+        NightwatchClient_kden27khxA4QoEfj\\Laravel\\NightwatchClient\Ingest
+        OUTPUT);
+});
+
+test('variables do not leak into scope', function () {
+    $path = __DIR__.'/fixtures/check_for_leaking_variables.php';
+    $process = Process::fromShellCommandline("php -f {$path}");
+    $process->setTimeout(10);
+
+    $process->mustRun();
+
+    expect($process->getOutput())->toBe(<<<'OUTPUT'
+        0
+        0
+        OUTPUT);
+});

client/src/client.php

@@ -0,0 +1,12 @@
+<?php
+
+// Wrapped in a closure to simulate a local scoped block so global variables are not
+// counted
+call_user_func(static function () {
+    echo count(get_defined_vars());
+    echo PHP_EOL;
+
+    require __DIR__.'./../../../entry.php';
+
+    echo count(get_defined_vars());
+});

client/tests/Unit/EntryPointTest.php

@@ -0,0 +1,24 @@
+<?php
+
+$factory = null;
+$factory = require __DIR__.'./../../../entry.php';
+echo $factory::class;
+echo PHP_EOL;
+$ingest = $factory();
+echo $ingest::class;
+echo PHP_EOL;
+
+$factory = null;
+$factory = require __DIR__.'./../../../entry.php';
+echo $factory::class;
+echo PHP_EOL;
+$ingest = $factory();
+echo $ingest::class;
+echo PHP_EOL;
+
+$factory = null;
+$factory = require __DIR__.'./../../../entry.php';
+echo $factory::class;
+echo PHP_EOL;
+$ingest = $factory();
+echo $ingest::class;

client/tests/Unit/fixtures/check_for_leaking_variables.php

@@ -4,11 +4,18 @@
 
 use Laravel\Nightwatch\Contracts\LocalIngest;
 
+use function call_user_func;
+
 /**
  * @internal
  */
 final class Ingest implements LocalIngest
 {
+    /**
+     * @var (callable(string): void)|null
+     */
+    private $ingest = null;
+
     public function __construct(
         private ?string $transmitTo,
         private ?float $ingestTimeout,
@@ -19,12 +26,17 @@ public function __construct(
 
     public function write(string $payload): void
     {
-        $transmitTo = $this->transmitTo;
-
-        $ingestTimeout = $this->ingestTimeout;
+        if ($this->ingest === null) {
+            /** @var (callable(string|null $transmitTo, float|null $ingestTimeout, float|null $ingestConnectionTimeout): (callable(string $payload): void)) */
+            $factory = require __DIR__.'/../client/entry.php';
 
-        $ingestConnectionTimeout = $this->ingestConnectionTimeout;
+            $this->ingest = $factory(
+                $this->transmitTo,
+                $this->ingestTimeout,
+                $this->ingestConnectionTimeout,
+            );
+        }
 
-        require __DIR__.'/../client/build/client.phar';
+        call_user_func($this->ingest, $payload);
     }
 }