@abtnode/router-provider 1.16.14-beta-3127f514 → 1.16.14-beta-5ac0c68b

package/lib/nginx/includes/image-filter-args

@@ -0,0 +1,20 @@
+map $arg_w $image_width {
+    default 1200;
+    ~^(\d+)$ $1;
+}
+map $arg_h $image_height {
+    default -;
+    ~^(\d+)$ $1;
+}
+map $arg_r $image_rotate {
+    default 0;
+    ~^(\d+)$ $1;
+}
+map $arg_q $image_quality {
+    default 90;
+    ~^(\d+)$ $1;
+}
+map $arg_s $image_sharpen {
+    default 0;
+    ~^(\d+)$ $1;
+}

package/lib/nginx/includes/image-filter-crop

@@ -0,0 +1,13 @@
+image_filter_buffer 16M;
+image_filter rotate $image_rotate;
+image_filter crop $image_width $image_height;
+# FIXME: @wangshijun turn on this will improve jpeg and breaks png
+image_filter_interlace on;
+image_filter_transparency on;
+image_filter_jpeg_quality $image_quality;
+image_filter_webp_quality $image_quality;
+image_filter_sharpen $image_sharpen;
+
+add_header x-image-filter "c/w/$image_width/h/$image_height/q/$image_quality/s/$image_sharpen";
+
+error_page 415 = /error.svg;

package/lib/nginx/includes/image-filter-resize

@@ -0,0 +1,13 @@
+image_filter_buffer 16M;
+image_filter rotate $image_rotate;
+image_filter resize $image_width $image_height;
+# FIXME: @wangshijun turn on this will improve jpeg and breaks png
+image_filter_interlace on;
+image_filter_transparency on;
+image_filter_jpeg_quality $image_quality;
+image_filter_webp_quality $image_quality;
+image_filter_sharpen $image_sharpen;
+
+add_header x-image-filter "r/w/$image_width/h/$image_height/q/$image_quality/s/$image_sharpen";
+
+error_page 415 = /error.svg;

package/lib/nginx/index.js

@@ -8,6 +8,7 @@ const shelljs = require('shelljs');
 const kill = require('fkill');
 const getPort = require('get-port');
 const uniqBy = require('lodash/uniqBy');
+const camelCase = require('lodash/camelCase');
 const isEmpty = require('lodash/isEmpty');
 const formatBackSlash = require('@abtnode/util/lib/format-back-slash');
 const {
@@ -38,6 +39,7 @@ const {
   getMainTemplate,
   getUpstreamName,
   joinNginxPath,
+  getDynamicModuleDirective,
 } = require('./util');
 const {
   decideHttpPort,
@@ -109,7 +111,9 @@ class NginxProvider extends BaseProvider {
     this.httpPort = decideHttpPort(httpPort);
     this.httpsPort = decideHttpsPort(httpsPort);
     this.cacheEnabled = !!cacheEnabled;
-    this.isHttp2Supported = this._isHttp2Supported();
+
+    this.capabilities = this._checkCapabilities();
+
     this.conf = null; // nginx `conf` object
 
     logger.info('nginx provider config', {
@@ -142,6 +146,7 @@ class NginxProvider extends BaseProvider {
       cacheDir: this.getRelativeConfigDir(formatBackSlash(this.cacheDir)),
       workerProcess: this.getWorkerProcess(),
       nginxLoadModules: getNginxLoadModuleDirectives(REQUIRED_MODULES, this.readNginxConfigParams()).join(os.EOL),
+      capabilities: this.capabilities,
     });
   }
 
@@ -181,7 +186,7 @@ class NginxProvider extends BaseProvider {
         conf.on('flushed', () => resolve());
         conf.live(this.configPath);
 
-        const { sites, configs: siteCorsConfigs } = formatRoutingTable(routingTable);
+        const { sites, configs: siteCorsConfigs } = formatRoutingTable(routingTable, this.capabilities);
 
         this._addCorsMap(conf, siteCorsConfigs);
         conf.nginx.http._add('server_tokens', 'off');
@@ -339,9 +344,31 @@ class NginxProvider extends BaseProvider {
     return result;
   }
 
-  _isHttp2Supported() {
-    const configArgs = this.readNginxConfigParams();
-    return typeof configArgs['with-http_v2_module'] !== 'undefined';
+  _checkCapabilities() {
+    const config = this.readNginxConfigParams();
+    const capabilities = ['http_v2', 'http_image_filter', 'http_geoip'].reduce((acc, key) => {
+      const arg = `with-${key}_module`;
+      const capability = camelCase(key);
+
+      if (config[arg] === '') {
+        acc[capability] = 'static';
+      } else if (config[arg] === 'dynamic') {
+        acc[capability] = 'dynamic';
+      } else {
+        acc[capability] = false;
+      }
+
+      return acc;
+    }, {});
+
+    capabilities.modulesPath = config['modules-path'];
+    if (capabilities.modulesPath && getDynamicModuleDirective('httpBrotli', capabilities.modulesPath)) {
+      capabilities.httpBrotli = 'dynamic';
+    } else {
+      capabilities.httpBrotli = false;
+    }
+
+    return capabilities;
   }
 
   readNginxConfigParams() {
@@ -455,6 +482,7 @@ class NginxProvider extends BaseProvider {
     commonHeaders,
     cacheGroup,
     pageGroup,
+    filter,
   }) {
     server._add('location', concatPath(prefix, suffix));
 
@@ -489,6 +517,16 @@ class NginxProvider extends BaseProvider {
       location._add('proxy_cache_valid', `200 ${ROUTER_CACHE_GROUPS[cacheGroup].period}`);
       location._add('include', 'includes/cache');
     }
+    if (filter) {
+      location._add('include', `includes/image-filter-${filter}`);
+    } else if (ROUTER_CACHE_GROUPS[cacheGroup] && this.capabilities.httpImageFilter) {
+      location._add('set', '$filter "off"');
+      location._addVerbatimBlock(`if ($uri ~* "^${prefix}.*\\.(png|jpg|jpeg|webp)$")`, 'set $filter "on";');
+      location._addVerbatimBlock('if ($arg_imageFilter = "resize")', 'set $filter "${filter}resize";'); // eslint-disable-line no-template-curly-in-string
+      location._addVerbatimBlock('if ($arg_imageFilter = "crop")', 'set $filter "${filter}crop";'); // eslint-disable-line no-template-curly-in-string
+      location._addVerbatimBlock('if ($filter = "onresize")', `rewrite ${prefix}(.+) ${prefix}$1/resize last;`);
+      location._addVerbatimBlock('if ($filter = "oncrop")', `rewrite ${prefix}(.+) ${prefix}$1/crop last;`);
+    }
 
     // Redirect blocklet traffic
     if (type === ROUTING_RULE_TYPES.BLOCKLET) {
@@ -515,8 +553,12 @@ class NginxProvider extends BaseProvider {
       }
 
       // Rewrite path
-      location._add('rewrite', `^${rewritePathPrefix}/?(.*) /$1  break`);
-      location._add('proxy_pass', `http://${getUpstreamName(process.env.ABT_NODE_SERVICE_PORT)}/`);
+      if (filter) {
+        location._add('rewrite', `^${rewritePathPrefix}/?(.*)/${filter}$ /$1  break`);
+      } else {
+        location._add('rewrite', `^${rewritePathPrefix}/?(.*) /$1  break`);
+      }
+      location._add('proxy_pass', `http://${getUpstreamName(process.env.ABT_NODE_SERVICE_PORT)}`);
 
       return;
     }
@@ -809,7 +851,7 @@ class NginxProvider extends BaseProvider {
     const crtPath = `${joinNginxPath(this.certDir, certificateFileName.replace('*', '-'))}.crt`;
     const keyPath = `${joinNginxPath(this.certDir, certificateFileName.replace('*', '-'))}.key`;
 
-    let listen = `${this.httpsPort} ssl ${this.isHttp2Supported ? 'http2' : ''}`.trim();
+    let listen = `${this.httpsPort} ssl ${this.capabilities.httpV2 ? 'http2' : ''}`.trim();
     if (serverName === '_') {
       listen = `${listen} default_server`;
     }
@@ -1008,6 +1050,9 @@ NginxProvider.check = async ({ configDir = '' } = {}) => {
 
     return result;
   } catch (error) {
+    if (process.env.DEBUG) {
+      console.error(error);
+    }
     result.available = false;
     result.error = error.message;
     logger.error('check nginx failed', { error });

package/lib/nginx/util.js

@@ -147,6 +147,26 @@ const getWorkerConnectionCount = (maxWorkerConnections, workerProcess) => {
   return Math.min(maxWorkerConnections, Math.floor(ulimit / workerProcess));
 };
 
+const getDynamicModuleDirective = (moduleName, modulesPath) => {
+  const mapping = {
+    httpImageFilter: ['ngx_http_image_filter_module.so'],
+    httpGeoip: ['ngx_http_geoip_module.so', 'ngx_stream_geoip_module.so'],
+    httpBrotli: ['ngx_http_brotli_filter_module.so', 'ngx_http_brotli_static_module.so'],
+  };
+
+  return mapping[moduleName]
+    .filter((x) => fs.existsSync(path.join(modulesPath, x)))
+    .map((x) => `load_module ${modulesPath}/${x};`)
+    .join(os.EOL);
+};
+
+const getDynamicModulesDirective = (capabilities) => {
+  return Object.keys(capabilities)
+    .filter((x) => capabilities[x] === 'dynamic')
+    .map((x) => getDynamicModuleDirective(x, capabilities.modulesPath))
+    .join(os.EOL);
+};
+
 const getMainTemplate = ({
   logDir,
   tmpDir,
@@ -154,9 +174,10 @@ const getMainTemplate = ({
   nginxLoadModules = '',
   workerProcess,
   maxBodySize = CLIENT_MAX_BODY_SIZE,
+  capabilities = {},
 }) =>
-  `
-  ${nginxLoadModules}
+  `${nginxLoadModules}
+${getDynamicModulesDirective(capabilities)}
 worker_processes  ${workerProcess};
 error_log /dev/null crit;
 user ${os.userInfo().username} ${getUserGroup(os.userInfo().username)};
@@ -192,10 +213,11 @@ http {
     include includes/params;
     include includes/mime.types;
     include includes/compression;
+    ${capabilities.httpImageFilter ? 'include includes/image-filter-args;' : ''}
 
     ${Object.keys(ROUTER_CACHE_GROUPS)
       .map((x) => getCachePathDirective(cacheDir, x))
-      .join('\n')}
+      .join(os.EOL)}
 }
 `;
 
@@ -316,6 +338,8 @@ module.exports = {
   getUserGroup,
   getWorkerConnectionCount,
   getCachePathDirective,
+  getDynamicModuleDirective,
+  getDynamicModulesDirective,
   getUpstreamName,
   joinNginxPath,
 };

package/lib/util.js

@@ -3,6 +3,7 @@ const fs = require('fs-extra');
 const path = require('path');
 const getPort = require('get-port');
 const portUsed = require('port-used');
+const cloneDeep = require('lodash/cloneDeep');
 const sortBy = require('lodash/sortBy');
 const isValidDomain = require('is-valid-domain');
 const checkDomainMatch = require('@abtnode/util/lib/check-domain-match');
@@ -45,7 +46,7 @@ const concatPath = (prefix = '', suffix = '') => {
   return suffix ? `~* ^${prefix}.*${suffix}$` : prefix;
 };
 
-const formatRoutingTable = (routingTable, onRule) => {
+const formatRoutingTable = (routingTable, capabilities = {}) => {
   const sites = {};
   const configs = [];
 
@@ -105,13 +106,24 @@ const formatRoutingTable = (routingTable, onRule) => {
         rule.pageGroup = x.to.pageGroup;
       }
 
-      const tmpPath = concatPath(prefix, suffix);
-      const tmpRules = sites[domain].rules;
-      if (!tmpRules.find(({ prefix: p, suffix: s }) => concatPath(p, s) === tmpPath)) {
-        sites[domain].rules.push(rule);
-        if (typeof onRule === 'function') {
-          onRule(sites[domain].rules, rule);
+      const addRule = (r) => {
+        const tmpPath = concatPath(r.prefix, r.suffix);
+        const tmpRules = sites[domain].rules;
+        if (!tmpRules.find(({ prefix: p, suffix: s }) => concatPath(p, s) === tmpPath)) {
+          sites[domain].rules.push(r);
         }
+      };
+
+      addRule(rule);
+
+      // add image filter rules for each cacheable path
+      if (capabilities.httpImageFilter && rule.cacheGroup) {
+        ['resize', 'crop'].forEach((filter) => {
+          const filterRule = cloneDeep(rule);
+          rule.filter = filter;
+          rule.suffix = `\\.(png|jpg|jpeg|webp)/${filter}`;
+          addRule(filterRule);
+        });
       }
     });
 

package/lib/www/error.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="300" height="200" viewBox="0 0 300 200"><rect width="100%" height="100%" fill="#DDDDDD"/><path fill="#999999" d="M112.5 94.58q0 5.4-1.79 10.01-1.78 4.61-5.05 7.97-3.26 3.37-7.85 5.26-4.59 1.88-10.2 1.88-5.58 0-10.17-1.88-4.59-1.89-7.87-5.26-3.28-3.36-5.08-7.97-1.8-4.61-1.8-10.01 0-5.41 1.8-10.02 1.8-4.6 5.08-7.97 3.28-3.36 7.87-5.25 4.59-1.89 10.17-1.89 3.74 0 7.04.87 3.29.87 6.05 2.45 2.75 1.58 4.94 3.84 2.2 2.26 3.73 5.05 1.53 2.79 2.33 6.05t.8 6.87Zm-9.35 0q0-4.05-1.09-7.26t-3.1-5.46q-2-2.24-4.88-3.43-2.87-1.19-6.47-1.19-3.61 0-6.48 1.19-2.87 1.19-4.9 3.43-2.02 2.25-3.11 5.46-1.08 3.21-1.08 7.26 0 4.04 1.08 7.26 1.09 3.21 3.11 5.44 2.03 2.22 4.9 3.41 2.87 1.19 6.48 1.19 3.6 0 6.47-1.19 2.88-1.19 4.88-3.41 2.01-2.23 3.1-5.44 1.09-3.22 1.09-7.26Zm31.51-10.85q3.88 0 7.06 1.26 3.18 1.26 5.44 3.57 2.26 2.31 3.48 5.64 1.23 3.34 1.23 7.45 0 4.15-1.23 7.48-1.22 3.33-3.48 5.68-2.26 2.34-5.44 3.6-3.18 1.26-7.06 1.26-3.91 0-7.1-1.26-3.2-1.26-5.46-3.6-2.26-2.35-3.5-5.68-1.24-3.33-1.24-7.48 0-4.11 1.24-7.45 1.24-3.33 3.5-5.64 2.26-2.31 5.46-3.57 3.19-1.26 7.1-1.26Zm0 29.48q4.36 0 6.45-2.92 2.09-2.93 2.09-8.57 0-5.65-2.09-8.6-2.09-2.96-6.45-2.96-4.42 0-6.54 2.97-2.13 2.98-2.13 8.59 0 5.61 2.13 8.55 2.12 2.94 6.54 2.94Zm32.03-18.73v15.64q1.43 1.73 3.11 2.44 1.69.72 3.66.72 1.9 0 3.43-.72 1.53-.71 2.6-2.17t1.65-3.69q.58-2.23.58-5.25 0-3.06-.49-5.19-.5-2.12-1.41-3.45-.92-1.33-2.23-1.94-1.31-.61-2.98-.61-2.61 0-4.45 1.1-1.84 1.11-3.47 3.12Zm-1.12-8.67.68 3.23q2.14-2.42 4.86-3.91 2.72-1.5 6.39-1.5 2.86 0 5.22 1.19 2.37 1.19 4.08 3.45 1.72 2.26 2.66 5.58.93 3.31.93 7.6 0 3.91-1.05 7.24-1.06 3.33-3.01 5.78-1.96 2.45-4.73 3.82-2.77 1.38-6.2 1.38-2.93 0-5-.9-2.08-.9-3.71-2.5v14.28h-8.4V84.28h5.14q1.63 0 2.14 1.53Zm54.54 2.24-1.91 3.03q-.34.54-.71.76-.38.22-.95.22-.62 0-1.31-.34-.7-.34-1.62-.76-.92-.43-2.09-.77t-2.77-.34q-2.48 0-3.89 1.06-1.41 1.05-1.41 2.75 0 1.12.73 1.89.73.76 1.93 1.34 1.21.58 2.74 1.04 1.53.46 3.11 1 1.58.54 3.11 1.24 1.53.7 2.74 1.77 1.21 1.07 1.94 2.57.73 1.49.73 3.6 0 2.52-.9 4.64-.9 2.13-2.67 3.67-1.77 1.55-4.37 2.42-2.6.86-6 .86-1.8 0-3.52-.32t-3.3-.9q-1.58-.58-2.92-1.36-1.34-.78-2.36-1.7l1.93-3.2q.38-.57.89-.88.51-.31 1.29-.31t1.48.45q.7.44 1.61.95.92.51 2.16.95 1.24.44 3.15.44 1.49 0 2.56-.36 1.08-.35 1.77-.93.7-.58 1.02-1.34.33-.77.33-1.58 0-1.23-.73-2.01-.74-.78-1.94-1.36-1.21-.58-2.76-1.04-1.54-.46-3.16-1-1.61-.54-3.16-1.27-1.55-.74-2.76-1.86-1.2-1.12-1.93-2.75t-.73-3.95q0-2.14.85-4.08.85-1.93 2.5-3.38 1.64-1.44 4.11-2.31 2.46-.87 5.69-.87 3.61 0 6.57 1.19 2.95 1.19 4.93 3.13ZM228.3 70h7.89v19.44q0 3.1-.31 6.07-.3 2.98-.78 6.31h-5.71q-.48-3.33-.78-6.31-.31-2.97-.31-6.07V70Zm-1.33 44.54q0-1.06.4-2.01.39-.95 1.08-1.63.7-.68 1.65-1.09.95-.41 2.04-.41 1.06 0 2.01.41.95.41 1.65 1.09.69.68 1.1 1.63.41.95.41 2.01 0 1.08-.41 2.02-.41.93-1.1 1.61-.7.68-1.65 1.08-.95.39-2.01.39-1.09 0-2.04-.39-.95-.4-1.65-1.08-.69-.68-1.08-1.61-.4-.94-.4-2.02Z"/></svg>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abtnode/router-provider",
-  "version": "1.16.14-beta-3127f514",
+  "version": "1.16.14-beta-5ac0c68b",
   "description": "Routing engine implementations for abt node",
   "author": "polunzh <polunzh@gmail.com>",
   "homepage": "https://github.com/ArcBlock/blocklet-server#readme",
@@ -32,10 +32,10 @@
     "url": "https://github.com/ArcBlock/blocklet-server/issues"
   },
   "dependencies": {
-    "@abtnode/constant": "1.16.14-beta-3127f514",
-    "@abtnode/logger": "1.16.14-beta-3127f514",
-    "@abtnode/router-templates": "1.16.14-beta-3127f514",
-    "@abtnode/util": "1.16.14-beta-3127f514",
+    "@abtnode/constant": "1.16.14-beta-5ac0c68b",
+    "@abtnode/logger": "1.16.14-beta-5ac0c68b",
+    "@abtnode/router-templates": "1.16.14-beta-5ac0c68b",
+    "@abtnode/util": "1.16.14-beta-5ac0c68b",
     "@arcblock/http-proxy": "^1.19.1",
     "axios": "^0.27.2",
     "debug": "^4.3.4",
@@ -59,5 +59,5 @@
     "bluebird": "^3.7.2",
     "fs-extra": "^10.1.0"
   },
-  "gitHead": "cb397b94b752e71dfc0ba2c4ad08628cf03ce396"
+  "gitHead": "f38cb0f87e1eac8e5acf0106561972f4cc1207e8"
 }