Merge pull request #74 from glensc/importer-cli

Author: glensc

README.md

@@ -26,6 +26,7 @@ In order to profile your application, you need to:
 - [Install profiler extension](#installing-profilers)
 - [Instantiate the profiler](#create-profiler)
 - [Configure saver to send data to XHGui](#savers)
+- [Import jsonl files](#import-jsonl-files) (optional)
 
 ## Installation
 
@@ -202,7 +203,7 @@ Example config:
     ),
 ```
 
-To import a saved files, use XHGui's provided `external/import.php` script.
+To import a saved files, see [Import jsonl files](#import-jsonl-files) section.
 
 ### MongoDB Saver
 
@@ -292,6 +293,23 @@ class StdOutSaver implements SaverInterface
 $profiler->setSaver(new StdOutSaver());
 ```
 
+### Import jsonl files
+
+You can use `./bin/import.php` script to submit files saved by [File Saver](#file-saver) to XHGui server.
+
+1. [Setup config file](#using-config-file)
+1. Configure to use [Upload Saver](#upload-saver)
+1. Execute the `./bin/import.php` script
+
+The script can take multiple [jsonl] formatted files, or if none given read stdin stream.
+
+```sh
+$ ./bin/import.php tests/tmp/php-profiler-xhgui-test-1596093567.787220-c857.json
+Imported 1 lines
+```
+
+[jsonl]: https://jsonlines.org/
+
 ## Configure Profiling Rate
 
 You may want to change how frequently you profile the application.  The

bin/import.php

@@ -0,0 +1,26 @@
+#!/usr/bin/env php
+<?php
+
+use Xhgui\Profiler\ImporterFactory;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+$importer = ImporterFactory::create();
+
+if ($argc > 1) {
+    foreach (array_splice($argv, 1) as $file) {
+        if (!is_readable($file)) {
+            throw new RuntimeException("{$file} isn't readable");
+        }
+
+        $fp = fopen($file, 'r');
+        if (!$fp) {
+            throw new RuntimeException("Can't open {$file}");
+        }
+        $importer->import($fp);
+        fclose($fp);
+    }
+} else {
+    $importer->import(STDIN);
+}
+

src/Importer.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Xhgui\Profiler;
+
+use Exception;
+use Xhgui\Profiler\Saver\SaverInterface;
+
+final class Importer
+{
+    /** @var SaverInterface */
+    private $saver;
+
+    public function __construct(SaverInterface $saver)
+    {
+        $this->saver = $saver;
+    }
+
+    public function import($stream)
+    {
+        $saver = $this->saver;
+        $lines = 0;
+        while (!feof($stream)) {
+            $line = trim(fgets($stream));
+            if (!$line) {
+                continue;
+            }
+            $data = json_decode($line, true);
+            if (!$data) {
+                error_log("Ignoring malformed JSON line: $line");
+                continue;
+            }
+
+            try {
+                $saver->save($data);
+                $lines++;
+            } catch (Exception $e) {
+                error_log($e);
+            }
+        }
+        error_log("Imported {$lines} lines");
+    }
+}

src/ImporterFactory.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Xhgui\Profiler;
+
+use RuntimeException;
+
+final class ImporterFactory
+{
+    public static function create()
+    {
+        $config = Config::create();
+        $saver = SaverFactory::create($config['save.handler'], $config);
+        if (!$saver) {
+            throw new RuntimeException("Unable to obtain saver");
+        }
+
+        return new Importer($saver);
+    }
+}