@abtnode/router-provider 1.6.21 → 1.6.24

package/lib/nginx/util.js

@@ -8,13 +8,12 @@ const { NginxConfFile } = require('nginx-conf');
 const shelljs = require('shelljs');
 const findProcess = require('find-process');
 const moment = require('moment');
-const { MAX_UPLOAD_FILE_SIZE, DEFAULT_HTTP_PORT, DEFAULT_HTTPS_PORT } = require('@abtnode/constant');
-const checkDomainMatch = require('@abtnode/util/lib/check-domain-match');
-const { template404, template502, template5xx, templateWelcome } = require('@abtnode/router-templates');
-const logger = require('@abtnode/logger')(`${require('../../package.json').name}:provider:nginx:util`);
+const { MAX_UPLOAD_FILE_SIZE } = require('@abtnode/constant');
+
+const logger = require('@abtnode/logger')('router:nginx:util');
 
-const CLIENT_MAX_BODY_SIZE = process.env.MAX_UPLOAD_FILE_SIZE || MAX_UPLOAD_FILE_SIZE;
 const WORKER_CONNECTIONS = 1000 * 10; // 10K
+const CLIENT_MAX_BODY_SIZE = process.env.MAX_UPLOAD_FILE_SIZE || MAX_UPLOAD_FILE_SIZE;
 
 const formatError = (errStr) => {
   if (!errStr) {
@@ -43,10 +42,10 @@ const formatError = (errStr) => {
   ).join(';');
 };
 
-const addTestServer = ({ configFilePath, port, upstreamPort }) =>
+const addTestServer = ({ configPath, port, upstreamPort }) =>
   new Promise((resolve, reject) => {
     // eslint-disable-next-line consistent-return
-    NginxConfFile.create(configFilePath, async (err, conf) => {
+    NginxConfFile.create(configPath, async (err, conf) => {
       if (err) {
         return reject(err);
       }
@@ -74,7 +73,7 @@ const addTestServer = ({ configFilePath, port, upstreamPort }) =>
       );
 
       conf.on('flushed', () => resolve());
-      conf.live(configFilePath);
+      conf.live(configPath);
       conf.flush();
     });
   });
@@ -131,7 +130,7 @@ const getUserGroup = (username) => {
 
 const getMainTemplate = ({
   logDir,
-  tmpDirectory,
+  tmpDir,
   nginxLoadModules = '',
   workerProcess,
   maxBodySize = CLIENT_MAX_BODY_SIZE,
@@ -152,11 +151,11 @@ http {
       default upgrade;
       '' close;
     }
-    client_body_temp_path ${path.join(tmpDirectory, 'client_body')};
-    proxy_temp_path ${path.join(tmpDirectory, 'proxy')};
-    fastcgi_temp_path ${path.join(tmpDirectory, 'fastcgi')};
-    uwsgi_temp_path ${path.join(tmpDirectory, 'uwsgi')};
-    scgi_temp_path ${path.join(tmpDirectory, 'scgi')};
+    client_body_temp_path ${path.join(tmpDir, 'client_body')};
+    proxy_temp_path ${path.join(tmpDir, 'proxy')};
+    fastcgi_temp_path ${path.join(tmpDir, 'fastcgi')};
+    uwsgi_temp_path ${path.join(tmpDir, 'uwsgi')};
+    scgi_temp_path ${path.join(tmpDir, 'scgi')};
     client_max_body_size ${maxBodySize}m;
 
     log_format compression '$remote_addr - $remote_user [$time_local] '
@@ -174,7 +173,7 @@ http {
 const getNginxStatus = async (configPath) => {
   const list = await findProcess('name', /nginx:/);
   const result = {
-    ownByABTNode: false,
+    managed: false,
     pid: 0,
     running: false,
   };
@@ -184,7 +183,7 @@ const getNginxStatus = async (configPath) => {
     result.running = true;
 
     if (abtnodeNginxProcess) {
-      result.ownByABTNode = true;
+      result.managed = true;
       result.pid = abtnodeNginxProcess.pid;
     }
 
@@ -194,37 +193,6 @@ const getNginxStatus = async (configPath) => {
   return result;
 };
 
-const decideHttpPort = (port) => port || process.env.ABT_NODE_HTTP_PORT || DEFAULT_HTTP_PORT;
-const decideHttpsPort = (port) => port || process.env.ABT_NODE_HTTPS_PORT || DEFAULT_HTTPS_PORT;
-
-const findCertificate = (certs, domain) => {
-  const results = certs
-    .filter((cert) => [cert.domain, ...(cert.sans || [])].some((d) => checkDomainMatch(d, domain)))
-    .sort((d1) => (d1.domain[0] === '*' ? 1 : -1)); // will first match a.b.com, then *.b.com
-  return results[0];
-};
-
-/**
- * trim tail slash
- * @param {string} str
- * @returns {string}
- */
-const trimEndSlash = (str) => {
-  if (str && str.length > 1 && str[str.length - 1] === '/') {
-    return str.substr(0, str.length - 1);
-  }
-
-  return str;
-};
-
-const concatPath = (prefix = '', suffix = '') => {
-  if (prefix === '/') {
-    return suffix ? `~* .*${suffix}$` : '/';
-  }
-
-  return suffix ? `~* ^${prefix}.*${suffix}$` : prefix;
-};
-
 const compressFile = ({ sourceFile, targetFile, options = {} }) => {
   if (fs.existsSync(targetFile)) {
     fs.unlinkSync(targetFile);
@@ -297,16 +265,7 @@ module.exports = {
   formatError,
   getMissingModules,
   parseNginxConfigArgs,
-  decideHttpPort,
-  decideHttpsPort,
-  concatPath,
-  trimEndSlash,
-  findCertificate,
   getNginxStatus,
   rotateNginxLogFile,
   getUserGroup,
-  get404Template: (nodeInfo) => template404(nodeInfo),
-  get502Template: (nodeInfo) => template502(nodeInfo),
-  get5xxTemplate: (nodeInfo) => template5xx(nodeInfo),
-  getWelcomeTemplate: (nodeInfo) => templateWelcome(nodeInfo),
 };

package/lib/util.js

@@ -0,0 +1,165 @@
+const sortBy = require('lodash/sortBy');
+const isValidDomain = require('is-valid-domain');
+const checkDomainMatch = require('@abtnode/util/lib/check-domain-match');
+const normalizePathPrefix = require('@abtnode/util/lib/normalize-path-prefix');
+const { template404, template502, template5xx, templateWelcome } = require('@abtnode/router-templates');
+
+const {
+  IP,
+  DEFAULT_HTTP_PORT,
+  DEFAULT_HTTPS_PORT,
+  DEFAULT_IP_DNS_DOMAIN_SUFFIX,
+  DOMAIN_FOR_DEFAULT_SITE,
+  ROUTING_RULE_TYPES,
+  SLOT_FOR_IP_DNS_SITE,
+} = require('@abtnode/constant');
+
+const decideHttpPort = (port) => port || process.env.ABT_NODE_HTTP_PORT || DEFAULT_HTTP_PORT;
+const decideHttpsPort = (port) => port || process.env.ABT_NODE_HTTPS_PORT || DEFAULT_HTTPS_PORT;
+
+const findCertificate = (certs, domain) => {
+  const results = certs
+    .filter((cert) => [cert.domain, ...(cert.sans || [])].some((d) => checkDomainMatch(d, domain)))
+    .sort((d1) => (d1.domain[0] === '*' ? 1 : -1)); // will first match a.b.com, then *.b.com
+  return results[0];
+};
+
+const trimEndSlash = (str) => {
+  if (str && str.length > 1 && str[str.length - 1] === '/') {
+    return str.substr(0, str.length - 1);
+  }
+
+  return str;
+};
+
+const concatPath = (prefix = '', suffix = '') => {
+  if (prefix === '/') {
+    return suffix ? `~* .*${suffix}$` : '/';
+  }
+
+  return suffix ? `~* ^${prefix}.*${suffix}$` : prefix;
+};
+
+const formatRoutingTable = (routingTable, onRule) => {
+  const sites = {};
+  const configs = [];
+
+  routingTable.forEach((site) => {
+    let { domain } = site;
+    if (site.domain === DOMAIN_FOR_DEFAULT_SITE) {
+      domain = '_';
+    }
+
+    configs.push({ domain, corsAllowedOrigins: site.corsAllowedOrigins });
+
+    if (!sites[domain]) {
+      sites[domain] = {
+        domain,
+        rules: [],
+        port: site.port,
+        corsAllowedOrigins: site.corsAllowedOrigins,
+      };
+    }
+
+    (site.rules || []).forEach((x) => {
+      const prefix = trimEndSlash(x.from.pathPrefix || '/');
+      const groupPrefix = trimEndSlash(x.from.groupPathPrefix || '/');
+      const suffix = trimEndSlash(x.from.pathSuffix || '');
+
+      const rule = {
+        ruleId: x.id,
+        type: x.to.type,
+        prefix,
+        groupPrefix,
+        suffix,
+        response: x.to.response,
+      };
+      if (x.to.type === ROUTING_RULE_TYPES.REDIRECT) {
+        rule.redirectCode = x.to.redirectCode || 302;
+        rule.url = x.to.url;
+      } else {
+        rule.port = +x.to.port;
+        rule.did = x.to.did;
+        rule.realDid = x.to.realDid;
+        rule.target = trimEndSlash(normalizePathPrefix(x.to.target || '/'));
+        rule.services = x.services || [];
+      }
+
+      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 { rules } = sites[domain];
+    const rulesWithoutSuffix = sortBy(rules.filter((x) => !x.suffix), (x) => -x.prefix.length); // prettier-ignore
+    const rulesWithSuffix = sortBy(rules.filter((x) => x.suffix), (x) => -x.prefix.length); // prettier-ignore
+
+    sites[domain].rules = rulesWithoutSuffix.concat(rulesWithSuffix);
+  });
+
+  return { sites: Object.values(sites), configs };
+};
+
+const isSpecificDomain = (domain) => {
+  if (isValidDomain(domain) === false) {
+    return false;
+  }
+
+  if (domain.endsWith(DEFAULT_IP_DNS_DOMAIN_SUFFIX)) {
+    return false;
+  }
+
+  return true;
+};
+
+const toSlotDomain = (domain) => {
+  if (domain.endsWith(DEFAULT_IP_DNS_DOMAIN_SUFFIX)) {
+    const subDomain = domain.split('.').shift();
+    const matches = subDomain.match(IP);
+    if (matches) {
+      return domain.replace(matches[0].slice(1), SLOT_FOR_IP_DNS_SITE);
+    }
+  }
+
+  return domain;
+};
+
+const findRule = (rules, url) =>
+  rules.find((x) => {
+    const { prefix, suffix = '' } = x;
+    if (suffix) {
+      return url.startsWith(prefix) && url.endsWith(suffix);
+    }
+
+    if (prefix === '/' && prefix === url) {
+      return true;
+    }
+
+    return url.startsWith(prefix);
+  });
+const matchRule = (rules, url) => {
+  const rulesWithSuffix = rules.filter((x) => x.suffix);
+  const rulesWithoutSuffix = rules.filter((x) => !x.suffix);
+  return findRule(rulesWithSuffix, url) || findRule(rulesWithoutSuffix, url);
+};
+
+module.exports = {
+  decideHttpPort,
+  decideHttpsPort,
+  findCertificate,
+  concatPath,
+  trimEndSlash,
+  formatRoutingTable,
+  isSpecificDomain,
+  toSlotDomain,
+  matchRule,
+  get404Template: (info) => template404(info),
+  get502Template: (info) => template502(info),
+  get5xxTemplate: (info) => template5xx(info),
+  getWelcomeTemplate: (info) => templateWelcome(info),
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abtnode/router-provider",
-  "version": "1.6.21",
+  "version": "1.6.24",
   "description": "Routing engine implementations for abt node",
   "author": "polunzh <polunzh@gmail.com>",
   "homepage": "https://github.com/ArcBlock/blocklet-server#readme",
@@ -32,25 +32,34 @@
     "url": "https://github.com/ArcBlock/blocklet-server/issues"
   },
   "dependencies": {
-    "@abtnode/constant": "1.6.21",
-    "@abtnode/logger": "1.6.21",
-    "@abtnode/router-templates": "1.6.21",
-    "@abtnode/util": "1.6.21",
+    "@abtnode/constant": "1.6.24",
+    "@abtnode/logger": "1.6.24",
+    "@abtnode/router-templates": "1.6.24",
+    "@abtnode/util": "1.6.24",
     "axios": "^0.25.0",
     "debug": "^4.3.3",
     "find-process": "^1.4.3",
     "fkill": "^7.0.1",
     "fs-extra": "^10.0.0",
     "get-port": "^5.1.1",
+    "http-proxy": "^1.18.1",
+    "is-valid-domain": "^0.1.6",
     "lodash": "^4.17.21",
+    "lru-cache": "^7.4.0",
     "moment": "^2.29.1",
     "nginx-conf": "^1.5.0",
+    "object-hash": "^3.0.0",
     "promise-retry": "^2.0.1",
     "shelljs": "^0.8.4",
-    "tar": "^6.1.0"
+    "tar": "^6.1.0",
+    "url-join": "^4.0.1",
+    "uuid": "^8.3.2",
+    "valid-url": "^1.0.9"
   },
   "devDependencies": {
-    "fs-extra": "^10.0.0"
+    "bluebird": "^3.7.2",
+    "fs-extra": "^10.0.0",
+    "needle": "^3.0.0"
   },
-  "gitHead": "864ae21711c119948475057a1f634fd7d16ae91a"
+  "gitHead": "6bd8792a155ebbbefea6ca3d42c5b59b354d9879"
 }

package/lib/none/index.js

@@ -1,50 +0,0 @@
-/* eslint-disable no-empty-function */
-const BaseProvider = require('../base');
-
-class NoneProvider extends BaseProvider {
-  constructor() {
-    super('none');
-  }
-
-  async update() {}
-
-  async reload() {}
-
-  async start() {}
-
-  async restart() {}
-
-  async stop() {}
-
-  initialize() {}
-
-  async validateConfig() {}
-
-  async rotateLogs() {}
-}
-
-NoneProvider.describe = () => {
-  const result = NoneProvider.check();
-  return {
-    name: 'none',
-    description: 'This provider does nothing, you must access blocklets through IP + Port',
-    error: result.error,
-    available: result.available,
-    running: result.running,
-  };
-};
-
-NoneProvider.check = () => ({
-  available: true,
-  running: true,
-  error: '',
-});
-
-NoneProvider.getStatus = () => ({
-  pid: 0,
-  running: false,
-});
-
-NoneProvider.exists = () => true;
-
-module.exports = NoneProvider;