Merge branch 'develop'

* develop: (39 commits)
  add missing calls to each section
  make sure all sections render without an error
  add type coverage badge
  remove unused dependency
  remove old documentation
  add documentation
  mention the package contains a middleware
  transform the package into a library
  add tests
  add named constructor to prefix routes for when used locally in an app
  make kernel constructor private
  fix display of contents
  remove old data
  prefix services to avoid collisions in user apps
  add dedicated route to display each section to avoid loading all profile data in a single page
  add sections loader
  extract the creation of the service used to load the profile
  add profile sections
  the call graph data is json, not svg
  add page to show a profile
  ...

Author: Baptouuuu

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macOS-latest]
-        php-version: ['7.4', '8.0']
+        php-version: ['8.1', '8.2']
     name: 'PHPUnit'
     steps:
       - name: Checkout
@@ -20,27 +20,36 @@ jobs:
           extensions: mbstring, intl
           coverage: xdebug
           ini-values: xdebug.max_nesting_level=2048
-      - name: Get Composer Cache Directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-      - name: Cache dependencies
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
-          restore-keys: ${{ runner.os }}-composer-
-      - name: Install Dependencies
-        run: composer install --no-progress
+      - name: Composer
+        uses: "ramsey/composer-install@v2"
       - name: PHPUnit
         run: vendor/bin/phpunit --coverage-clover=coverage.clover
       - uses: codecov/codecov-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
+  psalm:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version: ['8.1', '8.2']
+    name: 'Psalm'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: mbstring, intl
+      - name: Composer
+        uses: "ramsey/composer-install@v2"
+      - name: Psalm
+        run: vendor/bin/psalm --shepherd
   cs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-version: ['7.4']
+        php-version: ['8.1']
     name: 'CS'
     steps:
       - name: Checkout
@@ -50,16 +59,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           extensions: mbstring, intl
-      - name: Get Composer Cache Directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-      - name: Cache dependencies
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-${{ matrix.php-version }}-composer-${{ hashFiles('**/composer.json') }}
-          restore-keys: ${{ runner.os }}-${{ matrix.php-version }}-composer-
-      - name: Install Dependencies
-        run: composer install --no-progress
+      - name: Composer
+        uses: "ramsey/composer-install@v2"
       - name: CS
-        run: vendor/bin/php-cs-fixer fix --diff --dry-run --diff-format udiff
+        run: vendor/bin/php-cs-fixer fix --diff --dry-run

.php_cs.dist .php-cs-fixer.dist.php

@@ -2,24 +2,16 @@
 
 [![Build Status](https://github.com/Innmind/Profiler/workflows/CI/badge.svg?branch=master)](https://github.com/Innmind/Profiler/actions?query=workflow%3ACI)
 [![codecov](https://codecov.io/gh/Innmind/Profiler/branch/develop/graph/badge.svg)](https://codecov.io/gh/Innmind/Profiler)
+[![Type Coverage](https://shepherd.dev/github/innmind/profiler/coverage.svg)](https://shepherd.dev/github/innmind/profiler)
 
-(Framework agnostic) App profiler to help profile any kind of applications (http or cli).
+App profiler to help profile any kind of applications (http or cli).
 
-## Why
-
-For my side projects I decided to no longer use the Symfony framework to explore different ways to build apps. However Symfony ship with a builtin profiler to help debug the application, thus I lost this tool in my side projects.
-
-The problem with the current state of frameworks is that they either provide a profiler coupled to the framework or do not provide any. Since I needed to build a profiler for my needs I decided to also address the problem that many applications can't have access to a profiler by building one decoupled from any framework.
-
-The decoupling is guaranteed by 2 things:
-
-- it's a standalone project (so the application is not altered by much)
-- profiles are created via http, so we deal with raw values
+This package can be integrated in an existing app (using [`innmind/framework`](https://packagist.org/packages/innmind/framework)) or run as a [standalone app](docs/standalone.md)
 
 ## Installation
 
 ```sh
-composer create-project innmind/profiler
+composer require innmind/profiler
 ```
 
 ## Overview
@@ -28,14 +20,16 @@ The profiler contains 2 types of entities: a profile and sections.
 
 A profile contains a name (usually the http path called or the cli), the point in time the profile started, the status (succeeded, failed or pending) and an exit message.
 
-A section is a part of a profile. By default there are 7 sections:
+A section is a part of a profile. By default there are 9 sections:
 - Http: the request and response (if the app didn't crash) the app received
 - Exception: the stack trace represented as graph (see [`innmind/stack-trace`](https://packagist.org/packages/innmind/stack-trace))
 - App graph: the object graph representing the application (see [`innmind/object-graph`](https://packagist.org/packages/innmind/object-graph))
+- Call graph: a flamechart
 - Environment: the list of environment variables
 - Processes: the list of commands run on the machine
 - Remote / Http: all the http requests issued by the application
 - Remote / Processes: all the commands run on a distant machine
+- Remote / Sql: all the SQL queries issued to a database
 
 ![](overview/index.png)
 ![](overview/http.png)
@@ -46,14 +40,6 @@ A section is a part of a profile. By default there are 7 sections:
 ![](overview/remote_processes.png)
 ![](overview/remote_http.png)
 
-## Usage
-
-```sh
-cd profiler-directory/public && php -S localhost:8000
-```
-
-This will start the php builtin webserver to expose the profiler on the local machine on the port `8000`. (You can change the port or use a real webserver such a nginx, the use of php webserver is for simplicity)
-
-Then open `http://localhost:8000` in your browser to access the profiler.
+## Documentation
 
-To create new profiles you need to create them via http, you can use the [`innmind/rest-client`](https://packagist.org/packages/innmind/rest-client) to simplify the task. All the capabilities can be accessed via the url `OPTIONS http://localhost:8000/*`
+All the documentation can be found in the [`docs`](docs/) folder.

README.md

@@ -1,37 +1,33 @@
 {
     "name": "innmind/profiler",
-    "type": "project",
+    "type": "library",
     "description": "App profiler",
     "keywords": ["profiler", "http", "cli"],
     "homepage": "http://github.com/Innmind/Profiler",
     "license": "MIT",
     "authors": [
         {
             "name": "Baptiste Langlade",
-            "email": "langlade.baptiste@gmail.com"
+            "email": "baptiste.langlade@hey.com"
         }
     ],
     "support": {
         "issues": "http://github.com/Innmind/Profiler/issues"
     },
     "require": {
-        "php": "~7.4|~8.0",
-        "innmind/immutable": "~3.5",
-        "ramsey/uuid": "^3.8",
-        "innmind/operating-system": "~2.0",
-        "innmind/rest-server": "~8.0",
-        "innmind/http-framework": "~2.1",
-        "innmind/http-server": "~2.0",
-        "innmind/templating": "~2.0"
+        "php": "~8.1",
+        "innmind/immutable": "~4.13",
+        "ramsey/uuid": "~4.7",
+        "innmind/operating-system": "~3.7",
+        "innmind/framework": "~1.1",
+        "innmind/json": "^1.3",
+        "innmind/html": "^6.1.1",
+        "innmind/url-template": "^3.0"
     },
     "autoload": {
         "psr-4": {
             "Innmind\\Profiler\\": "src/"
-        },
-        "files": [
-            "src/Domain/bootstrap.php",
-            "src/Web/bootstrap.php"
-        ]
+        }
     },
     "autoload-dev": {
         "psr-4": {
@@ -40,6 +36,10 @@
     },
     "require-dev": {
         "phpunit/phpunit": "~9.0",
-        "innmind/coding-standard": "^1.1"
+        "vimeo/psalm": "~5.6",
+        "innmind/coding-standard": "~2.0"
+    },
+    "provide": {
+        "innmind/framework-middlewares": "1.0"
     }
 }

composer.json

@@ -0,0 +1,13 @@
+# Getting started
+
+## Installation
+
+```sh
+composer require innmind/profiler
+```
+
+## Use cases
+
+- [Add the profiler to an existing app](in-app.md)
+- [Record profiles](record.md)
+- [Run as standalone app](standalone.md)

docs/README.md

@@ -0,0 +1,23 @@
+# Add the profiler to an existing app
+
+For this use cas you must [`innmind/framework`](https://packagist.org/packages/innmind/framework).
+
+```php
+use Innmind\Framework\{
+    Application,
+    Main\Http,
+};
+use Innmind\Profiler\Web\Kernel;
+use Innmind\Url\Path;
+
+new class extends Http {
+    protected function configure(Application $app): Application
+    {
+        return $app->map(Kernel::inApp(Path::of('/tmp/')));
+    }
+};
+```
+
+This example will expose the profiler under the `/_profiler/` route and the profiles will be stored in the `/tmp/` folder. Using the tmp folder means the profiles will be lost when rebooting your machine, you can use a local folder if you want to keep them.
+
+> **Note** this example add the middleware in the entrypoint of your app but you can add it in your own middleware.

docs/in-app.md

@@ -0,0 +1,62 @@
+# Record profiles
+
+By default the profiler record nothing, it's up to you to record the data that will be shown in the profiler.
+
+The examples show how to record data when the profiler is [in the current app](in-app.md).
+
+```php
+use Innmind\Framework\{
+    Application,
+    Middleware,
+    Http\RequestHandler,
+};
+use Innmind\Profiler\{
+    Web\Kernel,
+    Profiler,
+};
+use Innmind\Http\Message\{
+    ServerRequest,
+    Response,
+};
+use Innmind\Url\Path;
+
+final class YourApp implements Middleware
+{
+    public function __invoke(Application $app): Application
+    {
+        return $app
+            ->map(Kernel::inApp(Path::of('/tmp/')))
+            ->mapRequestHandler(
+                static fn($handler, $get) => new class($handler, $get('innmind/profiler')) implements RequestHandler {
+                    public function __construct(
+                        private RequestHandler $inner,
+                        private Profiler $profiler,
+                    ) {
+                    }
+
+                    public function __invoke(ServerRequest $request): Response
+                    {
+                        $profile = $this->profiler->start($request->url()->path()->toString());
+                        $this->profiler->mutate(
+                            $profile,
+                            static function($mutation) {
+                                $mutation->sections(); // call any method here to record sections data
+                            },
+                        );
+
+                        $response = ($this->inner)($request);
+                        $this->profiler->mutate(
+                            $profile,
+                            static fn($mutation) => match ($response->statusCode()->successful()) {
+                                true => $mutation->succeed($response->statusCode()->toString()),
+                                false => $mutation->fail($response->statusCode()->toString()),
+                            },
+                        );
+
+                        return $response;
+                    }
+                },
+            );
+    }
+}
+```

docs/record.md

@@ -0,0 +1,30 @@
+# Run as standalone app
+
+The first step is to add an entrypoint that will be exposed by an HTTP server.
+
+```php
+<?php
+declare(strict_types=1);
+
+require 'path/to/vendor/autoload.php';
+
+use Innmind\Framework\{
+    Application,
+    Main\Http,
+};
+use Innmind\Profiler\Web\Kernel;
+use Innmind\Url\Path;
+
+new class extends Http {
+    protected function configure(Application $app): Application
+    {
+        return $app
+            ->map(Kernel::standalone(Path::of('/tmp/')))
+            ->map(new YourMiddleware);
+    }
+}
+```
+
+This will expose the profiler via the `/` route.
+
+Because the profiler doesn't come with its own HTTP api to record profiles you will need to implements these yourself via `YourMiddleware`.

docs/standalone.md

@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="1"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <directory name="public" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>