remove generated error pages (#3827)

Author: henzigo

build.xml

@@ -128,25 +128,25 @@
 
     <target name="build" depends="build-deploy-part-1-db-independent,build-deploy-part-2-db-dependent" description="Builds application for production preserving your DB."/>
 
-    <target name="build-demo" depends="production-protection,wipe,build-version-generate,composer-prod,redis-check,dirs-create,assets,npm,demo-data,error-pages-generate,warmup,clean-redis-old" description="Builds application for production with clean demo DB."/>
+    <target name="build-demo" depends="production-protection,wipe,build-version-generate,composer-prod,redis-check,dirs-create,assets,npm,demo-data,warmup,clean-redis-old" description="Builds application for production with clean demo DB."/>
 
-    <target name="build-demo-ci" depends="production-protection,build-version-generate,wipe-excluding-logs,composer-dev,timezones-check,dirs-create,test-dirs-create,assets,npm,demo-data,error-pages-generate,tests-acceptance-build,clean-redis-old,checks-ci" description="Builds application for development with clean demo DB and runs CI checks."/>
+    <target name="build-demo-ci" depends="production-protection,build-version-generate,wipe-excluding-logs,composer-dev,timezones-check,dirs-create,test-dirs-create,assets,npm,demo-data,tests-acceptance-build,clean-redis-old,checks-ci" description="Builds application for development with clean demo DB and runs CI checks."/>
 
-    <target name="build-demo-dev" depends="production-protection,build-version-generate,wipe-excluding-logs,composer-dev,timezones-check,dirs-create,test-dirs-create,assets,npm,demo-data,error-pages-generate,tests-acceptance-build,clean-redis-old,checks" description="Builds application for development with clean demo DB and runs checks on changed files."/>
+    <target name="build-demo-dev" depends="production-protection,build-version-generate,wipe-excluding-logs,composer-dev,timezones-check,dirs-create,test-dirs-create,assets,npm,demo-data,tests-acceptance-build,clean-redis-old,checks" description="Builds application for development with clean demo DB and runs checks on changed files."/>
 
     <target name="build-demo-dev-quick" depends="production-protection,build-version-generate,wipe-excluding-logs,composer-dev,dirs-create,test-dirs-create,assets,npm,demo-data,clean-redis-old" description="Builds application for development with clean demo DB while skipping nonessential steps."/>
 
     <target name="build-deploy-part-1-db-independent" depends="build-version-generate,clean,composer-prod,dirs-create,assets,npm" description="First part of application build for production preserving your DB (can be run without maintenance page)."/>
 
-    <target name="build-deploy-part-2-db-dependent" depends="check-migrate-uploaded-files,elasticsearch-index-migrate,redis-check,db-migrations,domains-data-create,friendly-urls-generate,domains-urls-replace,migrate-uploaded-files-force,error-pages-generate,warmup" description="Second part of application build for production preserving your DB (must be run with maintenance page when containing DB migrations)."/>
+    <target name="build-deploy-part-2-db-dependent" depends="check-migrate-uploaded-files,elasticsearch-index-migrate,redis-check,db-migrations,domains-data-create,friendly-urls-generate,domains-urls-replace,migrate-uploaded-files-force,warmup" description="Second part of application build for production preserving your DB (must be run with maintenance page when containing DB migrations)."/>
 
-    <target name="build-dev" depends="build-version-generate,clean,composer-dev,timezones-check,dirs-create,test-dirs-create,assets,npm,db-migrations,domains-data-create,friendly-urls-generate,friendly-url-entity-mapping-check,elasticsearch-index-recreate,elasticsearch-export,error-pages-generate,tests-acceptance-build,clean-redis-old,checks" description="Builds application for development preserving your DB and runs checks on changed files."/>
+    <target name="build-dev" depends="build-version-generate,clean,composer-dev,timezones-check,dirs-create,test-dirs-create,assets,npm,db-migrations,domains-data-create,friendly-urls-generate,friendly-url-entity-mapping-check,elasticsearch-index-recreate,elasticsearch-export,tests-acceptance-build,clean-redis-old,checks" description="Builds application for development preserving your DB and runs checks on changed files."/>
 
     <target name="build-dev-quick" depends="build-version-generate,clean,composer-dev,dirs-create,test-dirs-create,assets,npm,db-migrations,domains-data-create,friendly-urls-generate,friendly-url-entity-mapping-check,elasticsearch-index-migrate,clean-redis-old" description="Builds application for development preserving your DB while skipping nonessential steps."/>
 
-    <target name="build-new" depends="production-protection,wipe,build-version-generate,composer-prod,redis-check,dirs-create,assets,npm,db-rebuild,elasticsearch-index-recreate,error-pages-generate,warmup,clean-redis-old" description="Builds application for production with clean DB (with base data only)."/>
+    <target name="build-new" depends="production-protection,wipe,build-version-generate,composer-prod,redis-check,dirs-create,assets,npm,db-rebuild,elasticsearch-index-recreate,warmup,clean-redis-old" description="Builds application for production with clean DB (with base data only)."/>
 
-    <target name="build-review-ci" depends="production-protection,wipe,build-version-generate,redis-check,dirs-create,db-demo,error-pages-generate,warmup,elasticsearch-index-recreate,elasticsearch-export,clean-redis-old" description="Builds application for review with clean demo DB."/>
+    <target name="build-review-ci" depends="production-protection,wipe,build-version-generate,redis-check,dirs-create,db-demo,warmup,elasticsearch-index-recreate,elasticsearch-export,clean-redis-old" description="Builds application for review with clean demo DB."/>
 
     <target name="build-version-generate" description="Generates parameters_version.yaml config file with a new build version number.">
         <exec executable="${path.php.executable}" checkreturn="true" outputProperty="version">
@@ -231,7 +231,6 @@
         <phingcall target="frontend-api-generate-new-keys"/>
         <phingcall target="elasticsearch-index-recreate"/>
         <phingcall target="elasticsearch-export"/>
-        <phingcall target="error-pages-generate"/>
         <phingcall target="warmup"/>
     </target>
 
@@ -759,14 +758,6 @@
         </if>
     </target>
 
-    <target name="error-pages-generate" depends="prod-warmup,redis-check" description="Generates error pages displayed in production environment.">
-        <exec executable="${path.php.executable}" passthru="true" checkreturn="true">
-            <arg value="${path.bin-console}"/>
-            <arg value="shopsys:error-page:generate-all"/>
-            <arg value="--verbose"/>
-        </exec>
-    </target>
-
     <target name="eslint-check" description="Find JS coding standard violations in all files using ESLint and print human readable output." hidden="true">
         <exec executable="${path.npm.executable}" logoutput="true" passthru="true" checkreturn="true">
             <arg value="run"/>
@@ -1235,14 +1226,6 @@
 
     <target name="test-elasticsearch-index-recreate" depends="production-protection,test-elasticsearch-index-delete,test-elasticsearch-index-migrate" description="Recreates structure for searching via elasticsearch in test environment (deletes existing structure and creates new one)"/>
 
-    <target name="test-error-pages-generate" depends="redis-check" description="Generates error pages for testing environment.">
-        <exec executable="${path.php.executable}" passthru="true" checkreturn="true">
-            <arg value="${path.bin-console}"/>
-            <arg value="shopsys:error-page:generate-all"/>
-            <arg value="--env=test"/>
-        </exec>
-    </target>
-
     <target name="test-friendly-url-entity-mapping-check" description="Checks completeness of entity mapping by route name">
         <exec executable="${path.php.executable}" passthru="true" checkreturn="true">
             <arg value="${path.bin-console}"/>
@@ -1269,7 +1252,7 @@
         </exec>
     </target>
 
-    <target name="tests" depends="test-db-demo,test-elasticsearch-index-recreate,test-elasticsearch-export,test-error-pages-generate,tests-unit,tests-functional,tests-smoke" description="Runs unit, functional and smoke tests. Builds new test database in the process."/>
+    <target name="tests" depends="test-db-demo,test-elasticsearch-index-recreate,test-elasticsearch-export,tests-unit,tests-functional,tests-smoke" description="Runs unit, functional and smoke tests. Builds new test database in the process."/>
 
     <target name="tests-acceptance" depends="production-protection,clean,test-clean-redis" description="Runs acceptance tests. Running Selenium server is required (Selenium is always running in Docker setup).">
         <phingcall target="tests-acceptance-before"/>

phpstan.neon

@@ -8,9 +8,6 @@ parameters:
         -
             message: '~Instantiated class App\\Kernel not found~'
             path: *
-        -
-            message: '#Call to method .+\(\) on an unknown class App\\Kernel\.#'
-            path: %currentWorkingDirectory%/src/Component/Error/ErrorPagesFacade.php
         -
             message: '#Argument of an invalid type Symfony\\Component\\Validator\\Constraint supplied for foreach, only iterables are supported\.#'
             path: %currentWorkingDirectory%/src/Form/JsFormValidatorFactory.php

src/Command/GenerateErrorPagesCommand.php

@@ -9,6 +9,7 @@
 use Sentry\State\Scope;
 use Shopsys\FrameworkBundle\Component\Domain\Domain;
 use Shopsys\FrameworkBundle\Component\Domain\Exception\NoDomainSelectedException;
+use Shopsys\FrameworkBundle\Component\Error\ErrorIdProvider;
 use Shopsys\FrameworkBundle\Component\Localization\DisplayTimeZoneProviderInterface;
 use Shopsys\FrameworkBundle\Component\Maintenance\MaintenanceModeFacade;
 use Shopsys\FrameworkBundle\Model\Customer\User\CurrentCustomerUser;
@@ -26,12 +27,14 @@ class AddSentryContextSubscriber implements EventSubscriberInterface
      * @param \Shopsys\FrameworkBundle\Component\Domain\Domain $domain
      * @param \Shopsys\FrameworkBundle\Component\Localization\DisplayTimeZoneProviderInterface $displayTimeZoneProvider
      * @param \Shopsys\FrameworkBundle\Model\Customer\User\CurrentCustomerUser $currentCustomerUser
+     * @param \Shopsys\FrameworkBundle\Component\Error\ErrorIdProvider $errorIdProvider
      */
     public function __construct(
         protected readonly MaintenanceModeFacade $maintenanceModeFacade,
         protected readonly Domain $domain,
         protected readonly DisplayTimeZoneProviderInterface $displayTimeZoneProvider,
         protected readonly CurrentCustomerUser $currentCustomerUser,
+        protected readonly ErrorIdProvider $errorIdProvider,
     ) {
     }
 
@@ -59,6 +62,7 @@ public function setSentryContext(): void
 
         configureScope(function (Scope $scope) use ($context): void {
             $scope->setContext('Shopsys', $context);
+            $scope->setTag('errorId', $this->errorIdProvider->getErrorId());
         });
     }
 

src/Component/AddSentryContextSubscriber.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Component\Error;
+
+use Symfony\Component\ErrorHandler\ErrorRenderer\ErrorRendererInterface;
+use Symfony\Component\ErrorHandler\Exception\FlattenException;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Throwable;
+use Tracy\BlueScreen;
+use Tracy\Debugger;
+
+final class BlueScreenErrorRenderer implements ErrorRendererInterface
+{
+    /**
+     * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
+     * @param \Symfony\Component\ErrorHandler\ErrorRenderer\ErrorRendererInterface $fallbackErrorRenderer
+     * @param bool $isDebug
+     */
+    public function __construct(
+        private readonly RequestStack $requestStack,
+        private readonly ErrorRendererInterface $fallbackErrorRenderer,
+        private readonly bool $isDebug,
+    ) {
+    }
+
+    /**
+     * @param \Throwable $exception
+     * @return \Symfony\Component\ErrorHandler\Exception\FlattenException
+     */
+    public function render(Throwable $exception): FlattenException
+    {
+        if ($this->isDebug() === false) {
+            return $this->fallbackErrorRenderer->render($exception);
+        }
+
+        Debugger::$time = time();
+        $blueScreen = new BlueScreen();
+
+        ob_start();
+
+        $blueScreen->render($exception);
+
+        $result = ob_get_clean();
+
+        return FlattenException::createFromThrowable($exception)->setAsString($result);
+    }
+
+    /**
+     * @return bool
+     */
+    private function isDebug(): bool
+    {
+        $request = $this->requestStack->getCurrentRequest();
+
+        if ($request === null) {
+            return $this->isDebug;
+        }
+
+        return $this->isDebug && $request->attributes->getBoolean('showException', true);
+    }
+}

src/Component/Error/BlueScreenErrorRenderer.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Component\Error;
+
+use Monolog\LogRecord;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\KernelEvents;
+use Symfony\Contracts\Service\ResetInterface;
+
+final class ErrorIdLogProcessor implements EventSubscriberInterface, ResetInterface
+{
+    private ?string $errorId = null;
+
+    /**
+     * @param \Shopsys\FrameworkBundle\Component\Error\ErrorIdProvider $errorIdProvider
+     */
+    public function __construct(
+        private readonly ErrorIdProvider $errorIdProvider,
+    ) {
+    }
+
+    /**
+     * @param \Monolog\LogRecord $record
+     * @return \Monolog\LogRecord
+     */
+    public function __invoke(LogRecord $record): LogRecord
+    {
+        if ($this->errorId !== null) {
+            $record['extra']['errorId'] = $this->errorId;
+        }
+
+        return $record;
+    }
+
+    public function onException(): void
+    {
+        $this->errorId = $this->errorIdProvider->getErrorId();
+    }
+
+    public function reset(): void
+    {
+        $this->errorId = null;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            KernelEvents::EXCEPTION => ['onException', 1],
+        ];
+    }
+}

src/Component/Error/ErrorIdLogProcessor.php

@@ -6,14 +6,14 @@
 
 use Shopsys\FrameworkBundle\Component\String\HashGenerator;
 
-class ErrorIdProvider
+final class ErrorIdProvider
 {
-    protected ?string $errorId = null;
+    private ?string $errorId = null;
 
     /**
      * @param \Shopsys\FrameworkBundle\Component\String\HashGenerator $hashGenerator
      */
-    public function __construct(protected readonly HashGenerator $hashGenerator)
+    public function __construct(private readonly HashGenerator $hashGenerator)
     {
     }