Penyahpepijatan interaktif dengan Symfony Console

Salah satu sistem terpenting yang kami ada di RoundingWell ialah Enjin Penilaian, atau "penilaian" seperti yang biasa kami rujuk kepadanya. Sistem ini bertanggungjawab untuk memproses pendengar acara yang dikonfigurasikan khusus pelanggan, yang membolehkan kami menyediakan pengalaman pengguna yang sangat unik untuk setiap organisasi. Tidak perlu dikatakan, sistem ini sangat penting untuk aplikasi kami dan dapat mengetahui dengan tepat apa yang dilakukannya, atau akan dilakukan, kerana acara tertentu adalah kritikal.

Hari ini saya sedang berusaha untuk mengalihkan salah seorang pelanggan kami daripada beberapa acara lama kepada acara yang lebih baharu dan perlu memastikan bahawa salah satu langkah sedang memproses acara dengan betul. Kami mempunyai banyak log masuk sekitar penilaian, dan saya tahu maklumat yang saya perlukan ada dalam log. Tetapi masalah dengan mempunyai banyak pembalakan ialah, terdapat banyak balak. Selain itu, saya hanya perlu menjalankan bahagian pertama setiap pencetus untuk mengesahkan bahawa penghijrahan itu berjaya.

Saya terfikir sendiri, "Bukankah bijak jika kita boleh mempunyai penyahpepijat langkah seperti Xdebug untuk enjin penilaian? Saya tahu Symfony Console mempunyai semua fungsi yang saya perlukan untuk ini..."

Dan itulah yang saya lakukan. Oleh kerana aplikasi kami disuntik kebergantungan sepenuhnya, saya dapat mencipta kelas baharu untuk membalut StepFactory, yang bertanggungjawab untuk membaca konfigurasi dan mencipta "langkah" yang membentuk penilaian.

use RoundingWell\Framework\DebugVar;
use RuntimeException;
use Symfony\Component\Console\Style\SymfonyStyle;

readonly class StepFactoryWithConsoleConfirmation implements StepFactory
{
    public function __construct(
        private StepFactory $stepFactory,
        private SymfonyStyle $style,
        private bool $confirmCreatedStep = true,
        private bool $showCreatedStep = true,
        private bool $showStepDefinition = false,
    ) {
    }

    public function create(object $subject, StepDefinition $definition): Step
    {
        if ($this->showStepDefinition) {
            $debug = new DebugVar($definition->parameters);

            $this->style->info(
                message: <<<TEXT
                Next step is $definition->name with parameters:

                $debug
                TEXT,
            );
        }

        $step = $this->stepFactory->create($subject, $definition);

        if ($this->showCreatedStep) {
            $debug = new DebugVar($step);

            $this->style->info(
                message: <<<TEXT
                Step $definition->name created as:

                $debug
                TEXT,
            );
        }

        if ($this->confirmCreatedStep && ! $this->style->confirm(question: "Continue with evaluation?")) {
            throw new RuntimeException(
                message: "Evaluation aborted at step {$definition->name}",
            );
        }

        return $step;
    }
}

Dan, dengan sedikit manipulasi bekas dalam arahan konsol saya, kami mempunyai penyahpepijat penilaian interaktif:

use DI\Container;
use RoundingWell\Common\Command\CommandBus;
use RoundingWell\Common\Command\CommandBusComposed;
use RoundingWell\Common\Command\Middleware\LoggingMiddleware;
use RoundingWell\Evaluation\Command\EvaluateEvent;
use RoundingWell\Evaluation\Command\EvaluateEventHandler;
use RoundingWell\Evaluation\Step\StepFactory;
use RoundingWell\Evaluation\Step\StepFactoryWithConsoleConfirmation;
use Symfony\Component\Console\Style\SymfonyStyle;

readonly class EvaluationDebug
{
    public function __construct(
        private Container $container,
    ) {
    }

    public function __invoke(
        SymfonyStyle $symfonyStyle,
        string $eventType,
        string $eventId,
        string|null $evaluationId = null,
    ): void {
        // The command bus MUST ONLY log executed commands.
        $commandBus = new CommandBusComposed(
            $this->container->get(LoggingMiddleware::class),
        );

        // The step factory MUST be wrapped to step through the evaluation.
        $stepFactory = new StepFactoryWithConsoleConfirmation(
            stepFactory: $this->container->get(StepFactory::class),
            style: $symfonyStyle,
        );

        $this->container->set(CommandBus::class, $commandBus);
        $this->container->set(StepFactory::class, $stepFactory);

        $command = new EvaluateEvent(
            eventClass: $eventType,
            eventId: $eventId,
            evaluationId: $evaluationId,
        );

        $this->container->get(EvaluateEventHandler::class)->handle($command);

        $symfonyStyle->success('Evaluation complete');
    }
}

Itu sahaja untuk hari ini!

Atas ialah kandungan terperinci Penyahpepijatan interaktif dengan Symfony Console. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!