feature(views and popular articles): get article views and popular ar…

…ticles [Finishes #169124758]

.travis.yml

@@ -1,7 +1,7 @@
 language: node_js
 
 node_js:
-  - 'stable'
+  - '10'
 
 cache:
   directories:

package.json

@@ -35,7 +35,6 @@
     "dotenv": "^6.2.0",
     "express": "^4.17.1",
     "express-async-errors": "^3.1.1",
-    "express-ip": "^1.0.3",
     "express-session": "^1.15.6",
     "http": "0.0.0",
     "joi": "^14.3.1",
@@ -64,11 +63,6 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.5.5",
-    "@babel/core": "^7.5.5",
-    "@babel/node": "^7.5.5",
-    "@babel/preset-env": "^7.5.5",
-    "@babel/register": "^7.5.5",
     "chai": "^4.2.0",
     "chai-http": "^4.3.0",
     "coveralls": "^3.0.5",

src/app.js

@@ -1,14 +1,12 @@
 import winston from 'winston';
 import express from 'express';
-import expressip from 'express-ip';
 import bodyParser from 'body-parser';
 import logging from './helpers/logging';
 import routes from './routes/index';
 import './config/cloudinary.config';
 import { mock } from './middlewares/validators/socialLogin-mock';
 
 const app = express();
-app.use(expressip().getIpInfoMiddleware);
 app.use(bodyParser.json({ limit: '50mb' }));
 app.use(bodyParser.urlencoded({ limit: '50mb', extended: true }));
 

src/controllers/articles.controller.js

@@ -16,7 +16,6 @@ const { notifyViaEmailAndPush } = NotificationServices;
 const util = new Util();
 
 const db = models.Article;
-const viewDb = models.View;
 
 /**
  *
@@ -87,6 +86,7 @@ class Articles {
     if (!articles) {
       return res.status(200).json({ status: 200, message: 'There is no article.' });
     }
+
     const allArticles = _.map(
       articles,
       _.partialRight(_.pick, [
@@ -103,7 +103,16 @@ class Articles {
       ])
     );
 
-    allArticles.map((article) => {
+    const popularArticles = allArticles.slice(0);
+    popularArticles.sort((a, b) => b.views - a.views);
+    const mostPopular = popularArticles.slice(0, 9);
+
+    if (req.query.popular) {
+      util.setSuccess(200, 'The most popular articles on authors haven', mostPopular);
+      return util.send(res);
+    }
+
+    allArticles.map(async (article) => {
       const readTime = Helper.calculateReadTime(article.body);
       article.readtime = readTime;
       return true;
@@ -130,6 +139,7 @@ class Articles {
     const findArticle = await db.findOne({
       where: { slug: req.params.slug }
     });
+
     if (!findArticle) {
       return res.status(200).json({
         status: 200,
@@ -149,34 +159,31 @@ class Articles {
       'images',
       'views'
     ]);
-    const readTime = Helper.calculateReadTime(article.body);
-    article.readtime = readTime;
-    // find ip address
-    const ipAddress = req.header('x-forwarded-for') || req.connection.remoteAddress;
-
-    // check if the article was viewed
-    const findViewsOfArticle = await viewDb.findOne({ where: { articleId: findArticle.id } });
 
     let viewObject = {
-      articleId: findArticle.id,
-      userId: req.auth ? req.auth.id : null,
-      IP_address: ipAddress,
-      userType: req.auth ? 'loggedInUser' : 'guest',
+      slug: findArticle.slug,
+      title: findArticle.title,
+      description: findArticle.description,
+      body: findArticle.body,
+      flagged: findArticle.flagged,
+      favorited: findArticle.favorited,
+      favoritedcount: findArticle.favoritedcount,
+      images: findArticle.images,
       views: 1
     };
-    // update or create article views
-    if (findViewsOfArticle) {
-      viewObject = { ...viewObject, views: findViewsOfArticle.views + 1 };
-      await viewDb.update(viewObject, {
+    if (findArticle) {
+      viewObject = { ...viewObject, views: findArticle.views + 1 };
+      await db.update(viewObject, {
         where: {
-          articleId: findArticle.id
+          id: findArticle.id
         },
         returing: true
       });
     } else {
-      await viewDb.create(viewObject);
+      await db.create(viewObject);
     }
-
+    const readTime = Helper.calculateReadTime(article.body);
+    article.readtime = readTime;
     if (req.auth) {
       const { description } = article;
       const readerId = req.auth.id;
@@ -186,8 +193,7 @@ class Articles {
     return res.status(200).json({
       status: 200,
       message: 'Article successfully retrieved',
-      data: article,
-      views: findViewsOfArticle.views
+      data: article
     });
   }
 

src/helpers/viewArticle.helper.js

@@ -0,0 +1,44 @@
+import models from '../models';
+import Util from './util';
+
+const util = new Util();
+const db = models.Article;
+const viewDb = models.View;
+
+const viewArticleHelper = async (req, res, slug) => {
+  const findArticle = await db.findOne({ where: { slug } });
+  if (!findArticle) {
+    util.setError(404, 'That article does not exist');
+    util.send(res);
+  }
+  // find ip address
+  const ipAddress = req.header('x-forwarded-for') || req.connection.remoteAddress;
+
+  // check if the article was viewed
+  const findViewsOfArticle = await viewDb.findOne({ where: { articleId: findArticle.id } });
+
+  let viewObject = {
+    articleId: findArticle.id,
+    userId: req.auth ? req.auth.id : null,
+    IP_address: ipAddress,
+    userType: req.auth ? 'loggedInUser' : 'guest',
+    views: 1
+  };
+  // update or create article views
+  if (findViewsOfArticle) {
+    viewObject = { ...viewObject, views: findViewsOfArticle.views + 1 };
+    await viewDb.update(viewObject, {
+      where: {
+        articleId: findArticle.id
+      },
+      returing: true
+    });
+  } else {
+    await viewDb.create(viewObject);
+  }
+  return {
+    views: findViewsOfArticle.views
+  };
+};
+
+export default viewArticleHelper;

src/middlewares/query.check.js

@@ -29,7 +29,7 @@ export const searchArticleQuerybuilder = (searchQueries) => {
 
 export const checkQuery = (req, res, next) => {
   let {
-    limit, page, ...searchQueries
+    limit, page, popular, ...searchQueries
   } = req.query;
   const validQueries = ['author', 'keyword', 'tag', 'title'];
   let isValidRequest = true;

src/migrations/20190813125249-create-article.js

@@ -53,6 +53,7 @@ module.exports = {
       },
       views: {
         type: Sequelize.INTEGER,
+        defaultValue: 0,
         allowNull: true
       },
       createdAt: {

src/routes/api/article/article.routes.js

@@ -46,17 +46,17 @@ router.patch('/:articleId/:name', [auth, confirmEmailAuth], checkArticle, checkT
 router.delete('/:articleId/:name', [auth, confirmEmailAuth], checkArticle, checkTagName, deleteArticleTag);
 
 
-// Highlight
-router.post('/:slug/highlight', [auth], highlight.bodyHighlightedText);
-router.delete('/highlight/:id', auth, highlight.deleteHighlightComment);
-router.get('/:articleId/highlight', auth, highlight.getHighlights);
-router.get('/:id/highlight/share/:channel', [auth, share], highlight.shareHightlight);
-
-// tags
-
-router.post('/:articleId/tags', [auth, confirmEmailAuth], checkArticle, tagLimit, tagLength, createArticleTag);
-router.get('/:articleId/tags', checkArticle, getArticleTags);
-router.patch('/:articleId/:name', [auth, confirmEmailAuth], checkArticle, checkTagName, editArticleTag);
-router.delete('/:articleId/:name', [auth, confirmEmailAuth], checkArticle, checkTagName, deleteArticleTag);
+// // Highlight
+// router.post('/:slug/highlight', [auth], highlight.bodyHighlightedText);
+// router.delete('/highlight/:id', auth, highlight.deleteHighlightComment);
+// router.get('/:articleId/highlight', auth, highlight.getHighlights);
+// router.get('/:id/highlight/share/:channel', [auth, share], highlight.shareHightlight);
+
+// // tags
+
+// router.post('/:articleId/tags', [auth, confirmEmailAuth], checkArticle, tagLimit, tagLength, createArticleTag);
+// router.get('/:articleId/tags', checkArticle, getArticleTags);
+// router.patch('/:articleId/:name', [auth, confirmEmailAuth], checkArticle, checkTagName, editArticleTag);
+// router.delete('/:articleId/:name', [auth, confirmEmailAuth], checkArticle, checkTagName, deleteArticleTag);
 
 export default router;

src/services/article.service.js

@@ -32,17 +32,19 @@ class articleService {
    * @static
    *  @param {*} offset
    *  @param {*} limit
+   *  @param {*} popular
    *  @param {*} searchQueries
    * @returns {object} data
    * @memberof articleService
    */
-  static async getAllArticles(offset, limit, searchQueries) {
+  static async getAllArticles(offset, limit, popular, searchQueries) {
     try {
       return await db.findAll({
         where: searchQueries,
         order: [
           ['createdAt', 'DESC']
         ],
+        popular,
         offset,
         limit,
       });