@abtnode/router-provider 1.8.28 → 1.8.30

package/lib/index.js

@@ -9,12 +9,20 @@ const debug = require('debug')(`${require('../package.json').name}:provider:inde
 const Nginx = require('./nginx');
 const Default = require('./default');
 
-const providerMap = new Map([
-  ['nginx', Nginx],
-  ['default', Default],
-]);
+const providerMap = new Map([['default', Default]]);
 
-const getProviderNames = () => [...providerMap.keys()];
+if (process.platform !== 'win32') {
+  providerMap.set('nginx', Nginx);
+}
+
+const getProviderNames = () =>
+  [...providerMap.keys()].sort((x) => {
+    if (x === 'nginx') {
+      return -1;
+    }
+
+    return 1;
+  });
 
 /**
  * Get provider by name
@@ -36,15 +44,16 @@ const listProviders = async (configDir) =>
   Promise.all(getProviderNames().map((x) => providerMap.get(x).describe({ configDir })));
 
 const findExistsProvider = () => {
-  for (const [key, Provider] of providerMap.entries()) {
+  for (const name of getProviderNames()) {
     try {
+      const Provider = providerMap.get(name);
       const exists = Provider.exists();
       if (exists) {
-        return key;
+        return name;
       }
     } catch (error) {
       debug(error);
-      console.error(`provider ${key} exists check failed:`, error.message);
+      console.error(`provider ${name} exists check failed:`, error.message);
     }
   }
 

package/lib/nginx/index.js

@@ -10,6 +10,7 @@ const getPort = require('get-port');
 const uniqBy = require('lodash/uniqBy');
 const isEmpty = require('lodash/isEmpty');
 const cloneDeep = require('lodash/cloneDeep');
+const formatBackSlash = require('@abtnode/util/lib/format-back-slash');
 const {
   DOMAIN_FOR_DEFAULT_SITE,
   ROUTING_RULE_TYPES,
@@ -35,6 +36,7 @@ const {
   getMissingModules,
   getMainTemplate,
   getUpstreamName,
+  joinNginxPath,
 } = require('./util');
 const {
   decideHttpPort,
@@ -128,6 +130,19 @@ class NginxProvider extends BaseProvider {
     this.initialize();
   }
 
+  getRelativeConfigDir(dir) {
+    return path.relative(this.configDir, dir);
+  }
+
+  getConfTemplate() {
+    return getMainTemplate({
+      logDir: this.getRelativeConfigDir(formatBackSlash(this.logDir)),
+      tmpDir: this.getRelativeConfigDir(formatBackSlash(this.tmpDir)),
+      workerProcess: this.getWorkerProcess(),
+      nginxLoadModules: getNginxLoadModuleDirectives(REQUIRED_MODULES, this.readNginxConfigParams()).join(os.EOL),
+    });
+  }
+
   async update({
     routingTable = [],
     certificates = [],
@@ -144,12 +159,7 @@ class NginxProvider extends BaseProvider {
 
     // eslint-disable-next-line consistent-return
     return new Promise((resolve, reject) => {
-      const confTemplate = getMainTemplate({
-        logDir: this.logDir.replace(this.configDir, '').replace(/^\//, ''),
-        tmpDir: this.tmpDir.replace(this.configDir, '').replace(/^\//, ''),
-        workerProcess: this.getWorkerProcess(),
-        nginxLoadModules: getNginxLoadModuleDirectives(REQUIRED_MODULES, this.readNginxConfigParams()).join(os.EOL),
-      });
+      const confTemplate = this.getConfTemplate();
 
       NginxConfFile.createFromSource(confTemplate, (err, conf) => {
         if (err) {
@@ -180,7 +190,7 @@ class NginxProvider extends BaseProvider {
           this.addGlobalReqLimit(conf.nginx.http, requestLimit);
         }
 
-        logger.info('routing sites:', sites);
+        logger.debug('routing sites:', sites);
 
         const allRules = sites.reduce((acc, site) => {
           acc.push(...(site.rules || []));
@@ -199,8 +209,8 @@ class NginxProvider extends BaseProvider {
             // HTTPS configurations
             // update all certs to disk
             certificates.forEach((item) => {
-              const crtPath = `${path.join(this.certDir, item.domain)}.crt`;
-              const keyPath = `${path.join(this.certDir, item.domain)}.key`;
+              const crtPath = `${path.join(this.certDir, item.domain.replace('*', '-'))}.crt`;
+              const keyPath = `${path.join(this.certDir, item.domain.replace('*', '-'))}.key`;
               fs.writeFileSync(crtPath, item.certificate);
               fs.writeFileSync(keyPath, item.privateKey);
             });
@@ -262,21 +272,14 @@ class NginxProvider extends BaseProvider {
 
   async stop() {
     logger.info('stop');
+
     return this._exec('stop');
   }
 
   // FIXME: 这个函数可以不暴露出去？
   initialize() {
     if (!fs.existsSync(this.configPath)) {
-      fs.writeFileSync(
-        this.configPath,
-        getMainTemplate({
-          logDir: this.logDir.replace(this.configDir, '').replace(/^\//, ''),
-          tmpDir: this.tmpDir.replace(this.configDir, '').replace(/^\//, ''),
-          nginxLoadModules: getNginxLoadModuleDirectives(REQUIRED_MODULES, this.readNginxConfigParams()).join(os.EOL),
-          workerProcess: this.getWorkerProcess(),
-        })
-      );
+      fs.writeFileSync(this.configPath, this.getConfTemplate());
     }
   }
 
@@ -312,12 +315,13 @@ class NginxProvider extends BaseProvider {
    */
   _exec(param = '') {
     logger.info('exec', { param });
-    let command = `${this.binPath}  -c ${this.configPath} -p ${this.configDir}`; // eslint-disable-line no-param-reassign
+    let command = `${this.binPath} -c ${this.configPath} -p ${formatBackSlash(this.configDir)}`; // eslint-disable-line no-param-reassign
     if (param) {
       command = `${command} -s ${param}`;
     }
 
     logger.info('exec command:', { command });
+
     const result = shelljs.exec(command, { silent: true });
     if (result.code !== 0) {
       logger.error(`exec ${command} error`, { error: result.stderr });
@@ -614,7 +618,7 @@ class NginxProvider extends BaseProvider {
       throw new Error('daemonPort is required');
     }
 
-    server._add('root', this.wwwDir.replace(this.configDir, '').replace(/^\//, ''));
+    server._add('root', this.getRelativeConfigDir(this.wwwDir));
     server._add('error_page', '404 =404 /_abtnode_404');
     server._add('error_page', '502 =502 /_abtnode_502');
     server._add('error_page', '500 502 503 504 =500 /_abtnode_5xx');
@@ -639,6 +643,7 @@ class NginxProvider extends BaseProvider {
 
   _addWwwFiles(nodeInfo) {
     const welcomePage = nodeInfo.enableWelcomePage ? getWelcomeTemplate(nodeInfo) : get404Template(nodeInfo);
+
     fs.writeFileSync(`${this.wwwDir}/index.html`, welcomePage); // disable index.html
     fs.writeFileSync(`${this.wwwDir}/404.html`, get404Template(nodeInfo));
     fs.writeFileSync(`${this.wwwDir}/502.html`, get502Template(nodeInfo));
@@ -665,7 +670,7 @@ class NginxProvider extends BaseProvider {
     }
 
     if (this.isTest || process.env.NODE_ENV === 'test') {
-      fs.copySync(path.join(__dirname, 'includes/dhparam.pem'), targetFile, { overwrite: true });
+      fs.copySync(path.join(__dirname, 'includes', 'dhparam.pem'), targetFile, { overwrite: true });
       this._isDhparamGenerated = true;
       return;
     }
@@ -761,8 +766,8 @@ class NginxProvider extends BaseProvider {
     conf.nginx.http._add('server');
     const httpsServerUnit = this._getLastServer(conf);
 
-    const crtPath = `${path.join(this.certDir, certificateFileName)}.crt`;
-    const keyPath = `${path.join(this.certDir, certificateFileName)}.key`;
+    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();
     if (serverName === '_') {
@@ -889,7 +894,7 @@ NginxProvider.check = async ({ configDir = '' } = {}) => {
   }
 
   if (nginxStatus.managed) {
-    const pidFile = path.join(configDir, 'nginx/nginx.pid');
+    const pidFile = path.join(configDir, 'nginx', 'nginx.pid');
     if (fs.existsSync(pidFile)) {
       const diskPid = Number(fs.readFileSync(pidFile).toString().trim());
       // If we have the pid lock file, but not the same as running nginx pid, nginx should be killed

package/lib/nginx/util.js

@@ -9,6 +9,7 @@ const shelljs = require('shelljs');
 const findProcess = require('find-process');
 const moment = require('moment');
 const { MAX_UPLOAD_FILE_SIZE } = require('@abtnode/constant');
+const formatBackSlash = require('@abtnode/util/lib/format-back-slash');
 
 const logger = require('@abtnode/logger')('router:nginx:util');
 
@@ -62,7 +63,7 @@ const addTestServer = ({ configPath, port, upstreamPort }) =>
     `
       );
 
-      if (upstreamPort) {
+      if (upstreamPort && os.platform() !== 'win32') {
         conf.nginx._addVerbatimBlock(
           'stream',
           `
@@ -182,7 +183,6 @@ http {
     include includes/compression;
 }
 `;
-
 const getNginxStatus = async (configPath) => {
   const list = await findProcess('name', /nginx:/);
   const result = {
@@ -273,11 +273,16 @@ const getMissingModules = (configParams) => {
 
 const getUpstreamName = (port) => `server_${port}`;
 
+const joinNginxPath = (...args) => {
+  const result = path.join(...args);
+  return formatBackSlash(result);
+};
+
 module.exports = {
   addTestServer,
+  formatError,
   getMainTemplate,
   getNginxLoadModuleDirectives,
-  formatError,
   getMissingModules,
   parseNginxConfigArgs,
   getNginxStatus,
@@ -285,4 +290,5 @@ module.exports = {
   getUserGroup,
   getWorkerConnectionCount,
   getUpstreamName,
+  joinNginxPath,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abtnode/router-provider",
-  "version": "1.8.28",
+  "version": "1.8.30",
   "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.28",
-    "@abtnode/logger": "1.8.28",
-    "@abtnode/router-templates": "1.8.28",
-    "@abtnode/util": "1.8.28",
+    "@abtnode/constant": "1.8.30",
+    "@abtnode/logger": "1.8.30",
+    "@abtnode/router-templates": "1.8.30",
+    "@abtnode/util": "1.8.30",
     "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": "af7aacf5507177600ae563ab597cb42d7223b113"
+  "gitHead": "cb294f4ee7382c6ef7692b6c2c33ad080fced13e"
 }