feat: add topic_collect api (#131)

* feat: add topic_collect api

closes #125, closes #113

* chore: update status code

* chore: fix typo

Author: sinchang

app/controller/api/collect.js

@@ -0,0 +1,142 @@
+'use strict';
+
+const Controller = require('egg').Controller;
+const _ = require('lodash');
+
+const MongoObjectIdSchema = {
+  type: 'string',
+  max: 24,
+  min: 24,
+};
+
+class CollectController extends Controller {
+  async index() {
+    const { ctx, service } = this;
+    const name = ctx.params.name;
+
+    const user = await service.user.getUserByLoginName(name);
+
+    if (!user) {
+      ctx.status = 404;
+      ctx.body = {
+        success: false,
+        error_msg: '用户不存在',
+      };
+      return;
+    }
+
+    const opt = { skip: 0, limit: 100 };
+
+    const collects = await service.topicCollect.getTopicCollectsByUserId(user._id, opt);
+    const ids = collects.map(doc => {
+      return doc.topic_id.toString();
+    });
+
+    const query = { _id: { $in: ids } };
+    let topics = await service.topic.getTopicsByQuery(query, {});
+
+    topics = _.sortBy(topics, topic => {
+      return ids.indexOf(topic._id.toString());
+    });
+
+    topics = topics.map(topic => {
+      topic.author = _.pick(topic.author, [ 'loginname', 'avatar_url' ]);
+      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 collect() {
+    const { ctx, service } = this;
+    const topic_id = ctx.request.body.topic_id;
+    const user_id = ctx.request.user.id;
+
+    ctx.validate({
+      topic_id: MongoObjectIdSchema,
+    }, ctx.request.body);
+
+    const topic = await service.topic.getTopic(topic_id);
+
+    if (!topic) {
+      ctx.status = 404;
+      ctx.body = {
+        success: false,
+        error_msg: '话题不存在',
+      };
+      return;
+    }
+
+    const doc = await service.topicCollect.getTopicCollect(
+      user_id,
+      topic._id
+    );
+
+    if (doc) {
+      ctx.body = {
+        success: false,
+        error_msg: '已经收藏过该主题',
+      };
+      return;
+    }
+
+    await service.topicCollect.newAndSave(user_id, topic._id);
+    await Promise.all([
+      service.user.incrementCollectTopicCount(user_id),
+      service.topic.incrementCollectCount(topic_id),
+    ]);
+
+    ctx.body = { success: true };
+  }
+
+  async de_collect() {
+    const { ctx, service } = this;
+    const topic_id = ctx.request.body.topic_id;
+    const user_id = ctx.request.user.id;
+
+    ctx.validate({
+      topic_id: MongoObjectIdSchema,
+    }, ctx.request.body);
+
+    const topic = await service.topic.getTopic(topic_id);
+
+    if (!topic) {
+      ctx.status = 404;
+      ctx.body = {
+        success: false,
+        error_msg: '话题不存在',
+      };
+      return;
+    }
+
+    const removeResult = await service.topicCollect.remove(
+      user_id,
+      topic._id
+    );
+
+    if (removeResult.result.n === 0) {
+      ctx.status = 500;
+      ctx.body = {
+        success: false,
+        error_msg: '取消收藏失败',
+      };
+      return;
+    }
+
+    const user = await service.user.getUserById(user_id);
+
+    user.collect_topic_count -= 1;
+    await user.save();
+
+    topic.collect_count -= 1;
+    await topic.save();
+
+    ctx.body = { success: true };
+  }
+}
+
+module.exports = CollectController;

app/middleware/error_handler.js

@@ -0,0 +1,25 @@
+'use strict';
+
+module.exports = (option, app) => {
+  // 中间件的配置项，框架会将 app.config[${middlewareName}] 传递进来
+  return async function(ctx, next) {
+    try {
+      await next();
+    } catch (err) {
+      // 所有的异常都在 app 上触发一个 error 事件，框架会记录一条错误日志
+      app.emit('error', err, this);
+      const status = err.status || 500;
+      // 生产环境时 500 错误的详细错误内容不返回给客户端，因为可能包含敏感信息
+      const error_msg = status === 500 && app.config.env === 'prod'
+        ? 'Internal Server Error'
+        : err.message;
+      // 从 error 对象上读出各个属性，设置到响应中
+      ctx.body = { error_msg };
+      ctx.body.success = false;
+      if (status === 422) {
+        ctx.body.detail = err.errors;
+      }
+      ctx.status = status;
+    }
+  };
+};

app/router/api.js

@@ -7,7 +7,7 @@ module.exports = app => {
   const apiV1Router = app.router.namespace('/api/v1');
   const { controller, middleware } = app;
 
-  const { user, message, topic, reply } = controller.api;
+  const { user, message, topic, reply, collect } = controller.api;
 
   const tokenRequired = middleware.tokenRequired();
   const pagination = middleware.pagination();
@@ -30,6 +30,11 @@ module.exports = app => {
   apiV1Router.post('/topics', tokenRequired, topic.create);
   apiV1Router.post('/topics/update', tokenRequired, topic.update);
 
+  // 主题收藏
+  apiV1Router.post('/topic_collect/collect', tokenRequired, collect.collect);
+  apiV1Router.post('/topic_collect/de_collect', tokenRequired, collect.de_collect);
+  apiV1Router.get('/topic_collect/:name', collect.index);
+
   // 评论
   apiV1Router.post('/topic/:topic_id/replies', tokenRequired, reply.create);
   apiV1Router.post('/reply/:reply_id/ups', tokenRequired, reply.updateUps);

config/config.default.js

@@ -23,7 +23,7 @@ module.exports = appInfo => {
   config.session_secret = 'node_club_secret'; // 务必修改
 
   // add your config here
-  config.middleware = [ 'locals', 'authUser', 'blockUser', 'errorPage' ];
+  config.middleware = [ 'locals', 'authUser', 'blockUser', 'errorPage', 'errorHandler' ];
 
   config.authUser = {
     enable: true,

test/app/controller/api/collect.test.js

@@ -0,0 +1,82 @@
+'use strict';
+
+const { app, assert } = require('egg-mock/bootstrap');
+
+describe('test/app/controller/api/collect.test.js', () => {
+  let user,
+    topic_id;
+
+  before(async function() {
+    const ctx = app.mockContext();
+    const loginname = `user_loginname_${Date.now()}`;
+    const email = `${loginname}@test.com`;
+    user = await ctx.service.user.newAndSave('name', loginname, ctx.helper.bhash('pass'), email, 'avatar_url', 'active');
+    const title = 'test topic';
+    const content = 'test topic';
+    const tab = 'share';
+
+    const topic = await ctx.service.topic.newAndSave(title, content, tab, user.id);
+    topic_id = topic._id.toString();
+  });
+
+  it('post /topic_collect/collect should ok', async () => {
+    await app.httpRequest()
+      .post('/api/v1/topic_collect/collect')
+      .send({
+        accesstoken: user.accessToken,
+        topic_id,
+      })
+      .expect(200);
+    await app.httpRequest()
+      .post('/api/v1/topic_collect/collect')
+      .send({
+        accesstoken: user.accessToken,
+        topic_id: '5aaa4432f472129d5e4d6773',
+      })
+      .expect(404);
+    await app.httpRequest()
+      .post('/api/v1/topic_collect/collect')
+      .send({
+        accesstoken: user.accessToken,
+        topic_id: '123',
+      })
+      .expect(422);
+    const result = await app.httpRequest()
+      .post('/api/v1/topic_collect/collect')
+      .send({
+        accesstoken: user.accessToken,
+        topic_id,
+      });
+    assert(result.body.error_msg === '已经收藏过该主题');
+  });
+
+  it('get /topic_collect/:loginname should ok', async () => {
+    const loginname = user.loginname;
+    await app.httpRequest().get(`/api/v1/topic_collect/${loginname}`).expect(200);
+    await app.httpRequest().get(`/api/v1/topic_collect/${loginname}test`).expect(404);
+  });
+
+  it('post /topic_collect/de_collect should ok', async () => {
+    await app.httpRequest()
+      .post('/api/v1/topic_collect/de_collect')
+      .send({
+        accesstoken: user.accessToken,
+        topic_id: '123',
+      })
+      .expect(422);
+    await app.httpRequest()
+      .post('/api/v1/topic_collect/de_collect')
+      .send({
+        accesstoken: user.accessToken,
+        topic_id: '5aaa4432f472129d5e4d6773',
+      })
+      .expect(404);
+    await app.httpRequest()
+      .post('/api/v1/topic_collect/de_collect')
+      .send({
+        accesstoken: user.accessToken,
+        topic_id,
+      })
+      .expect(200);
+  });
+});