first version

mhujer · mhujer · commit 3ee0c7d9b58a · 2017-10-23T18:10:08.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/composer.lock
+/vendor
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,18 @@
+language: php
+
+php:
+  - 7.1
+  - 7.2
+
+env:
+  - # default environment without variables
+  - COMPOSER_DEPENDENCIES_OPTIONS="--prefer-lowest --prefer-stable"
+
+install:
+  - composer update --no-progress --no-interaction --no-suggest ${COMPOSER_DEPENDENCIES_OPTIONS}
+
+script:
+  - composer run build
+
+after_script:
+  - php vendor/bin/coveralls -v
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) Martin Hujer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
diff --git a/README.md b/README.md
@@ -0,0 +1,59 @@
+# JavaScriptErrorHandlerBundle
+[![Build Status](https://travis-ci.org/mhujer/JavaScriptErrorHandlerBundle.svg?branch=master)](https://travis-ci.org/mhujer/JavaScriptErrorHandlerBundle)  [![Coverage Status](https://coveralls.io/repos/github/mhujer/JavaScriptErrorHandlerBundle/badge.svg?branch=dev)](https://coveralls.io/github/mhujer/JavaScriptErrorHandlerBundle?branch=dev) [![Latest Stable Version](https://poser.pugx.org/mhujer/javascript-error-handler-bundle/v/stable)](https://packagist.org/packages/mhujer/javascript-error-handler-bundle) [![License](https://poser.pugx.org/mhujer/javascript-error-handler-bundle/license)](https://packagist.org/packages/mhujer/javascript-error-handler-bundle)
+
+It is easy to break the JavaScript in the application while doing some non-JS change. And if you don't have the browser console open, you may not notice it.
+
+This Bundle injects a JavaScript handler, which converts JavaScript errors to `alert()`. So they can't hide in the console unnoticed.
+
+
+Usage
+----
+1. Install the latest version with `composer require mhujer/javascript-error-handler-bundle`
+2. Register the Bundle in the `AppKernel.php`:
+
+```php
+<?php
+
+class AppKernel extends \Symfony\Component\HttpKernel\Kernel
+{
+
+	...
+
+	public function registerBundles()
+	{
+		$bundles = [
+			...
+			new \Mhujer\JavaScriptErrorHandlerBundle\JavaScriptErrorHandlerBundle(),
+		];
+
+	}
+
+```
+
+Configuration
+-------
+The Bundle is automatically enabled only in `dev` mode (by using `kernel.debug` configuration option).
+
+You can configure it manually by adding this to your `config.yml`:
+
+```yaml
+java_script_error_handler:
+    enabled: '%kernel.debug%'
+```
+
+
+Requirements
+------------
+PHP 7.1/7.2 and Symfony 3.3+.
+
+
+Author
+------
+[Martin Hujer](https://www.martinhujer.cz) 
+
+
+Changelog
+----------
+
+### 0.1 (2017-10-23)
+- initial release
diff --git a/build/logs/.gitignore b/build/logs/.gitignore
@@ -0,0 +1,2 @@
+coverage-report
+clover.xml
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
 	"name": "mhujer/javascript-error-handler-bundle",
 	"type": "library",
-	"description": "",
+	"description": "Converts JavaScript errors to alerts, so you won't miss them if you don't have the browser console open.",
 	"keywords": [
 		"javascript",
 		"symfony",
@@ -15,5 +15,46 @@
 			"email": "mhujer@gmail.com",
 			"homepage": "https://www.martinhujer.cz"
 		}
-	]
+	],
+	"require": {
+		"php": "7.1.*||7.2.*",
+		"symfony/symfony": "~3.3|~4.0"
+	},
+	"require-dev": {
+		"consistence/coding-standard": "2.2.1",
+		"jakub-onderka/php-parallel-lint": "0.9.2",
+		"phpstan/phpstan-shim": "0.8.4",
+		"phpunit/phpunit": "6.4.3",
+		"satooshi/php-coveralls": "1.0.1"
+	},
+	"autoload": {
+		"psr-4": {
+			"Mhujer\\JavaScriptErrorHandlerBundle\\": [
+				"src"
+			]
+		},
+		"classmap": [
+			"src"
+		]
+	},
+	"autoload-dev": {
+		"psr-4": {
+			"Mhujer\\JavaScriptErrorHandlerBundle\\": [
+				"tests"
+			]
+		}
+	},
+	"scripts": {
+		"build": [
+			"@composer validate --no-check-all",
+			"@phplint",
+			"@phpcs",
+			"@phpstan",
+			"@phpunit"
+		],
+		"phplint": "parallel-lint src tests",
+		"phpcs": "phpcs --standard=ruleset.xml src tests",
+		"phpstan": "php vendor/phpstan/phpstan-shim/phpstan.phar analyse src tests --level 7 --no-progress",
+		"phpunit": "phpunit"
+	}
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- https://phpunit.de/manual/current/en/appendixes.configuration.html -->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.4/phpunit.xsd"
+		 bootstrap="vendor/autoload.php"
+		 colors="true"
+		 failOnRisky="true"
+		 verbose="true"
+		 beStrictAboutChangesToGlobalState="true"
+		 beStrictAboutOutputDuringTests="true"
+>
+	<testsuites>
+		<testsuite name="Project Test Suite">
+			<directory>tests</directory>
+		</testsuite>
+	</testsuites>
+
+	<filter>
+		<whitelist processUncoveredFilesFromWhitelist="true">
+			<directory suffix=".php">src</directory>
+		</whitelist>
+	</filter>
+
+	<logging>
+		<log type="coverage-clover" target="build/logs/clover.xml"/>
+		<log type="coverage-html" target="build/logs/coverage-report"/>
+	</logging>
+</phpunit>
diff --git a/ruleset.xml b/ruleset.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<ruleset name="JavaScriptErrorHandlerBundle">
+	<exclude-pattern>vendor/</exclude-pattern>
+	<rule ref="vendor/consistence/coding-standard/Consistence/ruleset.xml">
+		<!-- we don't want to have FQCN after extends/implements -->
+		<exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameAfterKeyword"/>
+	</rule>
+</ruleset>
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Mhujer\JavaScriptErrorHandlerBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+class Configuration implements ConfigurationInterface
+{
+
+	/** @var bool */
+	private $enabledDefaultValue;
+
+	public function __construct(
+		bool $enabledDefaultValue
+	)
+	{
+		$this->enabledDefaultValue = $enabledDefaultValue;
+	}
+
+	public function getConfigTreeBuilder(): TreeBuilder
+	{
+		$treeBuilder = new TreeBuilder();
+		$rootNode = $treeBuilder->root('java_script_error_handler');
+
+		// @codingStandardsIgnoreStart tree is indented for better readability
+		$rootNode
+			->children()
+				->booleanNode('enabled')->defaultValue($this->enabledDefaultValue)->end()
+			->end();
+		// @codingStandardsIgnoreEnd
+
+		return $treeBuilder;
+	}
+
+}
diff --git a/src/DependencyInjection/JavaScriptErrorHandlerExtension.php b/src/DependencyInjection/JavaScriptErrorHandlerExtension.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Mhujer\JavaScriptErrorHandlerBundle\DependencyInjection;
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+
+class JavaScriptErrorHandlerExtension extends Extension
+{
+
+	/**
+	 * Configures the passed container according to the merged configuration.
+	 *
+	 * @param mixed[] $configs
+	 * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
+	 */
+	public function load(array $configs, ContainerBuilder $container): void
+	{
+		$configuration = $this->getConfiguration($configs, $container);
+		$config = $this->processConfiguration($configuration, $configs);
+
+		$enabled = $config['enabled'];
+
+		if ($enabled) {
+			$loader = new YamlFileLoader($container, new FileLocator(__DIR__ . '/config'));
+			$loader->load('kernel_response_listener.yml');
+		}
+	}
+
+	/**
+	 * @param mixed[] $config An array of configuration values
+	 * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
+	 * @return \Mhujer\JavaScriptErrorHandlerBundle\DependencyInjection\Configuration
+	 */
+	public function getConfiguration(array $config, ContainerBuilder $container): Configuration
+	{
+		return new Configuration($container->getParameter('kernel.debug'));
+	}
+
+}
diff --git a/src/DependencyInjection/config/kernel_response_listener.yml b/src/DependencyInjection/config/kernel_response_listener.yml
@@ -0,0 +1,5 @@
+services:
+    Mhujer\JavaScriptErrorHandlerBundle\EventListener\JsErrorToAlertListener:
+        tags:
+            -
+                name: kernel.event_subscriber
diff --git a/src/EventListener/JsErrorToAlertListener.php b/src/EventListener/JsErrorToAlertListener.php
@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Mhujer\JavaScriptErrorHandlerBundle\EventListener;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+class JsErrorToAlertListener implements EventSubscriberInterface
+{
+
+	public function onKernelResponse(FilterResponseEvent $event): void
+	{
+		$response = $event->getResponse();
+		$request = $event->getRequest();
+
+		if (!$event->isMasterRequest()) {
+			return;
+		}
+
+		if ($request->isXmlHttpRequest()) {
+			return;
+		}
+
+		if ($response->isRedirection()) {
+			return;
+		}
+
+		if ($response->headers->has('Content-Type') && strpos($response->headers->get('Content-Type'), 'html') === false) {
+			return;
+		}
+
+		if ($request->getRequestFormat() !== 'html') {
+			return;
+		}
+
+		if ($response->headers->has('Content-Disposition') && stripos($response->headers->get('Content-Disposition'), 'attachment;') !== false) {
+			return;
+		}
+
+		$this->injectScript($response, $request);
+	}
+
+	protected function injectScript(Response $response, Request $request): void
+	{
+		$content = $response->getContent();
+		$pos = stripos($content, '<head>');
+
+		if ($pos !== false) {
+			$toolbar = "\n\n" . '
+	<script type="text/javascript">
+		window.onerror = function (errorMessage, url, line, col, error) {
+			alert(
+				errorMessage + "\n\n" +
+				error.stack
+			);
+		};
+	</script>
+' . "\n";
+			$content = substr($content, 0, $pos + 6) . $toolbar . substr($content, $pos + 6);
+			$response->setContent($content);
+		}
+	}
+
+	/**
+	 * @return mixed[]
+	 */
+	public static function getSubscribedEvents(): array
+	{
+		return [
+			KernelEvents::RESPONSE => ['onKernelResponse', -200],
+		];
+	}
+
+}
diff --git a/src/JavaScriptErrorHandlerBundle.php b/src/JavaScriptErrorHandlerBundle.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Mhujer\JavaScriptErrorHandlerBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class JavaScriptErrorHandlerBundle extends Bundle
+{
+
+}
diff --git a/tests/EventListener/JsErrorToAlertListenerTest.php b/tests/EventListener/JsErrorToAlertListenerTest.php
