fest: add topic api (#128)

* refactor: sub router related

* fix: reply unit test error content

* feat: add topic api

* refactor: 修复 await 和 then 一起使用的问题；原本用 async function 的地方统一使用箭头函数

* test: Improve topic unit coverage & bug fix

Author: YeungKC

app/controller/api/topic.js

@@ -0,0 +1,200 @@
+'use strict';
+
+const Controller = require('egg').Controller;
+const _ = require('lodash');
+
+class TopicController extends Controller {
+  async index(ctx) {
+    const tab = ctx.query.tab || 'all';
+    const mdrender = ctx.query.mdrender !== 'false';
+
+    const query = {};
+    if (!tab || tab === 'all') {
+      query.tab = { $nin: [ 'job', 'dev' ] };
+    } else {
+      if (tab === 'good') {
+        query.good = true;
+      } else {
+        query.tab = tab;
+      }
+    }
+
+    let topics = await ctx.service.topic.getTopicsByQuery(query,
+      // TODO 修改 eslint 支持在 {} 内使用 ...，栗子：{ sort: '-top -last_reply_at', ...ctx.pagination }
+      Object.assign({ sort: '-top -last_reply_at' }, ctx.pagination));
+    topics = topics.map(topic => {
+      topic.content = mdrender ? ctx.helper.markdown(topic.content) : topic.content;
+      topic.author = _.pick(topic.author, [ 'loginname', 'avatar_url' ]);
+      topic.id = topic._id;
+      return _.pick(topic, [ 'id', 'author_id', 'tab', 'content', 'title', 'last_reply_at',
+        'good', 'top', 'reply_count', 'visit_count', 'create_at', 'author' ]);
+    });
+
+    ctx.body = {
+      success: true,
+      data: topics,
+    };
+  }
+
+  async create(ctx) {
+    const all_tabs = ctx.app.config.tabs.map(tab => {
+      return tab[ 0 ];
+    });
+
+    // TODO: 此处可以优化，将所有使用 egg_validate 的 rules 集中管理，避免即时新建对象
+    ctx.validate({
+      title: {
+        type: 'string',
+        max: 100,
+        min: 5,
+      },
+      tab: { type: 'enum', values: all_tabs },
+      content: { type: 'string' },
+    });
+
+    const body = ctx.request.body;
+
+    // 储存新主题帖
+    const topic = await ctx.service.topic.newAndSave(
+      body.title,
+      body.content,
+      body.tab,
+      ctx.request.user.id
+    );
+
+    // 发帖用户增加积分,增加发表主题数量
+    await ctx.service.user.incrementScoreAndReplyCount(topic.author_id, 5, 1);
+
+    // 通知被@的用户
+    await ctx.service.at.sendMessageToMentionUsers(
+      body.content,
+      topic.id,
+      ctx.request.user.id
+    );
+
+    ctx.body = {
+      success: true,
+      topic_id: topic.id,
+    };
+  }
+
+  async show(ctx) {
+    ctx.validate({
+      id: {
+        type: 'string',
+        max: 24,
+        min: 24,
+      },
+    }, ctx.params);
+
+    const topic_id = String(ctx.params.id);
+    const mdrender = ctx.query.mdrender !== 'false';
+    const user = await ctx.service.user.getUserByToken(ctx.query.accesstoken);
+
+    let [ topic, author, replies ] = await ctx.service.topic.getFullTopic(topic_id);
+
+    if (!topic) {
+      ctx.status = 404;
+      ctx.body = {
+        success: false,
+        error_msg: '此话题不存在或已被删除',
+      };
+      return;
+    }
+
+    // 增加 visit_count
+    topic.visit_count += 1;
+    // 写入 DB
+    await ctx.service.topic.incrementVisitCount(topic_id);
+
+    topic.content = mdrender ? ctx.helper.markdown(topic.content) : topic.content;
+    topic.id = topic._id;
+    topic = _.pick(topic, [ 'id', 'author_id', 'tab', 'content', 'title', 'last_reply_at',
+      'good', 'top', 'reply_count', 'visit_count', 'create_at', 'author' ]);
+
+    topic.author = _.pick(author, [ 'loginname', 'avatar_url' ]);
+
+    topic.replies = replies.map(reply => {
+      reply.content = mdrender ? ctx.helper.markdown(reply.content) : reply.content;
+
+      reply.author = _.pick(reply.author, [ 'loginname', 'avatar_url' ]);
+      reply.id = reply._id;
+      reply = _.pick(reply, [ 'id', 'author', 'content', 'ups', 'create_at', 'reply_id' ]);
+      reply.reply_id = reply.reply_id || null;
+
+      reply.is_uped = !!(reply.ups && user && reply.ups.indexOf(user.id) !== -1);
+
+      return reply;
+    });
+
+    topic.is_collect = user ? !!await ctx.service.topicCollect.getTopicCollect(
+      user.id,
+      topic_id
+    ) : false;
+
+    ctx.body = {
+      success: true,
+      data: topic,
+    };
+  }
+
+  async update(ctx) {
+
+    const all_tabs = ctx.app.config.tabs.map(tab => {
+      return tab[ 0 ];
+    });
+
+    ctx.validate({
+      topic_id: {
+        type: 'string',
+        max: 24,
+        min: 24,
+      },
+      title: {
+        type: 'string',
+        max: 100,
+        min: 5,
+      },
+      tab: { type: 'enum', values: all_tabs },
+      content: { type: 'string' },
+    });
+
+    const body = ctx.request.body;
+
+    let { topic } = await ctx.service.topic.getTopicById(body.topic_id);
+    if (!topic) {
+      ctx.status = 404;
+      ctx.body = { success: false, error_msg: '此话题不存在或已被删除。' };
+      return;
+    }
+
+    if (!topic.author_id.equals(ctx.request.user._id) && !ctx.request.is_admin) {
+      ctx.status = 403;
+      ctx.body = {
+        success: false,
+        error_msg: '对不起，你不能编辑此话题',
+      };
+      return;
+    }
+
+    delete body.accesstoken;
+    topic = Object.assign(topic, body);
+    topic.update_at = new Date();
+
+    await topic.save();
+
+    // 通知被 @ 的人
+    await ctx.service.at.sendMessageToMentionUsers(
+      topic.content,
+      topic.id,
+      ctx.request.user.id
+    );
+
+    ctx.body = {
+      success: true,
+      topic_id: topic.id,
+    };
+  }
+}
+
+module.exports = TopicController;

app/middleware/pagination.js

@@ -0,0 +1,22 @@
+'use strict';
+
+
+module.exports = () => {
+  return async (ctx, next) => {
+    if (!ctx.pagination) {
+
+      const query = ctx.query;
+      const config = ctx.app.config;
+      const pagination = {};
+
+      // 这里限制了最大 limit，不知道实际上需不需要
+      pagination.limit = Math.min(100, parseInt(query.limit || config.default_limit, 10));
+      const page = Math.max(1, parseInt(query.page || config.default_page, 10));
+      pagination.skip = (page - 1) * pagination.limit;
+
+      ctx.pagination = pagination;
+    }
+    await next();
+  };
+};
+

app/router/api.js

@@ -4,21 +4,29 @@
  * @param {Egg.Application} app - egg application
  */
 module.exports = app => {
-  const { router, controller, middleware } = app;
+  const apiV1Router = app.router.namespace('/api/v1');
+  const { controller, middleware } = app;
 
-  const { user, message } = controller.api;
+  const { user, message, topic } = controller.api;
 
   const tokenRequired = middleware.tokenRequired();
+  const pagination = middleware.pagination();
   // const createTopicLimit = middleware.createTopicLimit(config.topic);
   // const createUserLimit = middleware.createUserLimit(config.create_user_per_ip);
 
   // 用户
-  router.get('/api/v1/user/:loginname', user.show);
-  router.post('/api/v1/accesstoken', tokenRequired, user.verify);
+  apiV1Router.get('/user/:loginname', user.show);
+  apiV1Router.post('/accesstoken', tokenRequired, user.verify);
 
   // 消息通知
-  router.get('/api/v1/message/count', tokenRequired, message.count);
-  router.get('/api/v1/messages', tokenRequired, message.list);
-  router.post('/api/v1/message/mark_all', tokenRequired, message.markAll);
-  router.post('/api/v1/message/mark_one/:msg_id', tokenRequired, message.markOne);
+  apiV1Router.get('/message/count', tokenRequired, message.count);
+  apiV1Router.get('/messages', tokenRequired, message.list);
+  apiV1Router.post('/message/mark_all', tokenRequired, message.markAll);
+  apiV1Router.post('/message/mark_one/:msg_id', tokenRequired, message.markOne);
+
+  // 主题
+  apiV1Router.get('/topics', pagination, topic.index);
+  apiV1Router.get('/topic/:id', topic.show);
+  apiV1Router.post('/topics', tokenRequired, topic.create);
+  apiV1Router.post('/topics/update', tokenRequired, topic.update);
 };

config/config.default.js

@@ -166,5 +166,8 @@ module.exports = appInfo => {
     },
   };
 
+  config.default_page = 1;
+  config.default_limit = 20;
+
   return config;
 };

config/plugin.js

@@ -43,3 +43,8 @@ exports.validate = {
   enable: true,
   package: 'egg-validate',
 };
+
+exports.routerPlus = {
+  enable: true,
+  package: 'egg-router-plus',
+};

package.json

@@ -14,6 +14,7 @@
     "egg-passport-github": "^1.0.0",
     "egg-passport-local": "^1.2.1",
     "egg-redis": "^2.0.0",
+    "egg-router-plus": "^1.2.0",
     "egg-scripts": "^2.5.0",
     "egg-validate": "^1.0.0",
     "egg-view-ejs": "^2.0.0",