@abtnode/router-provider 1.8.65-beta-5405baf2 → 1.8.65-beta-bfcc12ce

package/lib/nginx/includes/cache

@@ -0,0 +1,6 @@
+proxy_cache_key $scheme$proxy_host$request_uri;
+proxy_cache_bypass $cookie_nocache $arg_nocache;
+proxy_cache_lock on;
+proxy_cache_revalidate on;
+
+add_header X-Cache-Status $upstream_cache_status;

package/lib/nginx/index.js

@@ -18,7 +18,9 @@ const {
   DEFAULT_ADMIN_PATH,
   SLOT_FOR_IP_DNS_SITE,
   WELLKNOWN_SERVICE_PATH_PREFIX,
+  USER_AVATAR_PATH_PREFIX,
   LOG_RETAIN_IN_DAYS,
+  ROUTER_CACHE_GROUPS,
 } = require('@abtnode/constant');
 const md5 = require('@abtnode/util/lib/md5');
 
@@ -101,6 +103,7 @@ class NginxProvider extends BaseProvider {
     this.errorLog = path.join(this.logDir, 'error.log');
     this.tmpDir = path.join(this.configDir, 'tmp');
     this.certDir = path.join(this.configDir, 'certs');
+    this.cacheDir = path.join(this.configDir, 'cache');
     this.includesDir = path.join(this.configDir, 'includes');
     this.wwwDir = path.join(this.configDir, 'www');
 
@@ -120,7 +123,7 @@ class NginxProvider extends BaseProvider {
     });
 
     // ensure directories
-    [this.configDir, this.logDir, this.tmpDir, this.certDir].forEach((dir) => {
+    [this.configDir, this.logDir, this.cacheDir, this.tmpDir, this.certDir].forEach((dir) => {
       if (!fs.existsSync(dir)) {
         fs.mkdirSync(dir);
       }
@@ -143,6 +146,7 @@ class NginxProvider extends BaseProvider {
     return getMainTemplate({
       logDir: this.getRelativeConfigDir(formatBackSlash(this.logDir)),
       tmpDir: this.getRelativeConfigDir(formatBackSlash(this.tmpDir)),
+      cacheDir: this.getRelativeConfigDir(formatBackSlash(this.cacheDir)),
       workerProcess: this.getWorkerProcess(),
       nginxLoadModules: getNginxLoadModuleDirectives(REQUIRED_MODULES, this.readNginxConfigParams()).join(os.EOL),
     });
@@ -449,6 +453,7 @@ class NginxProvider extends BaseProvider {
     ruleId,
     type,
     commonHeaders,
+    cacheGroup,
   }) {
     server._add('location', concatPath(prefix, suffix));
 
@@ -459,7 +464,9 @@ class NginxProvider extends BaseProvider {
     this._addCors({ location, corsAllowedOrigins, serverName, isDidAuthPath });
 
     this._addCommonResHeaders(location, commonHeaders);
-    this._addTailSlashRedirection(location, prefix); // Note: 末尾 "/" 的重定向要放在 CORS(OPTIONS) 响应之后, 这样不会影响 OPTIONS 的响应
+    if (!cacheGroup && !suffix) {
+      this._addTailSlashRedirection(location, prefix); // Note: 末尾 "/" 的重定向要放在 CORS(OPTIONS) 响应之后, 这样不会影响 OPTIONS 的响应
+    }
 
     if (did) {
       location._add('set', `$did "${did}"`);
@@ -467,18 +474,22 @@ class NginxProvider extends BaseProvider {
       location._add('proxy_set_header', `X-Blocklet-Component-Id "${componentId}"`);
     }
 
+    location._add('include', 'includes/proxy');
+
     // kill cache
     // TODO: 这个放在管理端的 Gateway 配置中
     if (this.cacheDisabled) {
       location._add('expires', '-1');
+    } else if (ROUTER_CACHE_GROUPS[cacheGroup]) {
+      location._add('proxy_cache', cacheGroup);
+      location._add('proxy_cache_valid', `200 ${ROUTER_CACHE_GROUPS[cacheGroup].period}`);
+      location._add('include', 'includes/cache');
     }
 
-    location._add('include', 'includes/proxy');
-
     // Redirect blocklet traffic
     if (type === ROUTING_RULE_TYPES.BLOCKLET) {
-      // FIXME logic related to server gateway should not in provider
-      const rewritePathPrefix = prefix.replace(WELLKNOWN_SERVICE_PATH_PREFIX, '') || '/';
+      // FIXME: logic related to server gateway should not in provider
+      const rewritePathPrefix = prefix.replace(WELLKNOWN_SERVICE_PATH_PREFIX, '').replace(USER_AVATAR_PATH_PREFIX, '');
 
       // Add header
 

package/lib/nginx/util.js

@@ -8,7 +8,7 @@ const { NginxConfFile } = require('nginx-conf');
 const shelljs = require('shelljs');
 const findProcess = require('find-process');
 const moment = require('moment');
-const { MAX_UPLOAD_FILE_SIZE, MAX_NGINX_WORKER_CONNECTIONS } = require('@abtnode/constant');
+const { MAX_UPLOAD_FILE_SIZE, MAX_NGINX_WORKER_CONNECTIONS, ROUTER_CACHE_GROUPS } = require('@abtnode/constant');
 const formatBackSlash = require('@abtnode/util/lib/format-back-slash');
 const { deleteOldLogfiles } = require('@abtnode/logger');
 
@@ -150,6 +150,7 @@ const getWorkerConnectionCount = (maxWorkerConnections, workerProcess) => {
 const getMainTemplate = ({
   logDir,
   tmpDir,
+  cacheDir,
   nginxLoadModules = '',
   workerProcess,
   maxBodySize = CLIENT_MAX_BODY_SIZE,
@@ -189,8 +190,22 @@ http {
     include includes/params;
     include includes/mime.types;
     include includes/compression;
+
+    ${Object.keys(ROUTER_CACHE_GROUPS)
+      .map((x) => getCachePathDirective(cacheDir, x))
+      .join('\n')}
 }
 `;
+
+const getCachePathDirective = (cacheDir, group) => {
+  if (!ROUTER_CACHE_GROUPS[group]) {
+    return '';
+  }
+
+  const config = ROUTER_CACHE_GROUPS[group];
+  return `proxy_cache_path ${cacheDir}/${group} levels=1:2 keys_zone=${group}:${config.minSize} inactive=${config.period} max_size=${config.maxSize};`;
+};
+
 const getNginxStatus = async (configPath) => {
   const list = await findProcess('name', /nginx:/);
   const result = {
@@ -299,6 +314,7 @@ module.exports = {
   rotateNginxLogFile,
   getUserGroup,
   getWorkerConnectionCount,
+  getCachePathDirective,
   getUpstreamName,
   joinNginxPath,
 };

package/lib/util.js

@@ -86,6 +86,7 @@ const formatRoutingTable = (routingTable, onRule) => {
       } else {
         rule.port = +x.to.port;
         rule.did = x.to.did;
+        rule.cacheGroup = x.to.cacheGroup;
         rule.componentId = x.to.componentId;
         rule.target = trimEndSlash(normalizePathPrefix(x.to.target || '/'));
         rule.services = x.services || [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abtnode/router-provider",
-  "version": "1.8.65-beta-5405baf2",
+  "version": "1.8.65-beta-bfcc12ce",
   "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.8.65-beta-5405baf2",
-    "@abtnode/logger": "1.8.65-beta-5405baf2",
-    "@abtnode/router-templates": "1.8.65-beta-5405baf2",
-    "@abtnode/util": "1.8.65-beta-5405baf2",
+    "@abtnode/constant": "1.8.65-beta-bfcc12ce",
+    "@abtnode/logger": "1.8.65-beta-bfcc12ce",
+    "@abtnode/router-templates": "1.8.65-beta-bfcc12ce",
+    "@abtnode/util": "1.8.65-beta-bfcc12ce",
     "axios": "^0.27.2",
     "debug": "^4.3.4",
     "find-process": "^1.4.7",
@@ -62,5 +62,5 @@
     "fs-extra": "^10.1.0",
     "needle": "^3.1.0"
   },
-  "gitHead": "e5dc838baded7031096118462a604fd70d78ff1c"
+  "gitHead": "f6a56512275a55feecf2f3953542ea98777a08f2"
 }