server comments

Author: maxchistt

app.js

@@ -5,6 +5,9 @@ const os = require('os')
 const mongoose = require('mongoose')
 require('dotenv').config()
 
+/**
+ * подключение переменных среды
+ */
 const devMode = process.env.NODE_ENV === "dev"
 const PORT = process.env.PORT || 5000
 const mongoUri = process.env.mongoUri
@@ -14,11 +17,17 @@ const app = express()
 
 app.use(express.json({ extended: true }))
 
+/**
+ * подключение роутов
+ */
 app.use('/api/auth', require('./routes/auth.routes'))
 app.use('/api/notes', require('./routes/notes.routes'))
 
 if (httpsRedirect) app.use(httpToHttps)
 
+/**
+ * подключение статической библиотеки клиента
+ */
 if (!devMode) {
     app.use('/', express.static(path.join(__dirname, 'client', 'build')))
     app.get('*', (req, res) => {
@@ -30,6 +39,9 @@ if (!devMode) {
     })
 }
 
+/**
+ * запуск сервера
+ */
 async function start() {
     try {
         connectMongo(mongoUri)
@@ -42,6 +54,10 @@ async function start() {
 
 start()
 
+/**
+ * подключение к MongoDb
+ * @param {*} mongoUri 
+ */
 async function connectMongo(mongoUri) {
     if (mongoUri) {
         await mongoose.connect(mongoUri, {
@@ -54,6 +70,9 @@ async function connectMongo(mongoUri) {
     }
 }
 
+/**
+ * Вывод информации о сервере
+ */
 function logServerStart() {
     dns.lookup(os.hostname(), (err, address) => {
         const [logName, sBef, sAft] = devMode ? ['Express server', ' ', ':'] : ['React Notes App', '-', '']
@@ -64,6 +83,9 @@ function logServerStart() {
     })
 }
 
+/**
+ * перенаправление с http на https для PWA 
+ */
 function httpToHttps(req, res, next) {
     if (req.header('x-forwarded-proto') !== 'https') {
         res.redirect(`https://${req.header('host')}${req.url}`)

middleware/auth.middleware.js

@@ -1,19 +1,29 @@
 const jwt = require('jsonwebtoken')
 require('dotenv').config()
 
+/**
+ * Функция-Middleware для проверки авторизации пользователя
+ * @param {*} req 
+ * @param {*} res 
+ * @param {*} next 
+ * @returns 
+ */
 module.exports = (req, res, next) => {
+  //проверка работы сервера
   if (req.method === 'OPTIONS') {
     return next()
   }
 
   try {
-
+    /**получение токена */
     const token = req.headers.authorization.split(' ')[1] // "Bearer TOKEN"
 
+    /**проверка отсутствия токена */
     if (!token) {
       return res.status(401).json({ message: 'Нет авторизации' })
     }
 
+    /**верификация токена */
     const decoded = jwt.verify(token, process.env.jwtSecret)
     req.user = decoded
     next()

models/Note.js

@@ -1,12 +1,14 @@
 const { Schema, model, Types } = require('mongoose')
 
+/**
+ * Схема заметки для базы данных
+ */
 const schema = new Schema({
-  id: { type: String, required: true, unique: true /*, default: String(Date.now) + String(Math.random)*/ },
+  id: { type: String, required: true, unique: true },
   name: { type: String },
   text: { type: String },
   color: { type: String },
   image: { type: String },
-  //date: { type: Date, default: Date.now },
   owner: { type: Types.ObjectId, ref: 'User', required: true }
 })
 

models/User.js

@@ -1,5 +1,8 @@
 const {Schema, model, Types} = require('mongoose')
 
+/**
+ * Схема данных пользователя
+ */
 const schema = new Schema({
   email: {type: String, required: true, unique: true},
   password: {type: String, required: true},

routes/auth.routes.js

@@ -6,18 +6,22 @@ const { check, validationResult } = require('express-validator')
 const User = require('../models/User')
 const router = Router()
 
-// /api/auth/register
+/**
+ * Регистрация
+ * /api/auth/register
+ */
 router.post(
   '/register',
   [
+    /**валидация */
     check('email', 'Некорректный email').isEmail(),
     check('password', 'Минимальная длина пароля 6 символов')
       .isLength({ min: 6 })
   ],
   async (req, res) => {
     try {
+      /**проверка данных */
       const errors = validationResult(req)
-
       if (!errors.isEmpty()) {
         return res.status(400).json({
           errors: errors.array(),
@@ -27,15 +31,15 @@ router.post(
 
       const { email, password } = req.body
 
+      /**Проверка существования пользователя */
       const candidate = await User.findOne({ email })
-
       if (candidate) {
         return res.status(400).json({ message: 'Такой пользователь уже существует' })
       }
 
+      /**Хеширование пароля и сохранение пользователя */
       const hashedPassword = await bcrypt.hash(password, 12)
       const user = new User({ email, password: hashedPassword })
-
       await user.save()
 
       res.status(201).json({ message: 'Пользователь создан' })
@@ -45,17 +49,21 @@ router.post(
     }
   })
 
-// /api/auth/login
+/**
+ * Вход
+ * /api/auth/login
+ */
 router.post(
   '/login',
   [
+    /**валидация */
     check('email', 'Введите корректный email').normalizeEmail().isEmail(),
     check('password', 'Введите пароль').exists()
   ],
   async (req, res) => {
     try {
+      /**проверка данных */
       const errors = validationResult(req)
-
       if (!errors.isEmpty()) {
         return res.status(400).json({
           errors: errors.array(),
@@ -65,18 +73,19 @@ router.post(
 
       const { email, password } = req.body
 
+      /**Поиск пользователя в бд */
       const user = await User.findOne({ email })
-
       if (!user) {
         return res.status(400).json({ message: 'Пользователь не найден' })
       }
 
+      /**Проверка пароля */
       const isMatch = await bcrypt.compare(password, user.password)
-
       if (!isMatch) {
         return res.status(400).json({ message: 'Неверный пароль, попробуйте снова' })
       }
 
+      /**Создание токена */
       const token = jwt.sign(
         { userId: user.id },
         process.env.jwtSecret,

routes/notes.routes.js

@@ -6,9 +6,13 @@ const router = Router()
 
 const { checkCard } = require('../validation/CardCheck')
 
-
+/**
+ * Добавление и редактирование заметки
+ * /api/notes/set
+ */
 router.post('/set', auth, async (req, res) => {
     try {
+        /**получение данных о заметке и запись в бд */
         const card = tryParce(req.body.card)
         if (checkCard(card)) {
             postNote(card)
@@ -20,18 +24,20 @@ router.post('/set', auth, async (req, res) => {
         res.status(500).json({ message: 'Что-то пошло не так, попробуйте снова' })
     }
 
+    /**Добавление или редактирование заметки в бд */
     async function postNote(noteToSave) {
 
         noteToSave.owner = req.user.userId
 
+        /**проверка существования заметки */
         const existing = await Note.findOne({ id: noteToSave.id })
 
         if (existing) {
-            //console.log("EXITING");
+            /**Выполнится если такая заметка уже есть */
             existing.overwrite(noteToSave)
             existing.save()
         } else {
-            //console.log("NON EXITING")
+            /**Выполнится если нет такой заметки */
             const note = new Note(noteToSave)
             await note.save()
         }
@@ -40,10 +46,13 @@ router.post('/set', auth, async (req, res) => {
 })
 
 
-
+/**
+ * Удаление заметки
+ * /api/notes/delete
+ */
 router.post('/delete', auth, async (req, res) => {
     try {
-        
+        /**получение данных о заметке и удаление */
         const card = tryParce(req.body.card)
         if (checkCard(card)) {
             deleteNote(card)
@@ -55,32 +64,29 @@ router.post('/delete', auth, async (req, res) => {
         res.status(500).json({ message: 'Что-то пошло не так, попробуйте снова' })
     }
 
+    /**Удаление заметки в бд */
     async function deleteNote(noteToSave) {
         noteToSave.owner = req.user.userId
 
         const existing = await Note.findOne({ id: noteToSave.id })
 
         if (existing) {
-            //console.log("EXITING");
-           
             existing.remove()
-
         } else res.status(500).json({ message: 'уже удален' })
     }
 })
 
-
-
+/**
+ * Получение массива заметок
+ * /api/notes/
+ */
 router.get('/', auth, async (req, res) => {
     try {
-        //console.log(req.user.userId);
+        /**Нахождение пользовательских заметок в бд */
         const notes = await Note.find({ owner: req.user.userId })
-        //console.log(notes);
-        res.json(notes)
+        res.status(200).json(notes)
     } catch (e) {
-        //console.log("\n\n\n   GET");
-        //console.log(e);
-        res.status(500).json({ message: '[GET] Что-то пошло не так, попробуйте снова' })
+        res.status(500).json({ message: 'Что-то пошло не так, попробуйте снова' })
     }
 })
 

validation/CardCheck.js

@@ -1,3 +1,8 @@
+/**
+ * Проверка рбьекта заметки
+ * @param {*} card 
+ * @returns 
+ */
 function checkCard(card) {
     return (
         typeof card.id === "string" &&