Few improvements, see changelog.

Author: roquie

CHANGELOG.md

@@ -0,0 +1,26 @@
+## [2.0.1] - 2020-01-27
+
+Prerender option now more configurable and supports many of sets
+cloud-services or local instances.
+
+### Added
+
+- Option `server.prerender.resolver`. This is a nginx "resolver" option to force DNS resolution and prevent caching of IPs.
+- Option `server.prerender.headers` (array of headers). This is an authorization headers (or others), format: key - $headerName, value - $headerValue.
+
+### Changed
+
+- Option `server.prerender.url` accepts url with schema and will be passed to `proxy_pass` option as is.
+
+### Removed
+
+- Option `server.prerender.token`. Use `server.prerender.headers` option.
+
+
+## [2.0.0] - 2020-01-09
+
+Released new version of SPA-webserver.
+Full backward compatibility with previous 1.0.0 version except
+compression options (it not configurable more). From this version
+changelog will be started.
+

README.md

@@ -4,7 +4,7 @@ Static server
 [![CircleCI](https://circleci.com/gh/microparts/static-server-php/tree/master.svg?style=svg)](https://circleci.com/gh/microparts/static-server-php/tree/master)
 [![codecov](https://codecov.io/gh/microparts/static-server-php/branch/master/graph/badge.svg)](https://codecov.io/gh/microparts/static-server-php)
 
- Special static server with support corporate standard of configuration and more.
+Specific static server with support corporate standard of configuration and more..
 This server is a simple wrapper for nginx or an any web server.
 
 Server created for javascript SPA apps like: Vue, React, Angular, etc.
@@ -15,7 +15,7 @@ Server created for javascript SPA apps like: Vue, React, Angular, etc.
 * Secure headers by default.
 * If backend app will be hacked, the hacker may write a letter to us, because email address injected to head section of index (console message) :)
 * Corporate config standard supported by default and injected too.
-* Brotli-compression. Compression based on `Accept-Encoding` header. [More](#Compression).
+* Brotli-compression (Gzip used as fallback for outdated browsers). Enabled by default. [More](#Compression).
 * Deny all `robots.txt` by default.
 * Hot reload
 
@@ -107,6 +107,8 @@ server:
   prerender:
     enabled: false
     url: null
+    resolver: "8.8.8.8 8.8.4.4 1.1.1.1 1.0.0.1"
+    headers: []
   service_worker:
     enabled: false
   log_info: '%%cSTAGE=%s SHA1=%s; %%cSecurity bugs: [email protected], Job/partnership: [email protected]'

configuration/defaults/___server.yaml

@@ -18,7 +18,9 @@ defaults:
         config: ~/.server/generated_nginx.conf
     prerender:
       enabled: false
-      url: null
+      url: null # Proxy pass URL for bots, with schema.
+      resolver: "8.8.8.8 8.8.4.4 1.1.1.1 1.0.0.1" # nginx "resolver" option to force DNS resolution and prevent caching of IPs
+      headers: [] # Authorization headers (or others), format: key - $headerName, value - $headerValue
     log_info: "%%cSTAGE=%s SHA1=%s; %%cSecurity bugs: [email protected], Job/partnership: [email protected]"
     logger:
       enabled: true

configuration/defaults/___server_compress.yaml

@@ -1,5 +1,5 @@
 parameters:
   excludes_analyse:
     - src/Handler/templates/*
-  ignoreErrors:
-    - '#Call to an undefined method RecursiveDirectoryIterator\|RecursiveIteratorIterator\:\:getSubPathname\(\)#'
+#  ignoreErrors:
+#    - '#Call to an undefined method RecursiveDirectoryIterator\|RecursiveIteratorIterator\:\:getSubPathname\(\)#'

phpstan.neon

@@ -69,7 +69,7 @@ protected function touchFile(string $filename): void
     }
 
     /**
-     * @param array $paths
+     * @param array<string> $paths
      */
     protected function makePathForFiles(array $paths): void
     {

src/Handler/AbstractHandler.php

@@ -79,7 +79,8 @@ public function generateConfig(HeaderInterface $header): void
             'serverHost' => $this->configuration->get('server.host'),
             'prerenderEnabled' => $this->configuration->get('server.prerender.enabled'),
             'prerenderUrl' => $this->getHostWithoutTrailingSlash('server.prerender.url'),
-            'prerenderToken' => $this->configuration->get('server.prerender.token'),
+            'prerenderHeaders' => $this->configuration->get('server.prerender.headers', []),
+            'prerenderResolver' => $this->configuration->get('server.prerender.resolver', false),
             'prerenderHost' => $this->getHostWithoutTrailingSlash('server.prerender.host'),
             'headers' => $header->convert($this->configuration),
             'connProcMethod' => $this->getConnectionProcessingMethod(),
@@ -172,18 +173,18 @@ private function checkIfPrerenderUrlIsAvailable(): void
             return;
         }
 
-        $scheme = parse_url($this->configuration->get('server.prerender.url', ''), PHP_URL_SCHEME);
-
-        if ($scheme) {
-            throw new InvalidArgumentException("Prerender url has a scheme: [$scheme], please remove it.");
-        }
-
         $url = $this->configuration->get('server.prerender.url', false);
 
         if (!$url) {
             throw new InvalidArgumentException('Prerender URL not set. Check server.prerender.url config key.');
         }
 
+        $url = (string) parse_url($url, PHP_URL_HOST);
+
+        if (strlen($url) < 1) {
+            throw new InvalidArgumentException('Prerender URL is invalid. Check server.prerender.url config key.');
+        }
+
         $this->logger->info('Ping prerender url...');
 
         $ping = new Ping($url);

src/Handler/NginxHandler.php

@@ -131,7 +131,7 @@
     open_file_cache_errors on;
 
     # to boost I/O on HDD we can disable access logs
-    access_log on;
+    access_log off;
 
     # copies data between one FD and other from within the kernel
     # faster than read() + write()
@@ -254,38 +254,39 @@
             }
 
             location @prerender {
-                <?php if ($prerenderEnabled && $prerenderToken):?>
-                  proxy_set_header X-Prerender-Token "<?=$prerenderToken?>";
-                <?php endif;?>
+                <?php foreach($prerenderHeaders as $name => $value):?>
+                  add_header "<?=$name?>" "<?=addslashes($value)?>";
+                <?php endforeach;?>
 
                 proxy_read_timeout 120s;
                 proxy_intercept_errors on;
                 proxy_buffering        on;
                 proxy_cache            STATIC;
-                proxy_cache_valid      200  12h;
+                proxy_cache_valid      200 404 24h;
                 proxy_cache_use_stale  error timeout invalid_header updating http_500 http_502 http_503 http_504;
 
                 set $prerender 0;
-                if ($http_user_agent ~* "googlebot|bingbot|yandex|baiduspider|twitterbot|facebookexternalhit|rogerbot|linkedinbot|embedly|quora link preview|showyoubot|outbrain|pinterest\/0\.|pinterestbot|slackbot|vkShare|W3C_Validator|whatsapp|telegram|bot") {
+                if ($http_user_agent ~* "bot|whatsapp|telegram|google|bing|yandex|baiduspider|twitterbot|facebookexternalhit|rogerbot|linkedin|embedly|quora link preview|showyoubot|outbrain|pinterest\/0\.|pinterestbot|slackbot|vkShare|W3C_Validator") {
                     set $prerender 1;
                 }
 
                 if ($args ~ "_escaped_fragment_") {
                     set $prerender 1;
                 }
 
-                if ($http_user_agent ~ "Prerender") {
+                if ($http_user_agent ~* "prerender") {
                     set $prerender 0;
                 }
 
-                # resolve using Google's DNS/Cloudflare server to force DNS resolution and prevent caching of IPs
-                resolver 8.8.8.8 8.8.4.4 1.1.1.1 1.0.0.1;
+                <?php if ($prerenderResolver):?>
+                    # resolve using Google's DNS/Cloudflare server to force DNS resolution and prevent caching of IPs
+                    resolver <?=$prerenderResolver?>;
+                <?php endif;?>
 
                 if ($prerender = 1) {
                     #setting prerender as a variable forces DNS resolution since nginx caches IPs and doesnt play well with load balancing
-                    set $prerender "<?=$prerenderUrl?>";
-                    rewrite .* /<?=$prerenderHost?>$request_uri? break;
-                    proxy_pass https://$prerender;
+                    rewrite .* /<?=$prerenderHost?>$request_uri?$query_string break;
+                    proxy_pass "<?=$prerenderUrl?>";
                 }
 
                 if ($prerender = 0) {

src/Handler/templates/nginx_default.conf.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types=1);
+
+namespace StaticServer\Tests\Modifier;
+
+use Microparts\Configuration\Configuration;
+use Psr\Log\NullLogger;
+use StaticServer\Modifier\Iterator\RecursiveIterator;
+use StaticServer\Modifier\Modify;
+use StaticServer\Modifier\ModifyInterface;
+use StaticServer\Modifier\NullModify;
+use StaticServer\Tests\TestCase;
+
+class ModifyTest extends TestCase
+{
+    public function testAddFilesToModify()
+    {
+        $conf = new Configuration(__DIR__ . '/../configuration', 'nested');
+        $conf->load();
+
+        $m = new Modify();
+        $m->setLogger(new NullLogger());
+        $m->setConfiguration($conf);
+        $m->addModifier(new NullModify());
+        $m->addTemplate(__FILE__, '/foobar');
+
+        $it = new RecursiveIterator();
+        $it->setLogger(new NullLogger());
+        $it->setConfiguration($conf);
+        /** @var \StaticServer\Modifier\Iterator\Transfer[] $array */
+        $m->modifyAndSaveToDisk($it->iterate());
+
+        $path = realpath($conf->get('server.modify.root'));
+        $this->assertFileExists($path . '/nested/bla-bla.txt');
+        $this->assertFileExists($path . '/foobar');
+        $this->assertEquals(file_get_contents(__FILE__), file_get_contents($path . '/foobar'));
+    }
+}

tests/example_dist/simple/modified/foobar

@@ -0,0 +1 @@
+-