@waline/vercel 1.13.4 → 1.14.0

package/package.json

@@ -1,8 +1,17 @@
 {
   "name": "@waline/vercel",
-  "version": "1.13.4",
+  "version": "1.14.0",
   "description": "vercel server for waline comment system",
-  "repository": "https://github.com/walinejs/waline",
+  "keywords": [
+    "waline",
+    "vercel",
+    "comment",
+    "blog"
+  ],
+  "repository": {
+    "url": "https://github.com/walinejs/waline",
+    "directory": "packages/server"
+  },
   "license": "MIT",
   "author": "lizheming <i@imnerd.org>",
   "dependencies": {
@@ -31,7 +40,7 @@
     "think-logger3": "^1.3.1",
     "think-model": "^1.5.4",
     "think-model-mysql": "^1.1.7",
-    "think-model-postgresql": "1.1.7",
+    "think-model-postgresql": "1.1.6",
     "think-model-sqlite": "^1.2.3",
     "think-mongo": "^2.1.2",
     "think-router-rest": "^1.0.5",

package/src/config/extend.js

@@ -1,5 +1,6 @@
 const Model = require('think-model');
 const Mongo = require('think-mongo');
+const request = require('request-promise-native');
 
 module.exports = [
   Model(think.app),
@@ -12,16 +13,23 @@ module.exports = [
           return SERVER_URL;
         }
 
-        const { protocol, host, path, controller } = this;
-        return `${protocol}://${host}${path.slice(0, -controller.length)}`;
+        const { protocol, host } = this;
+        return `${protocol}://${host}`;
       },
-    },
-    controller: {
-      fail(...args) {
-        if (this.ctx.status === 200) {
-          this.ctx.status = 500;
+      async webhook(type, data) {
+        const { WEBHOOK } = process.env;
+        if (!WEBHOOK) {
+          return;
         }
-        this.ctx.fail(...args);
+
+        return request({
+          uri: WEBHOOK,
+          method: 'POST',
+          headers: {
+            'content-type': 'application/json',
+          },
+          body: JSON.stringify({ type, data }),
+        });
       },
     },
   },

package/src/controller/comment.js

@@ -218,7 +218,12 @@ module.exports = class extends BaseRest {
           };
         }
 
-        const comments = await this.modelInstance.select(where, {
+        const totalCount = await this.modelInstance.count(where);
+        const pageOffset = Math.max((page - 1) * pageSize, 0);
+        let comments = [];
+        let rootComments = [];
+        let rootCount = 0;
+        const selectOptions = {
           desc: 'insertedAt',
           field: [
             'status',
@@ -233,7 +238,54 @@ module.exports = class extends BaseRest {
             'user_id',
             'sticky',
           ],
-        });
+        };
+
+        /**
+         * most of case we have just little comments
+         * while if we want get rootComments, rootCount, childComments with pagination
+         * we have to query three times from storage service
+         * That's so expensive for user, especially in the serverless.
+         * so we have a comments length check
+         * If you have less than 1000 comments, then we'll get all comments one time
+         * then we'll compute rootComment, rootCount, childComments in program to reduce http request query
+         *
+         * Why we have limit and the limit is 1000?
+         * Many serverless storages have fetch data limit, for example LeanCloud is 100, and CloudBase is 1000
+         * If we have much commments, We should use more request to fetch all comments
+         * If we have 3000 comments, We have to use 30 http request to fetch comments, things go athwart.
+         * And Serverless Service like vercel have excute time limit
+         * if we have more http requests in a serverless function, it may timeout easily.
+         * so we use limit to avoid it.
+         */
+        if (totalCount < 1000) {
+          comments = await this.modelInstance.select(where, selectOptions);
+          rootCount = comments.filter(({ rid }) => !rid).length;
+          rootComments = [
+            ...comments.filter(({ rid, sticky }) => !rid && sticky),
+            ...comments.filter(({ rid, sticky }) => !rid && !sticky),
+          ].slice(pageOffset, pageOffset + pageSize);
+        } else {
+          rootComments = await this.modelInstance.select(
+            { ...where, rid: undefined },
+            {
+              ...selectOptions,
+              offset: pageOffset,
+              limit: pageSize,
+            }
+          );
+          const children = await this.modelInstance.select(
+            {
+              ...where,
+              rid: ['IN', rootComments.map(({ objectId }) => objectId)],
+            },
+            selectOptions
+          );
+          comments = [...rootComments, ...children];
+          rootCount = await this.modelInstance.count({
+            ...where,
+            rid: undefined,
+          });
+        }
 
         const userModel = this.service(
           `storage/${this.config('storage')}`,
@@ -253,18 +305,11 @@ module.exports = class extends BaseRest {
           );
         }
 
-        const rootCount = comments.filter(({ rid }) => !rid).length;
-        const pageOffset = Math.max((page - 1) * pageSize, 0);
-        const rootComments = [
-          ...comments.filter(({ rid, sticky }) => !rid && sticky),
-          ...comments.filter(({ rid, sticky }) => !rid && !sticky),
-        ].slice(pageOffset, pageOffset + pageSize);
-
         return this.json({
           page,
           totalPages: Math.ceil(rootCount / pageSize),
           pageSize,
-          count: comments.length,
+          count: totalCount,
           data: await Promise.all(
             rootComments.map(async (comment) => {
               const cmt = await formatCmt(
@@ -343,7 +388,7 @@ module.exports = class extends BaseRest {
           'The comment author had post same comment content before'
         );
 
-        return this.fail('Duplicate Content');
+        return this.fail(this.locale('Duplicate Content'));
       }
 
       think.logger.debug('Comment duplicate check OK!');
@@ -358,7 +403,7 @@ module.exports = class extends BaseRest {
 
       if (!think.isEmpty(recent)) {
         think.logger.debug(`The author has posted in ${IPQPS} seconeds.`);
-        return this.fail('Comment too fast!');
+        return this.fail(this.locale('Comment too fast!'));
       }
 
       think.logger.debug(`Comment post frequence check OK!`);
@@ -415,21 +460,25 @@ module.exports = class extends BaseRest {
 
     think.logger.debug(`Comment have been added to storage.`);
 
-    let parrentComment;
-
+    let parentComment;
     if (pid) {
-      parrentComment = await this.modelInstance.select({ objectId: pid });
-      parrentComment = parrentComment[0];
+      parentComment = await this.modelInstance.select({ objectId: pid });
+      parentComment = parentComment[0];
     }
 
+    await this.ctx.webhook('new_comment', {
+      comment: { ...resp, rawComment: comment },
+      reply: parentComment,
+    });
+
     if (comment.status !== 'spam') {
       const notify = this.service('notify');
-      await notify.run({ ...resp, rawComment: comment }, parrentComment);
+      await notify.run({ ...resp, rawComment: comment }, parentComment);
     }
 
     think.logger.debug(`Comment notify done!`);
 
-    await this.hook('postSave', resp, parrentComment);
+    await this.hook('postSave', resp, parentComment);
 
     think.logger.debug(`Comment post hooks postSave done!`);
 

package/src/controller/db.js

@@ -19,10 +19,9 @@ module.exports = class extends BaseRest {
 
     for (let i = 0; i < exportData.tables.length; i++) {
       const tableName = exportData.tables[i];
-      const model = this.service(
-        `storage/${this.config('storage')}`,
-        tableName
-      );
+      const storage = this.config('storage');
+      const model = this.service(`storage/${storage}`, tableName);
+
       const data = await model.select({});
       exportData.data[tableName] = data;
     }
@@ -36,12 +35,13 @@ module.exports = class extends BaseRest {
       const jsonText = await readFileAsync(file.path, 'utf-8');
       const importData = JSON.parse(jsonText);
       if (!importData || importData.type !== 'waline') {
-        return this.fail('import data format not support!');
+        return this.fail(this.locale('import data format not support!'));
       }
 
       for (let i = 0; i < importData.tables.length; i++) {
         const tableName = importData.tables[i];
-        const model = this.model(tableName);
+        const storage = this.config('storage');
+        const model = this.service(`storage/${storage}`, tableName);
 
         // delete all data at first
         await model.delete({});

package/src/controller/index.js

@@ -12,7 +12,9 @@ module.exports = class extends think.Controller {
       <title>Waline Example</title>
     </head>
     <body>
-      <div id="waline" style="max-width: 800px;margin: 0 auto;"></div> <script src="https://cdn.jsdelivr.net/npm/@waline/client/dist/Waline.min.js"></script>
+      <div id="waline" style="max-width: 800px;margin: 0 auto;"></div>
+      <script src="https://unpkg.com/@waline/client@v2/dist/waline.js"></script>
+      <link href='//unpkg.com/@waline/client@v2/dist/waline.css' rel='stylesheet' />
       <script>
         console.log(
           '%c @waline/server %c v${version} ',
@@ -20,7 +22,7 @@ module.exports = class extends think.Controller {
           'padding:4px;border:1px solid #0078E7;'
         );
         const params = new URLSearchParams(location.search.slice(1));
-        const waline = new Waline({
+        const waline = Waline.init({
           el: '#waline',
           path: params.get('path') || '/',
           lang: params.get('lng'),

package/src/controller/token/2fa.js

@@ -47,7 +47,7 @@ module.exports = class extends BaseRest {
     });
 
     if (!verified) {
-      return this.fail('TWO_FACTOR_AUTH_ERROR_DETAIL');
+      return this.fail(this.locale('TWO_FACTOR_AUTH_ERROR_DETAIL'));
     }
 
     const userModel = this.service(

package/src/controller/user/password.js

@@ -36,8 +36,13 @@ module.exports = class extends BaseRest {
           ? `"${SENDER_NAME}" <${SENDER_EMAIL}>`
           : SMTP_USER,
       to: user[0].email,
-      subject: `【${SITE_NAME || 'Waline'}】Reset Password`,
-      html: `Please click <a href="${profileUrl}">${profileUrl}</a> to login and change your password as soon as possible!`,
+      subject: this.locale('[{{name}}] Reset Password', {
+        name: SITE_NAME || 'Waline',
+      }),
+      html: this.locale(
+        'Please click <a href="{{url}}">{{url}}</a> to login and change your password as soon as possible!',
+        { url: profileUrl }
+      ),
     });
 
     return this.success();

package/src/controller/user.js

@@ -21,7 +21,7 @@ module.exports = class extends BaseRest {
       !think.isEmpty(resp) &&
       ['administrator', 'guest'].includes(resp[0].type)
     ) {
-      return this.fail('USER_EXIST');
+      return this.fail(this.locale('USER_EXIST'));
     }
 
     const count = await this.modelInstance.count();
@@ -56,21 +56,37 @@ module.exports = class extends BaseRest {
       return this.success();
     }
 
-    const notify = this.service('notify');
-    const apiUrl =
-      this.ctx.serverURL +
-      '/verification?' +
-      qs.stringify({ token, email: data.email });
-
-    await notify.transporter.sendMail({
-      from:
-        SENDER_EMAIL && SENDER_NAME
-          ? `"${SENDER_NAME}" <${SENDER_EMAIL}>`
-          : SMTP_USER,
-      to: data.email,
-      subject: `【${SITE_NAME || 'Waline'}】注册确认邮件`,
-      html: `请点击 ${apiUrl} 确认注册，链接有效时间为 1 个小时。如果不是你在注册，请忽略这封邮件。`,
-    });
+    try {
+      const notify = this.service('notify');
+      const apiUrl =
+        this.ctx.serverURL +
+        '/verification?' +
+        qs.stringify({ token, email: data.email });
+
+      await notify.transporter.sendMail({
+        from:
+          SENDER_EMAIL && SENDER_NAME
+            ? `"${SENDER_NAME}" <${SENDER_EMAIL}>`
+            : SMTP_USER,
+        to: data.email,
+        subject: this.locale('[{{name}}] Registration Confirm Mail', {
+          name: SITE_NAME || 'Waline',
+        }),
+        html: this.locale(
+          'Please click <a href="{{url}}">{{url}}<a/> to confirm registration, the link is valid for 1 hour. If you are not registering, please ignore this email.',
+          { url: apiUrl }
+        ),
+      });
+    } catch (e) {
+      console.log(e);
+
+      return this.fail(
+        this.locale(
+          'Registeration confirm mail send failed, please {%- if isAdmin -%}check your mail configuration{%- else -%}check your email address and contact administrator{%- endif -%}.',
+          { isAdmin: think.isEmpty(count) }
+        )
+      );
+    }
 
     return this.success({ verify: true });
   }

package/src/controller/verification.js

@@ -13,13 +13,13 @@ module.exports = class extends BaseRest {
     const { token, email } = this.get();
     const users = await this.modelInstance.select({ email });
     if (think.isEmpty(users)) {
-      return this.fail('USER_NOT_EXIST');
+      return this.fail(this.locale('USER_NOT_EXIST'));
     }
 
     const user = users[0];
     const match = user.type.match(/^verify:(\d{4}):(\d+)$/i);
     if (!match) {
-      return this.fail('USER_REGISTED');
+      return this.fail(this.locale('USER_REGISTED'));
     }
 
     if (token === match[1] && Date.now() < parseInt(match[2])) {
@@ -27,6 +27,6 @@ module.exports = class extends BaseRest {
       return this.redirect('/ui/login');
     }
 
-    return this.fail('TOKEN_EXPIRED');
+    return this.fail(this.locale('TOKEN_EXPIRED'));
   }
 };

package/src/extend/controller.js

@@ -1,3 +1,6 @@
+const nunjucks = require('nunjucks');
+const locales = require('../locales');
+
 module.exports = {
   success(...args) {
     this.ctx.success(...args);
@@ -7,4 +10,12 @@ module.exports = {
     this.ctx.fail(...args);
     return think.prevent();
   },
+  locale(message, variables) {
+    const { lang } = this.get();
+    const locale = locales[(lang || '').toLowerCase()];
+    if (locale && locale[message]) {
+      message = locale[message];
+    }
+    return nunjucks.renderString(message, variables);
+  },
 };

package/src/locales/en.json

@@ -0,0 +1,15 @@
+{
+  "import data format not support!": "import data format not support!",
+  "USER_EXIST": "USER_EXIST",
+  "USER_NOT_EXIST": "USER_NOT_EXIST",
+  "USER_REGISTED": "USER_REGISTED",
+  "TOKEN_EXPIRED": "TOKEN_EXPIRED",
+  "TWO_FACTOR_AUTH_ERROR_DETAIL": "TWO_FACTOR_AUTH_ERROR_DETAIL",
+  "[{{name}}] Registration Confirm Mail": "[{{name}}] Registration Confirm Mail",
+  "Please click <a href=\"{{url}}\">{{url}}<a/> to confirm registration, the link is valid for 1 hour. If you are not registering, please ignore this email.": "Please click <a href=\"{{url}}\">{{url}}<a/> to confirm registration, the link is valid for 1 hour. If you are not registering, please ignore this email.",
+  "[{{name}}] Reset Password": "[{{name}}] Reset Password",
+  "Please click <a href=\"{{url}}\">{{url}}</a> to login and change your password as soon as possible!": "Please click <a href=\"{{url}}\">{{url}}</a> to login and change your password as soon as possible!",
+  "Duplicate Content": "Duplicate Content",
+  "Comment too fast": "Comment too fast",
+  "Registeration confirm mail send failed, please {%- if isAdmin -%}check your mail configuration{%- else -%}check your email address and contact administrator{%- endif -%}.": "Registeration confirm mail send failed, please {%- if isAdmin -%}check your mail configuration{%- else -%}check your email address and contact administrator{%- endif -%}."
+}

package/src/locales/index.js

@@ -0,0 +1,12 @@
+const en = require('./en.json');
+const zhCN = require('./zh-CN.json');
+const zhTW = require('./zh-TW.json');
+
+module.exports = {
+  'zh-cn': zhCN,
+  'zh-tw': zhTW,
+  en: en,
+  'en-us': en,
+  jp: en,
+  'jp-jp': en,
+};

package/src/locales/zh-CN.json

@@ -0,0 +1,15 @@
+{
+  "import data format not support!": "文件格式不支持",
+  "USER_EXIST": "用户已存在",
+  "USER_NOT_EXIST": "用户不存在",
+  "USER_REGISTED": "用户已注册",
+  "TOKEN_EXPIRED": "密钥已过期",
+  "TWO_FACTOR_AUTH_ERROR_DETAIL": "二步验证失败",
+  "[{{name}}] Registration Confirm Mail": "【{{name}}】注册确认邮件",
+  "Please click <a href=\"{{url}}\">{{url}}<a/> to confirm registration, the link is valid for 1 hour. If you are not registering, please ignore this email.": "请点击 <a href=\"{{url}}\">{{url}}</a> 确认注册，链接有效时间为 1 个小时。如果不是你在注册，请忽略这封邮件。",
+  "[{{name}}] Reset Password": "【{{name}}】重置密码",
+  "Please click <a href=\"{{url}}\">{{url}}</a> to login and change your password as soon as possible!": "请尽快点击链接 <a href=\"{{url}}\">{{url}}</a> 登录并修改你的密码！",
+  "Duplicate Content": "发送的内容之前已经发过",
+  "Comment too fast": "评论太快啦，请慢点！",
+  "Registeration confirm mail send failed, please {%- if isAdmin -%}check your mail configuration{%- else -%}check your email address and contact administrator{%- endif -%}.": "注册确认邮件发送失败，请{%- if isAdmin -%}检查一下网站的邮件相关配置{% else %}确认你的邮箱输入无误并联系管理员{%- endif -%}。"
+}

package/src/locales/zh-TW.json

@@ -0,0 +1,15 @@
+{
+  "import data format not support!": "文件格式不支持",
+  "USER_EXIST": "用戶已存在",
+  "USER_NOT_EXIST": "用戶不存在",
+  "USER_REGISTED": "用戶已註冊",
+  "TOKEN_EXPIRED": "密鑰已過期",
+  "TWO_FACTOR_AUTH_ERROR_DETAIL": "二步驗證失敗",
+  "[{{name}}] Registration Confirm Mail": "『{{name}}』註冊確認郵件",
+  "Please click <a href=\"{{url}}\">{{url}}<a/> to confirm registration, the link is valid for 1 hour. If you are not registering, please ignore this email.": "請點擊 <a href=\"{{url}}\">{{url}}</a> 確認註冊，鏈接有效時間為 1 個小時。如果不是你在註冊，請忽略這封郵件。",
+  "[{{name}}] Reset Password": "『{{name}}』重置密碼",
+  "Please click <a href=\"{{url}}\">{{url}}</a> to login and change your password as soon as possible!": "請盡快點擊鏈接 <a href=\"{{url}}\">{{url}}</a> 登錄並修改你的密碼！",
+  "Duplicate Content": "發送的內容之前已經發過",
+  "Comment too fast": "評論太快啦，請慢點！",
+  "Registeration confirm mail send failed, please {%- if isAdmin -%}check your mail configuration{%- else -%}check your email address and contact administrator{%- endif -%}.": "註冊確認郵件發送失敗，{%- if isAdmin -%}檢查一下網站的郵件相關配置{% else %}確認你的郵箱輸入無誤後聯繫管理員{%- endif -%}。"
+}

package/src/middleware/dashboard.js

@@ -14,8 +14,7 @@ module.exports = function () {
     window.SITE_NAME = ${JSON.stringify(process.env.SITE_NAME)};
     </script>
     <script src="${
-      process.env.WALINE_ADMIN_MODULE_ASSET_URL ||
-      'https://cdn.jsdelivr.net/npm/@waline/admin'
+      process.env.WALINE_ADMIN_MODULE_ASSET_URL || '//unpkg.com/@waline/admin'
     }"></script>
   </body>
 </html>`;

package/src/service/storage/cloudbase.js

@@ -154,6 +154,11 @@ module.exports = class extends Base {
   }
 
   async add(data) {
+    if (data.objectId) {
+      data._id = data.objectId;
+      delete data.objectId;
+    }
+
     const instance = await this.collection(this.tableName);
     const { id } = await instance.add(data);
     return { ...data, objectId: id };

package/src/service/storage/mongodb.js

@@ -121,6 +121,11 @@ module.exports = class extends Base {
   }
 
   async add(data) {
+    if (data.objectId) {
+      data._id = data.objectId;
+      delete data.objectId;
+    }
+
     const instance = this.mongo(this.tableName);
     const id = await instance.add(data);
     return { ...data, objectId: id.toString() };

package/src/service/storage/mysql.js

@@ -57,6 +57,11 @@ module.exports = class extends Base {
   }
 
   async add(data) {
+    if (data.objectId) {
+      data.id = data.objectId;
+      delete data.objectId;
+    }
+
     const instance = this.model(this.tableName);
     const id = await instance.add(data);
     return { ...data, objectId: id };