Env vars and process customization (#18)

* Env vars and process customization

* Documentation for env vars and custom process

Author: Padam87

ConfigHelper.php

@@ -16,7 +16,7 @@ public function __construct(string $projectDir, array $config)
         $this->projectDir = $projectDir;
     }
 
-    public function buildProcess(InputStream $input, array $arguments = []): Process
+    public function buildProcess(InputStream $input, array $arguments = [], array $env = []): Process
     {
         $process = new Process(
             array_merge(
@@ -27,7 +27,7 @@ public function buildProcess(InputStream $input, array $arguments = []): Process
                 array_values(array_merge($this->config['arguments'], $arguments))
             ),
             null,
-            [],
+            array_merge($this->config['env_vars'], $env),
             $input
         );
 

DependencyInjection/Configuration.php

@@ -44,6 +44,9 @@ public function getConfigTreeBuilder()
                     ->end()
                     ->prototype('scalar')->end()
                 ->end()
+                ->arrayNode('env_vars')
+                    ->prototype('scalar')->end()
+                ->end()
             ->end()
         ;
 

README.md

@@ -36,5 +36,7 @@ $response = new Response(
 
 **How to...**
  - [pass arguments to the javascript file?](Resources/docs/how_to_pass_arguments.md)
+ - [fully customize the Symfony Process?](Resources/docs/how_to_customize_the_process.md)
+
 
 

Rasterizer.php

@@ -16,15 +16,20 @@ public function __construct(ConfigHelper $configHelper, Stopwatch $stopwatch = n
         $this->stopwatch = $stopwatch;
     }
 
-    public function rasterize(string $html, $arguments = []): string
+    public function rasterize(string $html, array $arguments = [], array $env = [], callable $callback = null): string
     {
         if ($this->stopwatch instanceof Stopwatch) {
             $this->stopwatch->start('rasterizer');
         }
 
         $input = new InputStream();
 
-        $process = $this->configHelper->buildProcess($input, $arguments);
+        $process = $this->configHelper->buildProcess($input, $arguments, $env);
+
+        if ($callback) {
+            $callback($process);
+        }
+
         $process->start(null, []);
 
         $input->write($html);

Resources/docs/configuration_reference.md

@@ -9,4 +9,6 @@ padam87_rasterize:
         path: web\rasterize.js # Relative to project dir
     arguments:
         format: pdf # Default, will always be added, even if you remove it from here.
+    env_vars: # Empty by default
+        # NODE_PATH: /path/to/node
 ```

Resources/docs/how_to_customize_the_process.md

@@ -0,0 +1,20 @@
+# How to fully customize the process?
+
+The rasterize methods accepts a callback as the 4th parameter.
+
+```php
+$response = new Response(
+    $this->get('padam87_rasterize.rasterizer')->rasterize(
+        $this->renderView('Bundle:Folder:template.pdf.twig'),
+        [],
+        [],
+        function (Process $process) {
+            // HERE
+        }
+    ),
+    200, [
+        'Content-Type'          => 'application/pdf',
+        'Content-Disposition'   => 'attachment; filename="my.pdf"'
+    ]
+);
+```

Tests/ConfigHelperTest.php

@@ -30,6 +30,9 @@ public function setUp()
             ],
             'arguments' => [
                 'format' => 'pdf'
+            ],
+            'env_vars' => [
+                'NODE_PATH' => '/usr/local/lib/node_modules',
             ]
         ];
     }
@@ -48,5 +51,32 @@ public function isTheProcessBuilt()
             implode(DIRECTORY_SEPARATOR, ['node ' . __DIR__, 'assets', 'rasterize.js']) . ' pdf',
             str_replace(['"', "'"], '', $process->getCommandLine())
         );
+
+        $this->assertCount(1, $process->getEnv());
+    }
+
+    /**
+     * @test
+     */
+    public function attributeMerge()
+    {
+        $configHelper = new ConfigHelper(__DIR__, $this->config);
+        $process = $configHelper->buildProcess(new InputStream(), ['paper' => 'A4']);
+
+        $this->assertEquals(
+            implode(DIRECTORY_SEPARATOR, ['node ' . __DIR__, 'assets', 'rasterize.js']) . ' pdf A4',
+            str_replace(['"', "'"], '', $process->getCommandLine())
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function envMerge()
+    {
+        $configHelper = new ConfigHelper(__DIR__, $this->config);
+        $process = $configHelper->buildProcess(new InputStream(), [], ['MY_ENV' => 'something']);
+
+        $this->assertCount(2, $process->getEnv());
     }
 }

Tests/RasterizerTest.php

@@ -46,4 +46,27 @@ public function testRasterize()
 
         $this->assertSame('pdfcontent', $rasterizer->rasterize('<html></html>'));
     }
+
+    /**
+     * @test
+     */
+    public function testCallback()
+    {
+        $this->stopwatch->shouldReceive('start')->once();
+        $this->stopwatch->shouldReceive('stop')->once();
+
+        $this->configHelper->shouldReceive('buildProcess')->once()->andReturn($this->process);
+
+        $this->process->shouldReceive('start');
+        $this->process->shouldReceive('wait');
+        $this->process->shouldReceive('setTimeout');
+        $this->process->shouldReceive('getOutput')->andReturn('pdfcontent');
+
+        $rasterizer = new Rasterizer($this->configHelper, $this->stopwatch);
+        $output = $rasterizer->rasterize('<html></html>', [], [], function (Process $process) {
+            $process->setTimeout(999);
+        });
+
+        $this->assertSame('pdfcontent', $output);
+    }
 }