etsy/phan

<?php

declare(strict_types=1);

namespace Phan;

/**
 * Utility for profiling Phan runs. Used if the profiler_enabled config setting is true.
 */
trait Profile
{
    /**
     * @var array<string,list<float>>
     * Maps each phase of Phan analysis to a list of 1 or more durations (in seconds) spent in that phase.
     */
    private static $label_delta_map = [];

    /**
     * Measure the clock-time taken to execute the given
     * closure and emit the time with the given label to
     * a log.
     *
     * @param $label
     * A label to emit with the time taken to run the
     * given closure
     *
     * @param \Closure $closure
     * Any closure to measure how long it takes to run
     *
     * @return mixed
     *
     * @suppress PhanUnreferencedProtectedMethod (unused, may use something similar in the future)
     */
    protected static function time(string $label, \Closure $closure)
    {

        if (!Config::getValue('profiler_enabled')) {
            return $closure();
        }

        static $initialized = false;
        if (!$initialized) {
            self::initialize();
            $initialized = true;
        }

        // Measure the time to execute the given closure
        $start_time = \microtime(true);
        $return_value = $closure();
        $end_time = \microtime(true);

        // Emit a log message
        $delta = ($end_time - $start_time);

        self::$label_delta_map[$label][] = $delta;

        return $return_value;
    }

    /**
     * Initialize the profiler
     */
    private static function initialize(): void
    {

        // Create a shutdown function to emit the log when we're
        // all done
        \register_shutdown_function(static function (): void {
            $label_metric_map = [];

            // Compute whatever metric we care about
            foreach (self::$label_delta_map as $label => $delta_list) {
                $total_time = \array_sum($delta_list);
                $count = \count($delta_list);
                $average_time = $total_time / $count;
                $label_metric_map[$label] = [
                    $count,
                    $total_time,
                    $average_time
                ];
            }

            // Sort such that the highest metric value is on top
            \uasort(
                $label_metric_map,
                /**
                 * @param array{0:int,1:float,2:float} $a
                 * @param array{0:int,1:float,2:float} $b
                 */
                static function (array $a, array $b): int {
                    return $b[1] <=> $a[1];
                }
            );

            // Print it all out
            foreach ($label_metric_map as $label => $metrics) {
                // @phan-suppress-next-line PhanPluginRemoveDebugEcho
                print $label
                    . "\t"
                    . \implode("\t", \array_map(static function (float $v): string {
                        return \sprintf("%.6f", $v);
                    }, $metrics))
                    . "\n";
            }
        });
    }
}